SAP 3D Visual Enterprise Generator

USER GUIDE | PUBLIC2018-10-25

SAP 3D Visual Enterprise Generator

© 2

018

SAP

SE o

r an

SAP affi

liate

com

pany

. All r

ight

s re

serv

ed.

THE BEST RUN

Content

1 SAP 3D Visual Enterprise Generator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

2 User Interface - Administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92.1 Administration Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102.2 Server Monitoring. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Jobs Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Tasks Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Servers Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19Alerts Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22Cache Report Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

2.3 Server Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24Server Configuration Toolbars. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25Workflows Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Processes Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .224Derivative Types Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482Derivative Groups Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485Pick Lists Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487Metadata Categories Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .490Metadata Attributes Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .491File Types Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493Hot Folders Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .496Scheduled Activities Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498Plug-In Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500Activate Modules Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510

2.4 Security Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510Users Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513Groups Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515Projects Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518LDAP Servers Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521

2.5 SAP Integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523Connections Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523SAP Cache Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524User Names and Passwords Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525Visual Data Integration Upload Tool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527

3 Working with SAP 3D Visual Enterprise Generator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5303.1 Viewing, Filtering and Refreshing Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .531

2 P U B L I CSAP 3D Visual Enterprise Generator

Content

3.2 Server Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531Creating Workflows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532Creating Processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533Throttling Processes and Purging Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535Pausing Processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535Testing Processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536Loading, Reloading and Unloading Processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538Disabling and Enabling Processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539Exporting and Importing Processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539Initiating and Running Processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541Creating Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .542Finding and Loading Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543Entering Operation Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544Adding Parameter Selection Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545Generating Web-Service Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547Editing Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548Creating Derivative Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550Derivatives on Demand Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552Generating and Removing DoD Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553DoD Group for Individual Asset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555DoD Group for Asset Collection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556Creating Derivative Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556Creating Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557Creating, Editing, and Deleting Pick Lists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558Adding File Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .560Adding, Editing, Deleting Extensions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562Adding Hot Folders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563Manifest File Processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566Workflow Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568Adding Scheduled Activities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569Saving Parts and Assembly Instances. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572Activating Modules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .573

3.3 Server Monitoring. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574Aborting, Pausing, and Resuming Jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574Filtering and Searching Jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575Copying and Exporting Job Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576Creating Diagnostic Archives. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .576Viewing and Copying Tasks and Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 578Filtering Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581Server Farm. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582

3.4 Security Management in SAP 3D Visual Enterprise Generator. . . . . . . . . . . . . . . . . . . . . . . . . . . . 584

SAP 3D Visual Enterprise GeneratorContent P U B L I C 3

Permission Levels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586Asset Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588Managing Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .588Creating LDAP Server Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591

4 Configuration of Derivatives. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5954.1 Pick List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595

Creating and Editing Pick Lists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5964.2 Derivative Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598

Creating 3D Translation to Format Derivative Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600Creating Vector Illustration Derivative Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .601Creating Line Illustration Derivative Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602Creating Shaded Illustration Derivative Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .603Creating Solid Derivative Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .604Creating RH Exploded Derivative Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605Creating RH Export High Detail Derivative Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .606Creating RH Export Medium Detail Derivative Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607Creating RH Export Low Detail Derivative Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608Creating RH Reduced Derivative Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608Creating RH Removed Internals Derivative Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 609Creating 3D Translation to 3D Format Derivative Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610Creating PDF Publishing Derivative Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611Creating PDF Publishing 2D Drawing Derivative Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612

4.3 Derivative Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612Creating Default Derivative Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613Creating 2D Drawing Tech Illustrations Derivative Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614Creating 3D Step-By-Step Training Derivative Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617Creating CAD Assemblies and Parts Derivative Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623Creating Publishing Derivative Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625

4.4 Derivative Workflows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .626Creating Build Derivatives Workflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626Creating Select Derivatives Workflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627Creating Select All Derivatives Workflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628Creating Default Publishing Workflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629Creating Derivatives on Demand. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630

5 SAP 3D Visual Enterprise Import and Export Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6315.1 2D File Formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632

Adobe Encapsulated Postscript. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .634Adobe Illustrator Vector Graphic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635Adobe Photoshop Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636Autodesk Animator Graphic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636


Content

Computer Graphics Metafile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636Digital Imaging and Communications in Medicine Image. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638EA/Amiga Interchange File Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 638Enhanced Metafile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639Flexible Precision Buffer Map. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639FLIC Animator Animation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639Graphics Interchange Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640JEDMICS C4 Compressed Image. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640JPEG 2000 J2K and JPX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640JPEG 2000 JP2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640JPEG 2000 JPC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641JPEG Image. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642Maya Interchange File Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643OpenEXR Bitmap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .644Portable Network Graphics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645Portable Pixelmap Graphic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646Publisher's Paintbrush Bitmap Graphic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646Radiance Picture Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647Scalable Vector Graphics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647Silicon Graphics Image. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647SOFTIMAGE Picture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .648Tagged Image File Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .648TGA File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649Windows Bitmap Graphic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650Windows Cursor File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650Windows Icon File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650Windows Metafile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651Windows Run Length Encoded Bitmap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651

5.2 3D File Formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651AOFF File Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653AutoCAD Design Web Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654AutoCAD Drawing Files (.dxf, .dwg, .dst). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655Autodesk 3D Studio. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674Autodesk 3D Studio Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676Autodesk FBX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677Caligari trueSpace Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 678Caligari trueSpace Scene. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679CINEMA 4D. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .680COLLADA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 681DirectX Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682Gerber File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 684


Hewlett-Packard Graphics Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686Imagine Geometry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686ISO G Code Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686LightWave 3D and Binary Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687LightWave Scene. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689Maya ASCII Scene. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691Maya Binary Scene. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 693Object File Format Vector Graphics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696Open Inventor File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696OpenFlight Scene Description Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .697Points File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699Polygon Model Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 699Portable Graymap Heightfield. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700POV-Ray RAW Triangle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700Power Render Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701Protein Data Bank. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 701Rhinoceros 3D Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705SAP 3D Visual Enterprise Binary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707Silo3D. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710SketchUp Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711SOFTIMAGE|XSI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .712Stereolithography Rapid Prototyping Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 715Universal 3D. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716Visual Design Stream. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720Visual XML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 724VRML Worlds. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .726XAML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 728Wavefront Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 730

5.3 Video File Formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733Audio Video Interleave Animation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733Moving Pictures Expert Group Video Export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735

5.4 Document File Formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735Adobe Portable Document 2D. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736Adobe Portable Document 2D (Template). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .737Adobe Portable Document 3D. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739Adobe Portable Document Import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748Flex Web Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749HTML Document with 3D. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753Office PowerPoint Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .756Web Archived HTML Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759

5.5 Material File Formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .762


Content

Autodesk 3D Studio Material. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .762SAP 3D Visual Enterprise Material. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762Wavefront Material. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .763

5.6 Miscellaneous File Formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 763WinRAR Compressed Archive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764Text File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764ZIP Archive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764

5.7 CAD File Formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764ACIS Assembly and Part. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767CATIA Graphical Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 769CATIA V4 Assembly and Part. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .770CATIA V5 Assembly and Part. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777CATIA V6 (3DXML). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .793Creo Parametric (Pro/ENGINEER) Assembly and Part. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .794IGES Assembly and Part. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .805Industry Foundation Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .808Inventor Assembly. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .809Inventor Part. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812JT File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815MicroStation CAD Graphic. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821NX Parts, Assemblies, and Drawings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823Parasolid Assembly and Part. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .829PLMXML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 831Solid Edge Assembly. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832Solid Edge Part. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835Solid Edge Sheet Metal Part. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 838Solid Edge Weldment Design Part. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841Solid Edge Drawing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844SolidWorks Assembly. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .845SolidWorks Part. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .848SolidWorks Drawing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851STEP Compressed Assembly and Part. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 852STEP Assembly and Part. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855


1 SAP 3D Visual Enterprise Generator

SAP 3D Visual Enterprise Generator is a graphical processing client-server application that allows you to automate the processing of CAD and other 2D and 3D graphics.

With SAP 3D Visual Enterprise Generator, you can create enterprise solutions that enable nontechnical users to search, access, manipulate, and integrate complex graphical data into any business or office application across an organization.

SAP 3D Visual Enterprise Generator comprises the following parts:

● SAP 3D Visual Enterprise Generator Configuration● SAP 3D Visual Enterprise Generator Administration

You use SAP 3D Visual Enterprise Generator Configuration to start and stop SAP 3D Visual Enterprise Generator, and to establish configuration settings for SAP 3D Visual Enterprise Generator during and after its installation. In most instances, configuration is performed during installation; however, you are also able to configure certain settings of SAP 3D Visual Enterprise Generator after installation.

If the Manual Configuration option was selected during installation, you need to load additional operations and processes, and import PDF templates through the Administration component.

NoteThis help section provides you with functional information for both SAP 3D Visual Enterprise Generator Administrator and SAP 3D Visual Enterprise Generator Configuration. For more information about SAP 3D Visual Enterprise Generator Configuration, contact your system administrator.

You can use SAP 3D Visual Enterprise Generator Administration to monitor, manage, and administer SAP 3D Visual Enterprise Generator.

SAP 3D Visual Enterprise Generator Administration comprises the following administrative areas:

● Server Configuration (see Server Configuration [page 24])Used to manage configurable server procedures

● Server Monitoring (see Server Monitoring [page 10])Used to monitor and manage the SAP 3D Visual Enterprise Generator server farm

● Security Management (see Security Management [page 510])Used to control security within SAP 3D Visual Enterprise Generator

● SAP Integration(see SAP Integration [page 523])Used to control available options for operating in Integrated mode

NoteThis area is displayed only if you work in or connect to SAP 3D Visual Enterprise Generator that is installed in the Integrated mode.

See SAP Note 1787261 for information on corrections made after the documentation has been delivered.


SAP 3D Visual Enterprise Generator

http://help.sap.com/disclaimer?site=https://launchpad.support.sap.com/#/notes/1787261

2 User Interface - Administration

Once SAP 3D Visual Enterprise Generator Administration is opened, you can click the area names in the navigation pane to switch between the administrative areas. The selected node is remembered by SAP 3D Visual Enterprise Generator Administration when you switch between areas, enabling administrative tasks to be completed more quickly.

This SAP 3D Visual Enterprise Generator Administration user interface has the following component parts:

● Application title barDisplays the application title

● Navigation paneDisplays the administrative area nodes, and is used to access the selected area’s functionality

● Administrative areasUsed to switch between the administrative areasEach administrative area comprises a number of interface components: area nodes, a context-sensitive panel for each node comprising subpanels, toolbars, filters, node-related information, and various fields, and context depending on the selected node.

○ : The Server Configuration nodes, with which you can perform configuration activities including managing workflows and processes.

○ : The Server Monitoring nodes, with which you can monitor and manage the server farm.

○ : The Security Management nodes, with which you can control security within SAP 3D Visual Enterprise Generator.

○ SAP Integration: Available only if you work in or connect to SAP 3D Visual Enterprise Generator that is installed in the Integrated mode

● PanelDisplays the selected node’s items, toolbars, and subpanels, and is used to access functionality for the selected nodeNote that certain panels comprise subpanels with further items and toolbars, used to access functionality for the selected subpanel item.

● ToolbarsProvide access to the main commands for the selected node

● FiltersUsed to filter the items within the current panel

● Context menusUsed to access functionality related to the selected panel item

● NodesUsed to display the selected node’s panel

● Administration toolbar (see Administration Toolbar [page 10])Provides access to the main commands for SAP 3D Visual Enterprise Generator Administration

SAP 3D Visual Enterprise GeneratorUser Interface - Administration P U B L I C 9

2.1 Administration Toolbar

Use

The administration toolbar is situated on the right of the bottom edge of the SAP 3D Visual Enterprise Generator user interface. It provides access to the common functions of all administrative areas such as viewing information about SAP 3D Visual Enterprise Generator and the online help.

Features

Icon Functional Description

Displays version information about SAP 3D Visual Enterprise Generator Administration

Displays the SAP 3D Visual Enterprise Generator online help

Used to log out from, and to close SAP 3D Visual Enterprise Generator Administration

2.2 Server Monitoring

The area displays the Server Monitoring nodes to manage the server farm.

The Server Monitoring administrative area comprises the following panels:

Panel Functional Description

The top-level node; it can be minimized and maximized as required.

(see Jobs Panel [page 11])

Manages all jobs that are processed by SAP 3D Visual Enterprise Generator

(see Tasks Panel [page 16])

Manages SAP 3D Visual Enterprise Generator tasks


User Interface - Administration


(Server Farm) (see Servers Panel [page 19])

Starts and stops computers within the server farm

(see Alerts Panel [page 22])

Manages SAP 3D Visual Enterprise Generator alerts

2.2.1 Jobs Panel

Use

The Jobs panel displays a list of the current jobs and related information including the progress of jobs, the tasks required to complete the job, and the job owner. It is used to manage SAP 3D Visual Enterprise Generator jobs and their components.

A job is an activity that has been scheduled manually (see Scheduled Activities Panel [page 498]) using SAP 3D Visual Enterprise Generator, or requested through a client application such as SAP Visual Enterprise Access. For example, creating new 3D derivatives or uploading assets. All jobs implement a workflow that call up the processes that SAP 3D Visual Enterprise Generator uses to process files.

The job panel displays various information for each job. Once a job has run, you can access further information about each job including a job report, user action details, and diagnostic details where issues have arisen.

NoteJob information is not updated during processing; you must refresh the panels to see the most recent information.

Job Status

The job status depends on the stage at which the job is currently being processed. Job status is indicated by an icon displayed next to the job ID, and by the color of progress bar:

: The job is queued for processing.

: The job is being processed.

: The job was paused by a user.

: The job was stopped by a user.

: The job was processed successfully.


: The job was processed successfully with warnings.

: The job was not processed successfully due to errors.

Job Reports

When you click a job in the Jobs panel, the related job report is displayed below in the Job Report panel. Job reports display detailed information for each job. Reports comprise the status of the actions that are performed during job processing; the actions are arranged in logical groups called steps.

For example, the Startup Arguments step contains the arguments used to initiate the job, and the Extract BOM step contains information related to any BOM extraction and whether it was successful.

Diagnostic Archive

Diagnostic information can be saved as a ZIP file for each job. For example, you can save configuration data, definition file data, and all log files. This can be helpful if issues arise with a particular job, and the information can be used by SAP AG support to assist in resolving issues.

You can use the filters to refine the job display. For example, you can filter the jobs on their current status or associated workflow. You can also move your cursor over each job to display the job status. For example, whether the job completed successfully, or was aborted.

For more information, see Creating Diagnostic Archive [page 576].

Features

The Jobs panel comprises the following:

● Jobs toolbarThe Jobs toolbar provides access to the common job functions such as pausing and resuming job processing. When you click a job in the Jobs panel, the details of that are displayed in the Job Report panel.

Toolbar Buttons Functional Descriptions

Refresh Displays the most current job information

Abort Job Aborts the selected job: all the job tasks are removed from the queue and deleted from the database. Tasks that are currently running or that have already sent to the processing engine continue to run, but the results are ignored, and tasks that have not been sent to the processing engine do not run.




Pause Job Pauses the selected job: all job tasks are paused on the queue. Tasks that are currently running or that have already sent to the processing engine continue to run, but the results are ignored, and tasks that have not been sent to the processing engine are paused. The pause icon only displays for the job after any tasks have finished running.

Resume Job Resumes processing for the selected job

Maximum Results Limits the number of jobs displayed in the panel

Filters Displays advanced filters on which to refine the jobs display

Name: Filters for jobs with the specified text in the job name

Workflow: Filters for jobs with the specified text in the associated workflow name

Status: Filters for jobs with the selected status

Filter Filters jobs within the panel, based on the job name

● Jobs menuThe Job menu is displayed when you right-click a job in the Jobs panel.

Menu Options Functional Description

Abort Job Aborts the current job: all the job tasks are removed from the queue and deleted from the database. Tasks that are currently running or that have already sent to the processing engine continue to run, but the results are ignored, and tasks that have not been sent to the processing engine do not run.

Pause Job Pauses the selected job: all job tasks are paused on the queue. Tasks that are currently running or that have already sent to the processing engine continue to run, but the results are ignored, and tasks that have not been sent to the processing engine are paused. The pause icon only displays for the job after any tasks have finished running.

Resume Job Resumes processing for the selected job

Open Job Report Opens the selected job’s report in the Job Report window

View User Actions Opens the User Actions window to view detailed user information for the selected job



Create Diagnostic Archive Opens the Diagnostic Archive window to view detailed user information for the selected job

● A list of jobs and their attributes are displayed in the following table columns:

Columns Functional Descriptions

Job ID The job identification number allocated by the SAP 3D Visual Enterprise Generator database

Name The job name

Progress The job progress

Start The time that the job began processing

End The time that the job stopped processing

NoteA long time between the start and end times may indicate that more processing engines are required.

Elapsed The amount of time that the job took to process

Owner The system or an individual user who requested the job

Workflow The workflow used to execute the job

● Job Report subpanelA report is displayed in the Job Report subpanel when a job is selected: the report comprises steps and actions associated with the selected job. A toolbar allows you to manage the report. Double-clicking a job displays the job report in a separate window.

NoteRefresh the panels to see the most recent information as job information is not updated during processing.

Processes run manually from within the Process Designer (debug sessions) are not visible in the Jobs panel, regardless of their status.

The Job Report subpanel comprises the following:

● Job Report toolbarThe Job Report toolbar provides access to the common job report functions such as copying and exporting reports.




Refresh Displays the most current job report details

Copy to Clipboard Copies the selected job step to the clipboard

Export Used to save the selected job step as either a plain text or XML file

Plain Text: Saves the step as a plain text file in the location you choose

XML: Saves the step as a XML file in the location you choose

Reset Change Flag Resets the change flag for the selected report

Release ERP Locks Resets all ERP locks

Filter Searches for text within job steps and actions. Each instance that is located is highlighted in yellow.

● Report for the selected job, including the following:○ Steps

Used to display the status of actions performed for each job. Steps are different for each job depending on the job workflow. For example, one job may have the Startup Arguments step showing the arguments used to initiate the job, and the Build Assets step showing the status of asset building that the job attempts during processing. Another may include the Extract BOM step showing if the BOM was extracted successfully.

○ ActionsThe activities performed as part of the job workflow. These can be expanded to view action details.

Activities

To open the Job Report subpanel, open the Jobs panel and click a job.

To open the Job Report window, open the Jobs panel and double-click a job.

More Information

Aborting, Pausing, and Resuming Jobs [page 574]

Filtering and Searching Jobs [page 575]

Copying and Exporting Job Reports [page 576]

Creating Diagnostic Archives [page 576]


2.2.2 Tasks Panel

Use

The Tasks panel displays an activity history of the entire server farm: a task list of the current processes and related information including the job ID of the associated job, and the process name. It is used to manage SAP 3D Visual Enterprise Generator tasks and their components. Double-clicking a task displays the Task Log window for the selected task.

A task is a unit of work that SAP 3D Visual Enterprise Generator carries out when jobs are processed. Tasks relate directly to processes: once a job is initiated for processing, a message for each process-related task is sent to the incoming queue, and that task is queued for processing. Tasks can run independently of jobs. That is, if a job is initiated and then paused or stopped, any task messages that have already been queued continue to be processed.

If a process associated with a task is disabled of throttled, the related tasks are deferred until that process has once again become active.

NoteTask information is available for as long as it is in the database. Only the most recent information is displayed at first, but you can use the filters to view historical data. However, task detail data is dependent on the XML files that are periodically cleaned after 3 days.

Task Log

The Tasks andServer Task panels, and the Task Log window display a record (log) of each task, being all information that relates to the task’s associated process. This data is stored in the SAP 3D Visual Enterprise Generator database and can be displayed to a maximum of 1000 logs. Process-related messages can also be displayed for each task in the Task Log window including warning, error, information, and debug messages.

If a process is executing while the log is displayed, you can refresh the logs to view the most current information.

NoteThe level of logging is configured in the SAP 3D Visual Enterprise Generator Configuration. Contact your system administrator for more information.

Task Status

The task status depends on the stage at which the task is currently being processed: it is based on the period of time that a task entered or exited the queue. It is indicated by an icon in the first column, and by text in the Status column:

: The task is queued for processing.

: The task is being processed.

: The task was deferred by the system. For example, if the associated process was disabled or throttled.



: The task was processed successfully.

: The task was not processed successfully due to errors.

Task Details

When you double-click a task in the Tasks panel, the task details are displayed in the Task Log window, where you can view and filter task logs and to view process-related messages for individual tasks.

Task information is available for as long as it is in the database. Only the most recent info is displayed at first, but you can use the filters to view historical data; however, task detail data is dependent on the XML files that are periodically cleaned after 3 days.

Features

The Tasks panel comprises the following:

● Tasks toolbarThe Tasks toolbar provides access to the common task functions such as limiting the number of tasks displayed and filtering tasks.

Toolbar Buttons and Fields Functional Descriptions

Refresh Displays the most current task information

Max Results Limits the number of tasks displayed in the panel

Filter Filters tasks within the panel, based on the associated process name

Job ID Filters for tasks with the identical job ID

Process Filters for tasks with the specified text in the associated process’s name

Status Filters for tasks with the selected status

Server Filters for tasks with the specified text in the associated server name

Start Time Activates the start date and time filters


Toolbar Buttons and Fields Functional Descriptions

Start date and time fields Filters for jobs that were queued on the selected date and time

NoteClick in the hour, minute, and second fields to and use the arrows to select the exact time.

End Time Activates the end date and time filters

End date and time fields Filters for jobs that completed the queue on the selected date and time


● List of jobs and their attributes displayed in the following table columns:


Job ID The identification number of the task’s associated job

Task ID The task identification number allocated by the SAP 3D Visual Enterprise Generator database

Process The task’s associated process

Started The time that the task was queued

Completed The time that the task completed the queue

Elapsed The time taken for the task to complete. That is, when it stopped processing.

Status The current status of each task

Server The task’s associated server

More Information

Viewing and Copying Tasks and Details [page 578]

Filtering Tasks [page 581]



2.2.3 Servers Panel

Use

The Servers panel displays a list of the master and slave computers that form the server farm. It also displays related information including the machine name, status, and server operating system. It is used to manage SAP 3D Visual Enterprise Generator servers and their components. Server tasks are displayed in the Server Tasks subpanel when you select a server, from where you can view the task details and use the Task Log window to filter those tasks.

Server computers can be in one of three states, indicated by an icon displayed next to the server name, and the Status column:

● : The server is active and processing queued jobs.

● : The server is inactive after processing all queued jobs.

● : The server is stopped and cannot process any queued jobs.

Managing Servers

Individual servers can be stopped, started, and restarted to suspend and reinstate SAP 3D Visual Enterprise Generator operations, using the Servers panel. When a server stops, the following SAP 3D Visual Enterprise Generator components and activities are halted:

Incoming message queue

The controller sending jobs to slave computers

Hot folder monitoring

Running of scheduled activities

If the engine queue has a partially completed job, the job is completed and the queue is stopped until a ‘start’ command is received.

All task actions can also be performed in the Tasks panel.

Features

The Servers panel comprises the following:

● Servers toolbarThe Servers toolbar provides access to the common server functions such as starting and stopping individual servers. When you click a server in the Servers panel, the related tasks are displayed in the Server Tasks subpanel.



Refresh Displays the most current server information

Stop Processing Stops all processing on the selected server. The server status is Stopped.

Start Processing Starts all processing on the selected server. The server status is Running.

Restart Resumes all processing on the selected server. The server status is Running. You should only restart a server if you have paused all jobs on that server.

Filter Filters servers within the panel, based on the server name

● Server menuThe Server menu is displayed when you right-click a server in the Servers panel.


Stop Processing Stops all processing on the selected server. The server status is Stopped.

Start Processing Starts all processing on the selected server. The server status is Running.

Restart Server Resumes all processing on the selected server. The server status is Running. You should only restart a server if you have paused all jobs on that server.

● A list of servers and their attributes is displayed in the following table columns:


Name The server name

Status The master or slave’s current status

Queue The directory path of the MSMQ engine queue

Operating System The server operating system

Processors The number of allocated processes

● Server Tasks subpanel

The Server Tasks subpanel is used to view and filter server, and view server task details. Double-clicking a task displays the Task Log window for the selected task.



NoteTask information is available for as long as it is in the database. Only the most recent information is displayed at first, but you can use the filters to view historical data; however, task detail data is dependent on the XML files that are periodically cleaned after 3 days.

The Server Tasks subpanel comprises the following:

● Server Tasks toolbarThe Server Tasks toolbar provides access to the common task functions such as filtering and refreshing server tasks.


Refresh Displays the most current server information

Maximum Results Limits the number of tasks displayed in the panel

Filter Filters for tasks within the panel, based on the associated process name

● A list of tasks for the selected server and their attributes is displayed in the following table columns:


Job ID The identification number of the task’s associated job

Task ID The task identification number allocated by the SAP 3D Visual Enterprise Generator database

Process The task’s associated process

Started The time that the task was queued

Completed The time when the task completed the queue

Elapsed The time taken for the task to complete. That is, when it stopped processing.

Status The current status of each task

Server The task’s associated server

Activities

To open the Server Tasks subpanel, open the Servers panel and click a server.


To stop, start or restart a server, do one of the following in the Servers panel:

● Right-click the server and choose corresponding option (Stop Processing, Start Processing, Restart) in the context menu

● Select the server and choose corresponding button (Stop Processing, Start Processing, Restart) on the Servers toolbar

To view a task, do one of the following in the Servers panel:

● Choose the server in the Servers panel. The related tasks are displayed in the Server Tasks panel.● Double-click the task. The task is displayed in the Task Log.

More Information

Server Farm [page 582]

2.2.4 Alerts Panel

Use

The Alerts panel displays the alerts for the master, slaves, and server farm. It is used to manage alerts and their components.

An alert is a warning that conveys information relating to SAP 3D Visual Enterprise Generator processing activity and errors. SAP 3D Visual Enterprise Generator monitors all processing activity and provides a list of alerts, including the error that caused the alert, the way in which SAP 3D Visual Enterprise Generator responded to the error, and the time that SAP 3D Visual Enterprise Generator recovered or resumed.

Features

The Alerts panel comprises the following:

● Alerts toolbarThe Alerts toolbar provides access to the common alert functions such as filtering alerts and refreshing the display.


Refresh Displays the most current alert information

Filter Filters alerts within the panel, based on the alert name



● List of alerts and their attributes displayed in the following table columns:


Name The alert name

Type The type of alert

Description The alert description

Error An error that cause the alert

Action The action that SAP 3D Visual Enterprise Generator took as a response to the error

Time Raised The time the alert was raised

Time Last Raised The last time an instance of this alert was raised

Time Reset The time that SAP 3D Visual Enterprise Generator recovered or resumed

2.2.5 Cache Report Panel

Use

You can use the Cache Report panel to view the current status of the SAP 3D Visual Enterprise Generator original file and viewable cache. It also allows you to clear the cache to free up disk space.

Features

The Cache Report panel comprises the following:

● Cache Report toolbarThe Cache Report toolbar provides access to the common cache functions such as clearing the cache and refreshing the display.


Refresh Displays the most current cache information



Clear Cache Clears the cache to free up disk space

2.3 Server Configuration

The area opens by default when you log onto SAP 3D Visual Enterprise Generator Administration.

The Server Configuration administrative area comprises the following panels:


Manages processing workflows used by client applications such as SAP Visual Enterprise Access

Manages derivative types and derivatives, and generates derivative on demand (DoD) definitions

Manages all processes and opens the Process Designer

Manages tasks relating to derivative groups

Manages metadata categories

Manages associated metadata that is displayed and can be searched in client applications

Manages the pick lists and values that are displayed in client applications

Manages file types, asset types, and original file storage

Manages the folders that are monitored by SAP 3D Visual Enterprise Generator

Schedules jobs



2.3.1 Server Configuration Toolbars

Use

The Server Configuration toolbars are displayed when you click the Server Configuration nodes. They are context-sensitive depending on the selected node. For example, the Hot Folders toolbar is displayed when you click the Hot Folders node in the Server Configuration area.

Activities

The following table describes functions that are available for most Server Configuration toolbars:

Toolbar Button Functional Description

Refresh Depending on the panel you select, displays the most current information about one of the following:

● Workflows● Derivative types● Processes● Derivative groups● Metadata categories● Metadata● Pick lists● File types● Extensions● Hot folders● Scheduled activities

New Depending on the panel you select, can be used to create the following new objects:

● Workflow● Derivative type● Process (opens Process Designer)● Derivative group● Metadata category● Metadata● Pick list● File type● Extension● Hot folder● Scheduled activity



Edit Depending on the panel you select, can be used to modify one of the following:

● Workflow● Derivative type● Process● Derivative group● Metadata category● Metadata● Pick list● Extension● Hot folder● Scheduled activity

Note that this function is not available for file types.

Delete Depending on the panel you select, can be used to delete one of the following:

● Workflow● Derivative type● Derivative group● Metadata category● Metadata● Pick list● Extension● Hot folder● Scheduled activity

Note that this function is not available for processes.

For file types, choose file type to open the Extensions toolbar.




Filter Depending on the panel you select, filters one of the following based on the name:

● Workflows● Derivative types● Processes● Derivative groups● Metadata categories● Metadata● Pick lists● File types● Hot folders● Scheduled activities

Note that this function is not available for the Extensions toolbar.

2.3.2 Workflows Panel

Use

The Workflows panel displays a list of the current workflows and related information, including the controller and processing validity. You can use this panel to manage SAP 3D Visual Enterprise Generator workflows and their components.

All jobs implement a workflow. A workflow comprises the following:

● Business logic defined within a workflow controller● A Workflow controller is a configurable set of instructions (a template) that contains business logic for a

particular group of processing tasks. Controllers expose settings that can be used to define specific processing behavior: they employ SAP 3D Visual Enterprise Generator processing engine processes to perform file processing tasks.

● Numerous controllers are delivered with SAP 3D Visual Enterprise Generator. For all controller descriptions, see Controllers [page 29].

● Workflow settings that are configured for each workflow

By default, SAP 3D Visual Enterprise Generator is configured with a number of workflows that perform common processing tasks. However, you can customize SAP 3D Visual Enterprise Generator processing by changing the workflow settings, or by modifying the processes that are called by the workflow.

For example, you may want to create a workflow that uploads .jt assemblies in a different manner to the standard assembly upload.

When you upload an asset in client applications, you apply a workflow which determines how SAP 3D Visual Enterprise Generator builds the asset derivatives.


NoteContact your system administrator for information on configuring SAP 3D Visual Enterprise Generator during installation.

Pre-Completion and Post-Completion Workflows

Other jobs can be configured to run at certain times by configuring pre-completion and post-completion workflows.

● Pre-completion workflows are started when the current workflow finishes processing, but before the job is closed.

● Post-completion workflows are started after the current workflow job is closed.

Controller Specific Settings

Depending on the selected workflow controller, various settings may be available for definition including the following:

● Selecting the processes that the controller runs to perform specific tasks. For example, by default the Assembly Upload workflow contains the Extract BOM process to define the way in which the BOM is extracted when an assembly is uploaded. Whereas, the Build Derivatives workflow contains the Store the build derivatives process for saving derivatives that are created when assets are uploaded.

● Defining a child workflow that processes during the processing of its parent.● Additional settings that are specific to each controller. For example, you can choose a default derivative

group for certain controllers, with which derivatives are created.

Child Workflows

You can apply workflows as children of others: only workflows that accept the same input (are compatible) can be selected as children. For example, if you are creating a workflow based on the PLM Asset Publish controller, you can select the Select Published Asset Derivatives workflow as a child.

Monitoring and Scheduling

You can also use workflows to do the following:

● Process certain files when they are placed in a hot folder (see Hot Folders Panel [page 496])● Process files when a job is scheduled to run

Features

The Workflows panel comprises the following:

● Workflows toolbar● Workflows context menu

The Workflow menu is displayed when you right-click a workflow in the Workflows viewport.



Menu Options Functional Descriptions

Edit Opens the Workflows window to modify the selected workflow (see Creating Workflows [page 532])

Delete Deletes the selected workflow

Duplicate Duplicates the selected workflow

● The list of available workflows and their attributes is described in the following columns:

Fields Functional Description

Name The workflow name

Controller The template on which the workflow is based. Controllers contain the business logic that for a particular set of processing tasks.

Enabled If Yes, indicates that a workflow is available for asset processing

Is Valid If Yes, indicates that all processes required by the workflow are loaded

NoteThe workflow only processes correctly with the Yes setting. Otherwise, you must load all required processes.

Supported in Current Processing Mode If Yes, indicates that the workflow is available in the current processing mode

More Information

Creating Workflows [page 532]

2.3.2.1 Workflow ControllersA workflow controller is a configurable set of instructions (a template) that contains business logic for a particular group of processing tasks. Controllers expose settings that can be used to define specific processing behavior: they employ SAP 3D Visual Enterprise Generator processing engine processes to perform file processing tasks.

Numerous controllers are delivered with SAP 3D Visual Enterprise Generator. By default, SAP 3D Visual Enterprise Generator is configured with a number of workflows that perform common processing tasks.


However, you can customize SAP 3D Visual Enterprise Generator processing by changing the workflow settings, or by modifying the processes that are called by the workflow.

The controllers that are delivered with SAP 3D Visual Enterprise Generator vary, depending on your installation type. The delivered workflows are as follows:

Workflows Delivered with a Standalone Setup

Workflow Name Workflow Controller Functional Description

Assembly Upload CAD Assembly Upload Workflow Controller [page 54]

Analyzes the structure of CAD assemblies and creates assets, asset instances, and absolute instances in for each part and subassembly of the targeted assembly

Asset Upload Asset Upload Workflow Controller [page 34]

Uploads monolithic, single-file assets to SAP 3D Visual Enterprise Generator

Build Derivatives Build Derivatives Workflow Controller [page 42]

Builds a set of derivatives according to an input file that fully describes the derivatives to be produced.

Build Viewables Build Viewables Workflow Controller [page 46]

Generates visual representations of assets and assemblies (viewables) as defined in the input XML schema for this workflow

ConvertToRH Universal Process Workflow Controller [page 176]

Executes SAP 3D Visual Enterprise Generator processes in the context of a managed job. This means that SAP 3D Visual Enterprise Generator processes can be used everywhere that jobs can be used

Default Replace Parts PLM Replace Parts Workflow Controller [page 129]

Retranslates the affected parts and rebuilds all affected assemblies, asset instance, and assembly instance hierarchies where one or more parts have been translated incorrectly

Default Translation PLM Translation Workflow Controller [page 138]

Creates structured assets in SAP 3D Visual Enterprise Generator that have their identities controlled by external systems; for example, PLM systems. Parts and assemblies in the asset structures are reusable, so assets created by prior jobs can be referenced by subsequent jobs.

Download Object Cache Download Object Cache

Metadata Export Metadata Import and Export Workflow Controller [page 117]

Enables the import or export of asset and instance metadata related to assets stored in the SAP 3D Visual Enterprise Generator database

ProExplorer Assembly Upload CAD Assembly Upload Workflow Controller [page 54]

Analyzes the structure of ProE assemblies and creates assets, asset instances, and absolute instances in for each part and subassembly of the targeted assembly




Select All Derivatives Select All Derivatives Instructs the Build Derivatives workflow controller to create one secondary derivative for each derivative type instance in the derivative group specified for that asset version

Select Step Derivatives Select Step Derivatives Workflow Controller [page 167]

Allows multiple derivatives to be built for each asset version in the input file

System Maintenance System Maintenance Workflow Controller [page 174]

Performs system maintenance tasks

Workflows Delivered with an Integrated Setup


BOM Basic Views PDF Template Conversion

DMS PDF Template Converter Workflow Controller [page 66]

Analyzes the structure of CAD assemblies and creates assets, asset instances, and absolute instances in for each part and subassembly of the targeted assembly

Build Derivatives Build Derivatives Workflow Controller [page 42]

Builds a set of derivatives according to an input file that fully describes the derivatives to be produced.

Build Viewables Build Viewables Workflow Controller [page 46]


Build Viewables (VDS) Build Viewables Workflow Controller [page 46]


Conversion Complete Universal Process Workflow Controller [page 176]

Executes SAP 3D Visual Enterprise Generator processes in the context of a managed job. This means that SAP 3D Visual Enterprise Generator processes can be used everywhere that jobs can be used

Convert 2D CAD Integrated Asset Workflow Controller [page 108]

Converts single 2D CAD files in an SAP integrated system

Convert 2D Raster Integrate Asset Workflow Controller [page 176]

Converts single 2D raster files in an SAP integrated system

Convert 2D Vector Integrated Asset Workflow Controller [page 176]

Converts single 2D vector files in an SAP integrated system



Convert 3D CAD Integrated Asset Converter Workflow Controller [page 176]

Converts single 3D CAD files in an SAP integrated system

Convert 3D CAD ProE Integrated Asset Workflow Controller [page 176]

Converts single ProE files in an SAP integrated system

Convert Assembly CAD Integrated Assembly Workflow Controller [page 88]

Performs conversions of CAD assembly files to RH format, as well as any configured derivatives, for storage in the SAP Document Management System (DMS)

Convert Assembly CAD ProE Integrated Assembly Workflow Controller [page 88]

Performs conversions of CAD ProE assembly files to RH format, as well as any configured derivatives, for storage in the SAP Document Management System (DMS)

Convert RH to Animated GIF Integrated Asset Workflow Controller [page 176]

Converts single RH files in an SAP integrated system

Convert RH to JPG Integrated Asset Workflow Controller [page 176]

Converts single files to JPG in an SAP integrated system

Convert RH to VDS Integrated Asset Workflow Controller [page 176]

Converts single files to VDS in an SAP integrated system

Download Files (KPRO) Download Files Workflow Controller [page 71]

Creates structured assets in SAP 3D Visual Enterprise Generator that have their identities controlled by external systems; for example, PLM systems. Parts and assemblies in the asset structures are reusable, so assets created by prior jobs can be referenced by subsequent jobs.

Download Object Cache Download Object Cache

Extract Metadata DMS VDI Metadata Extractor Workflow Controller [page 212]

Takes an XML document describing hierarchies of visualization files to analyze (each hierarchy is analyzed independently), retrieves all files for each hierarchy, and then analyzes each hierarchy

Extract Metadata with TMats DMS VDI Metadata Extractor Workflow Controller [page 212]

Takes an XML document describing one or more hierarchies of visualization files to analyze (each hierarchy is analyzed independently), retrieves all files for each hierarchy, and then analyzes each hierarchy




Generic Conversion Generic Conversion Workflow Controller [page 81]

Converts translatable files to SAP viewables, optionally, creates derivatives from the viewables, creates CAD structure XML in public schema VZXML format and, stores the SAP viewables, derivatives, CAD structure XML, and response XML in a shared storage location

KPRO Retrieve KPRO Retrieve Workflow Controller [page 115]

Performs source file retrieval from KPRO and DMS in an SAP integrated system

KPRO Store KPRO Store Workflow Controller [page 116]

Stores files into KPRO and DMS in an SAP integrated system

KPRO Store (RFC) KPRO Store Workflow Controller [page 116]

Stores files into KPRO and DMS in an SAP integrated system

Select All Derivatives Select All Derivatives Instructs the Build Derivatives workflow controller to create one secondary derivative for each derivative type instance in the derivative group specified for that asset version

System Maintenance System Maintenance Workflow Controller [page 174]

Performs system maintenance tasks

Visual Data Integration (PLMXML) Visual Data Integration Workflow Controller [page 179]

Analyzes and converts CAD assets managed by an external Product Data Management system (PDM) into a configured DMS Document type

Visual Data Integration (Resolved Structure)

Visual Data Integration Workflow Controller [page 179]


Visual Data Integration (SAP PLM Solidworks Integration)



Visual Data Integration (Structure Extracted from CAD)



Visual Data Integration (Upload Client) Visual Data Integration Workflow Controller [page 179]

Manual upload of CAD assets from a file system


2.3.2.1.1 Asset Upload Workflow Controller

Use

The Asset Upload workflow controller is a controller for uploading monolithic, single-file assets to SAP 3D Visual Enterprise Generator. Each file uploaded corresponds to a distinct SAP 3D Visual Enterprise Generator asset.

For supported file formats, SAP 3D Visual Enterprise Generator translates the uploaded asset into a master derivative that can be used to build secondary derivatives.

Assets are identified by their SAP 3D Visual Enterprise Generator path. The SAP 3D Visual Enterprise Generator path of an asset is the target server path of the job in which it was created, combined with the path and file name of the uploaded asset. For example, given that the target server path for a particular asset upload job was Default\Assets, and the file name of an uploaded asset is Test\file.name, the SAP 3D Visual Enterprise Generator path of the asset will be Default\Assets\Test\file.name.

When an asset already exists with a particular SAP 3D Visual Enterprise Generator path, and an asset with the same path is uploaded again, a new version of the asset is created.

Features

The only configurable setting for the Asset Upload workflows is the Default Derivative Group. This is the derivative group describing which derivatives to build for an Asset Upload job. For more information, see Configuring Asset Upload Workflow [page 36].

The startup arguments for the Asset Upload workflow controller are the following:

Asset Upload: Arguments

Argument Description

InputFilePath Fully qualified path to an asset archive ZIP file containing a file named DS.manifest, and, if referencing is disabled, the assets themselves

TargetServerPath The default base path in SAP 3D Visual Enterprise Generator where assets should be stored. This can be overridden by the DS.manifest file inside of the archive ZIP file.



2.3.2.1.1.1 Starting Asset Upload Workflow Controller

Use

Workflows using the Asset Upload workflow controller can be used to start jobs as follows:

● Using an asset upload from SAP Visual Enterprise Access● Using a Manifest Workflow Job hot folder● Using SAP 3D Visual Enterprise Generator Web service API call

Procedure

To start an Asset Upload job from SAP Visual Enterprise Access, proceed as follows:

1. Log on to SAP Visual Enterprise Access.2. In the Browse page, navigate to the target folder into which you want to upload the assets.

3. Choose .4. Choose Add Files, select the assets to upload, and choose Open. The files are displayed in the Files to

Upload area. Choose Upload to start the job.

To start an Asset Upload job from a Manifest Workflow Job hot folder, proceed as follows:

1. Configure a Manifest Workflow Job hot folder, selecting asset and assembly workflows you want to use.2. Drop a manifest file in the hot folder.3. For more information about the manifest file format, see the SAP 3D Visual Enterprise Generator help.

To start an Asset Upload job from an SAP 3D Visual Enterprise Generator Web service API call, proceed as follows:

● When the assembly files are in a location accessible by SAP 3D Visual Enterprise Generator directly, call JobStart(), passing through the fully qualified path to an SAP 3D Visual Enterprise Generator asset archive ZIP file in the InputFilePath startup argument.

● When the file is not in a location accessible by SAP 3D Visual Enterprise Generator directly, do the following:1. Upload the SAP 3D Visual Enterprise Generator asset archive ZIP file using the following

VEGeneratorMTom7.asmx methods:○ StartUniqueFileUpload()○ UploadUniqueFileChunk()○ FinishUniqueFileUpload()

2. Call JobStartWithFiles() on VEGenerator7.asmx, passing through the unique ID returned by StartUniqueFileUpload(), in the value of the InputFilePath startup argument, and specifying InputFilePath as a file name argument in the fileNameArguments parameter.


2.3.2.1.1.2 Configuring Asset Upload Workflow

Use

Secondary Derivative Functionality

When uploading assets, the Asset Upload workflow controller supports building derivatives of assets as part of the job.

NoteIf the asset you are building is not supported by a derivative in a derivative group, derivative building will be skipped for that asset.

Prerequisites

You have configured a Select All Derivatives or Select Step Derivatives workflows and they are configured to call a Build Derivatives workflow on their Child Workflows tab page.

Procedure

To configure SAP 3D Visual Enterprise Generator to process Asset Upload jobs, proceed as follows:

1. Open SAP 3D Visual Enterprise Generator Administration and navigate to Server ConfigurationWorkflows .

2. Choose New on the Workflows toolbar. The Create Workflow window opens.3. On the General tab page, enter a name for the workflow.

NoteThe name can be the same as the controller name.

4. Enter Asset Upload workflow controller in the Controller field and choose OK.

To configure derivative building, modify your Asset Upload workflow, and choose the relevant Select Derivatives controller from the dropdown list on the Child Workflows tab page.

To build derivatives, proceed as follows:

1. In the Edit Asset Upload window on the Settings tab page, select a Default derivative group.2. In the Asset Upload window, select a derivative group on a per-file basis.

Original File Storage for File Extension

Select the appropriate extension from the File Types list under the Server Configuration node in SAP 3D Visual Enterprise Generator Administration and select the Store Originals checkbox to ensure that the original file is stored for that file extension when using the Asset Upload workflow controller.



Forcing the plug-in to use a File Extension

If you want a specific file extension to always use a particular plug-in file type, you can change the file type selection mode for the file type to Priority, then move the file type you want to always use to the top of the list by priority.

2.3.2.1.1.3 Asset Upload Processes

Use

The default processes and possible process customizations for the Asset Upload workflow controller are the following:

● Job – Archive Unpack (process slot: Unpack Archive)Unpacks an asset archive into the workspace of the asset job

● Asset – Build 2D (process slot: Build 2D Asset)Builds the PNG master derivative and thumbnails for 2D assets

NoteYou can modify the settings for rendering animated thumbnails for this process.

● Asset – Build 3D (process slot: Build 3D Asset)Builds the RHZ master derivative for non-RH 3D file formats

NoteYou can modify the settings for rendering animated thumbnails and extracting metadata for this process.

● Asset – Build RHUsed for building thumbnails of RH and RHZ files. No extra master derivative built for these file types, input file is used as master.

NoteYou can modify the settings for rendering animated thumbnails and extracting metadata for this process.

● Asset – Build General (process slot: Build Standard Asset)Used for file formats not supported by plug-ins. File is stored as is, thumbnail obtained from operating system, if possible.

NoteYou can modify the settings for rendering animated thumbnails for this process.


Activities

To disable metadata extraction, modify the relevant jmp_asset_build* process as follows:

1. Delete the internal_export_scene_metadata operation from the process.2. Clear the value of the MetadataFileName parameter in the xmlresponse operation.

To disable thumbnail generation, modify the relevant jmp_asset_build* process as follows:

1. Delete the go_thumbnail and go_animthumbnail branches from the process.2. Clear the value of the ThumbnailFileName and AnimatedThumbnailFileName parameters of the

xmlresponse operation.

2.3.2.1.1.4 Asset Upload Job Steps

Use

The following processing steps are performed by the Asset Upload workflow controller:

● Extraction● Pre-Processing● Locking● Security Checks● Asset Building● Asset Storage● Derivative Selection and Building

Features

Extraction

The SAP 3D Visual Enterprise Generator asset archive is extracted by invoking the Unpack Archive process configured for the asset. The default process used for this is Job – Archive Unpack.

This step extracts the ZIP file to the job workspace.

Pre-Processing

The workflow controller separates the original asset files into batches of 1000, and calls the pre-processing process for each of these batches. The default process used for this is Asset – Preprocess.

The goal of this step is to determine the following information, for each asset:

● The SAP 3D Visual Enterprise Generator file type to use for the asset; for example, CATIA5 part, ProE assembly, PNG image

● The SAP 3D Visual Enterprise Generator plug-in to use to open the asset original file● The asset type to use when creating the asset; for example, 2D, 3D, text



● How to create thumbnails for the asset; for example, using SAP 3D Visual Enterprise Generator or the operating system

● Whether or not to use a custom master derivative process set on the file type for the asset instead of one of the standard build processes set up in the processes configuration

● Whether or not the original file for the asset should be stored in SAP 3D Visual Enterprise Generator

Locking

Locks are requested for each asset, by using the full SAP 3D Visual Enterprise Generator path of the asset. This prevents other jobs from changing the asset while this job is still running.

The following rules apply:

● If no other job has the asset locked, the lock is successful.● If a new version of an existing asset is being uploaded, but the asset is not checked out, the lock is denied,

and the job will abort.

Security Checks

For each new asset, the workflow controller checks that the owner of the job has Create privilege on the folder path in which the asset will be created.

For each existing asset, the workflow controller checks that the owner of the job has the Update privilege on the existing asset.

If a security check fails for a specific asset, the asset is removed from the list of assets to create or update in the job, but assets with successful security checks will still be stored.

Asset Building

The workflow controller then executes a build process for each of the assets. The process executed depends on the result of pre-processing, as well as the existing configuration of the workflow as follows:

● If the SAP 3D Visual Enterprise Generator file type of the asset specifies a master derivative process, this overrides everything else, and it will enqueue the process to build this particular file into an asset. Whether or not this process generates regular thumbnails and animated thumbnails depends on the process itself.

● If it is an RH or RHZ file, it will enqueue the Asset – Build RH process, unless the RH and RHZ file types have been modified to no longer set this as the default process.

● If it is a plug-in file type, and its list of asset types (obtained from pre-processing) has a Picture2D asset type as the first asset type, it enqueues the configured Build 2D Asset process (default: Asset – Build 2D). This will build a PNG master derivative, and generate a regular thumbnail for the asset, but no animated thumbnail.

● If it is a plug-in file type, and its first asset type is a 3D asset type (Vector2D, Scene3D, Assembly, Part), it enqueues the configured Build 3D Asset process (default: Asset – Build 3D). This will build a RHZ master derivative, and generate regular and animated thumbnails for the asset.

● As a fallback, it will enqueue the Build Standard Asset process. This will not build any master derivatives, and it will use the operating system to generate standard thumbnails if possible, but no animated thumbnail.

Each asset that was built successfully is flagged as such. If an asset fails to build, a warning is generated for that asset, and the process continues.

Asset Storage


For each asset that was present in the DS.manifest of the asset archive, the workflow controller will create an original file record in SAP 3D Visual Enterprise Generator as follows:

● If the file type for that asset requires storage of the original file, and it is not a linked asset, the original file is stored in SAP 3D Visual Enterprise Generator.

● A new asset version for each asset is created referencing that original file record, regardless of build success or failure.

● For a newly created asset, the owner of the asset is set to the job owner. If the asset already exists, the owner is unchanged.

● If the asset is a linked asset, it is marked as such in SAP 3D Visual Enterprise Generator. Do not attempt to upload a new version of an asset as a link when that asset was previously a regular asset, or the other way around.

● If the build process extracted metadata for the asset, this metadata will be stored.● If the uploaded assets are to be associated with existing assets in SAP 3D Visual Enterprise Generator, the

controller will create the associations at this time.● If user metadata was provided at upload time, it will be stored.● If a master derivative was built successfully for an asset, it will be stored.

NoteBy default, master derivatives (RH preview) are not stored for RH and RHZ files.

● If thumbnails were built successfully for an asset, they will be stored against the asset version.● If animated thumbnails were built successfully for an asset, they will be stored.● Audit records will be created for each new asset version.

Derivative Selection and Building

After storing the new assets and asset versions, if a derivative group was assigned to at least one asset (using default derivative group, or the upload window), the controller will enqueue a new job for the configured derivative selection child workflow.

This job chooses which derivatives to build, and then enqueue a Build Derivatives job to build and store the new derivatives.

Once the derivatives have been built, the asset job is complete.

2.3.2.1.1.5 SAP Asset Upload Input File Format

SAP 3D Visual Enterprise Generator Asset Archive

An SAP 3D Visual Enterprise Generator asset archive consists of a ZIP file containing a file named DS.manifest, and optionally the assets.



Schema Definitions

The DS.manifest file is an XML file using the schema http://schemas.righthemisphere.com/FileUploadManifest/2009/July.

Schema Validation

The DS.manifest file must be valid according to the schema, and any ID references must refer to IDs that exist in the file.

Information in DS.manifest file

The following information can be present in a manifest file:

● The workflow to use to process the assets● The destination SAP 3D Visual Enterprise Generator project or folder where the assets should be stored in.

The list of files to process as assets.● Whether or not the files are included in the asset archive, or whether they are referenced and located

outside of the ZIP file, somewhere accessible to SAP 3D Visual Enterprise Generator● The modification times to associate with the original files in SAP 3D Visual Enterprise Generator● The subfolder path below the overall destination path, where a file should be stored, on a per-file basis. For

example, for a particular file, its relative path may be Test\file.name, which, combined with a target server path of Default\Assets, yields a final path in SAP 3D Visual Enterprise Generator of Default\Assets\Test\file.name.

● Any user-defined metadata to assign, on a per-file basis● The derivative group to use for building asset derivatives, on a per-file basis

2.3.2.1.1.5.1 Asset Upload Sample DS.manifest File

NoteA DS.manifest file with referencing disabled (assets are included in ZIP archive) is shown below:

Sample Code

<Manifest xmlns="http://schemas.righthemisphere.com/FileUploadManifest/2009/July"> <WorkflowName>Asset Upload</WorkflowName> <TargetServerPath>Default</TargetServerPath> <AutoBuild>false</AutoBuild> <ArchiveFiles> <ArchiveFile FileId="1" SourcePath="\\Models\123K RAES Field Installation.rh" OutputFileName="123K RAES Field Installation.rh" DerivativeGroup="3D Step-by-Step Training" CTime="2008-09-09T15:57:48" MTime="2008-07-21T02:25:48">1.rh</ArchiveFile>


</ArchiveFiles> </Manifest>

NoteA DS.manifest file with referencing enabled is shown below:

Sample Code

<Manifest xmlns="http://schemas.righthemisphere.com/FileUploadManifest/2009/July"> <WorkflowName>Asset Upload</WorkflowName> <TargetServerPath>Default\SubFolder</TargetServerPath> <AutoBuild>false</AutoBuild> <ReferencedFiles> <ReferencedFile FileId="1" SourcePath="\\fileserver\files\models\!internal good example files\!examples of 3D files\123K Product Tour.rh">123K Product Tour.rh</ReferencedFile> </ReferencedFiles> </Manifest>

2.3.2.1.2 Build Derivatives Workflow Controller

Use

Various types of jobs create new assets or new asset versions and must create derivatives for the new assets and asset versions in an automated way. The Build Derivatives workflow controller builds a set of derivatives according to an input file that fully describes the derivatives to be produced. The Build Derivatives workflow controller does not decide which derivatives should be built for a given set of asset versions.

Several workflow controllers exist that do the following:

● Determine which derivatives are to be built for a set of assets● Create an XML file to be used as input to the Build Derivatives workflow controller● Trigger a Build Derivatives child job

The Select All Derivatives workflow controller is the simplest of these workflow controllers. For each asset version in the input file, it instructs the Build Derivatives workflow controller to create one secondary derivative for each derivative type instance in the derivative group specified for that asset version.

When the Select All Derivatives workflow controller is configured as a child workflow of another workflow, the Default Derivative workflow setting is configured for the parent workflow. This setting is specified as the derivative group to use for each asset version in the input file.

When the Select All Derivatives workflow controller is used when building derivatives from a collection, the user selects the derivative group to use for all items in the collection.



Features

Features

The configurable settings for the Select All Derivatives workflow controller are the following:

Setting Description

Build Part Derivatives Indicates whether to build derivatives for parts in the top-level asset

Build Subassembly Derivatives Indicates whether to build derivatives for subassemblies in the top-level asset

Build Top-Level Derivatives Indicates whether to build derivatives for the top-level asset

Master Derivatives per Process The number of master derivatives to fetch from the database per process

The startup argument for the Select All Derivatives workflow controller is described in the following table:

Select All Derivatives: Argument


InputFilePath An input XML file with the http://schemas.righthemisphere.com/2009/DeepServer/Processing/SelectDerivatives/Request schema. For each asset version, the asset ID, asset version, asset name, derivative group, and optionally, a path to a master derivative are included.

2.3.2.1.2.1 Starting Select All Derivatives Workflow Controller

Use

Workflows using the Select All Derivatives workflow controller can be used to start jobs as follows:

● As child jobs of Asset Upload jobs● By creating derivatives from collections

NoteIt is also possible to invoke the Select All Derivatives jobs directly through API calls and using hot folders.


Procedure

When a Select All Derivatives workflow is configured as a child job of an Asset Upload workflow (or another workflow that supports Select All Derivatives child jobs), a Select All Derivatives job is invoked automatically after the new assets or asset versions have been built successfully.

When a Select All Derivatives workflow has been created and one or more derivative groups have been created, it is possible to use the Select All Derivatives workflow to create derivatives from a collection.

To start a Select All Derivatives job using Derivatives from Collection functionality, proceed as follows:

1. Browse or search assets in SAP Visual Enterprise Access.

2. Choose to add assets to the current collection.

3. Choose .4. Select the Select All Derivatives workflow.5. Select a Derivative Group.6. Choose OK.

One derivative for each derivative instance in the selected derivative group is created for the most recent asset versions of each asset in the collection.

2.3.2.1.2.2 Configuration of Select All Derivatives

Use

You use this process to configure a Select All Derivatives workflow.

Process

To configure SAP 3D Visual Enterprise Generator to allow Select All Derivatives jobs to be triggered using Create Derivatives From Collection functionality, proceed as follows:

1. Open SAP 3D Visual Enterprise Generator Administration.2. Create one or more derivative groups, if no derivative groups exist (see Creating Derivative Groups [page

556]).3. Create a Build Derivatives workflow, if no Build Derivatives workflow exists (see Creating Build Derivatives

Workflow [page 626]).4. Create a Select All Derivatives workflow, if no Select All Derivatives workflow exists (see Creating Select All

Derivatives Workflow [page 628]).5. Configure the Build Derivatives workflow as a child workflow of the Select All Derivatives workflow (see

Creating Workflows [page 532]).



To configure SAP 3D Visual Enterprise Generator to use the Select All Derivatives workflow for Asset Upload jobs, proceed as follows after performing all the steps above:

1. Create an Asset Upload workflow (see Configuring Asset Upload Workflow [page 36]).2. Configure the Select All Derivatives workflow as a child workflow of the Asset Upload workflow (see

Creating Workflows [page 532]).3. Specify a derivative group for the Default Derivative Group workflow setting for the Asset Upload workflow

2.3.2.1.2.3 Select All Derivatives Processes

The Select All Derivatives workflow controller uses the following process: Builds all selected derivatives. This workflow builds the selected derivatives. Currently only workflows that use the Build Derivatives job controller can be configured.

2.3.2.1.2.4 Select All Derivatives Job Steps

The following processing steps are performed by the Select All Derivatives workflow controller:

● Select DerivativesBuilds an XML file to be used as input to a Build Derivatives workflow

● Build DerivativesInvokes and waits for the completion of a Build Derivatives child job

NoteThe Builds All Selected Derivatives child workflow slot must be configured with a Build Derivatives workflow.

2.3.2.1.2.5 Select All Derivatives Input File Format

Code Syntax

<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://schemas.righthemisphere.com/2010/DeepServer/SelectStepDerivatives/DerivativeSelection/Request" elementFormDefault="qualified" attributeFormDefault="unqualified" xmlns="http://schemas.righthemisphere.com/2010/DeepServer/SelectStepDerivatives/DerivativeSelection/Request"> <xs:element name="Request"> <xs:complexType> <xs:sequence> <xs:elementname="SelectAssetVersionDerivativesRequest"


minOccurs="1"maxOccurs="unbounded"> <xs:complexType> <xs:attribute name="AssetId" type="xs:integer" use="required"/> <xs:attribute name="AssetVersion" type="xs:integer" use="required" /> <xs:attribute name="AssetName" type="xs:string" use="required" /> <xs:attribute name="DerivativeGroupName" type="xs:string" use="required" /> <xs:attribute name="MasterDerivativeFilePath" type="xs:string" use="optional" /> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element></xs:schema>

2.3.2.1.2.5.1 Select All Derivatives Sample Input File

NoteAn example input file is the following:

Sample Code

<?xml version="1.0" encoding="utf-8"?> <SelectDerivativesRequest xmlns="http://schemas.righthemisphere.com/2009/DeepServer/Processing/SelectDerivatives/Request"> <AssetVersionDerivativesRequestDerivativeGroup="Publishing"AssetId="314"AssetVersion="0"AssetName="BACN11N5CS" /> <AssetVersionDerivativesRequestDerivativeGroup="Publishing"AssetId="317"AssetVersion="0"AssetName="BACN11N4CS" /></SelectDerivativesRequest>

2.3.2.1.3 Build Viewables Workflow Controller

Use

The Build Viewables workflow controller generates visual representations of assets and assemblies (viewables) as defined in the input XML schema for this workflow.

The Build Viewables workflow controller is used by the Visual Data Integration processing workflow to produce viewable files that correspond to a set of input CAD files. The workflow takes an input request XML file



describing the hierarchy of the items to build, and produces as output rh or vds viewable files corresponding to the requested items in the input. It does no CAD analysis of its own, and instead builds viewables exactly as it is told to by the input, and takes care of parallelization of the build process and performing dependency ordering of the build tasks.

A configured instance of this workflow is required as a child workflow of the Visual Data Integration workflow. By default, the Build Viewables workflow controller has no child workflows.

Features

Workflow Settings

The Build Viewables workflow controller configurable setting is the following:

Field Description

Build Failure Policy Defines the action taken when an item fails to build, and decides whether to treat the failure as a warning or an error:

● Warning: Permits containing viewable outputs to be produced still

● Error: Prevents further production of viewable outputs

Launch Debugger during Build Launch a debugger during the build process

Outdated CAD Configurations Defines the action taken when outdated CAD configurations are found in CAD files:

● Warning: Ignores the missing CAD configurations and attempts to build anyway

● Error: Prevents further production of viewable outputs

The startup arguments for the Build Viewables workflow controller are described in the following table.

Build Viewables: Arguments

Argument Default Description

InputFilePath N/A Full path to the XML request file

ViewableOutputPath N/A Full path to the folder in which the newly created viewables reside

ResponseFile N/A Full path to the XML response file

Input Request File

The input to this workflow is an XML request file, the path to which is supplied in the Input File Path startup argument.


This XML request is typically produced by a Visual Data Integration processing workflow when it requests viewables to be created, although you can use the Build Viewables workflow on its own, as it does not have a dependency on any external systems.

Output Viewables

The viewables produced are placed in the folder set in the Viewable Output Path startup argument.

Output Response File

After the job completes, an XML response file is produced, in the location specified by the Response file path startup argument. This file contains an <Item> element describing the result of each <Entity> specified in the request.

More Information

Example Request [page 51]

Example Response [page 53]

2.3.2.1.3.1 Build Viewables Processes

The default processes and possible process customizations for the Build Viewables workflow controller are the following:

Process Functional Description

Process Viewable Build Input XML Default process is Build Viewables – Validate & Analyze Input

Build Viewable - 3D Default process is Build Viewables - Build 3D Viewable

Build Viewable - Raster Default process is Build Viewable - Build Raster Viewable

2.3.2.1.3.2 Build Viewables Processing Steps

Use

The following processing steps are performed by the Build Viewables workflow controller:

● Input Analysis● Build Viewables



Features

Input Analysis

In this step, the Build Viewables controller triggers the process configured in the Process Viewable Build Input XML slot to perform any validation and preprocessing on the input request XML file.

We recommend that in any customizations, you perform a precheck here to ensure that any information you require to perform a successful viewable build is correct.

Transformations of input request XML can also occur here. Ensure that you perform any transformations before the validate_analyze_input operation. This operation analyses the input request XML and prepares a build structure file, which contains an optimized representation of the items to build, after which any changes you make to the input request XML are ignored.

For an example, please consult the default Build Viewables Validate & Analyze Input process.

Build Viewables

In this step, the Build Viewables controller reads the prepared build structure, and starts enqueuing builds of all items in the build structure tree. The items are queued in dependency order, from leaf nodes (parts), to subassemblies, and top-level assemblies. If the assembly is top level, there is a parameter to customize the logic within the Build Viewables process for conditional processing.

The operation jmp_BuildViewables_Build3D contains a parameter isTopLevelViewable. If the viewable that is currently being built is a top-level assembly, the parameter is automatically set to “True”. You can use this parameter to apply some operations to the top-level assembly only. Or alternatively, to skip some operations on the top level viewable.

Builds are enqueued by spawning a task of the configured Build Viewable process slot; for example, the Build Viewables Build RH Viewable process, or the Build Viewables Build VDS Viewable process.

The controller enqueues tasks for all items with no dependencies or satisfied dependencies concurrently. It does, however, depend on the SAP 3D Visual Enterprise Generator server licensing and configuration as to how many tasks are actually executed concurrently.

Error Handling

If a particular item in the tree fails to build, the Build Failure Policy setting determines what occurs.

● If the value is Error (the default), the error propagates all the way to the top, meaning that a failure to build a part, would cause all of the parent items of the branch that the part is in to fail to build. Any independent items would still be built.

● If the value is Warning, a warning is produced, but any parent items are still built (and the failed item is excluded from the parent).

Extensibility

The default Build Viewables process has a select_viewable_base_name extension point. See the default Build Viewables Build RH Viewable process or the Build Viewables Build VDS Viewable process for an example. This extension point allows you to specify the base file name to use for the output viewable files, for example, output rh, gif and jpg files all use the same base file name.


Example select_viewable_base_name extension point (RH)

Code Syntax

# Returns the name to use given a build item ID, XML ID, and XML name. def SelectViewableBaseName(buildItemId, xmlId, xmlName): return Path.GetInvalidFileNameChars().Aggregate(xmlName, lambda current, c: current.Replace(c.ToString(), '_'))

2.3.2.1.3.3 Build Viewables Response XML Format

The Build Viewables Response describes the result of each <Entity> in the input XML.

Elements

<BuildViewablesResponse>This element is the root element and is a container for one or more <Item> elements, which represent a viewable item.

<Item>This element groups the results for viewables corresponding to an input <Entity>.

Attributes

Name Type Mandatory Description

XmlId String Yes The ID of the corresponding element in the input XML

Type Enum Yes The type of element in the input XML. May be Entity or Bom

Result Enum Yes The overall result for creating the viewables associated with this element. May be Success, Skipped, or Failure.

Message String No If the Result is Failure, this attribute contains a descriptive error message containing the reason for failure.

<Item>/<Viewable>This element contains the details for a particular viewable that was requested. One <Item> may have multiple associated <Viewable> elements.



Attributes


FilePath String Yes The absolute path to the viewable file

Type Enum Yes The type of the viewable file. May be one of Primary, Thumbnail, or Animated Thumbnail.

A particular <Item> has only one <Viewable> of type Primary.

MimeType String Yes Contains the MIME type of the viewable. The MIME type is determined by the process that builds it.

Message String No If the file status is not Downloaded, contains a message further describing the most recent reason for the failure.

RetryAttempts Integer No Contains the number of times downloading of the file was retried.

2.3.2.1.3.3.1 Example Request

This request is an example of a request XML that could be received by the Build Viewables controller. The example was produced by the VDI processing workflow, and is in the Visual XML (VZXML) file format developed by SAP 3D Visual Enterprise.

The controller will then proceed to attempt to build viewable files for each <Entity> for which the Skip attribute, in the http://schemas.sap.com/VE/Generator/BuildViewables/2013/Marchnamespace , is either not set, or set to false.

Each <Entity> represents a discrete viewable, which may correspond to an assembly or a part in the source structure.

Note

Sample Code

<MultiBom xmlns="http://schemas.sap.com/MultiBom/2012/June" xmlns:bv="http://schemas.sap.com/VE/Generator/BuildViewables/2013/March"> <Boms>


http://help.sap.com/disclaimer?site=http%3A%2F%2Fschemas.sap.com%2FVE%2FGenerator%2FBuildViewables%2F2013%2FMarchnamespace

2.3.2.1.3.3.2 Example Response

Note

Sample Code

<BuildViewablesResponse xmlns="http://schemas.sap.com/VE/Generator/BuildViewables/2013/March/BuildViewablesResponse"> <Item XmlId="b1" Type="Bom" Result="Skipped" /> <Item XmlId="e1" Type="Entity" Result="Success"> <Viewable FilePath="D:\Data\Output\2\PMI_Powertrain_Demo.rh" Type="Primary" MimeType="application/rh" WSApplication="RH" /> <Viewable FilePath="D:\Data\Output\2\PMI_Powertrain_Demo.jpg" Type="Thumbnail" MimeType="image/jpeg" WSApplication="JPG" /> <Viewable FilePath="D:\Data\Output\2\PMI_Powertrain_Demo.gif" Type="AnimatedThumbnail" MimeType="image/gif" WSApplication="GIF" /> </Item> <Item XmlId="e2" Type="Entity" Result="Success"> <Viewable FilePath="D:\Data\Output\3\Crank_Assy_000.rh" Type="Primary" MimeType="application/rh" WSApplication="RH" /> <Viewable FilePath="D:\Data\Output\3\Crank_Assy_000.jpg" Type="Thumbnail" MimeType="image/jpeg" WSApplication="JPG" /> <Viewable FilePath="D:\Data\Output\3\Crank_Assy_000.gif" Type="AnimatedThumbnail" MimeType="image/gif" WSApplication="GIF" /> </Item> <Item XmlId="e3" Type="Entity" Result="Success"> <Viewable FilePath="D:\Data\Output\4\crank_Assz.rh" Type="Primary" MimeType="application/rh" WSApplication="RH" /> <Viewable FilePath="D:\Data\Output\4\crank_Assz.jpg" Type="Thumbnail" MimeType="image/jpeg" WSApplication="JPG" /> <Viewable FilePath="D:\Data\Output\4\crank_Assz.gif" Type="AnimatedThumbnail" MimeType="image/gif" WSApplication="GIF" /> </Item> <Item XmlId="e4" Type="Entity" Result="Success"> <Viewable FilePath="D:\Data\Output\5\conrod_001.rh" Type="Primary" MimeType="application/rh" WSApplication="RH" /> <Viewable FilePath="D:\Data\Output\5\conrod_001.jpg" Type="Thumbnail" MimeType="image/jpeg" WSApplication="JPG" /> <Viewable FilePath="D:\Data\Output\5\conrod_001.gif" Type="AnimatedThumbnail" MimeType="image/gif" WSApplication="GIF" /> </Item> <Item XmlId="e5" Type="Entity" Result="Success"> <Viewable FilePath="D:\Data\Output\6\piston_Pin.rh" Type="Primary" MimeType="application/rh" WSApplication="RH" /> <Viewable FilePath="D:\Data\Output\6\piston_Pin.jpg" Type="Thumbnail" MimeType="image/jpeg" WSApplication="JPG" /> <Viewable FilePath="D:\Data\Output\6\piston_Pin.gif" Type="AnimatedThumbnail" MimeType="image/gif" WSApplication="GIF" /> </Item> <Item XmlId="e6" Type="Entity" Result="Success"> <Viewable FilePath="D:\Data\Output\7\PMITest_piston_000.rh" Type="Primary" MimeType="application/rh" WSApplication="RH" /> <Viewable FilePath="D:\Data\Output\7\PMITest_piston_000.jpg" Type="Thumbnail" MimeType="image/jpeg" WSApplication="JPG" /> <Viewable FilePath="D:\Data\Output\7\PMITest_piston_000.gif" Type="AnimatedThumbnail" MimeType="image/gif" WSApplication="GIF" /> </Item></BuildViewablesResponse>


2.3.2.1.4 CAD Assembly Upload Workflow Controller

Use

You can use the CAD Assembly Upload workflow controller to analyze the structure of CAD assemblies and to create assets, asset instances, and absolute instances in for each part and subassembly of the targeted assembly. This process creates subassembly assets by combining the processed parts as dictated by the assembly structure. This minimizes that amount of processing by preventing instanced parts from being processed multiple times.

For each asset created, the CAD Assembly Upload workflow controller creates the following:

● An RH file that will be used as the master derivative for the asset● A thumbnail in PNG format for display in SAP Visual Enterprise Access● An animated thumbnail in GIF format for display in SAP Visual Enterprise Access● Any required secondary derivatives

The number of assets created by the controller depends on the original assembly structure and does not necessarily have a one-to-one correspondence to the number of files in the assembly manifest. Some CAD formats, such as JT, can have subassemblies in the assembly structure that do not have a corresponding file. Additionally, when a single file is used in an assembly in more than one place with different import options, the controller creates more than one asset referencing this file.

The CAD Assembly Upload workflow controller differs from the Asset Upload workflow controller: while the Asset Upload workflow controller can handle any file type, the CAD Assembly Upload workflow controller can only handle supported CAD formats. In addition, the CAD Assembly Upload workflow controller deals with a single assembly as a whole unit, rather than treating each part as independent. Further, the CAD Assembly Upload workflow controller can only process a single assembly at a time, while the Asset Upload workflow controller can handle any number of independent files.

Secondary Derivatives

The building of secondary derivatives is handled by a child job. The CAD Assembly Upload workflow controller builds a request XML file that contains the assembly structure and a list of desired derivatives, and passes it to the child job, which builds the derivatives.

Features

You can configure the following settings for this workflow controller:

Setting Description

Build Part Derivatives If set to True (default), builds secondary derivatives for part assets. Part assets are assets that have no child assets.



Setting Description

Build Subassembly Derivatives If set to True (default), builds secondary derivatives for subassembly assets. Subassemblies are assets that have child assets but are not the top-level asset.

Build Top-Level Derivatives If set to True (default), builds secondary derivatives for the top-level asset

Job Report Detail Sets the amount of detail shown in the job report:

● Everything (default): The job report will show every asset built. For large assemblies, this can make the job report difficult to use or read.

● Errors Only: The job report will only show assets that generated errors during processing. This is recommended for large assemblies.

Errors: Missing File Instructs the workflow controller how to handle missing files referenced by the submitted top-level assembly

● Error (default): The workflow controller will abort the job if it cannot find required files.

CautionThe workflow controller will attempt to process the assembly, even if some files are missing. Missing part files will have placeholder assets created for them (for example, no geometry or metadata).

Workspace Serialization Method Instructs the workflow controller how to write job processing related internal files to the workspace:

● Production (default): The workflow controller will use an efficient (size and speed) method for writing files to the workspace, but these files are not user-friendly.

● Debug: The workflow controller will write all files to the workspace as XML. This will result in larger files and slower performance. This may make debugging workflow controller issues easier.

The startup arguments for the CAD Assembly Upload workflow controller are described below.

CautionBecause this workflow controller is invoked by uploading files from SAP 3D Visual Enterprise Access, do not set these arguments manually.


CAD Assembly Upload: Arguments


InputFilePath N/A The archive uploaded from SAP Visual Enterprise Access

TargetServerPath N/A The destination for the upload is specified in the archive. This setting is ignored.

2.3.2.1.4.1 Starting the CAD Assembly Upload Workflow Controller

Use

Workflows using the CAD Assembly Upload workflow controller can be used to start jobs as follows:

● Using an Assembly upload from SAP Visual Enterprise Access● Using a Manifest Workflow Job hot folder● Using SAP 3D Visual Enterprise Generator Web service API call

Procedure

To start a CAD Assembly upload job from SAP Visual Enterprise Access, proceed as follows:

1. Log on to SAP Visual Enterprise Access.2. In the Browse page, navigate to the target folder.

3. Choose .4. Add the desired files in the upload client, and select the Top Level option for the top-level assembly file.5. Set the job options as follows:

Job Options Description

Job Name The name of the job that will be displayed in SAP 3D Visual Enterprise Generator Administrator and the SAP Visual Enterprise Access job report. The default is Assembly Processing Job for <workflow controller name>.



Job Options Description

Workflow The CAD Assembly Upload workflow controller to use. If multiple configurations are required, more than one of these will be present. Normally, there is only a single controller for assembly upload.

Reference Files Informs the upload client not to package the CAD files into the archive sent to SAP 3D Visual Enterprise Generator, but to pass in the path to the top-level file. When this box is checked, only a single file can be selected for upload: the top-level file. The target path must be a UNC (network) path, which means it cannot be a URL or start with a drive letter.

CautionThe Windows user who is running SAP 3D Visual Enterprise Generator must have access to the UNC path, and it must be visible from the server machine. For more information, see the Prepare Workspace section in CAD Assembly Upload Processes [page 58].

Notify on Job Complete Instructs SAP 3D Visual Enterprise Generator to send an e-mail to the specified address (default is the e-mail address of the current user) when the job is complete. For this to work, SAP 3D Visual Enterprise Generator must be configured with an SMTP server.

Metadata Allows the user to set metadata, which will be set on the asset created for the top-level assembly only. Additionally, this allows only metadata fields that are pre-configured in SAP 3D Visual Enterprise Generator Administrator to be set at upload.

Tags Allows the user to set tags on the assets created by the workflow controller. Any tags set here are applied to all assets.

6. Choose the Upload button.

To start a CAD Assembly Upload job from a Manifest Workflow Job hot folder, proceed as follows:

1. Configure a Manifest Workflow Job hot folder, selecting asset and assembly workflows you want to use.2. Drop a manifest file in the hot folder.3. For more information about the manifest file format, see to the SAP 3D Visual Enterprise Generator help.


To start an Assembly Upload Job from an SAP 3D Visual Enterprise Generator Web service API call, proceed as follows:

● When the assembly files are in a location accessible by Visual Enterprise Generator directly, call JobStart(), passing through the fully qualified path to an SAP 3D Visual Enterprise Generator assembly archive ZIP file in the InputFilePath startup argument.

● When the file is not in a location accessible by SAP 3D Visual Enterprise Generator directly, do the following:1. Upload the SAP 3D Visual Enterprise Generator assembly archive ZIP file using the

VEGeneratorMTom7.asmx methods:○ StartUniqueFileUpload()○ UploadUniqueFileChunk()○ FinishUniqueFileUpload()


2.3.2.1.4.2 Configuring a CAD Assembly Upload Workflow

To configure SAP 3D Visual Enterprise Generator to process CAD Assembly Upload jobs, proceed as follows:


2. Choose New on the Workflows toolbar. The Create Workflow window opens.3. On the General tab page, enter a name for the workflow.4. Enter CAD Assembly Upload workflow controller in the Controller field.5. Select the Assembly classification.6. If secondary derivatives are to be built, choose the Child Workflows tab and select a Build Derivatives

workflow.

2.3.2.1.4.3 CAD Assembly Upload Processes

Use

The CAD Assembly Upload workflow controller uses the following processes:

● Unpack Archive● Extract BOM● Prepare Workspace● Build Part● Build Assembly● Build BOM Container● Build MultiBOM Container



● Store Assets

Features

Unpack Archive

Process: Job – Archive Unpack

The CAD Assembly Upload workflow controller uses the standard Unpack Archive process to extract the uploaded archive.

Extract BOM

Process: CAD Assembly – Extract BOM

This process uses the BOM Factory reader to open the top-level CAD assembly file and extract its assembly structure to an xml representation on disk. The output of the BOM Factory is a VzXML file, which is used throughout the rest of the job as a specification of assembly structure as per the top level CAD file – this information defines what will be processed and stored. After generating the VzXML file, this process builds several other important files:

● AssemblyInfo.datAssembly-level information such as user metadata, tags, scene orientation, and so on

● AssetInfo.datAsset information such as import options, post-processing instructions, CAD plug-ins to use when opening the files, and so on

● Assets\XYZ.datA series of files that contain information about specific assets. This information is split across multiple files to improve performance of large assemblies.

● AssetInstances.datThe asset instance tree. Assets will be CAD parts, subassemblies and top-level assembly.

● AbsoluteInstances.datThe absolute instance tree. Absolute instance is defined as a shortest asset instance path from and including the topmost asset instance down to the designated asset instance including all asset instances in that path. An absolute instance can be used to differentiate one asset instance from other asset instances of the same asset in the scope of top-level assembly. This is how you can have multiple instances of an asset with different attributes: front-left wheel and front-right wheel can be differentiated from rear left wheel and rear right wheel, assuming that left wheel and right wheel are two different asset instances of the same wheel asset, and that we have an asset wheels that includes these two asset instances, and that front and left wheels are two different asset instances of wheels asset.

● BuildGraph.datThe graph used to track assets as they are built, and to determine which assets should be built once their children are complete

● Derivatives.datInformation about the secondary derivatives to be built

● SourceFiles.datA list of CAD files to be used in building the assembly

● LockingIds.datThe lock ID map. This is split off from the asset data files for performance on large assemblies.


NoteThis process has some CAD import option operations to force the BOM Factory to load all configurations for those CAD formats that support multiple configurations (NX and SolidWorks). You can modify those operations to prevent overriding of the import options set in the normal manner in SAP 3D Visual Enterprise Generator Administrator.

Prepare Workspace

Process: CAD Assembly – Prepare Workspace

Any files that need to be copied to the workspace are copied here. The BOM Factory may have generated some additional CAD files (such as when processing a monolithic JT assembly where the original assembly is a single file containing the subassembly and part files). These files are moved to the appropriate location relative to the top-level file.

Build Part

Process: CAD Assembly – Build Part

This process opens a shallow VzXml file referencing the target CAD file and then saves it as a compressed RHZ file that contains both semantic part data in VzXML xml file and geometry data in binary RH files. For this to work, the process relies on the BOM Factory to include all the top-level-assembly information relevant to that part such as part color and metadata in its output so that those can all be applied in the RHZ during the process of part translation. It also produces a PNG thumbnail and a GIF animated thumbnail.

If the process needs to create a placeholder asset, as indicated in the request file from the workflow controller, it creates a shallow RHZ file containing a single entity with the appropriate name, metadata, and DS:ID (if appropriate). No thumbnails are generated for placeholder assets.

NoteYou can modify the settings for rendering animated thumbnails.

Build Assembly

Process: CAD Assembly – Build Assembly

Instead of opening an assembly-level CAD file as a graphics operation, this process builds an RHZ file based on the assembly structure output from the BOM Factory. The translated assembly is built by opening the CAD assembly file in order to extract assembly level CAD features while skipping repeated loading of CAD parts. Instead, the correct CAD parts that have already been translated into RHZ are merged into the scene. All child parts and subassemblies must be translated to RHZ before the assembly can be built and this is ensured by the workflow controller. Assembly scene built this way is saved into an RHZ file that will represent that assembly. Any necessary post-processing as specified per BOM factory is also performed in this step, for example, post-processing of CATIA 5 captures and model views. PNG and GIF thumbnails are also produced this way, from the built scene.

This prevents the reprocessing of part and subassembly geometry by the graphics library and minimizes the amount of time spent in CAD translation by anticipating merging of already translated parts. Another benefit is allowing better parallelization by splitting costly CAD file translations to a maximum one per process. For this to work, the process relies on the BOM Factory to include all assembly-level information such as assembly-level geometry, part positioning, part color in its output so that those can all be applied in the RHZ during the process of assembly translation.



This process can be very long running for large assemblies, so an appropriate time-out must be set in such cases.


Build BOM Container

Process: CAD Assembly – Build BOM Container

This process only runs if the uploaded assembly has multiple configurations and all of the configurations are loaded. It creates an asset that represents a single configuration. This asset contains a single BOM, named appropriately, which contains the entire assembly as it is in the configuration. This is done by building an RHZ file. This RHZ file is opened by the graphics library for creating thumbnails.


Build MultiBOM Container

Process: CAD Assembly – Build MultiBOM Container

It creates an asset that contains all of the configurations: one BOM for each configuration. This is done by building an RHZ file, which is then opened by the graphics library for creating thumbnails.

NoteThis process only runs if the uploaded assembly has multiple configurations and all of the configurations are loaded.

You can modify the settings for rendering animated thumbnails.

Store Assets

Process: CAD Assembly – Store

The outputs of all of the above build processes are stored in the database in this process. For large assemblies, this can be a very long running process, so make sure that the time-out is set to an appropriately long time.

2.3.2.1.4.4 CAD Assembly Upload Job Steps

Use

The following processing steps are performed by the CAD Assembly Upload workflow controller:

● Unpack Assembly Archive● Validate Manifest● Extract BOM● Prepare Workspace


● Lock Assets● Check Security● Build Assets● Store Assets● Build Derivatives

Features

Unpack Assembly Archive

This step uses the standard process for unpacking an uploaded archive. It extracts the manifest and all included files to the workspace. If the extracted files in the manifest have an archive name such as 1.CATPart, 2.CATPart, they are renamed to their as-uploaded name.

Validate Manifest

This step ensures that the manifest included in the archive is valid. It performs some processing on the manifest file.

NoteThe manifest must specify a main file and all non-referenced files in the manifest must have been extracted from the archive. All referenced files in the manifest must have a fully qualified path and must be accessible from the server.

Tags, derivatives, and metadata for the various assets are extracted from the manifest.

Extract BOM

This step opens the top-level assembly with the BOM Factory and processes the resulting VzXML file.

The data files used by the workflow controller are referenced here and a build graph is created. The build graph is used to determine when the prerequisites for building assemblies are complete. For more information, see CAD Assembly Upload Processes [page 58].

Prepare Workspace

If the archive contains referenced files, they are copied to the Originals folder in the workspace during this step. If the BOM Factory created additional files in the BOM folder, they are copied to the Originals folder.

Lock Assets

This step locks the assets that will be created by this job. To determine if the assets already exist (and the job needs to create a new version), a lock ID is generated for each asset that will be created.

If an entity has an original CAD file associated with it, then this file name is used for locking. This means that, in some complex assemblies, multiple versions of an asset will be created because multiple entities in the BOM referenced the same file, but with different CAD import options.

In some situations, there will be assets that do not have an original CAD file associated with them. Some CAD formats can have subassemblies in the assembly structure that do not have a corresponding file (this happens



often with JT and CATIA5 assemblies). In these situations, a lock ID must be generated for the affected file. The following pieces of information are concatenated and hashed to generate a lock ID:

● Names and values of any CAD import options● Names and parameters of any CAD processing instructions● If the entity has children:

○ The transformation matrix for each child node○ The lock IDs of each node’s entity

If any asset locks are denied, the job is aborted.

If any asset lock IDs match an existing asset, it is noted in Assets.dat, and new versions of the asset will be created instead of creating a new asset.

NoteThe generation of lock IDs is a delicate process. In cases where the assembly substantially changes between uploaded versions, it fails to find all of the existing assets. If this level of accuracy is required, do not use the CAD Assembly Upload workflow controller. Instead, a PLM system is needed and the PLM Translation workflow controller should be used.

Check Security

This step verifies that the user who started the job has sufficient permissions to create and update the required assets and folders. If any security checks fail, the job is aborted.

Build Assets

This step builds all of the assets for the assembly. Parts are created by opening their CAD files using graphics operations and saved as an RH file.

Assembly, subassemblies, BOM and multi-BOM container assets are built by generating an RHZ file representing that level of the assembly structure. This file references previously built RH and RHZ files in order to prevent processing the same geometry multiple times.

Store Assets

This step stores all assets, asset instances, absolute instances, and metadata created by the job.

Build Derivatives

If any secondary derivatives need to be built, this workflow controller creates a request file and starts a child job to build the derivatives.

2.3.2.1.4.5 CAD Assembly Upload Input File Format

Archive Manifest

Manifest files are generated by the Deep Transfer upload client, and should not need to be written by a user or third-party application.


Schema Definitions

The DS.manifest file is an XML file using the schema http://schemas.righthemisphere.com/FileUploadManifest/2009/July.

Schema Validation

No XML schema validation is performed on the manifest file, but the Validate Manifest step does checking to make sure the required information is present and validates the DS.manifest file. Any ID references must refer to IDs that exist in the file.

Information in DS.manifest file

The following information can be present in a manifest file:

● The workflow to use to process the assembly● The destination project or folder in which the assembly should be stored● Whether or not the files are included in the assembly archive, or whether it is referenced and located

outside of the ZIP file, somewhere accessible to SAP 3D Visual Enterprise Generator● The modification times to associate with the original files in SAP 3D Visual Enterprise Generator● Any user-defined metadata to assign, on a per-file basis

2.3.2.1.4.5.1 CAD Assembly Upload Sample Input File

NoteAn input manifest file that references the top level assembly:

Sample Code

<Manifest xmlns="http://schemas.righthemisphere.com/FileUploadManifest/2009/July"> <WorkflowName>CAD Assembly Upload</WorkflowName> <TargetServerPath>Default\Assembly </TargetServerPath> <AutoBuild>true</AutoBuild> <MainFile>1</MainFile> <ReferencedFiles> <ReferencedFile FileId="1" SourcePath="\\server\Assemblies\System_Wheel.CATProduct"> System_Wheel.CATProduct</ReferencedFile> </ReferencedFiles> </Manifest>



NoteAn input manifest file that includes the files in the archive:

Sample Code

<Manifest xmlns="http://schemas.righthemisphere.com/FileUploadManifest/2009/July"> <WorkflowName>CAD Assembly Upload</WorkflowName> <TargetServerPath>Default\Assembly</TargetServerPath> <AutoBuild>true</AutoBuild> <MainFile>1</MainFile> <ArchiveFiles> <ArchiveFile FileId="1" SourcePath=\\server\Assemblies\System_Wheel.CATProduct OutputFileName="System_Wheel.CATProduct">1.CATProduct</ArchiveFile> <ArchiveFile FileId="2" SourcePath=\\server\Assemblies\Wheel_Skateboard.CATPart OutputFileName="Wheel_Skateboard.CATPart">2.CATPart</ArchiveFile> <ArchiveFile FileId="3" SourcePath=\\server\Assemblies\Gear.CATPart OutputFileName="Gear.CATPart">3.CATPart</ArchiveFile> <ArchiveFile FileId="4" SourcePath=\\server\Assemblies\Logo.CATPart OutputFileName="Logo.CATPart">4.CATPart</ArchiveFile> </ArchiveFiles> </Manifest>

NoteAn input manifest file that assigns a tag to the assembly:

Sample Code

<Manifest xmlns="http://schemas.righthemisphere.com/FileUploadManifest/2009/July"> <WorkflowName>CAD Assembly Upload</WorkflowName> <TargetServerPath>Default\Assembly</TargetServerPath> <AutoBuild>true</AutoBuild> <MainFile>1</MainFile> <ReferencedFiles> <ReferencedFile FileId="1" SourcePath="\\server\Assemblies\System_Wheel.CATProduct"> System_Wheel.CATProduct</ReferencedFile> </ReferencedFiles> <Categories> <CategoryMapping FileRef="1" Category="ABCD" /> </Categories> </Manifest>

NoteAn input manifest file that assigns metadata to the assembly:

Sample Code

<Manifest xmlns="http://schemas.righthemisphere.com/FileUploadManifest/2009/July"> <WorkflowName>CAD Assembly Upload</WorkflowName> <TargetServerPath>Default\Assembly</TargetServerPath> <AutoBuild>true</AutoBuild> <MainFile>1</MainFile>


<ReferencedFiles> <ReferencedFile FileId="1" SourcePath="\\server\Assemblies\System_Wheel.CATProduct"> System_Wheel.CATProduct</ReferencedFile> </ReferencedFiles> <FileMetadata> <File FileRef="1"> <Field Category="TestCategory" Name="Field1" Type="String" Value="WXYZ" /> </File> </FileMetadata> </Manifest>

2.3.2.1.5 DMS PDF Template Converter Workflow Controller

Use

The DMS PDF Template Converter workflow controller is used to perform RH file conversion to PDF using a preloaded PDF template in an SAP integrated system.

Features

The configurable settings for the DMS PDF Template Converter workflow controller are the following:

Setting Description

Maximum Files per KPRO Task The maximum number of files each parallel KPRO task processes. A high number; for example 1000, causes KPRO Retrieve and Store child jobs to process files in a single task, lightening the load on KPRO service. A setting of 1 causes KPRO Retrieve and Store child jobs to process all files in parallel increasing the load on KPRO service.

Default: 5

Maximum KPRO Retrieve Attempts The maximum number of times a child job is launched to attempt to retrieve documents from KPRO. This setting only applies to consecutive failed attempts (no files were retrieved).

Default: 3



Setting Description

Maximum KPRO Store Attempts The maximum number of times a child job is launched to attempt to store documents into KPRO. This setting only applies to consecutive failed attempts (no files were stored).

Default: 3

PDF Template Name The name of a PDF template installed on the server that is to be used to convert RH files into PDF.

The startup arguments for the DMS PDF Template Converter workflow controller are the following:


StartMessage XML document in DMS Template Converter format describing the required conversions

DSConnectorURL XML document listing the web service URLs that should be used by this job when it communicates with SAP NetWeaver.

NoteThe StartMessage and DSConnectorURL startup arguments must always be specified.

Activities

Configuring a WorkflowYou can configure this workflow controller by selecting the DMS Integrated option in the SAP 3D Visual Enterprise Generator Configurator. This option runs after the SAP 3D Visual Enterprise Generator installation.

2.3.2.1.5.1 Starting the DMS PDF Template Converter Workflow Controller

Workflows using the DMS PDF Template Converter workflow controller can be used to start jobs as follows:

● Using SAP 3D Visual Enterprise Generator conversion server API call

Procedure

To start a PDF Template Conversion job using an SAP 3D Visual Enterprise Generator conversion server API call, proceed as follows


1. Call JobStart() exposed by the ConversionServer.asmx SOAP web service.The following job startup arguments are supported:○ StartMessage: used to specify the input XML○ DSConnectorURL: the URLs of the DSConnector web services (an XML based structure representing

the various DS Connector Web Services)2. Supply the DSConnectorURL startup argument along with the StartMessage argument.

NoteDSConnectorURL sample XML structure:

Sample Code

<urls> <url servicename="VEGTASKREQUEST_IN" endpoint="http://server/endpoint/url" /> <url servicename="DOCFILELINKINFORMATION_OUT" endpoint="http://server/endpoint/url" /> <url servicename="DOCFILELINKCHECKINREQUEST_IN" endpoint="http://server/endpoint/url" /> <url servicename="VEGOBJECTS_INFORMATION_IN" endpoint="http://server/endpoint/url" /></urls>

Name Description

VEGTASKREQUEST_IN The URL of the service that is notified when the PDF Template Conversion job has completed.

DOCFILELINKINFORMATION_OUT The URL of the service used by the KPRO Retrieve Controller to resolve URLs that can be used to retrieve content from the content server.

DOCFILELINKCHECKINREQUEST_IN The URL of the service used by the KPRO Store Controller to resolve URLs that can be used to upload content to the content server.

VEGOBJECTS_INFORMATION_IN The URL of the service used to submit error reports for conversions that fail. If not supplied, error reporting is skipped.



2.3.2.1.5.2 DMS PDF Template Converter Processes

The DMS PDF Template Converter workflow controller uses the following processes:


DMS PDF Template Publish Converts RH files into PDF.

Report Job Errors Reports conversion errors

2.3.2.1.5.3 DMS PDF Template Converter Processing Steps

Use

The following processing steps are performed by the DMS PDF Template workflow controller:

● Validate Input● Lock Documents● Retrieve Source Documents● Template Conversion● Store Result Documents● Report Job Errors● Post Completion Job

Features

Validate InputIn the Validate Input processing step, the workflow controller validates the input file.

Lock DocumentsIn the Lock Documents processing step, the workflow controller attempts to obtain locks for all of the source and target documents referenced in the input file.

A project with the same name as each SAP System ID specified in the input file must exist in SAP 3D Visual Enterprise Generator for the required locks to be granted.

NoteIf the requested locks are not all granted, the job is aborted.

Retrieve Source DocumentsIn the Retrieve Source Documents processing step, the workflow controller triggers a child job using the workflow specified in the KPRO Retrieve slot.


The child job downloads files from the KPRO web service into the job workspace using the source document IDs specified in the job input file.

When the child workflow returns a warning, it indicates that an issue occurred when attempting to retrieve the file, but that retries are possible.

When the child workflow returns an error, it indicates that the file was not successfully retrieved and that retries cannot be performed. If the child workflow returns an error, the job is aborted.

The workflow controller triggers KPRO retrieval child jobs until a success or an error result is returned or the maximum number of retry attempts are made

Template Conversion

In the Template Conversion processing step, the workflow controller enqueues tasks using the process specified in the PDF Template Publish process slot.

Store Result Documents

In the Store Result Documents processing step, the workflow controller triggers a child job using the workflow specified in the KPRO Store child workflow slot.

The child job uploads the files created during the Template Conversion step from the job workspace to the KPRO web service using the target document IDs specified in the job input file.

When the child workflow returns a warning for a particular file, it indicates that an issue occurred when attempting to store the file, but that retries are possible.

When the child workflow returns an error for any file in the request, it indicates that the file was not successfully stored and that retries cannot be performed. If the child workflow returns an error, the job is aborted.

The workflow controller triggers KPRO storage child jobs until a success result is returned for all files, or an error result is returned, or the maximum number of retry attempts have been made.

Report Job Errors

In the Report Job Errors processing step, the workflow controller reports collected error messages.

Error reporting is performed by submitting an error report to the web service URL specified in DSConnectorURL startup argument, for one or more, but not all conversions failed.

Post Completion Job

The workflow controller is configured with a post completion job that notifies the DMS system that the job has completed.

Currently the Universal workflow controller is used for this purpose.

2.3.2.1.5.4 DMS PDF Template Converter Sample Input File

NoteAn example file is below:



Sample Code

<Manifest xmlns="http://schemas.righthemisphere.com/2012/DeepServer/DMSTemplateConverter/TemplateManifest" VegId="VEG_TEST_INST_1" Version="1"> <Conversion SourceDocId="S1" TargetDocId="T1" FileName="\\vault02\files\dev\Project management\Test Management\Deep Server\DS 6 GA\Test Scripts\Test Data\AssetUploadWorkflowController\Assets\MVO_Robot_KR6.rh" ph_objid="P1" SAPSystemId="SAP1" StorageCategory="DMS1"> <SceneData> <Target MetadataGroup="SAP Metadata" Field="MaterialIDs" Value="Element 1"> <MetadataGroup Name="SalesData"> <Metadata Name="Document" Value="0000000001" /> <Metadata Name="Version" Value="1" /> <Metadata Name="Description" Value="Description 1" /> <Metadata Name="Quantity" Value="1" /> <Metadata Name="UoM" Value="n/a" /> <Metadata Name="Material" Value="Element 1" /> <Metadata Name="Price" Value="$12.34" /> </MetadataGroup> </Target> <Target MetadataGroup="SAP Metadata" Field="MaterialIDs" Value="Element 3"> <MetadataGroup Name="SalesData"> <Metadata Name="Document" Value="0000000002" /> <Metadata Name="Version" Value="1" /> <Metadata Name="Description" Value="Description 2" /> <Metadata Name="Quantity" Value="2" /> <Metadata Name="UoM" Value="n/a" /> <Metadata Name="Material" Value="Element 3" /> <Metadata Name="Price" Value="$234.56" /> </MetadataGroup> </Target> </SceneData> <FormData> <Field Name="Create User" Value="Srba Stankovic" /> <Field Name="Create Date" Value="2012-08-28 14:38:25" /> <Field Name="Document Title" Value="BOM basic views with sales metadata" /> </FormData> </Conversion></Manifest>

2.3.2.1.6 Download Files Workflow Controller

Use

The Download Files workflow controller is used to access and copy files from an external system into the SAP 3D Visual Enterprise Generator workspace.

The Download Files workflow controller is used by the VDI processing workflow to retrieve CAD original files, as well as any other files that may be required for processing. It has an extensible XML request file format, from which it determines how to retrieve the requested files, and produces a response file in an extensible XML


response file format. Each controller step is customizable, but the controller provides a framework for a general download workflow, and provides built-in support for making downloads more robust using a retry mechanism, as well as an error reporting mechanism.

Figure 1: Download Files controller customized for KPRO file downloading

The default implementation of this controller supports KPRO as the remote system and is set as a child workflow in the Visual Data Integration workflow. By default, the Download Files workflow controller has no child workflows.

Features

Workflow SettingsThe Download Files workflow controller configurable settings are the following:

Download Files: Configurable Settings

Field Default Description

Maximum Concurrent Tasks 10 Sets the maximum number of download tasks to enqueue concurrently

Maximum Files Per Task 10 The maximum number of files to download in a particular SAP 3D Visual Enterprise Generator task.

Maximum Retries Per File 3 The maximum number of times to retry downloading a file if the first attempt fails.

Input RequestThe input to this workflow is an XML request file, the path to which is supplied in the Input file path startup argument.



This XML request is typically produced by a VDI processing workflow when it requests files to be downloaded, though there is nothing preventing use of the Download Files workflow on its own.

Every XML element in the request allows both custom attributes and custom child elements to be added, provided they are in a different namespace than the default namespace.

In this example, all XML elements in the http://schemas.sap.com/VE/Generator/KPRODownloadnamespace are custom, and are not known to the Download Files workflow controller. The only thing the Download Files workflow controller knows is that there are two files to download, and that they should be downloaded to a specific base path.

NoteThis request is an example of the customization performed by SAP to create a Download Files workflow that can retrieve files from a KPRO content server. This example was produced by the VDI processing workflow, which itself was customized to generate the request, annotated with KPRO content server information. For an example of annotating the request with this custom information, see the createDownloadRequest extension point in the Visual Data Integration – Input Transformation (SAP PLM) process.

Example 1: Download request XML

Sample Code

<DownloadRequest DownloadedFileBasePath="\\Server\Workspace\JM_JOB1\RetrievedFiles\" xmlns="http://schemas.sap.com/VE/Generator/Download/2013/May"> <File Id="d1"> <KPROInfo kpro:SourceDocumentId="SWA000000000000001000002892100000" kpro:PhysicalObjectId="0000C9D275CA1EE38094D66545B1A028" kpro:FileName="mast_truck.SLDASM" kpro:DownloadKind="CADOriginal" xmlns:kpro="http://schemas.sap.com/VE/Generator/KPRODownload" xmlns="http://schemas.sap.com/VE/Generator/KPRODownload" /> </File> <File Id="d2"> <KPROInfo kpro:SourceDocumentId="SWA000000000000001000002891500000" kpro:PhysicalObjectId="0000C9D275CA1ED3809484F3E1A6BF2B" kpro:FileName="Outer mast.SLDASM" kpro:DownloadKind="CADOriginal" xmlns:kpro="http://schemas.sap.com/VE/Generator/KPRODownload" xmlns="http://schemas.sap.com/VE/Generator/KPRODownload" /> </File></DownloadRequest>

More Information

Download Files Request XML Format [page 78]


http://help.sap.com/disclaimer?site=http%3A%2F%2Fschemas.sap.com%2FVE%2FGenerator%2FKPRODownload

2.3.2.1.6.1 Download Files Processes

The default processes and possible process customizations for the Download Files workflow controller are the following:


Analyze Download Request Default process is Download Files – Analyze Input

Download File Batch. Default process is Download File Batch

Finalize Job Default process is Download Files – Finalize Job

2.3.2.1.6.2 Download Files Processing Steps

Use

The following processing steps are performed by the Download Files workflow controller:

● Input Analysis● Download● Finalize Job

Features

Input Analysis

In this step, the Download Files workflow controller invokes the process configured in the Analyze Download Request slot to perform any validation and preprocessing on the input request XML file.

RecommendationWe recommend that in any customizations, you perform a pre-check here to ensure any information you require to perform a successful download is present on the request.

For an example, please consult the Download Files, Analyze Input (KPRO) process. We suggest that you use a copy of this process as a starting point for your customization, the validate_request and transform_request extension points provide a place for you to insert Python code that can validate the input, and attach any extra information needed.

Example validate_request Extension Point (KPRO)

This example extension point checks that the request XML contains the extra attributes that are required to successfully perform a file download from the KPRO content server.

The extension point invokes both IsRequestValid() and IsFileValid() to perform request-wide and per-file validation of the input.



Code Syntax

from saplib.download.kpro import * # Validates that the file has the KPRO custom elements and attributes# required to successfully perform a download from the content server.def IsFileValid(request, file): info = custom_element(file, 'KPROInfo') if not info: return Invalid("Missing <KPROInfo> element on file '%s'" % file.Id) if not custom_attribute(info, 'PhysicalObjectId'): return Invalid("Missing kpro:PhysicalObjectId attribute for file '%s'" % file.Id) if not custom_attribute(info, 'SourceDocumentId'): return Invalid("Missing kpro:SourceDocumentId attribute for file '%s'" % file.Id) if not custom_attribute(info, 'FileName'): return Invalid("Missing kpro:FileName attribute for file '%s'" % file.Id) return Valid()# Validates that the request is a valid download request.def IsRequestValid(request): return Valid()

Example transform_request Extension Point (KPRO)

This extension point collapses duplicate files into a single request for downloading, as this is a scenario that can occur in the SAP PLM VDI workflows. This information is added to the download request, and is used by later steps of the KPRO customization to make additional decisions

Code Syntax

from saplib.download.kpro import * # Transforms the download request to only have unique file download requests.# Also ensures all file download requests have a RelativeOutputPath set.def TransformRequest(request): # We only want to download a particular unique file once. Collapse # multiple requests for the same file into one request. Keep track of # discarded request IDs, because we have to report back for those requests # in the response, with the correct IDs. uniques_by_file = groupby(request.Files, get_kpro_file_name) uniques = list() duplicates = list() for k, g in uniques_by_file: files = list(g) unique_file = files.First() duplicate_files = list(files.Skip(1)) duplicate_ids = String.Join(' ', [f.Id for f in duplicate_files]) if len(duplicate_files) > 0 else None uniques.append(unique_file) duplicates.extend(duplicate_files) if duplicate_ids: set_kpro_info(unique_file, ATTR_KPRO_DUPLICATEREQUESTIDS, duplicate_ids) for file in duplicates: request.Files.Remove(file) # All <File> elements should have RelativeOutputPath for downstream use. for file in uniques: file.RelativeOutputPath = get_kpro_file_name(file)

After this step is complete, the controller looks at the resulting download request XML, which may have been altered by the extension points, and prepares a batch of items to download.


Download

In this step, the Download Files controller knows how many items are to be downloaded, and starts enqueueing one or more SAP 3D Visual Enterprise Generator tasks to perform downloads, using the following rules:

● Assign up to MaxFilesPerTask files to an SAP 3D Visual Enterprise Generator download task● Enqueue at most MaxConcurrentTasks to SAP 3D Visual Enterprise Generator at the same time. As

tasks complete, enqueue tasks again up to this limit.

ExampleFor example, given 105 files to download, with MaxFilesPerTask of 10 and MaxConcurrentTasks of 5, we will initially enqueue 5 SAP 3D Visual Enterprise Generator tasks for downloading, each downloading 10 files each. As download tasks complete, it frees up MaxConcurrentTasks slots, so we enqueue additional download tasks, each task consuming up to 10 files, with the final task downloading 5 files.

The specific MaxFilesPerTask or MaxConcurrentTasks values come from the request XML file, and, if not provided in the request, the defaults come from the Download Files controller workflow settings. The specific process that is queued is the one configured in the Download File Batch slot. For an example, please consult the Download Files, Download File Batch (KPRO) process.

RecommendationWe suggest that you use a copy of this process as a starting point for your customization, the download_file extension point provides a place for you to put your custom Python code that performs the actual work of downloading.

Error Handling

Any download failures are handled on a per-file basis.

If the MaxRetriesPerFile setting is > 0, the controller will attempt to re-download the file that many times before giving up.

A successful download results in an entry in the response with a status of Downloaded, a failed download results in an entry with the status Failed, with the Message parameter containing a description of the failure.

Regardless of success or failure, the RetryAttempts parameter in the response will always contain the number of times a file was retried.

Example download_file Extension Point (KPRO)

This extension point connects to the SAP ERP system, and performs the calls required in order to get a KPRO content server URL from which it then does an HTTP GET to download.

Code Syntax

from saplib.download.kpro import * # Performs a download from the KPRO content server for the specified file.# We set up authentication for subsequent web service and HTTP calls,# and then call the DOCFILELINKINFORMATION web service to get the content# server HTTP URLs we should download the files from.def DownloadFile(request, file): base_path = request.DownloadedFileBasePath # use sap.rfc.GetDestination() for a generic SAP connector object that uses



# the credentials/connection info of the current job (or parent job). phobjid = get_kpro_info(file, ATTR_KPRO_PHYSOBJID) response = None try: svc = sap.rfc.GetIntegrationService() response = list(svc.GetFileDownloadUrls([DownloadUrlRequest(PHIO=phobjid)])) except Exception, e: return Failure("RFC call CDESK_SRV_GET_FILE_URL failed with error: %s" % e.Message) http_url = None if response and len(response) > 0: http_url = response[0].SourceUrl if http_url: sap.log.info("Downloading file from KPRO url '%s'" % http_url) temp_file_path = Path.Combine(base_path, Guid.NewGuid().ToString('N')) sap.http.GetFile(http_url, temp_file_path) relative_file_name = get_kpro_file_name(file, sap.http.ResponseHeaders) if relative_file_name: final_file_path = Path.Combine(base_path, relative_file_name) if sap.filesystem.FileExists(final_file_path): return Failure("File '%s' already exists in download location, will not overwrite." % final_file_path, isRetryable=False) sap.filesystem.EnsurePath(Path.GetDirectoryName(final_file_path)) sap.filesystem.MoveFile(temp_file_path, final_file_path) return Success(relative_file_name) return Failure("Unable to determine file name to use for file '%s'" % file.Id) else: return Failure("Could not get KPRO URL for file '%s' with physical object ID '%s'" % (file.Id, phobjid))

After this step is complete, the controller looks at the resulting download request XML, which may have been altered by the extension points, and prepares a batch of items to download.

Finalize Job

This step provides a place for a customization to perform verification actions like checking downloaded file integrity, and perform any additional modifications to the download response. The proposed download response file has already been produced by the controller at this point.

For an example, please consult the Download Files, Finalize Job (KPRO) process. It is suggested that you use a copy of this process as a starting point for your customization, the transform_response extension point provides a place for alter the response before returning control to the workflow.

Example transform_response extension point (KPRO)

Code Syntax

from saplib.download.kpro import * # Transforms the download response to include all the files in the # request, even duplicates. Duplicates are given the status of # their corresponding unique request.def TransformResponse(request, response): duplicates = list() for respfile in response.Files: reqfile = request.Files[respfile.Id] ids = get_kpro_info(reqfile, ATTR_KPRO_DUPLICATEREQUESTIDS) kind = get_kpro_info(reqfile, ATTR_KPRO_DOWNLOADKIND) if kind: set_kpro_info(respfile, ATTR_KPRO_DOWNLOADKIND, kind) if ids: for id in ids.split(' '):


newfile = ResponseFile(id, respfile.RelativeOutputPath, respfile.Status, respfile.Message, respfile.RetryAttempts) for msg in respfile.PreviousMessages: newfile.PreviousMessages.Add(PreviousMessage(msg.Text)) duplicates.append(newfile) response.Files.AddRange(duplicates)

2.3.2.1.6.3 Download Files Request XML Format

The Download Request describes the files that are to be downloaded, and to where they are to be downloaded.

It is intentionally open to extension to allow for addition of new download mechanisms. The XSD schema allows any custom elements to be added to any existing element, as well as any custom attributes to any existing element.

Elements

<DownloadRequest>

This is the root element and is a container for one or more <File> elements, which represent a file to download. It allows any number of custom attributes to be added, as well as any number of custom elements beneath it.

Attributes


MaxRetriesPerFile Integer No The maximum number of times to retry downloading a particular file when a download attempt fails. Default: 3.

MaxConcurrentTasks Integer No The maximum number of SAP 3D Visual Enterprise Generator download tasks that a particular instance of a download workflow will spawn concurrently. Default: 5.

MaxFilesPerTask Integer No The maximum number of files which will be sent to a particular SAP 3D Visual Enterprise Generator Generator download task for downloading. The task will download this batch in serial, but tasks can be running concurrently. Default: 5.




DownloadedFileBasePath String Yes The directory to where downloaded files should be saved. Directory must be a subdirectory of the share Workspace folder, or the controller will reject it, for security reasons.

<File>

This represents a single file to download. It allows any number of custom attributes to be added, as well as any number of custom elements beneath it.

Attributes


Id String Yes An identifier for this file, unique within the request. Must meet the requirements for an XSD ID value (e.g. not start with numeric values). This identifier will be used in the download response XML document to identify which requested file the result is for.

RelativeOutputPath String No If known, the relative path where the downloaded file is to be placed. This path is relative to the directory the download controller will place output files. It may contain relative directory names and path structures, but may not be an absolute path, for security reasons.

NoteIf not supplied, the RelativeOutputPath must be set for this file in the response, or the Finalize Job step will report an error.

2.3.2.1.6.4 Download Files Response XML Format

Use

The Download Request describes the files that were downloaded, and their status.

Elements

<DownloadResponse>


This is the root element, and the container for one or more <File> elements.

<File>

This is the element containing the result for a particular file. For each file in the request document, there will always be one entry in the response containing the outcome for that file.

Attributes


ID String Yes The identifier of the file, corresponding to its identifier in the download request.

Status Enum Yes The status of the file. May be one of Downloaded or Failed.

RelativeOutputPath String Yes Contains the actual downloaded file path, which may be different to the RelativeOutputPath supplied in the request, or if RelativeOutputPath was not supplied in the request, it will have been determined later at run-time. It will always have a value.

Message String No If the file status is not Downloaded, will contain a message further describing the most recent reason for the failure.

RetryAttempts Integer No Contains the number of times downloading of the file was retried

<PreviousMessage>

This is an element containing previous messages, if multiple retry attempts occurred.

Attributes


Text String Yes The message text

Note

Sample Code

<DownloadResponse>



<File Id='f1' Status='Downloaded' RetryAttempts='1' ResponseFilePath='SubFolder\Part.prt'> <PreviousMessage Text='Connection reset by peer' /> </File> <File Id='f2' Status='Failed' Message='401 Unauthorized' RetryAttempts='3' /> <File Id='f3' Status='Downloaded' Message='302 Redirected' RelativeOutputPath='Assemblies\ActualFileName.CATProduct' /></DownloadResponse>

2.3.2.1.7 Generic Conversion Workflow

The Generic Conversion workflow controller takes as input an XML document in Visual Data Integration manifest format that points to translatable files in a user’s shared storage location or a ZIP file that contains an XML document in Visual Data Integration manifest format and all the translatable files to which this document points. From this input data, the workflow controller converts translatable files to SAP viewables, optionally creates derivatives from these viewables, creates CAD structure XML in public schema VZXML format and, stores the SAP viewables, derivatives, CAD structure XML and response XML in the user’s shared storage location.

Features

The startup arguments for the Generic Conversion workflow controller are described below:


Generic Conversion: Startup Arguments


InputFilePath String Yes The fully qualified path to the file which is the input to the workflow.

The file can be either:

● an XML document in Visual Data Integration manifest format that points to translatable files in the user’s shared storage location

● a ZIP file that contains an XML document in Visual Data Integration manifest format and all the translatable files to which this document points

ConversionKind enum No The conversion type.

This can be one of the following:

● Monolithic: a generic viewable is produced for each element in the scene tree

● Shattered: a shattered viewable is produced for each element in the scene tree

NoteThis option is not supported in SAP 3D Visual Enterprise Generator 8.0 SP4.

● Analysis: viewables and derivatives are not produced – only CAD structure XML is created

The default is Monolithic.




ViewableType enum No The output viewable type.

This can be one of the following:

● RH: binary RH format● VDS: VDS3 format in

SAP 3D Visual Enterprise Generator 8.0 SP4, VDS4 format in SAP 3D Visual Enterprise Generator 9.0

The default is RH in VEG 8.0 SP4, VDS in VEG 9.0

JobDataRetention integer No The number of days to keep job output files available in the user’s shared storage location.

The default is 7 days, but there is a supported range of 1-30 days if an outside range default is used.

DerivativeBuildFailureAsWarning

boolean No A flag indicating whether derivative build failure should be treated as a warning or error.

If derivative build failure occurs, and it is treated as a warning, the job will continue and store the built viewables, otherwise, the job will complete without storing anything.

The default value is True .



CADExtractionFailureAsWarning

boolean No A flag indicating whether CAD structure extraction failure should be treated as a warning or error.

If CAD structure extraction fails, and it is treated as warning, the job will continue with successful extractions (if any). Otherwise, the job will fail.

The default value is False .

ExtractAllConfigsIfNoneSpecified

boolean No A flag indicating whether to extract all configurations from the CAD file if no config-urations have been specified.

If set to False , and no configurations were specified, only the last save configura-tion will be extracted.

The default value is True .

The output argument for the Generic Conversion workflow controller is described below:

Generic Conversion: Output Argument


ResponseFileId String Yes The unique ID identifying the job response XML file in the user’s shared storage.

2.3.2.1.7.1 Generic Conversion Workflow Processes

The Generic Conversion workflow controller uses the following processes:

Processes


Generic Conversion – Input Validation Validates the input

Generic Conversion – CAD Configuration Selection Selects the required configurations




Generic Conversion – CAD Structure Extraction Extracts the assembly structure

Generic Conversion – CAD Structure Merge Finalizes the assembly structure

Generic Conversion – Create Build Viewables Request Prepares for building veiwables

Generic Conversion – Store Viewables Stores viewables and derivatives

Generic Conversion – Finalize Job Finalizes the job

2.3.2.1.7.2 Generic Conversion Processing Steps

The following processing steps are performed by the Generic Conversion workflow.

Features

Validate Input

In the Validate Input processing step, the workflow controller checks all start-up arguments for validity before continuing with the job to ensure correctness of output. Depending on the value of InputFilePath start-up argument, there are three paths of execution:

File Type

File Type Execution

XML input file Input XML file is validated against the VDI Input Manifest schema. Additionally, the file is validated to contain structure from CAD with all referenced CAD files using absolute paths pointing to the user’s shared storage or resolved structure with all referenced CAD files using absolute paths pointing to the user’s shared storage.

Any validation error returned must clearly state what is invalid about the XML file.


File Type Execution

ZIP Input file Input ZIP file is validated to be an Upload Archive. It must contain:

1. DS.manifest file in File Upload Manifest format that has Main File set to VDIInputManifest.xml

2. VDIInputManifest.xml file in VDI Input Manifest format

Additionally, the VDIInputManifest.xml file is validated to contain structure from CAD with all referenced CAD files using relative paths pointing to files contained in the input ZIP file or resolved structure with all referenced CAD files using relative paths pointing to files contained in the input ZIP file.

Any validation error returned must clearly state what is invalid about the ZIP file.

Any other file type An invalid input validation error is returned stating what file types are supported.

See Start-up Arguments in Generic Conversion Workflow [page 81]for more details on controller start-up arguments.

Any failure results in the job completing with an Error state and job processing continuing with the Finalize Job step.

Select Configurations

In the Select Configurations processing step, the workflow controller executes an SAP 3D Visual Enterprise Generator process to select CAD configurations (reused VDI workflow step).

If a resolved structure is supplied in the input file, this step is skipped and job processing continues with the Build Viewables processing step.

Any failure results in the job completing with an Error state and job processing continuing with the Finalize Job processing step.

Extract Assembly Structure

In the Extract Assembly Structure processing step, the workflow controller executes SAP 3D Visual Enterprise Generator processes to extract selected CAD configurations. The extraction rules are the following:

1. If a file format is supported by BOMFactory, run BOMFactory to produce VZXML2. If Creo file format is detected, run ProExplorer to produce neutral files, and then run BOMFactory on them

to produce VZXML3. If RH, RHZ, or VDS file format is detected, produce VZXML4. If 3D/2D Vector file format is detected, create VZXML that represents the hierarchy5. If 2D Raster file format is detected, create VZXML6. All other file formats will produce an error



If a resolved structure is supplied in the input file, this step is skipped and job processing continues with the Build Viewables processing step. Any failure results in the job completing with an Error state and job processing continuing with the Finalize Job processing step.

Finalize Assembly Structure

In the Finalize Assembly Structure processing step, the workflow controller executes an SAP 3D Visual Enterprise Generator process to merge extracted CAD configurations into one file (reused VDI workflow step).

If a resolved structure is supplied in the input file, this step is skipped and job processing continues with the Build Viewables processing step. Any failure results in the job completing with an Error state and job processing continuing with the Finalize Job processing step.

Prepare for Building Viewables

In the Prepare for Building Viewables processing step, the workflow controller executes an SAP 3D Visual Enterprise Generator process to create a Build Viewables request.

There are two methods of creating the Build Viewables request:

Method Action

VDI input manifest contains Structure from CAD VZXML created by the Finalize Assembly Structure processing step is updated with identifiers and metadata from theVDI input manifest

VDI input manifest contains Resolved Structure VDI input manifest is converted to VZXML


Build Viewables

In the Build Viewables processing step, the workflow controller enqueues a child Build Viewables job (reused VDI workflow step). Upon successful viewable creation, a CAD structure XML is created from the build viewables request. If the ConversionKind start-up argument is set to Analysis, this step is skipped.


Prepare for Building Derivatives

In the Prepare for Building Derivatives processing step, the workflow controller executes an SAP 3D Visual Enterprise Generator process to create a Build Derivatives request. if any are required. If the ConversionKind start-up argument is set to Analysis, this step is skipped.


Build Derivatives

In the Build Derivatives processing step, the workflow controller enqueues a child Build Derivatives job. If the ConversionKind start-up argument is set to Analysis, this step is skipped.


Store Viewables and Derivatives


In the Store Viewables and Derivatives processing step, the workflow controller executes an SAP 3D Visual Enterprise Generator process to store built viewables and derivatives, if any, and CAD structure XML files in the user’s shared storage.


Finalize Job

In the Finalize Job processing step, the workflow controller executes an SAP 3D Visual Enterprise Generator process to create job response XML file.

The file contains the following information:

● An entry for each output viewable● Inside the entry for a viewable, the identifiers for that viewable● Inside the entry for a viewable, an entry for each derivative● The path to the VZXML CAD Structure XML file

Upon successful response XML file creation, the SAP 3D Visual Enterprise Generator process saves this file in the user’s shared storage and updates the ResponseFileId job output argument with the unique id of the saved file.

Any failure results in the job completing with an Error state.

NoteThis step is always executed regardless of job outcome or failure occurring in any of the previous steps.

2.3.2.1.8 Integrated Assembly Workflow Controller

Use

The Integrated Assembly workflow controller is an Integrated workflow. It is designed to receive conversion job requests from an ERP system, and store the conversion results in an ERP system.

Jobs are started in the ERP system manually (DMS_CONV01 transaction), or automatically through a scheduled background job (VEG_CNV_BATCHJOB transaction).

The Integrated Assembly workflow produces viewables tagged with metadata and identifiers. If requested, it may also produce derivatives. These outputs are then stored back on the source DMS document structures.



Features

The Integrated Assembly workflow controller configurable settings are the following:

Integrated Assembly: Configurable Settings

Setting Type Default Description

Use Original File Cache Boolean true If set to true, original files are cached, and if they exist in the cache, are reused instead of being downloaded. If set to false, original files are always downloaded, even if they exist in the cache.

Use Viewable File Cache Boolean true If set to true, viewable files are cached, and if they exist in the cache, they are reused instead of being built. If set to false, viewable files are always built, even if they exist in the cache.



Configuration Structure Enum FilePerConfiguration Indicates the configuration structure of a viewable, can be Default, FilePerConfiguration, or AllConfigurationsInOneFile.

● FilePerConfiguration: A viewable is created per configuration

● AllConfigurationsInOneFile: All configurations are stored in one viewable

NoteThis setting is incompatible with a StoragePolicy of All. Additionally, if you specify AllConfigurationsinOneFile, user-specified configurations are ignored, and all configurations are extracted.

Viewable Format Enum VDS The file format of built viewables. Available options are RH or VDS.

Structure Enum Monolithic The structure of the built viewable files, can be Shattered or Monolithic.

● Monolithic: Each built file contains the entirety of all its children

● Shattered: Each built file contains only the content for itself, and children are merely referenced




Extract all Configurations if None Specified

Boolean true If no configurations are specified in the request, indicates whether to extract all configurations from the CAD file. If set to False, and no cofigurations are specified in the request, only the last saved configuration is extracted.

Build Primary Conversion Thumbnails

Boolean true If set to true, primary conversion thumbnails (JPG) are built

Build Primary Conversion Animated Thumbnails

Boolean true If set to true, primary conversion animated thumbnails (GIF) are built

Missing Original File Failure Policy

Enum Error Determines the outcome if, during structure analysis of the original files, it is found that the original files for some parts or assemblies are missing.

● Error: The job fails● Warning: A warning is

logged but the job continues and creates an empty placeholder for the failed item

Build Failure Policy Enum Error Determines the outcome if a part or assembly fails to build.

● Error: The job fails● Warning: A warning is

logged but the job continues and creates an empty placeholder for the failed item



File Conflict Policy Enum Error The policy to use when conflicting files with the same file name are present in the input.

● Error: The files are rejected

● UseLatestInStructure: The latest version of the file is used

Ignore DIR Collisions for Conflicts

Enum False When resolving file conflicts, indicates whether to ignore multiple DIRs referencing a file with the same file name and different DIR document numbers




Storage Policy Enum TopLevelOnly The policy to use when storing viewables and derivatives.

● TopLevelOnly: Stores only top-level requested viewables and derivatives

NoteIf TopLevelOnly is selected, and the BuildStructure is “Shattered”, conversions must have occurred for all items in a hierarchy before it is displayed to users.

● All: Stores all requested viewables and derivatives

NoteThis setting is incompatible with a ConfigurationStructure of “AllConfigura-tionsInOneFile”.

Max KPRO Retrieve Attempts Integer 3 The maximum number of times that KPRO retrieval is retried in the event of recoverable errors

Max KPRO Store Attempts Integer 3 The maximum number of times the KPRO storage is retried in the event of recoverable errors



Max Files per KPRO Task Integer 50 The maximum number of files each parallel KPRO task processes. Setting a high number; for example 1000, causes KPRO Retrieve and Store child jobs to process files in a single task. This action lightens the load on the KPRO service. Setting to 1 causes KPRO Retrieve and Store child jobs to process all files in parallel increasing the load on KPRO service.

Overwrite TMatrices Enum False Overwrite transformation matrices of Source Document Structure

The Integrated Assembly workflow controller startup arguments are the following:

Integrated Assembly: Arguments

Argument Type Mandatory Description

Start Message String Yes An XML document in public schema VZXML format describing hierarchical assembly structure, annotated with DMS extension attributes

DSConnectorURL String Yes An XML document listing the web service URLs to use by this job when it communicates with the ERP

SAP 3D Visual Enterprise Generator Connector web service URLs in XML format

ViewableFileFormat Enum No The file format of built viewables:

● Default: The value of the workflow setting with the same name is taken

● RH: Binary RH format

● VDS: VDS4 format



Argument Type Mandatory Description

ViewableStructure Enum No The structure of the built viewable files:

● Default: Value of the workflow setting with the same name is taken

● Shattered: Each built file contains only the content for itself, and children are just referenced

● Monolithic: Each built file contains the entirety of all its children

UseOriginalFileCache Nullable Boolean No If set to true, original files are cached, and if they exist in the cache, they are reused instead of being downloaded. If set to false, original files are always downloaded, even if they exist in the cache.

NoteIf False, UseViewableFileCache is also forced to False as it cannot be used without original file cache

UseViewableFileCache Nullable Boolean No If set to true, viewable files are cached, and if they exist in the cache, they are reused instead of being built. If set to false, viewable files are always built, even if they exist in the cache.

This startup argument is optional, and if supplied, it overrides the value of the workflow setting with the same name.


2.3.2.1.8.1 Starting an Integrated Assembly Workflow Controller

Use

Workflows using the Integrated Assembly workflow controller can be used to start jobs as follows:

● Using the dms_conv01 transaction in the SAP system● Using a Workflow Job hot folder● Using the Conversion Server web service

Procedure

To start an Integrated Assembly job from an SAP system, proceed as follows:

NoteThe SAP system has been configured to connect to an SAP 3D Visual Enterprise Generator instance running in the Integrated mode.

1. Start the dms_conv01 transaction2. Locate the document representing the assembly you wish to convert.3. Start the conversion by selecting the appropriate Integrated Assembly Conversion configuration ID (for

example, CONVERT ASSEMBLY CAD, or CONVERT ASSEMBLY CAD PROE). Configuration IDs correspond to workflow names in SAP 3D Visual Enterprise Generator.

To start an Integrated Assembly job from the Conversion Server web service, call the JobStart() method, passing through the appropriate startup arguments.

To start an Integrated Assembly job from a Workflow Job hot folder, proceed as follows:

1. Configure a Workflow Job hot folder by selecting the required Integrated Assembly workflow.2. Drop a Schema1 file, annotated with the DMS extensions, in the hot folder.

2.3.2.1.8.2 Configuring an Integrated Assembly Workflow

To configure SAP 3D Visual Enterprise Generator to process Integrated Assembly jobs, proceed as follows:

1. Open 3D Visual Enterprise Generator Administration and navigate to Server ConfigurationWorkflows .

2. Choose New on the Workflows toolbar. The Create Workflow window opens.3. On the General tab page, enter a name for the workflow.4. Enter Integrated Assembly workflow controller in the Controller field.

5. If you want to build secondary derivatives, navigate to Child Workflows Select Derivatives .




Building of secondary derivatives is handled by a child job. The Integrated Assembly controller builds a request XML file that contains the assembly structure and a list of desired derivatives. The controller passes it to the child job, which builds the derivatives.

You can select the derivative group to build in the Default Derivative Group dropdown list on the Settings tab.

2.3.2.1.8.3 Configuring Pro/ENGINEER Conversions Workflow

Use

To support some Pro/ENGINEER features fully, additional configuration is required on the SAP 3D Visual Enterprise Generator server.

Prerequisites

You have set up the following:

● Pro/ENGINEER Wildfire 3.0 or later, or Creo Elements Pro/5.0 or later is installed on the same server as SAP 3D Visual Enterprise Generator.

● A Pro/ENGINEER license is available for use by this installation.

Procedure

This configuration is already performed on a default Integrated SAP 3D Visual Enterprise Generator by the configuration script in the SAP 3D Visual Enterprise Generator Configuration application. It creates a Convert Assembly CAD ProE workflow. If this step must be performed manually, the configuration it performs is described as follows, .

1. The Integrated Assembly – PreProcess CAD (ProE) process must be selected in the Pre-process retrieved CAD files slot, on the Processes tab of the workflow configuration.

2. The Pre-process CAD files workflow setting must be set to True.3. The Entity error matching error policy for TopDown builds workflow setting must be set to Warning.4. If multiple versions of Pro/ENGINEER are installed on the SAP 3D Visual Enterprise Generator server, the

Integrated Assembly – PreProcess CAD (ProE) process can be modified. Modify by setting the value of the proe_installation_directory variable to indicate which version should be used.

5. The Integrated Assembly – PreProcss CAD (ProE) process should be throttled to run as many processes concurrently as there are Pro/ENGINEER licenses available only. By default, the configuration script sets this value to 1, but you can change it to a higher value if more licenses are available.


RecommendationThis workflow is only able to process Pro/ENGINEER CAD files, so we recommend to name it appropriately.

2.3.2.1.8.4 Integrated Assembly Processes

Use

The Integrated Assembly workflow controller uses the following processes:

● DMS Assembly – Analyze Input (Process Slot: Analyze DMS Structure of Input Schema1 XML)Analyzes the input Schema1 XML to determine the DMS document IDs to create conversions for and CAD files to retrieve

● DMS Assembly – Build Assembly (Process Slot: Primary Conversion of CAD Assemblies)Builds an RH file representing an assembly from one or more already converted part RH files

● DMS Assembly – Build Part (Process Slot: Primary Conversion of CAD Parts)Builds an RH file representing a part from a CAD original file

● DMS Assembly – Retrieve Assets (Process Slot: Retrieve Items Cached in SAP 3D Visual Enterprise Generator)Retrieves RH and other conversions from the SAP 3D Visual Enterprise Generator cache, if they exist

● DMS Assembly – Store Assets (Process Slot: Local Storage of Converted Files)Caches RH files and derivatives created by the conversion process in the local SAP 3D Visual Enterprise Generator database

● DMS Assembly – PreProcess CAD (ProE) (Process Slot: Pre-Process Retrieved CAD Files)Pre-processes Pro/ENGINEER ® CAD files to extract additional information (see Configuring Pro/ENGINEER ® Conversions)

● DMS Assembly – Analyze CAD Analyze (Process Slot: Analyze Structure of Retrieved CAD Files)● Report Job Errors (Process Slot: Report Job Errors)● DMS Assembly – Build Assembly (Remap Metadata) (Process Slot: Primary Conversion of CAD

Assemblies)Builds an RH file representing an assembly from one or more already converted part RH files, remapping metadata according to rules in remap XML file

● DMS Assembly – Build Part (Remap Metadata) (Process Slot: Primary Conversion of CAD parts)Builds an RH file representing a part from a CAD original file, remapping metadata according to rules in remap XML file

NoteThe DMS Assembly – Build Part (Remap Metadata) and DMS Assembly – Build Assembly (Remap Metadata) are additional processes and are not loaded by default.



Activities

The Integrated Assembly workflow can be modified to apply custom metadata field remapping during the process of creating primary conversions for parts or assemblies. There are two ways to achieve this.

Using Built-In Metadata RemappingSAP 3D Visual Enterprise Generator ships with two pre-configured processes DMS Assembly - Build Assembly (Remap Metadata) and DMS Assembly - Build Part (Remap Metadata).

To use them, load them in the Processes list of SAP 3D Visual Enterprise Generator Administration, and then select them on your Integrated Assembly workflow, in the Primary conversion of CAD assemblies, and Primary conversion of CAD parts slots. The processes expect a Batch Metadata Request format XML file to be located in $SHARE\Workspace\DMSAssemblyMetadataRemap.xml.

Configuring Remapping ManuallyWe recommend that you add a new instance of the go_object_setbatchmetadata operation to a custom version of the jmp_dms_assembly_buildpart or jmp_dms_assembly_buildassembly processes, placing this operation before go_save. The inputfile parameter for this operation should then be modified to point to a common XML file located in the SAP 3D Visual Enterprise Generator, describing the metadata field remapping to be performed, this XML file should be in Batch Metadata Request format.

2.3.2.1.8.5 Integrated Assembly Processing Steps

Use

The following processing steps are performed by the Integrated Assembly workflow controller:

● Validate Input● Input Analysis● Locking● Retrieve Originals from Cache● Retrieve Originals from ERP● Cache Originals● Release Unnecessary Locks● Build Viewables● Store Viewables in ERP● Report Errors● Finalize Job


Features

Validate Input

This step checks all start-up arguments for validity before continuing with the job to ensure correctness of output. Depending on the value of StartMessage start-up argument, there are two paths of execution.

XML Input File

Input XML file is validated against the public VZXML schema and DMS extensions schema. Additionally, the DSConnectorURL start-up argument is validated to contain all required URLs (see the following table for URL service names).

Common validations are as follows:

● At least one <Node> element is required within a <Bom> element in the <Boms> section● All <Entity> elements are required to have one and only one <EntityId> element targeting them, to

ensure that DMS identifiers are correctly specified● The <MultiBom> element must have a dms:VegId attribute specified● All <File> elements must have a dms:PhObjId attribute specified● All dms:TMatrix attributes are validated to contain 13 floating point numbers separated by whitespace● Only top-level <Entity> is allowed to have the dsm:CadConfigurations element

Any validation error returned must clearly state what is invalid about the SML file.

Validation Errors

Service Name Mandatory Description

DOCFILELINKINFORMATION_OUT Yes The URL of the service used by the KPRO Retrieval Controller to resolve URLs that can be used to retrieve content from the content server

DOCFILELINKCHECKINREQUEST_IN Yes The URL of the service used by the KPRO Storage Controller to resolve URLs that can be used to upload content to the content server

VEGOBJECTS_INFORMATION_IN No The URL of the service used to submit error reports for primary and secondary conversions that fail. If not supplied, error reporting will be skipped

VEGTASKREQUEST_IN Yes The URL of the service that is notified when the DMS Assembly 2.0 job has completed

Any Other File Type

An invalid input validation error is returned stating what file types are supported.

See Job Start-up Arguments for more details on controller start-up arguments. Any failure results in the job completing with the Error state.



Input AnalysisThis step analyses the input VZXML, and creates a model (internal state file) of the assembly hierarchy, which is used throughout the job.

Mapping DMS Info to VZXML

DMS VZXML

Source Document ID Uid attribute on <EntityId> element

Target Document ID dms:TargetDocId attribute on <EntityId> element

Storage Category dms:StorageCategory attribute on <EntityId> element

Physical Object ID dms:PhObjId attribute on <File> element

Doc Type dms:DocType attribute on <EntityId> element

Authority Group dms:AuthorityGroup attribute on <EntityId> element

Folder Path dms:FolderPath attribute on <EntityId> element

Viewable Base File Name Name attribute on <Entity>

Configuration Names dsm:CadConfigurations element on top-level <Entity> element

Identifiers dsm:Identifiers element on <Entity> element

Metadata <Metadata> element on <Entity> element

Mapping from VZXML to VEG

VZXML VEG

<Entity> 1 or more child <Node> elements: Assembly Asset

0 child <Node> elements: Part Asset

<Node> Within <Bom>: Top-level asset instance

Within <Entity>: Instance relative to containing asset

<EntityId> Asset version external ID

<NodeId> Asset instance external ID

<SelectorId> Ignored

<Selector> Ignored

Any failure results in the job completing with the Error state.

LockingThis step uses the values from the internal state file to obtain an asset version lock by external system ID from the VEG Lock Manager, blocking until all requested locks are available.


Retrieve Originals from CacheThis step executes an SAP 3D Visual Enterprise Generator process. The operation to execute is the following:

● Retrieve cached original files into job workspace (if original file cache is enabled) and update internal state file


Retrieve Originals from ERPIf there are files that are not available in the cache, or the original file cache is disabled, the controller generates a KPRO Retrieval Request and invokes the KPRO Retrieve Controller as a child job, to retrieve the files and place them in the job workspace. This step is skipped if all original files have been retrieved from the cache.

If any files failed to retrieve due to a recoverable error; for example, content server returned a response indicating that the request should be retried, the DMS Assembly controller will retry KPRO retrieval until the file is retrieved, or the maximum number of retry attempts for KPRO Retrieval has been reached, whichever occurs first.


Cache OriginalsThis step executes an SAP 3D Visual Enterprise Generator process. The operation to execute is the following:

● Cache original files retrieved from ERP (if original file cache is enabled) and update internal state file

This step is skipped if the Retrieve Originals from ERP step is skipped.


Release Unnecessary LocksIf the controller was able to determine that certain assets will not be updated by the job, it releases the locks on those assets to improve concurrency when there is a high degree of reuse of certain assets.

If this step fails, a message displays in the job report to this effect, but the job status does not change.

Build ViewablesThis step creates a VDI input manifest from the internal state file and invokes the Generic Conversion Controller as a child job, to build required viewables and derivatives. The viewables to build are determined by the ViewableStructure start-up argument, and their format is determined by ViewableFileFormat start-up argument.

If viewable structure is Monolithic only the viewable for top-level asset is requested – all others are skipped. If viewable structure is Shattered, viewables for all assets are requested.

Thumbnails and animated thumbnails are always requested for viewables that are to be built.

The derivatives to build are determined by the default derivative group assigned to the workflow. You must map the derivative group name to its external name using the Derivative Mappings.

Upon child job completion, the Generic Conversion job response file is retrieved from Shared File Storage and processed.

If one or more viewables, but not all, failed to create and Viewable Conversion Failure Policy is set to Warning, the job outputs a warning message and continues; otherwise, the job completes with the Error state. If one or more derivatives, but not all, failed to create and Secondary Conversion Failure Policy is set to Warning, the job outputs a warning message and continues; otherwise, the job completes with the Error state.



Store Viewables in ERPThis step generates a KPRO Store Request from the internal state file and triggers the KPRO Store Controller as a child job, to store files in ERP.

If any files failed to store due to a recoverable error; for example, content server returned a response indicating that the request should be retried, the DMS Assembly workflow controller will retry KPRO store until the file is stored, or the maximum number of retry attempts for KPRO Store has been reached, whichever occurs first.

Any failure results in the job completing with the Error state and continuing with the Report Errors step.

Report ErrorsThis step executes an SAP 3D Visual Enterprise Generator process.

If an endpoint URL is supplied in the DSConnectorURL start-up argument for the VEGOBJECTS_INFORMATION_IN service name, error reporting is performed, otherwise, error reporting is skipped.

Error reporting is performed by submitting an error report to the web service URL, for each of the following types of errors:

● Primary conversion failure● Secondary conversion failure● Failure to store a primary or secondary conversion in ERP

The error report identifies the Source Document ID of the affected item, and also includes a readable error message describing the nature of the error. If the error reporting task fails to report errors, a message displays in the job report to this effect. Whether or not the reporting task fails, the job completes with the same status.

Finalize JobThis step executes an SAP 3D Visual Enterprise Generator process. The operations to execute are the following:

● Remove all viewables that failed to store in ERP from SAP 3D Visual Enterprise Generator cache● Remove all files generated by the Generic Conversion child job from the Shared File Storage

If this process fails, a message displays in the job report to this effect, but the job status does not change. This step is always executed regardless of job outcome or failure in any of the previous steps.

2.3.2.1.8.6 Integrated Assembly Input File Format

The file specified in the Input File Path startup argument, or the XML specified in the Start Message startup argument must be a file in the Schema1 XML format.

Schema Validation

The input file must be valid according the schema definition. In addition, the DMS Assembly Conversion workflow controller performs additional checks to guard against invalid input data, described in the Schema Rules section.


Schema Rules

The following additional business rules are checked for all submitted Schema1 files, any failure causes the job to be aborted at the validation stage:

● A top-level <Node> must be present below a <Bom>● All <Entity> elements must have one and only one external ID assigned to them by an <EntityId>

element in an <ExternalSystem> block.● All <File> elements must have a dms:PhysObjId attribute.

In addition, based on the active build method set by dms:BuildMethod attribute on <MultiBom> element, additional rules apply.

BottomUp build method:

● All <Node> elements must have one and only one external ID assigned to them by a <NodeId> element in an <ExternalSystem> block.

● All <Entity> elements that have no child <Node> elements must have a FileRef attribute.

The TopDown build method is not supported.

Schema Mapping to SAP 3D Visual Enterprise Generator Assets

The mapping from Schema1 XML elements into SAP 3D Visual Enterprise Generator assets and instances is as follows:

● <Node> elements in the <Bom> pointing to top-level asset entities are top-level instances.● <Entity> elements correspond to assets.● An <Entity> with one or more <Node> children is an Assembly asset.● An <Entity> with no <Node> children is a Part asset.● A <Node> within an <Entity> is a relative instance child of that asset.● <NodeId> maps to SAP 3D Visual Enterprise Generator relative instance external ID.● <EntityId> maps to SAP 3D Visual Enterprise Generator asset external ID.● <SelectorId> is ignored.● <Selector> is ignored.

2.3.2.1.8.6.1 Integrated Assembly Sample Input File

NoteA Schema1 file containing an assembly with instancing:

Sample Code

<MultiBom xmlns="http://schemas.righthemisphere.com/MultiBom/2009/May" xmlns:dms="http://schemas.sap.com/MultiBom/2011/Oct/DMS" dms:BuildMethod="BottomUp"



Generator="SAP_DMS" dms:VegId="VEG1"> <Boms> <Bom Id="IAM_0000000000000010000000143_000_00" Name="MVO_Robot_KR6"> <Node Id="n1" Name="MVO_Robot_KR6" EntityRef="e1" /> </Bom> </Boms> <Entities> <Entity Id="e1" Name="MVO_Robot_KR6" FileRef="f1" > <Metadata> <MetadataGroup Name="Test Metadata"> <Array Name="Materials"> <String Value="Element 0" /> <String Value="Element 1" /> <String Value="Element 2" /> </Array> </MetadataGroup> </Metadata> <Node Id="n2" EntityRef="e2" Name="MVO_Robot_Zentralhand" /> <Node Id="n3" EntityRef="e3" Name="MVO_Robot_Arm-komplett" dms:TMatrix="1.0000000000000000E+00 0.0000000000000000E+00 0.0000000000000000E+00 0.0000000000000000E+00 1.0000000000000000E+00 0.0000000000000000E+00 0.0000000000000000E+00 0.0000000000000000E+00 1.0000000000000000E+00 0.0000000000000000E+00 0.0000000000000000E+00 0.0000000000000000E+00 1.0000000000000000E+00" /> <Node Id="n4" EntityRef="e4" Name="MVO_Robot_Schwinge-komplett" /> <Node Id="n5" EntityRef="e5" Name="MVO_Robot_Karussell-komplett" /> <Node Id="n6" EntityRef="e6" Name="MVO_Robot_Grundgestell-komplett" /> </Entity> <Entity Id="e2" Name="MVO_Robot_Zentralhand" FileRef="f2"> <Node Id="n7" EntityRef="e7" Name="MVO_Robot_A5-Gehaeuse" /> <Node Id="n8" EntityRef="e8" Name="MVO_Robot_A4-Gehaeuse" /> <Node Id="n9" EntityRef="e9" Name="MVO_Robot_Deckel" /> <Node Id="n10" EntityRef="e10" Name="MVO_Robot_Getriebe_A4" /> <Node Id="n11" EntityRef="e11" Name="MVO_Robot_Getriebe_A6" /> <Node Id="n12" EntityRef="e12" Name="MVO_Robot_Getriebe_A5" /> <Node Id="n13" EntityRef="e13" Name="MVO_Robot_Adapter" /> </Entity> <Entity Id="e3" Name="MVO_Robot_Arm-komplett" FileRef="f3"> <Node Id="n14" EntityRef="e14" Name="MVO_Robot_Arm-Gehaeuse" /> <Node Id="n15" EntityRef="e15" Name="MVO_Robot_Motor_1" /> <Node Id="n16" EntityRef="e15" Name="MVO_Robot_Motor_1" /> <Node Id="n17" EntityRef="e15" Name="MVO_Robot_Motor_1" /> <Node Id="n18" EntityRef="e16" Name="MVO_Robot_Motor_2" /> </Entity> <Entity Id="e4" Name="MVO_Robot_Schwinge-komplett" FileRef="f4" /> <Entity Id="e5" Name="MVO_Robot_Karussell-komplett" FileRef="f5"> <Node Id="n19" EntityRef="e17" Name="MVO_Robot_Motor_3" /> <Node Id="n20" EntityRef="e17" Name="MVO_Robot_Motor_3" /> <Node Id="n21" EntityRef="e18" Name="MVO_Robot_Karussell-komplett-None" /> </Entity> <Entity Id="e6" Name="MVO_Robot_Grundgestell-komplett" FileRef="f6" /> <Entity Id="e7" Name="MVO_Robot_A5-Gehaeuse" FileRef="f7"/> <Entity Id="e8" Name="MVO_Robot_A4-Gehaeuse" FileRef="f8"/> <Entity Id="e9" Name="MVO_Robot_Deckel" FileRef="f9"/> <Entity Id="e10" Name="MVO_Robot_Getriebe_A4" FileRef="f10"/> <Entity Id="e11" Name="MVO_Robot_Getriebe_A6" FileRef="f11"/> <Entity Id="e12" Name="MVO_Robot_Getriebe_A5" FileRef="f12"/> <Entity Id="e13" Name="MVO_Robot_Adapter" FileRef="f13"/> <Entity Id="e14" Name="MVO_Robot_Arm-Gehaeuse" FileRef="f14"/> <Entity Id="e15" Name="MVO_Robot_Motor_1" FileRef="f15"/> <Entity Id="e16" Name="MVO_Robot_Motor_2" FileRef="f16"/> <Entity Id="e17" Name="MVO_Robot_Motor_3" FileRef="f17"/> <Entity Id="e18" Name="MVO_Robot_Karussell-komplett-None"


FileRef="f18"/> </Entities> <ExternalSystems> <ExternalSystem Name="E6C001" > <EntityId EntityRef="e1" Uid="IAM#0000000000000010000000143#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <EntityId EntityRef="e2" Uid="IAM#0000000000000010000000144#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <EntityId EntityRef="e3" Uid="IAM#0000000000000010000000152#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <EntityId EntityRef="e4" Uid="IPT#0000000000000010000000156#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <EntityId EntityRef="e5" Uid="IAM#0000000000000010000000157#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <EntityId EntityRef="e6" Uid="IPT#0000000000000010000000160#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <EntityId EntityRef="e7" Uid="IPT#0000000000000010000000145#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <EntityId EntityRef="e8" Uid="IPT#0000000000000010000000146#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <EntityId EntityRef="e9" Uid="IPT#0000000000000010000000147#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <EntityId EntityRef="e10" Uid="IPT#0000000000000010000000148#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <EntityId EntityRef="e11" Uid="IPT#0000000000000010000000149#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <EntityId EntityRef="e12" Uid="IPT#0000000000000010000000150#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <EntityId EntityRef="e13" Uid="IPT#0000000000000010000000151#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <EntityId EntityRef="e14" Uid="IPT#0000000000000010000000153#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <EntityId EntityRef="e15" Uid="IPT#0000000000000010000000154#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <EntityId EntityRef="e16" Uid="IPT#0000000000000010000000155#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <EntityId EntityRef="e17" Uid="IPT#0000000000000010000000158#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <EntityId EntityRef="e18" Uid="IPT#0000000000000010000000159#000#00" Version="" Revision="" dms:StorageCategory="DMS1" /> <NodeId NodeRef="n1" Uid="IAM#0000000000000010000000143#000#00" /> <NodeId NodeRef="n2" Uid="6B6D094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n3" Uid="6C6D094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n4" Uid="6D6D094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n5" Uid="6E6D094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n6" Uid="6F6D094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n7" Uid="0B6D094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n8" Uid="0C6D094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n9" Uid="0D6D094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n10" Uid="0E6D094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n11" Uid="0F6D094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n12" Uid="106D094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n13" Uid="116D094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n14" Uid="C96C094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n15" Uid="CA6C094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n16" Uid="CB6C094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n17" Uid="CC6C094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n18" Uid="CD6C094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n19" Uid="986C094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n20" Uid="996C094CC2425A34E10000000A4286E9" /> <NodeId NodeRef="n21" Uid="9A6C094CC2425A34E10000000A4286E9" /> </ExternalSystem> </ExternalSystems> <FileGroups> <FileGroup BasePath="" Type="Absolute"> <File Id="f1" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor



\SAPRobot\MVO_Robot_KR6_f1.iam" dms:PhObjId="D5DB094CE8425334E10000000A4286E9" /> <File Id="f2" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor\SAPRobot\MVO_Robot_Zentralhand_f2.iam" dms:PhObjId="DEDB094CE8425334E10000000A4286E9"/> <File Id="f3" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor\SAPRobot\MVO_Robot_Arm-komplett_f3.iam" dms:PhObjId="26DC094CE8425334E10000000A4286E9" /> <File Id="f4" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor\SAPRobot\MVO_Robot_Schwinge-komplett_f4.ipt" dms:PhObjId="4ADC094CE8425334E10000000A4286E9" /> <File Id="f5" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor\SAPRobot\MVO_Robot_Karussell-komplett_f5.iam" dms:PhObjId="53DC094CE8425334E10000000A4286E9" /> <File Id="f6" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor\SAPRobot\MVO_Robot_Grundgestell-komplett_f6.ipt" dms:PhObjId="6EDC094CE8425334E10000000A4286E9"/> <File Id="f7" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor\SAPRobot\MVO_Robot_A5-Gehaeuse_f7.ipt" dms:PhObjId="E7DB094CE8425334E10000000A4286E9"/> <File Id="f8" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor\SAPRobot\MVO_Robot_A4-Gehaeuse_f8.ipt" dms:PhObjId="F0DB094CE8425334E10000000A4286E9"/> <File Id="f9" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor\SAPRobot\MVO_Robot_Deckel_f9.ipt" dms:PhObjId="F9DB094CE8425334E10000000A4286E9"/> <File Id="f10" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor\SAPRobot\MVO_Robot_Getriebe_A4_f10.ipt" dms:PhObjId="02DC094CE8425334E10000000A4286E9"/> <File Id="f11" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor\SAPRobot\MVO_Robot_Getriebe_A6_f11.ipt" dms:PhObjId="0BDC094CE8425334E10000000A4286E9"/> <File Id="f12" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor\SAPRobot\MVO_Robot_Getriebe_A5_f12.ipt" dms:PhObjId="14DC094CE8425334E10000000A4286E9"/> <File Id="f13" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor\SAPRobot\MVO_Robot_Adapter_f13.ipt" dms:PhObjId="1DDC094CE8425334E10000000A4286E9"/> <File Id="f14" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor\SAPRobot\MVO_Robot_Arm-Gehaeuse_f14.ipt" dms:PhObjId="2FDC094CE8425334E10000000A4286E9"/> <File Id="f15" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor\SAPRobot\MVO_Robot_Motor_1_f15.ipt" dms:PhObjId="38DC094CE8425334E10000000A4286E9"/> <File Id="f16" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor\SAPRobot\MVO_Robot_Motor_2_f16.ipt" dms:PhObjId="41DC094CE8425334E10000000A4286E9"/> <File Id="f17" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor\SAPRobot\MVO_Robot_Motor_3_f17.ipt" dms:PhObjId="5CDC094CE8425334E10000000A4286E9"/> <File Id="f18" Source="\\vault02\Models\CAD_3Dmodels_Drawings\Inventor\SAPRobot\MVO_Robot_Karussell-komplett-None_f18.ipt" dms:PhObjId="65DC094CE8425334E10000000A4286E9"/> </FileGroup> </FileGroups></MultiBom>


2.3.2.1.9 Integrated Asset Workflow Controller

Use

You can use the Integrated Asset workflow controller to convert single files in an SAP integrated system. You can use different processes to handle different types of files, and to customize conversion behavior.

Features

The configurable settings for the Integrated Asset workflow controller are the following:

Setting Description

Max KPRO Retrieve Attempts The maximum number of times a child job is launched to attempt to retrieve documents from KPRO. This setting only applies to consecutive failed attempts (no files were retrieved).

Default value is 3.

Max KPRO Store Attempts The maximum number of times a child job is launched to attempt to store documents into KPRO. This setting only applies to consecutive failed attempts (no files were stored).

Default value is 3.

Max Files per KPRO Task The maximum number of files each parallel KPRO task processes. Setting a high number; for example 1000, causes KPRO Retrieve and Store child jobs to process files in a single task. This action lightens the load on the KPRO service. Setting to 1 causes KPRO Retrieve and Store child jobs to process all files in parallel increasing the load on KPRO service.

Default value is 5.

Cache Originals Use the VEG cache for storage and retrieval of originals

Cache Viewables Use the VEG cache for storage and retrieval of viewables

Viewable Format The file format of the viewable to be generated

Build Thumbnail Indicates whether to build thumbnails

Build Animated Thumbnail Indicates whether to build animated thumbnails

Store Viewables Indicates whether to store the built viewables in DMS



Setting Description

Missing Original File Policy Determines the outcome if, during structure analysis of the original files, it is found that the original files for some parts or assemblies are missing. If this setting is set to Error, the job fails. If it is set to Warning, a warning is logged but the job continues and creates an empty placeholder for the failed item.

Build Failure Policy Determines the outcome if a part or assembly fails to build. If this setting is set to Error, the job fails. If it is set to Warning, a warning is logged but the job continues and creates an empty placeholder for the failed item.

The required startup arguments for the Integrated Asset workflow controller are the following:


StartMessage XML document in Integrated Asset format describing the required conversions

DSConnectorURL XML document listing the web service URLs that should be used by this job when it communicates with SAP NetWeaver

NoteAll startup arguments are required.

Activities

Configuring an Integrated Asset Workflow

The Integrated Asset workflow controller is configured by selecting the DMS Integrated option in the SAP 3D Visual Enterprise Generator Configurator, which runs following the SAP 3D Visual Enterprise Generator installation. At least one process exists for each type of input file (2D raster, 2D Vector, and 3D). The PowerShell script that the SAP 3D Visual Enterprise Generator Configurator runs (when the DMS Integrated option is chosen), configures one workflow for each type of input file using the appropriate process for each workflow.


The building of secondary derivatives is handled by a child job. The Integrated Asset workflow controller builds a request XML file that contains the asset structure and a list of desired derivatives, and passes it to the child job, which builds the derivatives.


2.3.2.1.9.1 Starting the Integrated Asset Workflow Controller

Use

You can use a workflow using the Integrated Asset workflow controller to start jobs by using SAP 3D Visual Enterprise Generator conversion server API call.

Procedure

To start an Integrated Asset job using a conversion server API call, proceed as follows

1. Call the JobStart() method exposed by the ConversionServer.asmx SOAP web service.The following job startup arguments are supported:○ StartMessage: Used to specify the input XML○ DSConnectorURL: The URLs of the DSConnector web services (an XML based structure representing

the various DS Connector Web Services).2. Add the DSConnectorURL startup argument along with the StartMessage argument.

DSConnectorURL sample XML structure is the following:

<urls> <url servicename="VEGTASKREQUEST_IN" endpoint="http://server/endpoint/url" /> <url servicename="DOCFILELINKINFORMATION_OUT" endpoint="http://server/endpoint/url" /> <url servicename="DOCFILELINKCHECKINREQUEST_IN" endpoint="http://server/endpoint/url" /> <url servicename="VEGOBJECTS_INFORMATION_IN" endpoint="http://server/endpoint/url" /></urls>

Name Description

VEGTASKREQUEST_IN The URL of the service that is notified when the Integrated Asset job has completed

DOCFILELINKINFORMATION_OUT The URL of the service used by the KPRO Retrieve Controller to resolve URLs that can be used to retrieve content from the content server

DOCFILELINKCHECKINREQUEST_IN The URL of the service used by the KPRO Store Controller to resolve URLs that can be used to upload content to the content server

VEGOBJECTS_INFORMATION_IN The URL of the service used to submit error reports for primary and secondary conversions that fail. If not supplied, error reporting is skipped.



2.3.2.1.9.2 Integrated Asset Processes

Use

The default processes and possible process customizations for the Integrated Asset workflow controller are the following:


Integrated Asset Converter - Input Processing Default process for input processing

NoteYou can modify the settings to determine whether thumbnails or animated thumbnails are produced.

Integrated Asset Converter - Input Transformation Default process for transformation.

Integrated Asset Converter -Process Source Retrieval Default process for source retrieval response.

Integrated Asset Converter - Process Viewables Creation Response

Default process for source viewables response.

Activities

The Integrated Asset workflow can be modified to apply custom metadata field remapping during the process of creating primary conversions for 3D or 3D CAD input files. There are two ways to achieve this.

Using Built-In Metadata Remapping

SAP 3D Visual Enterprise Generator ships with one pre-configured process DMS Asset – Build 3D (Remap Metadata). To use it, load it in the Processes list of SAP 3D Visual Enterprise Administration, and then select it on your 3D Integrated Asset workflow, in the Build Asset slots. The process expects a Batch Metadata Request format XML file to be located in $SHARE\Workspace\DMSAssetBuild3DMetadataRemap.xml. The Batch Metadata Request XML format is described in full in the SAP 3D Visual Enterprise Generator Operations Guide along with metadata field remapping example.

Configuring Remapping Manually

We recommend that you to add a new instance of the go_object_setbatchmetadata operation to a custom version of the jmp_dms_asset_build3d process, placing this operation before go_save. The input file parameter for this operation should then be modified to point to a common XML file located in the SAP 3D Visual Enterprise Generator, describing the metadata field remapping to be performed, this XML file should be in Batch Metadata Request format. This operation, and the Batch Metadata Request XML format, are described in full in the SAP 3D Visual Enterprise Generator Operations Guide along with metadata field remapping example.


2.3.2.1.9.3 Integrated Asset Processing Steps

Use

The following processing steps are performed by the Integrated Asset workflow controller:

● Validate Input● Lock Documents● Retrieve Source Documents● Primary Conversion● Addition Conversions● Store Result Documents● Report Job Errors● Post Completion Job

Features

Validate Input

In the Validate Input processing step, the workflow controller validates the input file.

Lock Documents

In the Lock Documents processing step, the workflow controller attempts to obtain locks for all of the source and target documents referenced in the input file.

A project with the same name as each SAP System ID specified in the input file must exist in SAP 3D Visual Enterprise Generator for the required locks to be granted.

NoteIf the requested locks are not all granted, the job is aborted.

Retrieve Source Documents

In the Retrieve Source Documents processing step, the workflow controller triggers a child job using the workflow specified in the KPRO Retrieve slot.

The child job downloads files from the KPRO web service into the job workspace using the source document IDs specified in the job input file.

When the child workflow returns a warning, it indicates that an issue occurred when attempting to retrieve the file, but that retries are possible.

When the child workflow returns an error, it indicates that the file was not successfully retrieved and that retries cannot be performed. If the child workflow returns an error, the job is aborted.

KPRO retrieval child jobs are enqueued until a success or an error result is returned, or the maximum number of retry attempts are made.



Primary ConversionIn the Primary Conversion processing step, the workflow controller enqueues tasks using the process specified in the Build Asset process slot.

In the case of 2D raster image inputs, the task creates the following:

● A binary RH file● A JPG thumbnail file

In the case of 2D vector or 2D CAD inputs, the task creates:

● A binary RH file● A JPG thumbnail file

In the case of 3D inputs, the task creates:

● A binary RH file● A JPG thumbnail file● A GIF animated thumbnail file (optional).

Additional ConversionsIf a Default Derivative Group value is specified in the Default Derivative Group setting for the workflow being used, the Additional Conversions processing step is executed.

In the Additional Conversions processing step, the workflow controller triggers a child job using the workflow specified in the Select Additional Conversions child workflow slot.

The child job determines the set of derivatives (conversions) to be created and in turn triggers a child job to create them.

Typically, a workflow using the Select All Derivatives workflow controller is used as the child workflow for the Integrated Asset workflow, and a workflow using the Build Derivatives workflow controller would be used as the child workflow for the Select All Derivatives workflow. In this scenario, one instance of each derivative specified by the default derivative group is created for each source document.

Store Result DocumentsIn the Store Result Documents processing step, the workflow controller triggers a child job using the workflow specified in the KPRO Store child workflow slot.

The child job uploads the files created during the Template Conversion step from the job workspace to the KPRO web service using the target document IDs specified in the job input file.

When the child workflow returns a warning for a particular file, it indicates that an issue occurred when attempting to store the file, but that retries are possible.

When the child workflow returns an error for any file in the request, it indicates that the file was not successfully stored and that retries cannot be performed. If the child workflow returns an error, the job is aborted.

The workflow controller will enqueue KPRO storage child jobs until a success result is returned for all files, or an error result is returned, or the maximum number of retry attempts have been made.

Report Job ErrorsIn the Report Job Errors processing step, the workflow controller reports collected error messages.

Error reporting is performed by submitting an error report to the web service URL specified in DSConnectorURL startup argument, for one or more primary or secondary, but not all conversions failed.


Post Completion JobThe workflow controller is configured with a post completion job that notifies the DMS system that the job has completed. Currently the Universal Process workflow controller performs this task.

2.3.2.1.9.4 Integrated Asset Sample Input File

NoteAn example input file is below:

Sample Code

<Manifest xmlns="http://schemas.righthemisphere.com/2011/DeepServer/DMSSingleDocumentConverter/DMSStartManifest" VegId="VEG_INST_1" Version="2"> <Conversion SourceDocId="IPT#0000000000000010000000159#000#00" TargetDocId="IPT#0000000000000010000000159#000#00" FileName="C:\Users\d021381\Documents\demo\Inventor\WorkDir\E6C\MVO_Robot_Getriebe_A4.ipt" ph_objid="F9DB094CE8425334E10000000A4286E9" SAPSystemId="E6C001" TargetStorageLoc="" /> <Conversion SourceDocId="IPT#0000000000000010000000160#000#00" TargetDocId="IPT#0000000000000010000000160#000#00" FileName="C:\Users\d021381\Documents\demo\Inventor\WorkDir\E6C\MVO_Robot_Getriebe_A5.ipt" ph_objid="F9DB094CE8425334E10000000A428610" SAPSystemId="E6C001" TargetStorageLoc=""> <Metadata> <MetadataGroup Name="Group 1"> <String Name="String 1" Value="Testing 1234..." /> <Integer Name="Integer 1" Value="1234" /> <Real Name="Real 1" Value="12.34" /> <DateTime Name="DateTime 1" Value="2012-01-26T15:20:00Z" /> <Boolean Name="Boolean 1" Value="true" /> <Array Name="Array 1"> <String Value="Testing 5678..." /> <Integer Value="5678" /> <Real Value="56.78" /> <DateTime Value="2012-01-27T15:20:00Z" /> <Boolean Value="false" /> </Array> </MetadataGroup> <MetadataGroup Name="Group 2"> <String Name="String 4" Value="Testing 3456..." /> <Integer Name="Integer 4" Value="3456" /> </MetadataGroup> </Metadata> </Conversion> </Manifest>



2.3.2.1.10 KPRO Retrieve Workflow Controller

Use

You can use the KPRO Retrieve workflow controller to perform source file retrieval from KPRO and DMS in an SAP integrated system.

NoteThe KPRO Retrieve workflow controller can only be invoked programmatically by other workflow controllers.

Configuring a KPRO Retrieve Workflow

To configure the KPRO Retrieve workflow controller, select the DMS Integrated option in the SAP 3D Visual Enterprise Generator Configurator which runs after the SAP 3D Visual Enterprise Generator installation.

Features

The startup arguments for the KPRO Retrieve workflow controller are the following:



InputFilePath Full path to the KPRO Retrieve request file

OutputFilePath Full path to the KPRO Retrieve response file

FilesPerTask Number of files to process per retrieval task

NoteAll startup arguments are required.

2.3.2.1.10.1 KPRO Retrieve Process

The default process for the KPRO Retrieve workflow controller is KPRORetrieve. You use this process to retrieve source files from KPRO or DMS.


2.3.2.1.10.2 KPRO Retrieve Job Steps

The following processing steps are performed by the KPRO Retrieve workflow controller:

● Validate InputIn the Validate Input job step, the KPRO Retrieve workflow controller validates the input file.

● Download FilesIn the Download Files job step, the KPRO Retrieve workflow controller enqueues tasks using the process specified in the Download Required Files process slot.

2.3.2.1.11 KPRO Store Workflow Controller

Use

You use the KPRO Store workflow controller to store files into KPRO and DMS in an SAP integrated system.

The KPRO Store workflow controller can only be invoked programmatically by other workflow controllers.

Features

The required startup arguments for the KPRO Store workflow controller are the following:



InputFilePath Full path to the KPRO Store request file

OutputFilePath Full path to the KPRO Store response file

FilesPerTask Number of files to process per storage task

Activities

To configure the KPRO Store workflow controller, select the DMS Integrated option in the SAP 3D Visual Enterprise Generator Configurator (which runs following the SAP 3D Visual Enterprise Generator installation).



2.3.2.1.11.1 KPRO Store Processes

The default process and possible process customizations for the KPRO Store workflow controller are the following:

● KproStoreDefault process for file storing into KPRO and DMS

● KproStoreRFCAlternative process for file storing into KPRO and DMS using Remote Function Calls (RFC)

● KproStoreRFCV2

2.3.2.1.11.2 KPRO Store Processing Steps

The following processing steps are performed by the KPRO Store workflow controller:

● Validate InputIn the Validate Input processing step, the KPRO Store workflow controller validates the input file.

● Store FilesIn the Store Files processing step, the KPRO Store workflow controller enqueues tasks using the process specified in the Store Files in KPRO Server process slot.The controller processes file uploads in one or more parallel tasks. The number of parallel tasks depends on the number of requested files and the FilesPerTask startup argument.

2.3.2.1.12 Metadata Import/Export Workflow Controller

Use

You can use the Metadata Import/Export workflow controller to export asset metadata for further analysis, in some cases – to edit and then re-import the data.

The controller enables the import or export of asset and instance metadata related to assets stored in the SAP 3D Visual Enterprise Generator database. The structure of the input file must conform to one of the schema specified below:

● Import:Schema in Schemas/MetadataExportImport.xsd.Namespaces:http://www.righthemisphere.com/Schemas/Nov2010/MetadataExportImporthttp://www.righthemisphere.com/Schemas/Jan2011/MetadataExportManifestSchema in Schemas/Legacy/DeepServer_MetadataImport.xsd.Namespace:http://www.righthemisphere.com/deepserver/metadataimport

● Export:Schema in Schemas/MetadataExportManifest.xsd.Namespace: http://www.righthemisphere.com/Schemas/Jan2011/MetadataExportManifest


http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.righthemisphere.com%2FSchemas%2FNov2010%2FMetadataExportImport

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.righthemisphere.com%2FSchemas%2FJan2011%2FMetadataExportManifest

http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.righthemisphere.com%2Fdeepserver%2Fmetadataimport


Features

The startup arguments for the Metadata Import/Export workflow controller are described below:

Metadata Import/Export: Arguments


InputFilePath N/A The full path to the import or export instruction file

TargetProject N/A The project containing the assets to which this operation applies

IsImport True Although the workflow controller will establish whether the input file defines an import or an export operation, the workflow controller settings allows to specify this value.

2.3.2.1.12.1 Starting Metadata Import/Export Workflow Controller

Use

Workflows using the Metadata Import/Export workflow controller can be used to start jobs as follows:

● Using an SAP 3D Visual Enterprise Generator hot folder● Using SAP 3D Visual Enterprise Generator Web service API call

Procedure

To start a Metadata Import/Export job from a hot folder, proceed as follows:

1. Configure a Metadata Import/Export job hot folder, selecting the Metadata Import/Export workflow (see Configuring a Metadata Import/Export Workflow [page 119]).

2. Place an xml file conforming to one of the following three schemes into the hot folder.○ http://www.righthemisphere.com/Schemas/Nov2010/MetadataExportImport○ http://www.righthemisphere.com/deepserver/metadataimport○ http://www.righthemisphere.com/Schemas/Jan2011/MetadataExportManifest

To start a Metadata Import/Export job using a Web service API call, proceed as follows

● When the metadata import/export input file is in a location accessible by Visual Enterprise Generator directly, call JobStart(), passing through the fully qualified path to the input file in the InputFilePath startup argument.






● When the input file is not in a location accessible by server directly, do the following1. Upload the input file using the VEGeneratorMTom7.asmx methods:

○ StartUniqueFileUpload()○ UploadUniqueFileChunk()○ FinishUniqueFileUpload()


2.3.2.1.12.2 Configuring a Metadata Import/Export Workflow

To configure the server to process Metadata Import/Export jobs, proceed as follows:

1. Open SAP 3D Visual Enterprise Generator Administration, and navigate to Server ConfigurationWorkflows .

2. Choose New on the Workflows toolbar. The Create Workflow window opens.3. On the General tab page, enter a name for the workflow.4. Enter Metadata Import/Export workflow controller in the Controller field and choose OK.

2.3.2.1.12.3 Metadata Import/Export Processes

The default processes and possible process customizations for the Metadata Import/Export workflow controller are the following:

● Metadata Validation (process slot: Validate Metadata Import XML)Validates that SAP 3D Visual Enterprise Generator can access the input file, and that this file is well-formed XML which complies with one of the three qualifying schema

● Export Metadata (process slot: Export Metadata)Processes a metadata export

● Metadata – Apply Metadata (process slot: Apply Metadata)Processes a metadata import

2.3.2.1.12.4 Metadata Import/Export Steps

Use

The following processing steps are performed by the Metadata Import/Export workflow controller:

● Validate Input and Prepare Workspace● Locking Assets● Apply Metadata (import)


● Export Metadata (export)

Features

Validate Input and Prepare Workspace

This step performs the following:

● Prepares the local workspace for processing● Validates that the specified input file is accessible to server and copies it to the workspace, and sets the

output file path● Validates that the input XML file is well-formed and complies with one of the following three schema:

Import namespaces:http://www.righthemisphere.com/Schemas/Nov2010/MetadataExportImporthttp://www.righthemisphere.com/deepserver/metadataimportExport namespace:http://www.righthemisphere.com/Schemas/Jan2011/MetadataExportManifest

Lock Assets

Locks are requested for each asset reference in the input file.

Apply Metadata (Import)

This step is executed when the workflow controller has determined that the input file contains instructions pertaining to metadata import.

The import process comprises the following steps:

1. For each entity referenced in the input file, the workflow controller extracts an ID for the entity and retrieves the entity from the database. If the entity does not exist, the workflow controller logs this and continues.

2. The workflow controller adds and removes metadata according to the instructions contained in the input file, ensuring that each metadata element is classified as file or project metadata as instructed.

Export Metadata (Export)

This step is executed when the workflow controller has determined that the input file contains instructions pertaining to metadata export.

The export process comprises the following steps:

1. For each entity referenced in the input file, the workflow controller extracts an ID for the entity and retrieves the entity from the database. If the entity does not exist, the workflow controller logs this and continues.

2. The workflow controller extracts metadata from the database objects as XML, and inserts this into the output file, grouped according to whether the metadata is file or project metadata.

NoteIf the output file already exists, this step fails. The output file is written during the exporting metadata process.






2.3.2.1.12.5 Metadata Import/Export Input File Format

Export Schema

Code Syntax

<?xml version="1.0" encoding="utf-8"?> <xs:schema targetNamespace="http://www.righthemisphere.com/Schemas/Jan2011/MetadataExportManifest" elementFormDefault="qualified" xmlns="http://www.righthemisphere.com/Schemas/Jan2011/MetadataExportManifest" xmlns:mstns="http://www.righthemisphere.com/Schemas/Jan2011/MetadataExportManifest" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="MetadataExportManifest" type="MetadataExportManifest"/> <xs:complexType name="MetadataExportManifest"> <xs:sequence> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element name="Asset" type="Asset" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="AbsoluteInstance" type="AbsoluteInstance" minOccurs="0" maxOccurs="unbounded"/> </xs:choice> </xs:sequence> <xs:attribute name="OutputPath" type="xs:string" use="required"/> </xs:complexType> <xs:complexType name="Asset"> <xs:attribute name="AssetID" type="xs:long" use="required"/> <xs:attribute name="Version" type ="xs:int" use ="required"/> </xs:complexType> <xs:complexType name="AbsoluteInstance"> <xs:attribute name="AbsoluteInstanceID" type="xs:long" use="required"/> <xs:attribute name="Recurse" type="xs:boolean" use="optional" default="false"/> </xs:complexType></xs:schema>

Import Schema (Legacy)

Code Syntax

<?xml version="1.0" encoding="utf-8"?> <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://www.righthemisphere.com/deepserver/metadataimport" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="metadata"> <xs:complexType> <xs:sequence> <xs:element maxOccurs="unbounded" name="asset"> <xs:complexType> <xs:sequence> <xs:element maxOccurs="unbounded" name="category">


<xs:complexType> <xs:sequence> <xs:element maxOccurs="unbounded" name="item"> <xs:complexType> <xs:attribute name="name" type="xs:string" use="required" /> <xs:attribute name="value" type="xs:string" use="required" /> </xs:complexType> </xs:element> </xs:sequence> <xs:attribute name="name" type="xs:string" use="required" /> </xs:complexType> </xs:element> </xs:sequence> <xs:attribute name="assetid" type="xs:string" use="optional" /> <xs:attribute name="assetversion" type="xs:string" use="optional" /> <xs:attribute name="partnersystemname" type="xs:string" use="optional" /> <xs:attribute name="partnersystemid" type="xs:string" use="optional" /> <xs:attribute name="partnersystemversion" type="xs:string" use="optional" /> <xs:attribute name="partnersystemrevision" type="xs:string" use="optional" /> <xs:attribute name="projectname" type="xs:string" use="optional" /> <xs:attribute name="dsId" type="xs:string" use="optional"/> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element></xs:schema>

Import Schema

Code Syntax

<?xml version="1.0" encoding="utf-8"?> <xs:schema targetNamespace="http://www.righthemisphere.com/Schemas/Nov2010/MetadataExportImport" elementFormDefault="qualified" xmlns="http://www.righthemisphere.com/Schemas/Nov2010/MetadataExportImport" xmlns:mstns="http://www.righthemisphere.com/Schemas/Nov2010/MetadataExportImport" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="MetadataExportImport"> <xs:sequence> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element name="Entity" type="Entity"/> <xs:element name="AbsoluteInstance" type="AbsoluteInstance"/> </xs:choice> </xs:sequence> <xs:attribute type="ImportErrorHandling" name="ImportErrorHandling" use="optional" default="Stop"/> </xs:complexType> <xs:element type="ItemBase" name="ItemBase" abstract="true"/> <xs:complexType name="Entity"> <xs:complexContent>



<xs:extension base="ItemBase"> <xs:sequence> <xs:element name="ProjectMetadata" type="Metadata" minOccurs="0" maxOccurs="1"/> <xs:element name="ExternalSystemID" minOccurs="0" maxOccurs="unbounded"> <xs:complexType> <xs:attribute name="SystemName" type="xs:string" use="required"/> <xs:attribute name="Uid" type="xs:string" use="required"/> <xs:attribute name="Version" type="xs:string" use="required"/> <xs:attribute name="Revision" type="xs:string" use="required"/> </xs:complexType> </xs:element> </xs:sequence> <xs:attribute name="LockKey" type="DSString" use="optional"/> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="AbsoluteInstance"> <xs:complexContent> <xs:extension base="ItemBase"> <xs:sequence> <xs:element name="ExternalSystemID" minOccurs="0" maxOccurs="unbounded"> <xs:complexType> <xs:attribute name="SystemName" type="xs:string" use="required"/> <xs:attribute name="Uid" type="xs:string" use="required"/> </xs:complexType> </xs:element> </xs:sequence> <xs:attribute name="AbsoluteInstancePath" type="DSString" use="optional"/> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="ItemBase" abstract="true"> <xs:sequence> <xs:element name="Metadata" type="Metadata" minOccurs="0" maxOccurs="1"/> </xs:sequence> <xs:attribute name="dsId" type="DSString" use="optional"/> </xs:complexType> <xs:complexType name="Metadata"> <xs:sequence> <xs:element name="Group" type="MetadataGroup" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <xs:simpleType name="DSString"> <xs:restriction base="xs:string"> <xs:maxLength value="250"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="DSMetadataString"> <xs:restriction base="xs:string"> <xs:maxLength value="4000"/> </xs:restriction> </xs:simpleType>  <xs:complexType name="MetadataBase" abstract="true"> <xs:attribute name="Name" type="DSString" use="required"/> <xs:attribute name="Action" type="MetadataFieldAction" use="optional" default="Edit"/> <xs:attribute name="Path" type="xs:string" use="optional"> <xs:annotation>

<xs:documentation>This is currently used only for exporting metadata, for importing anything that is not root of the asset will not be imported.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType>  <xs:complexType name="StringMetadata"> <xs:complexContent> <xs:extension base="MetadataBase"> <xs:attribute name="Value" type="DSMetadataString"/> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="IntegerMetadata"> <xs:complexContent> <xs:extension base="MetadataBase"> <xs:attribute name="Value" type="xs:integer"/> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="RealMetadata"> <xs:complexContent> <xs:extension base="MetadataBase"> <xs:attribute name="Value" type="xs:float"/> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="DateTimeMetadata"> <xs:complexContent> <xs:extension base="MetadataBase"> <xs:attribute name="Value" type="xs:dateTime"/> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="BooleanMetadata"> <xs:complexContent> <xs:extension base="MetadataBase"> <xs:attribute name="Value" type="xs:boolean"/> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="TextMetadata"> <xs:complexContent mixed="true"> <xs:extension base="MetadataBase"/> </xs:complexContent> </xs:complexType>  <xs:complexType name="MetadataArrayBase" abstract="true"/> <xs:complexType name="StringArrayMetadata"> <xs:complexContent> <xs:extension base="MetadataArrayBase"> <xs:attribute name="Value" type="DSMetadataString"/> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="IntegerArrayMetadata"> <xs:complexContent> <xs:extension base="MetadataArrayBase"> <xs:attribute name="Value" type="xs:integer"/> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="RealArrayMetadata"> <xs:complexContent> <xs:extension base="MetadataArrayBase"> <xs:attribute name="Value" type="xs:float"/> </xs:extension>

</xs:complexContent> </xs:complexType> <xs:complexType name="DateTimeArrayMetadata"> <xs:complexContent> <xs:extension base="MetadataArrayBase"> <xs:attribute name="Value" type="xs:dateTime"/> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="BooleanArrayMetadata"> <xs:complexContent> <xs:extension base="MetadataArrayBase"> <xs:attribute name="Value" type="xs:boolean"/> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="TextArrayMetadata"> <xs:complexContent mixed="true"> <xs:extension base="MetadataArrayBase"/> </xs:complexContent> </xs:complexType> <xs:element type="MetadataBase" name="MetadataBase" abstract="true"/> <xs:element type="MetadataArrayBase" name="MetadataArrayBase" abstract="true"/> <xs:complexType name="ArrayArrayMetadata"> <xs:sequence> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element name="String" type="StringArrayMetadata"/> <xs:element name="Integer" type="IntegerArrayMetadata"/> <xs:element name="Real" type="RealArrayMetadata"/> <xs:element name="DateTime" type="DateTimeArrayMetadata"/> <xs:element name="Boolean" type="BooleanArrayMetadata"/> <xs:element name="Map" type="MapArrayMetadata"/> <xs:element name="Array" type="ArrayArrayMetadata"/> <xs:element ref="MetadataArrayBase"/> </xs:choice> </xs:sequence> </xs:complexType> <xs:complexType name="MapArrayMetadata"> <xs:sequence> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element name="String" type="StringMetadata"/> <xs:element name="Integer" type="IntegerMetadata"/> <xs:element name="Real" type="RealMetadata"/> <xs:element name="DateTime" type="DateTimeMetadata"/> <xs:element name="Boolean" type="BooleanMetadata"/> <xs:element name="Map" type="MapMetadata"/> <xs:element name="Array" type="ArrayMetadata"/> <xs:element ref="MetadataBase"/> </xs:choice> </xs:sequence> </xs:complexType>  <xs:complexType name="ArrayMetadata"> <xs:complexContent> <xs:extension base="MetadataBase"> <xs:sequence> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element name="String" type="StringArrayMetadata"/> <xs:element name="Integer" type="IntegerArrayMetadata"/> <xs:element name="Real" type="RealArrayMetadata"/> <xs:element name="DateTime" type="DateTimeArrayMetadata"/> <xs:element name="Boolean" type="BooleanArrayMetadata"/> <xs:element name="Map" type="MapArrayMetadata"/> <xs:element name="Array" type="ArrayArrayMetadata"/> <xs:element ref="MetadataArrayBase"/> </xs:choice> </xs:sequence>

</xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="MapMetadata"> <xs:complexContent> <xs:extension base="MetadataBase"> <xs:sequence> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element name="String" type="StringMetadata"/> <xs:element name="Integer" type="IntegerMetadata"/> <xs:element name="Real" type="RealMetadata"/> <xs:element name="DateTime" type="DateTimeMetadata"/> <xs:element name="Boolean" type="BooleanMetadata"/> <xs:element name="Map" type="MapMetadata"/> <xs:element name="Array" type="ArrayMetadata"/> <xs:element name="Text" type="TextMetadata"/> <xs:element ref="MetadataBase"/> </xs:choice> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType>  <xs:complexType name="PublicArrayArrayMetadata"> <xs:sequence> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element name="String" type="StringArrayMetadata"/> <xs:element name="Integer" type="IntegerArrayMetadata"/> <xs:element name="Real" type="RealArrayMetadata"/> <xs:element name="DateTime" type="DateTimeArrayMetadata"/> <xs:element name="Boolean" type="BooleanArrayMetadata"/> <xs:element name="Map" type="PublicMapArrayMetadata"/> <xs:element name="Array" type="PublicArrayArrayMetadata"/> </xs:choice> </xs:sequence> </xs:complexType> <xs:complexType name="PublicMapArrayMetadata"> <xs:sequence> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element name="String" type="StringMetadata"/> <xs:element name="Integer" type="IntegerMetadata"/> <xs:element name="Real" type="RealMetadata"/> <xs:element name="DateTime" type="DateTimeMetadata"/> <xs:element name="Boolean" type="BooleanMetadata"/> <xs:element name="Map" type="PublicMapMetadata"/> <xs:element name="Array" type="PublicArrayMetadata"/> </xs:choice> </xs:sequence> </xs:complexType> <xs:complexType name="PublicArrayMetadata"> <xs:complexContent> <xs:extension base="MetadataBase"> <xs:sequence> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element name="String" type="StringArrayMetadata"/> <xs:element name="Integer" type="IntegerArrayMetadata"/> <xs:element name="Real" type="RealArrayMetadata"/> <xs:element name="DateTime" type="DateTimeArrayMetadata"/> <xs:element name="Boolean" type="BooleanArrayMetadata"/> <xs:element name="Map" type="MapArrayMetadata"/> <xs:element name="Array" type="ArrayArrayMetadata"/> </xs:choice> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="PublicMapMetadata"> <xs:complexContent>

<xs:extension base="MetadataBase"> <xs:sequence> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element name="String" type="StringMetadata"/> <xs:element name="Integer" type="IntegerMetadata"/> <xs:element name="Real" type="RealMetadata"/> <xs:element name="DateTime" type="DateTimeMetadata"/> <xs:element name="Boolean" type="BooleanMetadata"/> <xs:element name="Map" type="PublicMapMetadata"/> <xs:element name="Array" type="PublicArrayMetadata"/> </xs:choice> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType>  <xs:complexType name="MetadataGroup"> <xs:complexContent> <xs:extension base="MapMetadata"/> </xs:complexContent> </xs:complexType> <xs:complexType name="MetadataBlock"> <xs:sequence> <xs:element maxOccurs="unbounded" name="MetadataGroup" type="MetadataGroup"/> </xs:sequence> </xs:complexType>  <xs:complexType name="PublicMetadataGroup"> <xs:complexContent> <xs:extension base="PublicMapMetadata"/> </xs:complexContent> </xs:complexType> <xs:complexType name="PublicMetadataBlock"> <xs:sequence> <xs:element maxOccurs="unbounded" name="MetadataGroup" type="PublicMetadataGroup"/> </xs:sequence> </xs:complexType> <xs:element name="Metadata" type="PublicMetadataBlock"/> <xs:complexType name="MetadataSupportingNodeBase" abstract="true"> <xs:sequence> <xs:element minOccurs="0" name="Metadata" type="PublicMetadataBlock"/> </xs:sequence> </xs:complexType>  <xs:complexType name="MetadataFieldBase" abstract="true"> <xs:attribute name="Name" type="xs:string" use="required"/> <xs:attribute name="Action" type="MetadataFieldAction" use="optional" default="Edit"/> </xs:complexType> <xs:simpleType name="MetadataFieldAction"> <xs:restriction base="xs:string"> <xs:enumeration value="Edit"/> <xs:enumeration value="Delete"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="ImportErrorHandling"> <xs:restriction base="xs:string"> <xs:enumeration value="ReportAsWarnings"/> <xs:enumeration value="Stop"/> </xs:restriction> </xs:simpleType> <xs:element name="MetadataExportImport" type="MetadataExportImport"/></xs:schema>

2.3.2.1.12.5.1 Metadata Import/Export Sample Input File

An example input file is shown below:

NoteAn example input file is shown below:

Export

Sample Code

<?xmlversion="1.0"encoding="utf-8"?> <MetadataExportManifestxmlns="http://www.righthemisphere.com/Schemas/Jan2011/MetadataExportManifest" OutputPath="\\servername\share\downloads\myfile.xml"> <AssetAssetID="1"Version="2"/> <AbsoluteInstanceAbsoluteInstanceID="3"/></MetadataExportManifest>

NoteImport

Sample Code

<?xml version="1.0" encoding="utf-8"?> <MetadataExportImport xmlns="http://www.righthemisphere.com/Schemas/Nov2010/MetadataExportImport"> <Entity> <Metadata> <Group Name="group_name" Action="Edit"> <String Name="key_name" Value="value"/> </Group> </Metadata> <ProjectMetadata> <Group Name="test"> <String Name="name" Value="value"/> </Group> </ProjectMetadata> <ExternalSystemID SystemName="PLM" Uid="Whell" Version="AA-" Revision="4"/> </Entity> <AbsoluteInstance dsId=”d1:201”> <Metadata> <Group Name="group_name" Action="Edit"> <String Name="key_name" Value="value"/> </Group> </Metadata> </AbsoluteInstance></MetadataExportImport>



2.3.2.1.13 PLM Replace Parts Workflow Controller

Use

The PLM Replace Parts workflow controller is used when one or more parts have been translated incorrectly.

Potentially the geometry of the parts could have been imported or processed incorrectly if there was a software bug in a plug-in, process or workflow controller when a particular part was translated. A PLM Replace Parts workflow could be run to fix the database after a software update has been applied to fix the bug.

The PLM Replace Parts workflow controller will retranslate the affected parts and rebuild all affected assemblies and asset instance and assembly instance hierarchies as follows:

● The affected assembly hierarchies reference the newly created asset versions instead of the old asset versions.

● New derivatives are created for the affected assembly hierarchies that are built using the new asset versions.

● External system IDs applied to the existing asset versions are moved forward to the newly created versions.● External system IDs applied to existing absolute instances in the existing absolute instance hierarchy are

moved forward to the newly created absolute instance hierarchy.

A single part could be referenced by multiple top-level assemblies created by subsequent PLM Translation jobs, so a single part replacement could cause parts of multiple assembly hierarchies to be rebuilt.

The PLM Replace Parts workflow controller differs from the PLM Translation workflow controller in that existing external system IDs (instead of new external system IDs) are used for new asset versions created in SAP 3D Visual Enterprise Generator by PLM Replace Parts jobs. No new external system IDs are provided by the PLM system, as there have not been any changes to the geometry or the metadata of the parts as far as the PLM is concerned, even though the new asset versions created in SAP 3D Visual Enterprise Generator would normally differ from the versions that they replace.

Hierarchy Rebuilding

When the PLM Replace Parts workflow controller needs to create any new asset version, a new version of the assembly hierarchy will be created (the top-level assembly will have a new asset version created).

Any ancestor assembly of any part that will have a new version created will need to be rebuilt so that its primary and secondary derivatives incorporate the changes.

When a new version of the assembly hierarchy will be created, the structure of the asset instance hierarchy and absolute instance hierarchy needs to be replicated for the new version of the assembly hierarchy (leaving the existing hierarchies for previous versions of the top level assembly intact).

In the case of the asset instance hierarchy, replicating the structure does not mean that copies of all of the asset instances in the existing hierarchy are created; some existing asset instances may be reused.

In the case of the absolute instance hierarchy, the entire absolute instance hierarchy for the assembly hierarchy will be replicated when a new asset version of the top level assembly is created.

When a new asset version is created for a particular asset, existing asset instances that refer to the existing asset version (through a parent or child relationship) need to be replicated. Restating that, existing asset instances need to be replicated when new asset versions are created for the asset they refer to or the parent asset that they refer to.


Features


Setting Description

Build Part Derivative If a default derivative group is configured for the workflow controller, the secondary derivatives defined by the default derivative group are built for all the parts in the assembly hierarchy.

Default value: True

Build Subassembly Derivative If this setting is set to true and a default derivative group is configured for the workflow controller, the secondary derivatives defined by the default derivative group are built for all the subassemblies in the assembly hierarchy.

Default value: True

Build Top-Level Derivative If this setting is set to true and a default derivative group is configured for the workflow controller, the secondary derivatives defined by the default derivative group are built for the top level assembly of the assembly hierarchy.

Default value: True

Validate Input MBOM Schema This setting determines whether schema validation will be enforced on the input schema1 VZXML file. This must always be set to true.

Default value: True

The startup argument for the PLM Replace Parts workflow controller is the following:



InputFilePath Fully qualified path to Schema 1 VZXML

Metadata

The PLM Replace Parts workflow controller does not support metadata in its input files.

File metadata is read from the original files specified in the VZXML input file.

Any assembly that references one or more of the part assets specified in the VZXML input file will have a new asset version created.

For each assembly that is rebuilt during a PLM Replace Parts job, the asset metadata is copied from the version of the assembly that was referenced in the original hierarchies to the newly created asset version in the newly created hierarchies.



Absolute instance metadata is copied from each absolute instance in each of the absolute instance hierarchies affected by a PLM Replace Parts job to the corresponding instances in the newly created absolute instance hierarchies.

Currently, asset instance metadata (metadata attached to node elements in the input VZMXL supplied to the original PLM Translation job) is not copied from one instance hierarchy to another by the PLM Replace Parts job.

Mapping from External System IDs to SAP 3D Visual Enterprise Generator IDs

The PLM Replace Parts workflow controller uses the lock manager to obtain locks on assets before performing any processing on them. The lock manager translates entity external system ids in a lock request to SAP 3D Visual Enterprise Generator asset IDs and asset versions for existing assets.

The PLM Replace Parts workflow controller distinguishes between a new asset version and an existing one based on the response from the lock manager.

If an entity external system ID in the lock request matches an external system ID in the database it will be assigned to an existing asset version, the response from the lock manager will contain the asset id of the asset and the asset version to which the external system ID relates.

If an entity external system ID in the lock request does not match an external system ID in the database that is assigned to an existing asset version, the response from the lock manager will not contain an asset ID or asset version.

All of the entity external system IDs in the submitted file must exactly match external system IDs stored in the database, otherwise the job will fail.

Existing Assets

PLM Replace Parts jobs do the following:

● Reference only assets that already exist● Cannot reference assets created by Asset Upload or Assembly Upload jobs● Cannot MBOM type assets created by Asset Publish jobs● Do not create new assets● Create new asset versions of assets that were created by PLM Translation jobs

The PLM Replace Parts workflow controller expects all assets for all of the external system IDs in its input file to have already been created by one or more previous PLM Translation jobs (the referenced asset versions may have been created by either PLM Translation or PLM Replace Parts jobs).

Released Asset Versions

Asset versions can be marked as released in a PLM Translation job (using an attached external system ID) in order to signify that they are in a ready state to be used in manufacturing processes.

PLM Replace Parts does not support changing the released status of a particular part. It preserves the released status of a particular entity external system ID when it reassigns an external system ID to refer to a new SAP 3D Visual Enterprise Generator asset version.

A validation error will occur if an IsReleased attribute is specified in the PLM Replace Parts input VZMXL.

Assets Without Original Files

The PLM Translation workflow controller allows you to create placeholder assets when the structure for an assembly hierarchy is known, but no original file is available for some part in the hierarchy. In these cases, the


PLM Translation workflow controller just creates an asset with no geometry, meaning that these assets are handled transparently by the PLM Replace Parts workflow controller.

The PLM Replace Parts workflow controller does not allow its input files to contain an Entity element that does not reference a file element.

2.3.2.1.13.1 Starting PLM Replace Parts Workflow Controller

Use

Workflows using the PLM Replace Parts workflow controller can be used to start jobs as follows:

● Using a Workflow Job hot folder● Using SAP 3D Visual Enterprise Generator Web service API call

Procedure

To start a PLM Replace Parts workflow from a hot folder, proceed as follows:

1. In Action Settings, configure a Workflow Job hot folder by entering PLM Replace Parts as the workflow.2. Drop a Schema 1 VZXML file in the hot folder.

To start a PLM Replace Parts workflow from an SAP 3D Visual Enterprise Generator Web service API call, proceed as follows:

1. Upload a Schema1 VZXML file using one of the following methods exposed by VEGeneratorMtom7.asmx:○ StartUniqueFileUpload() – Start a file upload○ UploadUniqueFileChunk() – Upload a chunk of file data to a particular offset in the file created on

the server○ FinishUniqueFileUpload() – Complete the file upload

2. Call the JobStartWithFiles() method exposed by VEGenerator7.asmx, passing the unique ID returned by StartUniqueFileUpload().

Example code can be provided in various programming languages.

Libraries that abstract file transfers using DeepServerMtom6.asmx may be available for some programming languages.

2.3.2.1.13.2 Configuring a PLM Replace Parts Workflow

To configure SAP 3D Visual Enterprise Generator to process PLM Replace Parts workflows, proceed as follows:




2. Choose New on the Workflows toolbar. The Create Workflow window opens.3. On the General tab page, enter a name for the workflow.4. Enter PLM Replace Parts workflow controller in the Controller field and choose OK.

5. Navigate to Server Configuration Workflows Hot Folders .6. Choose New in the Workflows panel. The Add New Hot Folder window opens.7. In the Path field, select the path to the folder that you want to use as the hot folder for PLM Replace Parts8. Choose OK to use the remaining default settings.


The PLM Replace Parts workflow controller can also be configured to build additional secondary derivatives. The functionality that builds secondary derivatives may be moved into a separate workflow controller in the future as it is common to multiple workflow controllers.

The following workflow settings determine which assets will have secondary derivatives built:

● Build Part Derivative● Build Sub-Assembly Derivative● Build Top-Level Derivative

For more information about workflow settings listed above, see the PLM Translation & PLM Replace Parts Workflow Settings section.

Currently secondary derivatives are built by the PLM Replace Parts workflow controller.

To build secondary derivatives, proceed as follows:

1. Open SAP 3D Visual Enterprise Generator Administration and navigate to Server ConfigurationDerivative Groups .

2. in the Derivative Groups panel, choose New .3. Add derivative types to the group.

Note that you can use predefined derivative types, or create your own in the Derivative Types pane in Repository Administration.

4. Edit the configured PLM Replace Parts workflow by selecting the created derivative group in the Default Derivative Group field.

2.3.2.1.13.3 PLM Replace Parts Processes

The PLM Replace Parts workflow controller uses the following processes:

● PLM – Build Assembly (Process Slot: Build Assembly)● PLM – Build Part (Process Slot: Build Part)● PLM – Prepare Workspace (Process Slot: Prepare Workspace)● PLM – Preprocess (Process Slot: Pre-Process Originals)● PLM Part Replace – Check If Hierarchies Modified (Process Slot: Check If Hierarchies Modified)● PLM Part Replace – Generate MBOM (Process Slot: Generate MBOM)


● PLM Part Replace – Store (Process Slot: Store Assets)● PLM Part Replace – Validate Input (Process Slot: Validate Input)

NoteNote that all these processes must not be customized. Only the PLM – Processes phase could conceivably be optimized for customers where input files are all of the same type.

2.3.2.1.13.4 PLM Replace Parts Processing Steps

Use


● Validate Input● Generate MBOM● Lock Assets● Check If Hierarchies Modified● Prepare Workspace● Preprocess● Build Primary Derivatives● Store Assets● Track Changes

Features

Validate Input

In the Validate Input processing step, the PLM Replace Parts workflow controller explicitly checks the input file for the following:

● The input file does not contain the following:○ BOM elements○ Selector elements○ Effectivity elements○ CAD parameters○ Multiple entity elements with the same ID attribute value○ Node elements○ Material elements○ Processing instructions○ Entity metadata or system metadata○ Duplicate external system IDs○ External system IDs that have an IsReleased attribute value



○ File elements that reference files that do not exist○ Entity elements that do not reference a File element

● The input file contains one or more or more entity elements● All entities have a single external system ID assigned● No entity elements have a ds:Id attribute value

Generate MBOM

In the Generate MBOM processing step, a task is enqueued which generates an MBOM that represents the hierarchy of the following:

● Assets that need to be replaced● Assemblies that need to be rebuilt● Direct children of assemblies that need to be rebuilt

The path to the input MBOM VZXML file is passed to the SAP 3D Visual Enterprise Generator process that performs the MBOM generation.

The SAP 3D Visual Enterprise Generator process that performs this processing checks for the following:

● External system IDs that cannot be resolved● Entities being replaced that do not refer to assets● The generated MBOM contains SAP 3D Visual Enterprise Generator IDs as well as external system IDs

The original file paths found in the input MBOM VZXML file are used in the corresponding entities in the generated MBOM.

If an error is returned by the SAP 3D Visual Enterprise Generator process, the job is aborted.

This generated MBOM is used later in the processing for generating shallow MBOM files.

Lock Assets

In the Lock Assets processing step, the PLM Replace Parts workflow controller attempts to obtain locks for all of the assets referenced in the MBOM generated by the Generate MBOM processing step.

If the locks requested are not all granted, the job will be aborted.

Check If Hierarchies Modified

In the Check If Hierarchies Modified processing step, the PLM Replace Parts workflow controller checks whether any new versions of the top-level assemblies that will be rebuilt by this job have been created between the MBOM generation phase and the locking phase.

During the MBOM generation phase none of the assets are locked; the set of assets that need to be locked is determined during the MBOM generation phase.

Another PLM Replace Parts job could potentially create new versions of assets while the MBOM generation phase is in progress. The checking in this processing step is intended to mitigate the possibility that the asset versions contained in the generated MBOM are out of date at the time the locking request is processed.

Prepare Workspace

In the Prepare Workspace processing step, the PLM Replace workflow controller queues two tasks: One task copies original files into the job workspace, and the other retrieves existing assets into the job workspace.

● The original files for the parts to be replaced and the assemblies to be rebuilt are copied into the job workspace.


● The direct children of assemblies that are being rebuilt that are not parts to be replaced are retrieved into the workspace.

Preprocess

In the Preprocess processing step, the PLM Replace Parts workflow controller queues a task that determines the plug-in GUID to use when creating the primary derivatives for each asset that will have a new asset version built.

Build Primary Derivatives

In the Build Primary Derivatives processing step, the PLM Replace Parts workflow controller queues tasks to build the primary derivatives for the assets that are being replaced, and the ancestor assemblies of those parts without storing the results in the database.

Store Assets

In the Store Assets processing step, the PLM Replace Parts workflow controller creates new asset versions and asset instances for the post-update hierarchies in the database.

Track Changes

In the Track Changes processing step, the PLM Replace Parts workflow controller records changes made to assets to allow affected work instructions to be determined by the publish workflow.

2.3.2.1.13.5 PLM Replace Parts Input File Format

Schema Definitions

Schema 1 files created by PLM systems should only use the definitions in the public VZXML schema: http://schemas.righthemisphere.com/MultiBom/2009/May.

The BOM factory plug-in generates Schema 1 files that include elements and attributes defined in these schemas:

● http://schemas.righthemisphere.com/MultiBom/2009/May/Cad

● http://schemas.righthemisphere.com/MultiBom/2009/May/Internal

PLM Systems should not use the non-public schemas, because such elements and attributes are not relevant to PLM integrators.

Schema Validation

By default, the PLM Replace Parts workflow controller performs XSD schema validation.

The order of the elements within the XML is significant when schema validation is performed (xs:sequence is used in many places in the schema). Elements that are not arranged in the order defined by the XSD schemas will cause validation errors.



Schema Rules

There are general rules for Schema 1 files – some apply to all files, and some apply to specific files.

General rules for Schema 1 files for the PLM Replace Parts workflow controller are the following:

● PLM Replace Parts workflow controller uses a subset of the definitions in the public VZXML schema.● The VZXML file for the PLM Replace Parts workflow controller does not describe any assembly hierarchy

and is only used for identifying the part assets that need to be updated and identify the original files for the new versions of the parts.

● The PLM Replace Parts workflow controller cannot be used to modify existing metadata.● The PLM Replace Parts workflow controller cannot be used to modify the IsReleased flag on external

system IDs.

A Schema 1 VZXML file for the PLM Replace Parts workflow controller must contain these elements:

● Entities.● ExternalSystems.● FileGroups.

A Schema 1 VZXML file for the PLM Replace Parts workflow controller should never contain the following:

● Any elements or attribute that is not defined in the public schema● A BOM element● A selectors element● Any element apart from EntityId elements in the ExternalSystems element● A node element within an entity elements● A metadata element within an entity elements.● An IsReleased attribute within an EntityId elements

In Schema 1 files for the PLM Replace Parts workflow controller:

● The entities element contains one or more entity elements.● The ExternalSystems element contains one or more ExternalSystem elements.● Each ExternalSystem element contains a Name attribute that describes the name of the external system

(PLM system) used to generate the external system ID values represented by its child elements. This name is used to distinguish different sources of external system IDs.

● Each ExternalSystem element may contain one or more EntityId child elements.● Each EntityIdelement represents an external system id for an asset.● Each EntityId element has an EntityRef attribute value that matches the ID attribute value of an entity

within the file.● Each entity element must have a corresponding EntityId element.● The FileGroups element contains one or more FileGroup elements.● Each FileGroup element contains one or more File elements.● Each FileGroup element contains a BasePath attribute value that specifies the base path for its child File

elements.● Each FileGroup contains a Type attribute value that indicates whether the path is absolute or relative. In

VZXML files that are not included within an RHZ archive (as is the case for PLM Replace Parts), use the absolute paths and the Absolute type attribute value.

● Each file element contains a path to an original CAD file.


● Each entity element must have a corresponding file element.

2.3.2.1.13.5.1 PLM Replace Parts Sample File

NoteAn input file that references two part assets is the following:

Sample Code

<MultiBom xmlns="http://schemas.righthemisphere.com/MultiBom/2009/May"> <Entities> <Entity Id="e1" Name="Deck" FileRef="f1" /> <Entity Id="e2" Name="Gear" FileRef="f2" /> </Entities> <ExternalSystems> <ExternalSystem Name='PLM'> <EntityId EntityRef='e1' Uid='P_Deck' Version='V1' Revision='R1'/> <EntityId EntityRef='e2' Uid='P_Gear' Version='V1' Revision='R1'/> </ExternalSystem> </ExternalSystems> <FileGroups> <FileGroup BasePath=\\fileserver\models\CAD_3Dmodels_Drawings\CATIA\OPEN\Skateboard 2\ Type="Absolute"> <File Id="f1" Source="Deck.CATPart"/> <File Id="f2" Source="Gear.CATPart"/> </FileGroup> </FileGroups></MultiBom>

2.3.2.1.14 PLM Translation Workflow Controller

Use

The PLM Translation workflow controller is used to create structured assets in SAP 3D Visual Enterprise Generator that have their identities controlled by external systems like PLM systems. Parts and assemblies in the asset structures are reusable, so assets created by prior jobs can be referenced by subsequent jobs.

Absolute & Relative Instances

Two types of instances are created in SAP 3D Visual Enterprise Generator by the PLM Translation workflow controller: absolute and relative.

Absolute instances represent absolutely positioned instances of an asset and are part of an absolute instance tree. The parent of an absolute instance is either another absolute instance, or none, if it is at the root of the hierarchy.



NoteExternal IDs associated with <Selector> elements matching a particular absolute instance path are associated with the absolute instance record in SAP 3D Visual Enterprise Generator. The same is true for metadata defined on <Selector> elements.

Relative instances represent an instance that is contained within a particular asset version, and are positioned relative to their containing asset. The parent of a relative instance is its containing asset version.

Features


Setting Description

Build Part Derivative Instructs the workflow controller to build derivatives for parts (leaf nodes) in the asset hierarchy.

Default value: True

Build Sub-Assembly Derivative Instructs the workflow controller to build derivatives for subassemblies (non-root container nodes) in the asset hierarchy.

Default value: True

Build Top-Level Derivative Instructs the workflow controller to build derivatives for top-level nodes in the asset hierarchy.

Default value: True

Enable Tracing Enables or disables diagnostic tracing, used for debugging.

Default value: True

Validate Input MBom Schema Instructs the workflow controller to perform XML validation on the input Schema1 file. We recommend that you do not turn this setting off, as it may cause errors that are more difficult to debug further down the processing workflow.

Default value: True

Default Derivative Group Identifies the derivative group containing the derivatives to build for a PLM Translation job. For more information, see Secondary Derivative.

Default value: True

Storage Request Serialization Format Set to Production for ProtoBuf backed serialization; set to Debug for XML


PLM Translation: Arguments


ChangeEventName The change event name to assign to any assets created by this instance of the PLM Translation workflow. You can use it to route assets to different downstream workflows.

InputFilePath The fully qualified path to the Schema1 file to use as input when starting the job. The path must be readable by SAP 3D Visual Enterprise Generator.

TargetServerPath The SAP 3D Visual Enterprise Generator folder path where assets created by this workflow should be stored

Activities

Releasing assets

Asset versions created in SAP 3D Visual Enterprise Generator can be marked as Released. This has implications for downstream usage, for example, released assets may have restrictions on whether they can be modified.

To release assets, set the value of the Released attribute on the <ExternalID> for a particular asset version to True. Once an asset version has been released, its released status cannot be changed.

To release assets that have already been translated into SAP 3D Visual Enterprise Generator, submit a Schema1 file that contains the same structure as before, but sets the Released attribute to True.

2.3.2.1.14.1 Starting the PLM Translation Workflow Controller

Use

Workflows using the PLM Translation workflow controller can be used to start jobs as follows:

● Using a SAP 3D Visual Enterprise Generator hot folder● Using a SAP 3D Visual Enterprise Generator Web service API call

Procedure

To start a PLM Translation job from a hot folder, proceed as follows:

1. Configure a PLM Translation hot folder.2. Drop a Schema 1 XML file into the hot folder.



To start a PLM Translation job from a SAP 3D Visual Enterprise Generator Web service API call, proceed as follows:

● When the Schema 1 file is in a location accessible by SAP 3D Visual Enterprise Generator directly, call JobStart() on VEGenerator7.asmx, passing through the fully qualified path to the Schema 1 in the InputFilePath startup argument.

● When the file is not in a location accessible by SAP 3D Visual Enterprise Generator directly, do the following:1. Upload the Schema 1 file using the VEGeneratorMTom7.asmx methods:

○ StartUniqueFileUpload()○ UploadUniqueFileChunk()○ FinishUniqueFileUpload()


2.3.2.1.14.2 Configuring a PLM Translation Workflow

To configure SAP 3D Visual Enterprise Generator to process PLM Translation jobs, proceed as follows:

1. Open SAP 3D Visual Enterprise Generator Administration, and navigate to Server ConfigurationWorkflows .

2. Choose New in the Workflows panel. The Create Workflow window opens.3. On the General tab page, enter a name for the workflow.


4. Enter PLM Translation workflow controller in the Controllers field and choose OK.

5. Navigate to Server Configuration Workflows Hot Folders .6. Choose New in the Workflows panel. The Add New Hot Folder window opens.7. In the Path field, select the path to the folder that you want to use as the hot folder for PLM Translation8. Select Start Workflow Job in the Action field.9. Select PLM Translation on the Action Settings toolbar. The PLM Translation startup arguments appear.10. Choose the ellipsis (…) next to the Target Server Path field, and select the location in SAP 3D Visual

Enterprise Generator where you want to store translated assets. Choose OK.11. If you want to create new hot folder, choose OK again.

CautionWe do not recommend to select an existing folder containing original files because files are deleted as they are processed. Instead, create a new folder and copy source files into this. The default pattern for files to send to SAP 3D Visual Enterprise Generator is *.*.



The PLM Translation workflow controller supports building derivatives as part of the job when translating assets.

To build secondary derivatives, modify your PLM Translation workflow, and choose one of the following derivative groups to use from the drop-down list on the Settings tab:

● 2D Drawing Tech Illustrations● 3D Step-by-Step Training● CAD Assemblies and Parts● DetailedPart● Publishing● VisualContext

2.3.2.1.14.3 PLM Translation Processes

Use

The PLM Translation workflow controller uses the following processes:

● PLM – Build Assembly (Process Slot: Build Assembly)Performs assembly builds by merging constituent child RHZ files into one containing RHZ file. You can customize this process by disabling animated thumbnails.

● PLM – Build Part (Process Slot: Build Part)Performs part builds by translating CAD original files into RHZ format. You can customize this process by disabling animated thumbnail.

● PLM – Prepare Workspace (Process Slot: Prepare Workspace)Copies original files into the job workspace, and retrieves any re-used existing assets into the workspace.

● PLM – Preprocess (Process Slot: Pre-Process Originals)Performs pre-processing of asset original files. You can customize this process by changing master derivative process or derivative group to use per asset.

● PLM – Validate Input (Process Slot: Validate Input)Validates the input Schema1 file for correctness.

● PLM – Store (Process Slot: Store Assets)Stores the built assets, thumbnails and derivatives in SAP 3D Visual Enterprise Generator.

Activities

To disable animated thumbnails, modify the relevant build assembly or build part process as folliows:

● Clear the AnimatedThumbnailFileTypeID field in the xmlresponse operation (set its value to 0).● Delete the go_animthumbnail branch in the process.



2.3.2.1.14.4 PLM Translation Job Steps

Use

The following processing steps are performed by the PLM Translation workflow controller:

1. Validation2. Lock Assets3. Prepare Workspace4. Pre-Process Original Files5. Build Assets6. Build Derivatives7. Store Assets8. Track Changed Assets

Features

Validation

This is the first step. It validates the syntax of the input Schema1 file and checks the file content against the rules described in the validation section above. Any validation failure causes the job to be aborted at this stage to avoid causing hard-to-track errors later in the Visual Manufacturing workflow.

The job controller also analyzes the structure of the input Schema1 file at this point, and determines which items in the Schema1 file will become assets and instances in SAP 3D Visual Enterprise Generator.

● Absolute instance trees are generated by navigating the tree paths starting from root <Node> elements in the <BOM> element.

● Assets are generated for each <Entity> in the Schema1 file referenced by one of the absolute instance tree paths.

● External system (partner system) IDs to assign to assets and absolute instances are obtained by consulting the <ExternalSystems> section of the Schema1 file.

Lock Assets

All of the assets that the workflow controller has determined should be created in SAP 3D Visual Enterprise Generator are requested to be locked, passing in the external system ID obtained from the Schema1 file as the identity of the asset.

If any locks are rejected, the job is aborted. If the assets are already locked by another job, the PLM Translation job will be blocked until that job completes.

Prepare Workspace

This step copies all the original files referenced by asset <Entity> elements to the job workspace folder.

Additionally, all asset versions that will be reused because they already exist in SAP 3D Visual Enterprise Generator, are also retrieved to the workspace from SAP 3D Visual Enterprise Generator.

Pre-Process Original Files


The PLM Translation workflow controller separates the asset original files into batches of 1000, and calls the pre-processing process for each of these batches. The default process used for this is PLM – Preprocess.

The goal of this step is to determine the following information, for each asset:

● The SAP 3D Visual Enterprise Generator file type to use for the asset, for example, CATIA5 part, ProE assembly, PNG image

● The SAP 3D Visual Enterprise Generator plug-in to use to open the asset original file● The asset type to use when creating the asset, for example, 2D, 3D, text● Whether or not to use a custom master derivative process set on the file type for the asset instead of one

of the standard build processes set up in the Processes configuration● Whether or not to use a custom derivative group when building derivatives for the asset.

NoteUnlike the asset or assembly controllers, the PLM Translation workflow controller never stores original files in SAP 3D Visual Enterprise Generator, and the Store Originals setting of the detected file type is disregarded.

Build Assets

The build assets step creates RHZ master derivative files for each asset node in the hierarchy.

The following processes are executed:

● If the asset is a part (leaf node), the configured Build Part process is executed (default: PLM – Build Part).● If the asset is a subassembly (container node) or top-level assembly, the configured Build Assembly

process is executed (default: PLM – Build Assembly).

If any node fails to build, building of the top-level is skipped. This job controller does not support building nodes with incomplete child hierarchies, nor storing of incomplete absolute instance trees, to avoid storing incorrect data.

Subsequent PLM Translation jobs can remedy this by resubmitting the job if the problematic node issue has been resolved and the top-level will be built if no other errors were present.

Build Derivatives

If a default derivative group is selected for a PLM Translation workflow, or a Pre-Processing step indicated that a particular derivative group should be used for certain files, the secondary derivatives will be built in this step.

Store Assets

This step stores all of the master and secondary derivative assets that were built by the job. This step also stores the metadata present in the original files and defined in the Schema1 files, and sets the external system IDs to use to refer to the assets in SAP 3D Visual Enterprise Generator.

Track Changed Assets

This step creates change management records for all of the asset versions created by the PLM Translation job.

These records are used by other downstream workflows (such as PLM Asset Publish and Detailed Part Publish) to determine which assets have been created or changed and should be processed.



2.3.2.1.14.5 PLM Translation Input File Format

The file specified in the Input File Path startup argument must be a file in the Schema1 XML format (http://schemas.righthemisphere.com/MultiBom/2009/May).

Schema Validation

The input file must be valid according the schema definition. In addition, the PLM Translation workflow controller performs additional checks to guard against invalid input data, described in the Schema Rules section.

Schema Rules

The following additional business rules are checked for all submitted Schema1 files, any failure will cause the job to be aborted at the validation stage:

● At least one <Entity> must be present in the file.● All <Entity> elements must have one and only one external ID assigned to them by an <EntityID>

element in an <ExternalSystem> block.● All <Selector> elements must have unique Path values; duplicate Path values are not allowed.● All nodes referenced by Path attributes of <Selector> elements must exist in the Schema1.● If an external ID with the same UID is assigned to multiple <Entity> elements, the Version and/or

Revision fields must be different.● If a <Selector> has an external ID assigned to it by a <SelectorID> element in an <ExternalSystem>

block, the external ID must be unique across all selectors.

Schema1 Reference for PLM Translation

The XML schema for Schema1 XML files does not fully specify the requirements and assumptions made by the PLM Translation workflow controller.

For instance, although some elements are not required to have any children according to XSD, the PLM Translation workflow controller may require children to be present.

A Schema1 XML file for the PLM Translation workflow controller has a top level <MultiBOM> element which always contains the following elements:

● <BOMs>● <Entities>● <ExternalSystems>

The top-level <MultiBOM> element contains the <FileGroups> element. This element is only be omitted in the unlikely scenario in which no original file is specified for any of the parts in the XML file.


The top-level <MultiBOM> element in a Schema1 VZXML file for the PLM Translation workflow controller may also contain the <Selector> element.

Additionally, the following elements can be contained:

● The <BOMs> element contains a single <BOM> element that represents the scene.● The <BOM> element can contain one or more <Node> elements.● The <Entities> element contains one or more <Entity> elements.● The <ExternalSystems> element contains one or more <ExternalSystems> elements.● Each <ExternalSystem> element contains a Name attribute that describes the name of the external

system (PLM system). This name is used to distinguish different sources of external system identifiers.● Each <ExternalSystem> element can contain one or more <EntityID> child elements.● Each <EntityID> element represents an external system ID for a particular asset version.● Each <EntityID> element has an EntityRef attribute value that matches the Id attribute value of an

<Entity> within the file.● Each <Entity> element must have a corresponding <EntityID> element.● An <ExternalSystem> element can contain one or more <SelectorID> child elements.● Each <SelectorID> element has a <SelectorRef> attribute value that matches the ID attribute value of

a <Selector> element within the file.● A <Selector> element does not necessarily have a corresponding <SelectorID> element.● Each <SelectorID> element represents an external system ID for an absolutely positioned asset

instance.● The <FileGroups> element contains one or more <FileGroup> elements.● Each <FileGroup> element contains one or more <File> elements.● Each <FileGroup> element contains a BasePath attribute value that specifies the base path for its child

File elements.● Each <FileGroup> contains a Type attribute value that indicates whether the path is absolute or relative.● Each <File> element contains a path to an original CAD file.● Each <Entity> element can contain one or more <Node> elements.● Each <Entity> element becomes an asset version in SAP 3D Visual Enterprise Generator.● Each <Node> element that is a child of an <Entity> element represents a relatively positioned asset

instance in SAP 3D Visual Enterprise Generator.● Each <Node> element that is a child of the <BOM> element either represents an absolutely positioned root

asset instance or some non-geometry object such as a camera. The latter is not supported in Schema1 files produced by non-Right Hemisphere components.

● Each <Node> element that represents an asset instance contains an EntityRef attribute that references the ID of the <Entity> element that represents the asset referred to by the asset instance.

● <Node> elements that represent asset instances in a Schema1 file will have no Type attribute.● <Node> elements that do not represent asset instances must have a Type attribute value that indicates

what the node represents.● <Node> elements that do not represent asset instances should be children of the <BOM> element.● <Node> elements can have a TMatrix attribute value which is a relative transformation matrix, for example,

it is a transformation relative to the parent node. If a TMatrix attribute value is omitted from a <Node> element, the identity matrix is assumed.

● Each <Entity> element can contain a FileRef attribute that contains a reference to the ID attribute value of a <File> element within the Schema1 file.



● Each <Selector> element contains a Path attribute that describes the path through the instance hierarchy that the absolute instance represents.

● A <Selector> element can contain a TMatrix attribute value which is an absolute (relative to origin of the world coordinate system) transformation matrix. If no TMatrix attribute value is specified for a <Selector> element, no value is assumed (it is assumed to be uncalculated).

● Although the BOM factory plug-in calculates absolute TMatrix attribute values by multiplying out the relative transformation matrices of the nodes in the path, it is not necessary to do this. The transformation matrices will be calculated before the absolutely positioned instances that the selectors represent are stored in the database.

● Selectors do not have to be included in the input Schema1 if there is no absolute instance specific metadata or positioning. A complete absolute instance hierarchy and asset instance hierarchy is always created regardless of which <Selector> elements exist in the input Schema1.

2.3.2.1.14.5.1 PLM Translation Sample Input File

NoteASchema1 file is below:

Sample Code

<MultiBom xmlns="http://schemas.righthemisphere.com/MultiBom/2009/May" Generator="ABC"> <Boms> <Bom Id="bom1" Name="Deck" ViewUp="ZPOS" ViewRight="YPOS"> <Node Id="n1" EntityRef="e1" Name="Deck Install Assembly"/> </Bom> </Boms> <Selectors> <Selector Id="s1" Name="S_Deck" Path="n1" /> <Selector Id="s2" Name="S_Deck_Part" Path="n1/n2" /> </Selectors> <Entities> <Entity Id="e2" Name="Deck" FileRef="f2"/> <Entity Id="e1" Name="Deck Install Assembly"> <Node Id="n2" EntityRef="e2" Name="Deck" TMatrix="-1 -3.88578e-016 9.63634e-018 0 3.88578e-016 -1 -1.22081e-016 0 9.63634e-018 -1.22081e-016 1 0 467.519 1.43924 -3.55271e-015 1"/> </Entity> </Entities> <ExternalSystems> <ExternalSystem Name='PLM'> <SelectorId SelectorRef="s1" Uid="S_Deck_IA" /> <SelectorId SelectorRef="s1" Uid="S_Deck_P" /> <EntityId EntityRef='e1' Uid='SA_Deck_IA' Version='V1' Revision='R1'/> <EntityId EntityRef='e2' Uid='P_Deck' Version='V1' Revision='R1'/> </ExternalSystem> </ExternalSystems> <FileGroups> <FileGroup BasePath="\\Models\Skateboard" Type="Absolute"> <File Id="f2" Source="Deck.rh"/> </FileGroup> </FileGroups></MultiBom>


2.3.2.1.14.6 PLM Translation Asset Versioning

Versioning in the PLM Translation workflow controller occurs at the asset level. The external ID of an <Entity> determines the SAP 3D Visual Enterprise Generator asset version, using the following rules:

● If an external ID with the system name and UID does not exist in SAP 3D Visual Enterprise Generator, a new asset is created.

● If an asset having an external ID with the same system name and UID exists in SAP 3D Visual Enterprise Generator, but the version or revision parts of the external ID do not match, a new version of the existing asset is created.

● If an asset having an external ID with the same system name and UID exists in SAP 3D Visual Enterprise Generator, and the version and revision parts of the external ID do match exactly, the existing SAP 3D Visual Enterprise Generator asset is reused in the hierarchy created by the current job.

2.3.2.1.14.6.1 Initial Load

This is the absolute instance tree that exists in SAP 3D Visual Enterprise Generator after submitting the below Schema1:

Initial Load Versioning

Three assets are created, along with seven absolutely positioned instances referring to these assets.

NoteIn this example, no assets exist in SAP 3D Visual Enterprise Generator yet, and the following Schema1 is submitted for translation:



Sample Code

<MultiBom xmlns="http://schemas.righthemisphere.com/MultiBom/2009/May"> <Boms> <Bom Id="bom1" Name="Front Landing Gear" ViewUp="ZPOS" ViewRight="YPOS"> <Node Id="n1" EntityRef="e1" Name="Front Landing Gear"/> </Bom> </Boms> <Selectors> <Selector Id="s1" Name="FrontLandingGear" Path="n1" /> <Selector Id="s2" Name="FrontLandingGear LeftWheel" Path="n1/n2" /> <Selector Id="s3" Name="FrontLandingGear LeftWheel FrontBrake" Path="n1/n2/n4" /> <Selector Id="s4" Name="FrontLandingGear LeftWheel RearBrake" Path="n1/n2/n5" /> <Selector Id="s5" Name="FrontLandingGear RightWheel" Path="n1/n3" /> <Selector Id="s6" Name="FrontLandingGear RightWheel FrontBrake" Path="n1/n3/n4" /> <Selector Id="s7" Name="FrontLandingGear RightWheel RearBrake" Path="n1/n3/n5" /> </Selectors> <Entities> <Entity Id="e1" Name="Landing Gear" FileRef="f1"> <Node Id="n2" Name="Left Wheel" EntityRef="e2" TMatrix="1 0 1" /> <Node Id="n3" Name="Right Wheel" EntityRef="e2" TMatrix="2 0 1" /> </Entity> <Entity Id="e2" Name="Wheel" FileRef="f2"> <Node Id="n4" Name="Front Brake" EntityRef="e3" TMatrix="3 0 1" /> <Node Id="n5" Name="Rear Brake" EntityRef="e3" TMatrix="4 0 1" /> </Entity> <Entity Id="e3" Name="Brake" FileRef="f3" /> </Entities> <ExternalSystems> <ExternalSystem Name='PLM'> <SelectorId SelectorRef="s1" Uid="S_FrontLandingGear" /> <SelectorId SelectorRef="s2" Uid="S_FrontLandingGear_LeftWheel" /> <SelectorId SelectorRef="s3" Uid="S_FrontLandingGear_LeftWheel_FrontBrake" /> <SelectorId SelectorRef="s4" Uid="S_FrontLandingGear_LeftWheel_RearBrake" /> <SelectorId SelectorRef="s5" Uid="S_FrontLandingGear_RightWheel" /> <SelectorId SelectorRef="s6" Uid="S_FrontLandingGear_RightWheel_FrontBrake" /> <SelectorId SelectorRef="s7" Uid="S_FrontLandingGear_RightWheel_RearBrake" /> <EntityId EntityRef='e1' Uid='A_LandingGear' Version='V1' Revision='--'/> <EntityId EntityRef='e2' Uid='A_Wheel' Version='V1' Revision='--'/> <EntityId EntityRef='e3' Uid='A_Brake' Version='V1' Revision='--'/> </ExternalSystem> </ExternalSystems> <FileGroups> <FileGroup BasePath="\\Models\LandingGear" Type="Absolute"> <File Id="f1" Source="LandingGear.CATProduct"/> <File Id="f2" Source="Wheel.CATProduct"/> <File Id="f3" Source="Brake.CATPart"/> </FileGroup> </FileGroups></MultiBom>


2.3.2.1.14.6.2 Container Asset RevvedIn this scenario, the version of the containing Landing Gear asset changed, but the Wheel and Brake assets inside it are unchanged.

Because the external IDs declared in the Schema1 is an exact match for the assets created in previous example, the Wheel and Brake assets already existing in SAP 3D Visual Enterprise Generator are reused, and not rebuilt.

The Schema1:

Sample Code

<MultiBom xmlns="http://schemas.righthemisphere.com/MultiBom/2009/May"> <Boms> <Bom Id="bom1" Name="Front Landing Gear" ViewUp="ZPOS" ViewRight="YPOS"> <Node Id="n1" EntityRef="e1" Name="Front Landing Gear"/> </Bom> </Boms> <Selectors> <Selector Id="s1" Name="FrontLandingGear" Path="n1" /> <Selector Id="s2" Name="FrontLandingGear LeftWheel" Path="n1/n2" /> <Selector Id="s3" Name="FrontLandingGear LeftWheel FrontBrake" Path="n1/n2/n4" /> <Selector Id="s4" Name="FrontLandingGear LeftWheel RearBrake" Path="n1/n2/n5" /> <Selector Id="s5" Name="FrontLandingGear RightWheel" Path="n1/n3" /> <Selector Id="s6" Name="FrontLandingGear RightWheel FrontBrake" Path="n1/n3/n4" /> <Selector Id="s7" Name="FrontLandingGear RightWheel RearBrake" Path="n1/n3/n5" /> </Selectors> <Entities> <Entity Id="e1" Name="Landing Gear" FileRef="f1"> <Node Id="n2" Name="Left Wheel" EntityRef="e2" TMatrix="1 0 1" /> <Node Id="n3" Name="Right Wheel" EntityRef="e2" TMatrix="2 0 1" /> </Entity> <Entity Id="e2" Name="Wheel" FileRef="f2"> <Node Id="n4" Name="Front Brake" EntityRef="e3" TMatrix="3 0 1" /> <Node Id="n5" Name="Rear Brake" EntityRef="e3" TMatrix="4 0 1" /> </Entity> <Entity Id="e3" Name="Brake" FileRef="f3" /> </Entities> <ExternalSystems> <ExternalSystem Name='PLM'> <SelectorId SelectorRef="s1" Uid="S_FrontLandingGear" /> <SelectorId SelectorRef="s2" Uid="S_FrontLandingGear_LeftWheel" /> <SelectorId SelectorRef="s3" Uid="S_FrontLandingGear_LeftWheel_FrontBrake" /> <SelectorId SelectorRef="s4" Uid="S_FrontLandingGear_LeftWheel_RearBrake" /> <SelectorId SelectorRef="s5" Uid="S_FrontLandingGear_RightWheel" /> <SelectorId SelectorRef="s6" Uid="S_FrontLandingGear_RightWheel_FrontBrake" /> <SelectorId SelectorRef="s7" Uid="S_FrontLandingGear_RightWheel_RearBrake" /> <EntityId EntityRef='e1' Uid='A_LandingGear' Version='V2' Revision='--'/> <EntityId EntityRef='e2' Uid='A_Wheel' Version='V1' Revision='--'/> <EntityId EntityRef='e3' Uid='A_Brake' Version='V1' Revision='--'/> </ExternalSystem> </ExternalSystems> <FileGroups> <FileGroup BasePath="\\Models\LandingGear" Type="Absolute"> <File Id="f1" Source="LandingGear.CATProduct"/>



<File Id="f2" Source="Wheel.CATProduct"/> <File Id="f3" Source="Brake.CATPart"/> </FileGroup> </FileGroups></MultiBom>

A new, separate absolute instance tree is created, containing as root instance an instance pointing to V2 of the Landing Gear asset. The previous instance tree still exists, still pointing to V1 as the root of its hierarchy. The external IDs declared through <SelectorId> are moved to absolute instances in the newly created tree, and the previous absolute instances are no longer addressable through external ID, but only by SAP 3D Visual Enterprise Generator database ID.

Container Asset Revved Versioning

2.3.2.1.14.6.3 Example: Part Asset Revved

In this example, the Brake asset is updated to a new version. Because it is contained in all paths of the hierarchy, all of its parents have to be updated to new versions as well, to reflect that they now contain V2 of the asset. The Schema1:

Sample Code

<MultiBom xmlns="http://schemas.righthemisphere.com/MultiBom/2009/May"> <Boms> <Bom Id="bom1" Name="Front Landing Gear" ViewUp="ZPOS" ViewRight="YPOS"> <Node Id="n1" EntityRef="e1" Name="Front Landing Gear"/> </Bom> </Boms> <Selectors> <Selector Id="s1" Name="FrontLandingGear" Path="n1" /> <Selector Id="s2" Name="FrontLandingGear LeftWheel" Path="n1/n2" />


<Selector Id="s3" Name="FrontLandingGear LeftWheel FrontBrake" Path="n1/n2/n4" /> <Selector Id="s4" Name="FrontLandingGear LeftWheel RearBrake" Path="n1/n2/n5" /> <Selector Id="s5" Name="FrontLandingGear RightWheel" Path="n1/n3" /> <Selector Id="s6" Name="FrontLandingGear RightWheel FrontBrake" Path="n1/n3/n4" /> <Selector Id="s7" Name="FrontLandingGear RightWheel RearBrake" Path="n1/n3/n5" /> </Selectors> <Entities> <Entity Id="e1" Name="Landing Gear" FileRef="f1"> <Node Id="n2" Name="Left Wheel" EntityRef="e2" TMatrix="1 0 1" /> <Node Id="n3" Name="Right Wheel" EntityRef="e2" TMatrix="2 0 1" /> </Entity> <Entity Id="e2" Name="Wheel" FileRef="f2"> <Node Id="n4" Name="Front Brake" EntityRef="e3" TMatrix="3 0 1" /> <Node Id="n5" Name="Rear Brake" EntityRef="e3" TMatrix="4 0 1" /> </Entity> <Entity Id="e3" Name="Brake" FileRef="f3" /> </Entities> <ExternalSystems> <ExternalSystem Name='PLM'> <SelectorId SelectorRef="s1" Uid="S_FrontLandingGear" /> <SelectorId SelectorRef="s2" Uid="S_FrontLandingGear_LeftWheel" /> <SelectorId SelectorRef="s3" Uid="S_FrontLandingGear_LeftWheel_FrontBrake" /> <SelectorId SelectorRef="s4" Uid="S_FrontLandingGear_LeftWheel_RearBrake" /> <SelectorId SelectorRef="s5" Uid="S_FrontLandingGear_RightWheel" /> <SelectorId SelectorRef="s6" Uid="S_FrontLandingGear_RightWheel_FrontBrake" /> <SelectorId SelectorRef="s7" Uid="S_FrontLandingGear_RightWheel_RearBrake" /> <EntityId EntityRef='e1' Uid='A_LandingGear' Version='V3' Revision='--'/> <EntityId EntityRef='e2' Uid='A_Wheel' Version='V2' Revision='--'/> <EntityId EntityRef='e3' Uid='A_Brake' Version='V2' Revision='--'/> </ExternalSystem> </ExternalSystems> <FileGroups> <FileGroup BasePath="\\Models\LandingGear" Type="Absolute"> <File Id="f1" Source="LandingGear.CATProduct"/> <File Id="f2" Source="Wheel.CATProduct"/> <File Id="f3" Source="Brake.CATPart"/> </FileGroup> </FileGroups></MultiBom>

A new, separate absolute instance tree is created again, containing as root instance an instance pointing to V3 of the Landing Gear asset. All of the child instances point to the updated versions of their assets as well.

The previous instance tree still exists, still pointing to V2 as the root of its hierarchy.

The external IDs declared through <SelectorId> are moved to absolute instances in the newly created tree, and the previous absolute instances are longer addressable through external ID, but only by SAP 3D Visual Enterprise Generator database ID.



Part Asset Revved Versioning

2.3.2.1.15 Process User Report Workflow Controller

Use

The Process User Report workflow controller creates subscriptions reports, and is one of two workflow controllers that are part of Subscriptions and Notifications feature.

This workflow controller is invoked through a Web API when viewing a subscription in SAP Visual Enterprise Access, and also invoked by the Subscriptions and Notifications Reporting workflow controller when running periodic (daily) scheduled report processing.

This workflow controller reads, format and output the report through the download area (for WAPI use), or e-mail the report.


Features


Process User Report: Configurable Settings

Setting Description

CSV XSLT File Path XSLT transformation for report to get CSV file format. Default: $SharePath\Templates\XSLTs\ReportTransform_CSV.xslt.

XML XSLT File Path XSLT transformation for report to get XML file format. Default: $SharePath\Templates\XSLTs\ReportTransform_XML.xslt.

HTML XSLT File Path XSLT transformation for report to get HTML file format. Default: $SharePath\Templates\XSLTs\ReportTransform_HTML.xslt.

The startup arguments for the Process User Report workflow controller are the following:

Process User Report: Arguments


UserId 0 User for which the report is requested.

SubscriptionId 0 The subscription ID for the requested report

Until Now UTC date/time until which events should be gathered

Format XML Format for reports (XML, CSV, HTML)

OutputMethod StagingArea How to output the report (StagingArea, Email)

Workflow Steps

Process User Report is the only step, and the process of this workflow controller. It start the process, passing the arguments passed to the workflow controller, and then reads task results and outputs parameters as required.

Note that the OutStagingAreaGuid parameter contains a value that is required to download the generated report if the specified output method is Staging Area.



2.3.2.1.15.1 Starting the Process User Report Workflow Controller

Use

Workflows using the Process User Report workflow controller are used to start jobs as follows:

● Viewing subscriptions on demand● Creating and sending periodic (daily) reports

Procedure

To start a Process User Report job from SAP Visual Enterprise Access, proceed as follows:

1. Subscribe to folder, asset, and job events.2. Perform actions to accumulate events on the subscribed actions.

3. Navigate to Administration Subscriptions , and select the required subscription.4. View the subscription.

When the assembly files are in a location accessible by SAP 3D Visual Enterprise Generator directly, you can start a Process User Report job from a SAP 3D Visual Enterprise Generator Web service API call as follows:

:

● Call JobStart(), passing through the user ID and subscription ID for the required report, specifying Staging Area as the output method, and the desired report format,

● When the job is complete (pool by checking job status), you can obtain the output parameter StagingAreaGUID to use to download the generated job report (the output method has been set to Staging Area).

2.3.2.1.15.2 Configuring the Process User Report Workflow

To configure SAP 3D Visual Enterprise Generator to run Process User Report jobs, proceed as follows:




4. Enter Process User Report workflow controller in the Controller field and choose OK.


NoteThere is a value in web.config of the Web API that specifies the workflow name to use when viewing subscriptions. Change this value to reflect the new workflow.

The workflow is referenced as a child workflow of the Subscriptions and Notifications Reporting controller workflow. The child workflow setting must be changed to make it use a different workflow.

2.3.2.1.15.3 Process User Report Processes

The default process for the Process User Report workflow controller is jmp_Subscriptions_ProcessUserReport(Process Slot: Process User Report). It reads, formats, and outputs the report. By default, SAP 3D Visual Enterprise Generator reads default configured administrator e-mail and uses that as Send From. To specify a different e-mail, type it in to SendFrom parameter of the E-mailReport operation.

2.3.2.1.16 SAP 3D Visual Enterprise Navigator Scene Build Workflow Controller

Use

You use the SAP 3D Visual Enterprise Navigator Scene Build workflow controller to create SAP 3D Visual Enterprise Navigator Scenes (VDS or DViS) from SAP 3D Visual Enterprise Generator assets or standalone RH files. The SAP 3D Visual Enterprise Navigator Scene Build workflow controller outputs VDS files to a predefined output location; it does not create or update SAP 3D Visual Enterprise Generator assets.

Secondary Derivatives

The building of secondary derivatives is handled by a child job. The CAD Assembly Upload workflow controller builds a request XML file that contains the assembly structure and a list of desired derivatives, and passes it to the child job, which builds the derivatives.



Features


SAP 3D Visual Enterprise Navigator Scene Build: Configurable Settings

Setting Description

Extract Errors Are Critical If set to True, all errors in extracting data are treated as critical causing the job to fail. If set to False (default), the errors are treated as warnings, and the job continues without using the data that failed to extract.

The startup arguments for the SAP 3D Visual Enterprise Navigator Scene Build workflow controller are the following:

SAP 3D Visual Enterprise Navigator Scene Build: Arguments


BuildVisualEnterprise NavigatorSceneNotificationXML

The input XML file specifying the content of the VDS to create. If this is not specified, output folder, external system name and target server path are required.

Cache Folder

(always required)

The VDS plug-in cache folder. This folder must be a UNC path that is accessible by SAP 3D Visual Enterprise Generator.

Output Folder The folder under which the created VDS will be saved. The folder must be a UNC path that is accessible by SAP 3D Visual Enterprise Generator.

External System Name The name of the external system whose assets will be combined to create the VDS

Target Server Path The default base path in SAP 3D Visual Enterprise Generator where the workflow controller will look for data to extract in order to build the VDS

2.3.2.1.16.1 Starting SAP 3D Visual Enterprise Navigator Scene Build Workflow Controller

Use

Workflows using the SAP 3D Visual Enterprise Navigator Scene Build workflow controller can be used to start jobs as follows:

● Using a Manifest Workflow Job hot folder


● Using SAP 3D Visual Enterprise Generator scheduled activity

Procedure

To start a SAP 3D Visual Enterprise Navigator Scene Build job from a Manifest Workflow Job hot folder, proceed as follows:

1. Configure a Manifest Workflow Job hot folder, selecting the SAP 3D Visual Enterprise Navigator Scene Build workflow that you wish to use, and configure the Cache Folder startup argument (other arguments are provided inside the BuildVisualEnterpriseNavigatorScene notification file).

2. Place the BuildVisualEnterpriseNavigatorScene notification file in the hot folder.

To start a SAP 3D Visual Enterprise Navigator Scene Build job using SAP 3D Visual Enterprise Generator scheduled activity, configure SAP 3D Visual Enterprise Generator Scheduled activity, selecting the SAP 3D Visual Enterprise Navigator Scene Build workflow that you wish to use; configure all startup arguments apart from BuildVisual EnterpriseNavigatorScene Notification XML.

For more information about scheduled activities, see Adding Scheduled Activities [page 569].

2.3.2.1.16.2 Configuring SAP 3D Visual Enterprise Navigator Scene Build Workflow

To configure SAP 3D Visual Enterprise Generator to process SAP 3D Visual Enterprise Navigator Scene Build jobs, proceed as follows:


2. Choose New on the Workflows toolbar. The Create Workflow window opens.3. On the General tab page, enter a name for the workflow.4. Enter SAP 3D Visual Enterprise Navigator Scene Build controller in the Controller field and choose OK.

2.3.2.1.16.3 SAP 3D Visual Enterprise Navigator Scene Build Processes

The default processes for the Asset Upload workflow controller are the following:

● Deep Vision – Analyze Notification (process slot: Analyze DVIS)Analyzes the BuildVisualEnterpriseNavigatorScene notification, and verifies requested data for VDS creation

● Deep Vision – Extract Data (process slot: Extract DVIS)Extracts the requested VDS creation data into the job workspace

● Deep Vision – Create Scene (process slot: Create DVIS)Creates the VDS create instruction and invokes the VDS plug-in to build the scene



2.3.2.1.16.4 SAP 3D Visual Enterprise Navigator Scene Build Steps

Use

The following processing steps are performed by the Deep Vision Scene Build workflow controller:

● Validate Input● Analyze BuildVisualEnterpriseNavigatorScene Notification● Extract Data

Extracts the requested VDS build data into the job workspace● Create DeepVision Scene

Creates a DeepVision plug-in instruction file and invokes the plug-in to create the VDS output. When the plug-in returns an execution response, the plug-in output is validated, and if correct, is copied to the specified output location.

Features

Validate Input

Validates that the Cache Folder startup argument is present, and is a UNC path to which SAP 3D Visual Enterprise Generator has read/write access as follows:

● If the BuildVisualEnterpriseNavigatorScene input file is not present, validates that Output Folder, External System Name and Target Server Path startup arguments are present. Additionally, Output Folder is validated to be a UNC path to which SAP 3D Visual Enterprise Generator has read/write access.

● If the BuildVisualEnterpriseNavigatorScene input file is present, the file is validated against the BuildVisualEnterpriseNavigatorScene schema. Additionally, <BuildDeepVision> element’s FilePath attribute value is validated to be a UNC path to which SAP 3D Visual Enterprise Generator has read/write access.

Analyze DeepVision Build Notification

If the BuildVisualEnterpriseNavigatorScene input file is not present:

A default BuildVisualEnterpriseNavigatorScene notification is created as follows:

Code Syntax

<BuildDeepVision xmlns='http://schemas.righthemisphere.com/2009/May/BuildDeepVision' Name='ProjectDeepVisionScene' Project='[Project Name]' FilePath='[Output]\ DVis_Job_[Job ID]\ ProjectDVis.rh'> <Contents> <Selectors TopLevels='true' PartnerName='[External System Name]'/> </Contents></BuildDeepVision>

[Project Name] is the value specified in the Target Server Path startup argument.


[Output] is the value specified in the Output Folder startup argument.

[Job ID] is the ID of the job running the controller.

[External System name] is the value specified in the External System Name startup argument.

If the BuildDeepVision input file is present or the default has been created, requested VDS build data details are retrieved from the SAP 3D Visual Enterprise Generator database and job workspace is prepared for data extraction.

2.3.2.1.16.5 SAP 3D Visual Enterprise Navigator Scene Build Input File Format

BuildVisualEnterpriseNavigatorScene is an xml file that specifies the content of VDS to create.

Schema Definitions

The file specified in the BuildVisualEnterpriseNavigatorScene Notification xml startup argument must be a file in BuildVisualEnterpriseNavigatorScene xml format (see http://schemas.righthemisphere.com/2009/May/BuildDeepVision). The schema is below:

Code Syntax

<?xml version="1.0" encoding="utf-8"?> <xs:schema id="BuildDeepVision" attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://schemas.righthemisphere.com/2009/May/BuildDeepVision" xmlns="http://schemas.righthemisphere.com/2009/May/BuildDeepVision" xmlns:public="http://schemas.righthemisphere.com/2009/May" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="BuildDeepVision"> <xs:complexType> <xs:sequence> <xs:element name="Contents" type="Contents" minOccurs="1" maxOccurs="1"/> </xs:sequence> <xs:attribute name="Name" use="required" type="xs:string"/> <xs:attribute name="Project" use="required" type="xs:string"/> <xs:attribute name="FilePath" use="optional" type="xs:string"/> <xs:attribute name="ServerPath" use="optional" type="xs:string"/> </xs:complexType> </xs:element> <xs:complexType name="Contents"> <xs:sequence> <xs:element name="Assets" type="Assets" minOccurs="0" maxOccurs="1"/> <xs:element name="Parts" type="Parts" minOccurs="0" maxOccurs="1"/> <xs:element name="AbsoluteInstances" type="AbsoluteInstances" minOccurs="0" maxOccurs="1"/> <xs:element name="Selectors" type="Selectors" minOccurs="0" maxOccurs="1"/> <xs:element name="Folders" type="Folders" minOccurs="0" maxOccurs="1"/> <xs:element name="FileSystem" type="FileSystem" minOccurs="0" maxOccurs="1"/>



</xs:sequence> </xs:complexType> <xs:complexType name="Selectors"> <xs:sequence> <xs:element name="Selector" type="Selector" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="Exclude" minOccurs="0" maxOccurs="1"> <xs:complexType> <xs:sequence> <xs:element name="Selector" type="Selector" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> <xs:attribute name="PartnerName" type="xs:string" use="required"/> <xs:attribute name="TopLevels" type="xs:boolean" use="optional"/> </xs:complexType> <xs:complexType name="Parts"> <xs:sequence> <xs:element name="Part" type="Part" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="Exclude" minOccurs="0" maxOccurs="1"> <xs:complexType> <xs:sequence> <xs:element name="Part" type="Part" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> <xs:attribute name="PartnerName" type="xs:string" use="required"/> <xs:attribute name="TopLevels" type="xs:boolean" use="optional"/> </xs:complexType> <xs:complexType name="Assets"> <xs:sequence> <xs:element name="Asset" type="Asset" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="Exclude" minOccurs="0" maxOccurs="1"> <xs:complexType> <xs:sequence> <xs:element name="Asset" type="Asset" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> <xs:attribute name="TopLevels" type="xs:boolean" use="optional"/> </xs:complexType> <xs:complexType name="AbsoluteInstances"> <xs:sequence> <xs:element name="AbsoluteInstance" type="AbsoluteInstance" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="Exclude" minOccurs="0" maxOccurs="1"> <xs:complexType> <xs:sequence> <xs:element name="AbsoluteInstance" type="AbsoluteInstance" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> <xs:attribute name="TopLevels" type="xs:boolean" use="optional"/> </xs:complexType> <xs:complexType name="Folders"> <xs:sequence>


<xs:element name="Folder" type="Folder" minOccurs="1" maxOccurs="unbounded"/> </xs:sequence> <xs:attribute name="ContentType" type="ContentType" use="required"/> </xs:complexType> <xs:complexType name="FileSystem"> <xs:sequence> <xs:element name="FSFolder" type="FSFolder" minOccurs="1" maxOccurs="unbounded" /> </xs:sequence> </xs:complexType> <xs:complexType name="FSFolder"> <xs:sequence> <xs:element name="Files" type="Files" minOccurs="1" maxOccurs="1"/> </xs:sequence> <xs:attribute name="Path" type="xs:string" use="required"/> </xs:complexType> <xs:complexType name="Files"> <xs:sequence> <xs:element name="File" type="File" minOccurs="0" maxOccurs="unbounded"/> <xs:element name="Exclude" minOccurs="0" maxOccurs="1"> <xs:complexType> <xs:sequence> <xs:element name="File" type="File" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> <xs:complexType name="Selector"> <xs:attribute name="Uid" type="xs:string" use="required"/> </xs:complexType> <xs:complexType name="Part"> <xs:attribute name="Uid" type="xs:string" use="required"/> <xs:attribute name="Ver" type="xs:string" use="required"/> <xs:attribute name="Rev" type="xs:string" use="required"/> </xs:complexType> <xs:complexType name="Asset"> <xs:attribute name="AssetId" type="xs:long" use="required"/> <xs:attribute name="AssetVer" type="xs:integer" use="required"/> </xs:complexType> <xs:complexType name="AbsoluteInstance"> <xs:attribute name="Id" type="xs:long" use="required"/> </xs:complexType> <xs:complexType name="Folder"> <xs:sequence> <xs:element name="Files" type="Files" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> <xs:attribute name="Name" type="xs:string" use="required"/> <xs:attribute name="TopLevels" type="xs:boolean" use="optional"/> </xs:complexType> <xs:complexType name="File"> <xs:attribute name="Name" type="xs:string" use="required"/> </xs:complexType> <xs:simpleType name="ContentType"> <xs:restriction base="xs:string"> <xs:enumeration value="Asset"/> <xs:enumeration value="AbsoluteInstance"/> </xs:restriction> </xs:simpleType> </xs:schema>



Schema Validation

The file specified in the BuildVisualEnterpriseNavigatorScene Notification xml startup argument must be valid according to the schema. In addition, the SAP 3D Visual Enterprise Navigator Scene Build job controller performs additional checks to guard against invalid input data.

Schema Rules

The following additional business rules are imposed on all submitted BuildVisualEnterpriseNavigatorScene xml files; any failure will cause the job to be aborted at the validation stage:

● <BuildDeepVision> element’s Project attribute value must specify a name of the project that is defined in SAP 3D Visual Enterprise Generator.

● <BuildDeepVision> element’s FilePath attribute value must specify a UNC location that is accessible by SAP 3D Visual Enterprise Generator.

2.3.2.1.16.5.1 SAP 3D Visual Enterprise Navigator Scene Build Sample Input Files

NoteThe Build VDS from Standalone Files workflow controller builds a VDS using all RH files found in the \\localhost\Input standalone files location:

Sample Code

<BuildDeepVision xmlns='http://schemas.righthemisphere.com/2009/May/BuildDeepVision' Name='Skateboard - Input Standalone Files' Project='Default' FilePath='\\localhost\_VDSOutput\Skateboard - Input Standalone Files.rh'> <Contents> <FileSystem> <FSFolder Path='\\localhost\Input standalone files'> <Files> <File Name='*.rh' /> </Files> </FSFolder> </FileSystem> </Contents></BuildDeepVision>


NoteThe Build VDS from Top-Level Absolute Instance workflow controller builds a VDS using only top-level absolute instances found in the Translation - VDS Test project:

Sample Code

<BuildDeepVision xmlns='http://schemas.righthemisphere.com/2009/May/BuildDeepVision' Name='Skateboard - Top Level Absolute Instances' Project='Translation - VDS Test' FilePath='\\localhost\_VDSOutput\Skateboard - Top Level Absolute Instances.rh'> <Contents> <AbsoluteInstances TopLevels='true'/> </Contents></BuildDeepVision>

NoteThe Build VDS from Top-Level Selectors workflow controller builds a VDS using only top-level selectors that have the PLM external system name (partner name) and are found in the Translation - VDS Test project:

Sample Code

<BuildDeepVision xmlns='http://schemas.righthemisphere.com/2009/May/BuildDeepVision' Name='Skateboard - Top Level Selectors' Project='Translation - VDS Test' FilePath='\\localhost\_VDSOutput\Skateboard - Top Level Selectors.rh'> <Contents> <Selectors TopLevels='true' PartnerName="PLM"/> </Contents></BuildDeepVision>

NoteThe Build VDS from Top-Level Parts workflow controller builds a VDS using only top-level parts that have the PLM external system name (partner name) and are found in the Translation - VDS Test project:

Sample Code

<BuildDeepVision xmlns='http://schemas.righthemisphere.com/2009/May/BuildDeepVision' Name='Skateboard - Top Level Parts' Project='Translation - VDS Test' FilePath='\\localhost\_VDSOutput\Skateboard - Top Level Parts.rh'> <Contents> <Parts TopLevels='true' PartnerName="PLM"/> </Contents></BuildDeepVision>



NoteThe Build VDS from Top-Level Assets workflow controller builds a VDS using only top-level assets that are found in the Translation - VDS Test project:

Sample Code

<BuildDeepVision xmlns='http://schemas.righthemisphere.com/2009/May/BuildDeepVision' Name='Skateboard - Top Level Assets' Project='Translation - VDS Test' FilePath='\\localhost\_VDSOutput\Skateboard - Top Level Assets.rh'> <Contents> <Assets TopLevels='true'/> </Contents></BuildDeepVision>

NoteThe Build VDS from Folder workflow controller builds a VDS using top-level absolute instances from project Translation - VDS Test that are located in the Folder1\Folder2\Folder3 folder path.

NoteSubfolders are always included.

Sample Code

<BuildDeepVision xmlns='http://schemas.righthemisphere.com/2009/May/BuildDeepVision' Name='Skateboard - Top Level Assets' Project='Translation - VDS Test' FilePath='\\localhost\_VDSOutput\Skateboard - Folders.rh'> <Contents> <Folders ContentType='AbsoluteInstance'> <Folder Name='Folder1\Folder2\Folder3' TopLevels='true'/> </Folders> </Contents></BuildDeepVision>

NoteThe Build VDS from Absolute Instances workflow controller builds a VDS using only absolute instances with specified SAP 3D Visual Enterprise Generator IDs that are found in the Translation - VDS Test project:

Sample Code

<BuildDeepVision xmlns='http://schemas.righthemisphere.com/2009/May/BuildDeepVision' Name='Skateboard - 2 Absolute Instances' Project='Translation - VDS Test' FilePath='\\localhost\_VDSOutput\Skateboard - 2 Absolute Instances.rh'> <Contents> <AbsoluteInstances> <AbsoluteInstance Id="3012" /> <AbsoluteInstance Id="3040" /> </AbsoluteInstances>


</Contents></BuildDeepVision>

NoteThe Build VDS from Selectors workflow controller builds a VDS using only selectors that have the PLM external system name (partner name), specified UIDs, and are found in the Translation - VDS Test project:

Sample Code

<BuildDeepVision xmlns='http://schemas.righthemisphere.com/2009/May/BuildDeepVision' Name='Skateboard - 2 Selectors' Project='Translation - VDS Test' FilePath='\\localhost\_VDSOutput\Skateboard - 2 Selectors.rh'> <Contents> <Selectors PartnerName="PLM"> <Selector Uid="SB_CompleteTrucksWithWheelsBack"/> <Selector Uid="SB_CompleteTrucksWithWheelsFront"/> </Selectors> </Contents></BuildDeepVision>

NoteThe Build VDS from Parts workflow controller builds a VDS using only parts that have the PLM external system name (partner name), specified UIDs, versions, revisions and are found in the Translation - VDS Test project:

Sample Code

<BuildDeepVision xmlns='http://schemas.righthemisphere.com/2009/May/BuildDeepVision' Name='Skateboard - 2 Parts' Project='Translation - VDS Test' FilePath='\\localhost\_VDSOutput\Skateboard - 2 Parts.rh'> <Contents> <Parts PartnerName="PLM"> <Part Uid="SA_CompleteTruckWithWheelsIA Front" Ver="V1" Rev="R1" /> <Part Uid="SA_CompleteTruckWithWheelsIA Back" Ver="V1" Rev="R1" /> </Parts> </Contents></BuildDeepVision>

NoteThe Build VDS from Assets workflow controller builds a VDS using only assets that have specified SAP 3D Visual Enterprise Generator IDs and versions and are found in the Translation - VDS Test project.

Sample Code

<BuildDeepVision xmlns='http://schemas.righthemisphere.com/2009/May/BuildDeepVision' Name='Skateboard - 2 Assets'



Project='Translation - VDS Test' FilePath='\\localhost\_VDSOutput\Skateboard - 2 Assets.rh'> <Contents> <Assets> <Asset AssetId="18194" AssetVer="0" /> <Asset AssetId="18201" AssetVer="0" /> </Assets> </Contents></BuildDeepVision>

NoteThe Build VDS with Exclusions workflow controller builds a VDS using only top-level absolute instances found in the Translation - VDS Test project that do not have the specified SAP 3D Visual Enterprise Generator IDs:

Sample Code

<BuildDeepVision xmlns='http://schemas.righthemisphere.com/2009/May/BuildDeepVision' Name='Skateboard - Top Level Absolute Instances - Exclude 1' Project='Translation - VDS Test' FilePath='\\localhost\_VDSOutput\Skateboard - Top Level Absolute Instances - Exclude 1.rh'> <Contents> <AbsoluteInstances TopLevels='true'> <Exclude> <AbsoluteInstance Id="3012" /> </Exclude> </AbsoluteInstances> </Contents></BuildDeepVision>

2.3.2.1.17 Select Step Derivatives Workflow Controller

Use

The Select Step Derivatives workflow controller is a controller that allows multiple derivatives to be built for each asset version in the input file.

The Select Step Derivatives workflow controller uses metadata applied to viewports in the asset versions specified in its input to determine which derivatives should be built. It matches the names of the derivative type instances in the derivative group with the names of metadata fields applied to a viewport in order to determine which derivatives will be built using the view of the asset specified by the viewport. Multiple derivatives can be built for each viewport for each asset in the input by applying multiple metadata fields to the viewport. The Select Step Derivatives workflow controller instructs the Build Derivatives workflow controller to create one secondary derivative for each metadata field (from a specific metadata category – Publishing by default) applied to a viewport. The name of each metadata field applied to a viewport is used to look up a derivative type instance by name. The derivative group specified for each asset in the input file is searched to find the matching derivative type instance.


When the Select Step Derivatives workflow is invoked by another workflow, the Default Derivative workflow setting for the parent workflow is typically be used for all the assets in the input file.

When the Create Derivative from Collection function is invoked, the derivative group for all the assets is selected by the user at the time Create Derivative from Collection function is invoked.

Features

The startup argument for the Select Step Derivatives workflow controller is the following:



InputFilePath An input XML file with the http://schemas.righthemisphere.com/2009/DeepServer/Processing/SelectDerivatives/Request schema. For each asset version, the asset ID, asset version, asset name, derivative group and optionally a path to a master derivative are included.

2.3.2.1.17.1 Starting Select Step Derivatives Workflow Controller

Use

Workflows using the Select All Derivatives workflow controller can be used to start jobs as follows:

● As child jobs of Asset Upload jobs● By creating derivatives from collections

NoteIt is also possible to invoke the Select All Derivatives jobs directly through API calls and using hot folders.

Procedure

When a Select Step Derivatives workflow is configured as a child job of an Asset Upload workflow (or some other workflow that supports Select Step Derivatives child jobs), a Select Step Derivatives job is invoked automatically after the new asset versions have been built successfully.

When a Select Step Derivatives workflow has been created and one or more derivative groups have been created, it is possible to use the Select Step Derivatives workflow to create derivatives from a collection.



To start a Select All Derivatives job using Derivatives from Collection functionality, proceed as follows:

1. Browse or search assets in SAP Visual Enterprise Access.

2. Choose to add assets to the current collection.

3. Choose .4. Select the Select Step Derivatives workflow.5. Select a Derivative Group.6. Choose OK.

One derivative for each derivative instance in the selected derivative group is created for the most recent asset versions of each asset in the collection.

2.3.2.1.17.2 Configuration of Select Step Derivatives

Use

You use this process to configure a Select Step Derivatives workflow.

Process

To configure SAP 3D Visual Enterprise Generator to allow Select Step Derivatives jobs to be triggered using Create Derivatives From Collection functionality, proceed as follows:

1. Open SAP 3D Visual Enterprise Generator Administration.2. Create one or more derivative groups, if no derivative groups exist (see Creating Derivative Groups [page

556]).3. Create a Build Derivatives workflow, if no Build Derivatives workflow exists (see Creating Build Derivatives

Workflow [page 626]).4. Create a Select Step Derivatives workflow, if no Select All Derivatives workflow exists (see Creating Select

Derivatives Workflow [page 627]).5. Configure the Build Derivatives workflow as a child workflow of the Select Step Derivatives workflow (see

Creating Workflows [page 532]).

To configure SAP 3D Visual Enterprise Generator to use the Select Step Derivatives workflow for Asset Upload jobs, proceed as follows after performing all the steps above:

1. Create an Asset Upload workflow (see Configuring Asset Upload Workflow [page 36]).2. Configure the Select Step Derivatives workflow as a child workflow of the Asset Upload workflow (see

Creating Workflows [page 532]).3. Specify a derivative group for the Default Derivative Group workflow setting for the Asset Upload workflow


2.3.2.1.17.3 Select Step Derivatives Processes

The PLM Translation workflow controller uses the Select Step Derivatives – Derivative Selection process (Process Slot: Derivative Selection) to do the following for each asset:

● Loops through each viewport● Extracts viewport metadata from the master derivative● Adds an entry to the response for each metadata field (in the appropriate metadata category) that is

applied to a viewport● Tags viewports in the master derivative file that have metadata with a GUID to allow the Build Derivatives

workflow to identify them.

NoteYou can modify the process to allow a metadata category other than Publishing to be used to identify the metadata fields that are intended to match names of derivative type instances.

2.3.2.1.17.4 Select Step Derivatives Processing Steps

Use


1. Validate Input2. Derivative Selection3. Build Derivatives

Features

Validate Input

Ensures that the required job startup arguments are supplied and the input file can be parsed

Derivative Selection

Queues the following tasks:

● Extracts the viewport metadata from the master derivatives for the asset versions in the input file● Tags the viewports in the master derivative file with GUID IDs (so that the Build Derivatives workflow can

identify match viewports in the master derivative file with those in the Build Derivatives input XML file● Builds an XML file to be used as input to a Build Derivatives workflow

Build Derivatives

Invokes and waits for the completion of a Build Derivatives child job.



NoteThe Builds All Selected Derivatives child workflow slot should be configured with a Build Derivatives workflow.

2.3.2.1.17.5 Select Step Derivatives Input File Format

Code Syntax

<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://schemas.righthemisphere.com/2010/DeepServer/SelectStepDerivatives/DerivativeSelection/Request" elementFormDefault="qualified" attributeFormDefault="unqualified" xmlns="http://schemas.righthemisphere.com/2010/DeepServer/SelectStepDerivatives/DerivativeSelection/Request"> <xs:element name="Request"> <xs:complexType> <xs:sequence> <xs:elementname="SelectAssetVersionDerivativesRequest"minOccurs="1"maxOccurs="unbounded"> <xs:complexType> <xs:attribute name="AssetId" type="xs:integer" use="required"/> <xs:attribute name="AssetVersion" type="xs:integer" use="required" /> <xs:attribute name="AssetName" type="xs:string" use="required" /> <xs:attribute name="DerivativeGroupName" type="xs:string" use="required" /> <xs:attribute name="MasterDerivativeFilePath" type="xs:string" use="optional" /> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element></xs:schema>

2.3.2.1.17.5.1 Select Step Derivatives Sample Input File

NoteA sample file is the following:

Sample Code

<?xml version="1.0" encoding="utf-8"?> <SelectDerivativesRequest xmlns="http://schemas.righthemisphere.com/2009/DeepServer/Processing/SelectDerivatives/Request">


<AssetVersionDerivativesRequestDerivativeGroup="Publishing"AssetId="314"AssetVersion="0"AssetName="BACN11N5CS" /> <AssetVersionDerivativesRequestDerivativeGroup="Publishing"AssetId="317"AssetVersion="0"AssetName="BACN11N4CS" /></SelectDerivativesRequest>

2.3.2.1.18 Subscriptions and Notifications Reporting Workflow Controller

Use

The Subscriptions and Notifications Reporting workflow controller is the first of two controllers that form part of the Subscriptions and Notifications feature.

This workflow controller is used as a scheduled process that is configured to generate and send reports to users daily. Generation of individual reports for users is achieved by invoking a second workflow controller: Process User Report for each user with pending notifications.

The Subscriptions and Notifications Reporting workflow controller is also responsible for the clean up of reporting records in the repository. Cleanup is performed to remove old event records from the database. The workflow controller also acts as a central point for all process reporting, and displays information about users who have been sent notification, notifications that have been skipped, and reasons for doing so.

Features

You can configure the following settings for the Subscriptions and Notifications Reporting workflow controller:

Setting Default Description

Maximum age of data 90 All data older than the specified age will be cleaned up (in days).

Report format HTML Format in which to send reports



2.3.2.1.18.1 Starting a Subscriptions and Notifications Reporting Controller

Context

Workflows using the Subscriptions and Notifications Reporting workflow controller can be used to start jobs as follows:

● Scheduled process● On demand (diagnostic purposes only)

2.3.2.1.18.2 Configuring a Subscriptions and Notifications Reporting Workflow

Prerequisites

1. All Subscription processes are loaded (see Subscriptions and Notifications Reporting Processes [page 174]).

2. You have configured the Process User Report workflow.

Procedure




4. Enter Subscriptions and Notifications Reporting workflow controller in the Controller field.5. Select the Process User Report as a child job workflow. and choose OK.


2.3.2.1.18.3 Subscriptions and Notifications Reporting Processes

The Subscriptions and Notifications Reporting workflow controller uses the following processes:

● jmp_Subscriptions_GatherData (Process Slot: Gather Data)Used to locate users with pending notifications

● jmp_Subscriptions_CleanUp (Process Slot: Clean-Up)Once report processing is complete, this process cleans up older records.

2.3.2.1.18.4 Subscriptions and Notifications Reporting Job Steps

The following processing steps are performed by the Subscriptions and Notifications Reporting workflow controller:

1. Gather DataThis step will spawn gather data process and collect data about all users that have pending notifications.

2. Spawn Child JobsChild workflows are spawned, for a user, to process their notifications, sending the reports to them, if required. Note that only one child job can run at one time.

3. Clean UpAfter processing is complete, the process for cleanup is invoked to remove old event records.

4. ReportThis step builds the Job Report, using data from previous steps.

2.3.2.1.19 System Maintenance Workflow Controller

You can use the System Maintenance workflow controller to perform system maintenance tasks.

Features

The configurable setting for the System Maintenance workflow controller is the following:

System Maintenance: Configurable Setting

Setting Description

Cleanup Batch Size The maximum number of folder, asset, version, or derivative records to clean per batch. Default: 100

The System Maintenance workflow controller does not have any startup arguments.



2.3.2.1.19.1 Starting System Maintenance Workflow Controller

The System Maintenance workflow controller can be used to start jobs using an SAP 3D Visual Enterprise Generator scheduled activity. To do this, proceed as follows:

● Configure an SAP 3D Visual Enterprise Generator scheduled activity, selecting the required System Maintenance workflow.

For more information, see Scheduled Activities Panel [page 498].

2.3.2.1.19.2 Configuring a System Maintenance Workflow

To configure SAP 3D Visual Enterprise Generator to process System Maintenance jobs, proceed as follows:



NoteThe name can be the same as the workflow controller name.

4. Enter System Maintenance workflow controller in the Controller field.5. Select the Assembly classification and choose OK.

2.3.2.1.19.3 System Maintenance Processes

The default processes for the System Maintenance workflow controller are the following:

● System Maintenance – Get Records To Purge (process slot: Get Records To Purge)Gets database records marked for deletion

● System Maintenance – Prepare Records To Archive (process slot: Prepare Records To Archive)Prepares database records marked for deletion for archiving

● System Maintenance – Archive Records (process slot: Archive Records)Archives database records marked for deletion

● System Maintenance – Purge Records (process slot: Purge Records)Purges database records marked for deletion


2.3.2.1.19.4 System Maintenance Processing Steps

The following processing steps are performed by the System Maintenance workflow controller:

● Checking SecurityThis step validates that the user executing the job has System Administrator rights.

● Getting RecordsThis step retrieves the folder, MBOM, asset version and asset records marked as deleted from the database.

● Preparing Records to ArchiveThis step prepares records for archiving. The step is skipped if the Archive Location controller setting is not specified.

● Creating Archiving BatchesThis step creates archiving batches containing up to the Cleanup Batch Size controller setting value records per batch. The step is skipped if the Archive Location controller setting is not specified.

● Archiving RecordsThis step archives records. The step is skipped if the Archive Location controller setting is not specified.

● Creating Processing BatchesThis step creates processing batches containing up to the Cleanup Batch Size controller setting value records per batch.

● Purging RecordsThis step purges records from the database.

● Getting BLOB RecordsThis step retrieves the BLOB records marked as deleted from the database.

● Creating BLOB Processing BatchesThis step creates BLOB processing batches containing up to the Cleanup Batch Size controller setting value records per batch.

● Purging BLOB RecordsThis step purges BLOB records from the database.

2.3.2.1.20 Universal Process Workflow Controller

Use

You use the Universal Process workflow controller to execute SAP 3D Visual Enterprise Generator processes in the context of a managed job, so that SAP 3D Visual Enterprise Generator processes can be used everywhere that jobs can be used.



Features


Setting Description

Default Process Name The default process to execute if the Process Name startup argument is not provided

The only process executed by the workflow controller is the process passed through as a startup argument or configured in the Default Process Name setting.

The startup argument for the Universal Process workflow controller is the following:


Process Name The name of the SAP 3D Visual Enterprise Generator process to execute

The output arguments for the Universal Process workflow controller are the following:


ProcessSuccessful Indicates whether the process executed successfully.

Default value: false.

ProcessResultMessage The result message

Activities

Starting a Universal Process Job Using Completion Workflows

Add a Universal Process workflow as a pre or post completion workflow, and click Arguments to select the process that will run

Starting a Universal Process Job From a SAP 3D Visual Enterprise Generator Web Service API Call

Call JobStart() on VEGenerator7.asmx, passing through the process name in the ProcessName startup argument.

2.3.2.1.20.1 Configuring Universal Process Workflow

To configure SAP 3D Visual Enterprise Generator to process Universal Process jobs, proceed as follows:

1. Open SAP 3D Visual Enterprise Generator Administration, and select the Server Configuration node.


2. Select the Workflows node in the Server Configuration panel.3. Choose New in the Workflows panel. The Create Workflow window opens.4. Select the Universal Process workflow controller in the Controllers field.5. Enter a name for the workflow and choose OK.

NoteYou can use the same name as the job controller name.

6. If required, navigate to the Settings panel and select a Default Process Name from the dropdown list provided.

2.3.2.1.20.2 Universal Process Processing Steps

Use

The following processing steps are performed by the Universal Process workflow controller:

● Validate InputThe workflow controller validates that all required startup arguments are present.

● Execute ProcessThe workflow controller executes the process in SAP 3D Visual Enterprise Generator.

Activities

Mapping Startup Arguments Onto Process Trigger Parameters

You can have the workflow controller set trigger parameters on the executed process. To do this, add a custom parameter to the workflow startup arguments, prefixed with trigger, and followed by the name of the trigger parameter.

Example

Field Value

Process Name Derivative-SVG

trigger.filename $startup:InputFilePath

You can use expansion variables in the parameter values. In the example above, the value of the InputFilePath startup argument of the parent job will be set on the filename parameter of the Derivative – SVG process.



The expansion variables are described below:

Variable Expands To

$startup:NAME The value of the startup argument NAME, of the parent job

$output:NAME The value of the output argument NAME, of the parent job

$ParentJobId The job ID of the parent job

$ParentUserId The user ID of the parent job

2.3.2.1.21 Visual Data Integration Workflow Controller

The Visual Data Integration workflow controller (VDI) analyzes and converts CAD assets managed by an external Product Data Management system (PDM) into a configured DMS Document type. Visual Enterprise Document (VED) is the default document type. Document Info Records (DIR), document BoM and viewables (generated visual representations of the asset) are the primary output of the workflow. The workflow stores outputs in the appropriate structure in the configured system.

Features

You can use the following mechanisms to trigger the Visual Data Integration workflow:

Mechanism Functional Description

SAP PLM Triggered or manual submission of CAD assets managed by SAP PLM system through the DMS SAP 3D Visual Enterprise Generator conversion services

External PDM system Triggered or manual submission of CAD assets managed by an external PDM system through the VDI API service

VDI Upload Client Manual upload of CAD assets from a file system

The following CAD file formats are supported by the workflow:

● Creo Neutral (.neu)● JT (.jt)● NX (.prt)● Solid Edge (.par, .asm)● Solidworks (.sldasm, .sldprt, .asm, .prt)● Inventor (.ipt)● Catia v5 (.catproduct)


The default VED output contains the following viewables:

● An RH file● A JPG file● A GIF file

Child Workflows

You can configure the workflow to create more derivatives. You can configure processes and child workflows based on workflow controller settings.

The default child workflows are the following:

Workflow Mandatory Functional Description

Generic conversion Yes Takes as input an XML document in Visual Data Integration manifest format that points to translatable files in a shared storage location or a ZIP file that contains an XML document in Visual Data Integration manifest format and all the translatable files to which this document points. From this input data, the workflow controller converts translatable files to SAP viewables. It optionally creates derivatives from the viewables, creates CAD structure XML in public schema VZXML format, and stores the SAP viewables, derivatives, CAD structure XML, and response XML in the shared storage location.

Retrieve documents Yes Specifies a configured instance of the Download Files workflow controller. If the source of files for conversion is a PDM, the Download Files controller retrieves files from an external file store (see Download Files Workflow Controller [page 71]).

Store documents in KPRO Yes Specifies a configured instance of the KPRO Store workflow controller, and stores files in KPRO

Workflow Settings

You can specify the following workflow settings:

Field Description

Default Derivative Group Selects 2D Drawing or 3D Standard

Manual ERP Lock Release Process Selects the process for releasing locks



Field Description

ERP Connection Specifies details of the ERP Connection as follows:

● SAP System Connection: The SAP system to which this workflow should connect

● DIR Extraction Mode: The source of the DIR identifier for document storage in ERP:○ System Provided: Default logic is used○ PDM Identifier: The PDM identifier is used○ Script: Python function ExtractDIRCustom in the

Python script associated with the createDIRs operation is used

● Project name: The project to use for locking and authentication lookup

● Storage Category: The storage category to use when storing viewables in DMS

● Instance ID: The SAP 3D Visual Enterprise Generator Instance ID as configured in SPRO that points to this machine

● DMS File Path Prefix: The file path prefix used when storing files in the DMS

● DIR Creation Mode: Specifies the way that DIRs are created for viewables.○ Default: Determined based on file format used.○ New: New DIRs are created.○ UseSource: Uses source DIRs. This flag is used only

for SAP PLM workflows.

PDM ID Extraction Specifies PDM ID extraction details as follows:

● PDM ID Extraction Mode: If there are no PDM identifiers in the VDI manifest file, the source of PDM identifier in CAD data to be used○ EntityName: CAD component names are used○ EntityMetadata: CAD component metadata value

of the category and key specified in parameters for extraction of PDM IDs

○ Script: ExtractPdmIdentifiers function in the Python script associated with the ExtractDocumentStructure operation is used

● PDM ID Metadata Category: If PDM ID Extraction Mode is set to EntityMetadata, the metadata category to use

● PDM ID Metadata Key: If PDM ID Extraction Mode is set to EntityMetadata, the metadata key to use


Field Description

PDM Version Extraction Specifies PDM version extraction details as follows:

● PDM Version Extraction Mode: If there is no matching PDM version in the VDI manifest file, the source of PDM version in CAD data to be used○ Disabled: This parameter is omitted○ EntityMetadata: CAD component metadata value

of the category and key specified in parameters for extraction of PDM version information

○ Script: ExtractPdmVersion function in the Python script associated with the ExtractDocumentStructure operation is used

● PDM Version Metadata Category: If PDM Version Extraction Mode is set to EntityMetadata, the metadata category to use

● PDM Version Metadata Key: If PDM Version Extraction Mode is set to EntityMetadata, the metadata key to use

PDM Configuration Extraction Specifies PDM configuration extraction details as follows:

● PDM Configuration Extraction Mode: If there is no matching PDM configuration in the VDI manifest file, the source of PDM configuration in CAD data to be used○ Disabled: This parameter is omitted○ EntityMetadata: CAD component metadata value

of the category and key specified in parameters for extraction of PDM configuration information

○ Script: ExtractCadConfiguration function in the Python script associated with the ExtractDocumentStructure operation is used

● PDM Version Metadata Category: If PDM Configuration Extraction Mode is set to EntityMetadata, the metadata category to use

● PDM Version Metadata Key: If PDM Configuration Extraction Mode is set to EntityMetadata, the metadata key to use



Field Description

SAP Material Extraction Specifies material extraction details as follows:

● Material Extraction Mode: If there is no matching material in the VDI manifest file, the source of material in CAD data to be used○ Disabled: This parameter is omitted○ EntityMetadata: CAD component metadata value

of the category and key specified in parameters for material extraction is used

○ Script: EntitySapMaterialId function in the Python script associated with the ExtractDocumentStructure operation is used

○ ScriptOrEntityMetadata: Either method is used● Material Metadata Category: If Material Extraction Mode

is set to EntityMetadata or ScriptOrEntityMetadata, the metadata category to use

● Material Metadata Key: If Material Extraction Mode is set to EntityMetadata or ScriptOrEntityMetadata, the metadata key to use

● Automatically Create SAP Materials: If one does not exist, automatically creates a SAP material


Field Description

KPRO Storage Specifies KPRO settings:

● Maximum KPRO Store Attempts: The maximum number of times a child job is launched to store documents into KPRO. This setting only applies to consecutive failed attempts (no files were stored). The default value is 3.

● Maximum Files per KPRO Task: The maximum number of files each parallel KPRO task processes. Setting to a high number; for example, 1000, causes KPRO Retrieve and Store child jobs to process files in a single task, lightening the load on the KPRO service. Setting to 1 causes KPRO Retrieve and Store child jobs to process all files in parallel increasing the load on the KPRO service. The default value is 3.

● Storage Policy: The policy to use when storing viewables and derivatives.○ TopLevelOnly: Stores only top-level requested view

able and derivatives.

NoteIf TopLevelOnly is selected, and BuildStructure is Shattered, conversions must have occurred for all items in a hierarchy before it is displayed to users.

○ All: Stores all requested viewables and derivatives. All is the default setting.



Field Description

Generic Conversion Specifies the settings for generic conversion:

● Conversion Type: The type of conversion for input data.○ Monolithic: a generic viewable is produced for each

element in the scene tree○ Shattered: a shattered viewable is produced for

each element in the scene tree○ Default

● Viewable Type: The type of viewable required.○ RH: binary RH format○ VDS: VDS4 format○ Default

● Viewable Build Failure Policy: Defines the action taken when an item fails to build, and decides whether to treat the failure as a warning or an error:○ Warning (default): A warning is logged, but the job

continues, and creates an empty placeholder for the failed item

○ Error: Prevents further production of viewable outputs

● Derivative Build Failure Policy: Defines the action taken when an item fails to build, and decides whether to treat the failure as a warning or an error:○ Warning (default): A warning is logged, but the job

continues, and stores all built viewables○ Error: Prevents further production of viewable out

puts● CAD Structure Extraction Failure Policy: Defines the ac

tion taken when a structure fails to extract, and decides whether to treat the failure as a warning or an error:○ Warning (default): A warning is logged, but the job

continues with the successful extractions, if any○ Error: The job fails

● Missing CAD Files Policy: Defines the action taken when an item is missing, and decides whether to treat the failure as a warning or an error:○ Warning (default): A warning is logged, but the job

continues and the items are skipped when building viewables

○ Error: The job fails● Extract all Configurations if None Specified: If no config-

urations are specified in the request, indicates whether to extract all configurations from the CAD file. If set to


Field Description

False, and no cofigurations are specified in the request, only the last saved configuration is extracted.

● Use Original File Cache: Uses the cache when retrieving originals

● Use Viewable File Cache: Uses the cache when building viewables

● Extract Assembly Level Feature File: If present, extracts the assembly level feature file alongside the shattered VDS viewable

● Enable ERP Simulation: Uses a simulation of ERP and stores all files locally

More Information

For more information about Visual Data Integration, see the Installation Guide at http://help.sap.com/SAP 3D Visual Enterprise Generator SAP 3D Visual Enterprise Generator [version number] Installation

Guide for SAP 3D Visual Enterprise Generator .



http://help.sap.com/disclaimer?site=http%3A%2F%2Fhelp.sap.com%2F

2.3.2.1.21.1 Configuring the Visual Data Integration Workflow

Use

Determine the way in which the VDI job is Triggered in SAP 3D Visual Enterprise GeneratorThere are several methods in which a VDI workflow controller job can be triggered:

Method Description Comments

SAP 3D Visual Enterprise Generator standard hot-folder

SAP 3D Visual Enterprise Generator can be set up to monitor a folder on the file system.

Whenever a file of a specific extension appears in that folder, a specific SAP 3D Visual Enterprise Generator workflow controller job is started. The file that triggered the event is supplied to the started job.

The hot-folder approach can be used in cases where:

● it is problematic to write code that calls the web service

● some kind of file can be supplied as the input message into the VDI workflow

It is more limiting than the web service approach in terms of functionality. For example, there is only one ERP technical user configured per VDI workflow instance who creates and manages all the SAP DMS document info records.

Web service API SAP 3D Visual Enterprise Generator web API web service that can be used to initiate VDI workflow job and supply all the required information to it

Submitting jobs using the web service API provides the most flexibility, but there is additional work required on the caller side. Code must be written that calls a web service and passes in all required data.

This method potentially allows for the following:

● choosing between different VDI workflow controller instances

● passing in potentially different SAP ERP authentication credentials for different users

● passing in all the required CAD files● retrieving VDI workflow job reports

upon job completion


Method Description Comments

VDI Upload Client tool Uses the Upload Client to perform the following:

● load the CAD data manually● select configurations they want to

process● start a VDI workflow job on SAP 3D

Visual Enterprise Generator for selected data

● monitor the job progress

The VDI Upload Client approach is easy to use for testing and proof of concept purposes. It cannot, however, be automated. A user action is always required to submit a job.

Choose the Appropriate Input Message for the VDI Workflow

The VDI workflow internally uses the VDI input xml format to handle input data. This xml format supports either of the fully resolved structure modes.

VDI input xml format is publicly available, and is the default method of supplying input to VDI workflow. However, if the external PLM or PDM system is supplying a file as an input that is not in this format, it is possible to convert the input file into the VDI input xml format in the VDI workflow job. This can be done through a standard extension point.

If the input data is “fully resolved” in terms described above, the VDI Workflow Manifest ultimately has a different content and structure than if the input data is not “fully resolved”. Each of the cases is processed in a different way.

If there is a requirement to reuse previously built viewables, and not to send all the CAD files every time, input data must be “fully resolved”. If data is not “fully resolved” and if the VDI workflow must perform inference of the assembly structure from CAD files, you cannot reuse previously built viewables. In a reuse scenario, it is possible to send batches of part files to be prebuilt for later reuse.

Choose the Appropriate VDI Workflow Configuration

SAP 3D Visual Enterprise Generator comes with some pre-installed VDI workflow instances. Each of these instances corresponds to a particular type of workflow. Some of those instances will work out-of-the-box and some are provided as starting point and require further customizing

Workflow Functional Description

Visual Data Integration (SAP PLM SolidWorks Integration) Supports SAP PLM SolidWorks integration, should work out-of-the-box, but additional customizations may be required depending on specific customer needs

Visual Data Integration (Resolved Structure) A workflow instance that can be used as a starting point for “fully resolved structure supplied” mode.

Visual Data Integration (Structure Extracted from CAD) A workflow instance that can be used as a starting point for “fully resolved structure extracted from CAD files” mode.



Workflow Functional Description

Visual Data Integration (PLMXML) A workflow instance that can be used as a starting point for integration with PLMXML referencing JT CAD files. Additional customization is necessary for it to be used.

There is an example extension point or python script that transforms PLMXML xml into VDI input manifest xml. This script can be extended to support actual customer PLMXML implementation.

NoteThis workflow assumes that the input PLMXML and JT data is “fully resolved”.

Visual Data Integration (Upload Client) Supports the VDI Upload Client input mode. This workflow instance has been configured to work out-of-the box – the default configuration uses the CAD file and configuration name as external PDM system identifier.

This workflow can be customized to use other data available in the CAD file to determine the external PDM system identifier.

Set up the Connection to ERPThe VDI workflow relies on being able to communicate with SAP ERP. For this connection to work correctly, you must ensure the following:

1. SAP GUI is installed on the machine on which SAP 3D Visual Enterprise Generator is running2. SAP GUI has all the connections that are used to connect to ERP configured for the user account on which

SAP 3D Visual Enterprise Generator is running3. Once the above conditions are fulfilled, the SAP systems that were configured in SAP GUI can be used in

the SAP Integration/Connections pane. A new connection to that SAP system can be successfully created.4. A correct SAP client must be specified for each created ERP connection.

RecommendationWe recommend that each ERP system and client combination has a different SAP 3D Visual Enterprise Generator project associated to it. This association means that for each ERP connection in SAP Integration/Connections pane in SAP 3D Visual Enterprise Generator Administrator there should be a corresponding SAP 3D Visual Enterprise Generator project created.

5. Setting up authentication: valid ERP username and password with privileges that allow creating and updating SAP DMS documents must exist on the ERP system that is associated with VDI workflow instance through a previously created Connection.


There are two ways in which a VDI workflow can be set up to pass in these credentials:

Method Description

Upload Client or Integration using web services Upload Client user or web service caller passes credentials to ERP for authentication via SAP 3D Visual Enterprise Generator.

The authentication is close to direct authentication of the calling user on the ERP system that results in an open ERP connection that the VDI workflow and SAP 3D Visual Enterprise Generator uses to store the data.

Hot-folder integration (or a web service integration where credentials are not passed through)

An ERP username and password is associated with an ERP connection using the SAP Integration/User Names and passwords pane in SAP 3D Visual Enterprise Generator Administrator.

The username and password pair is stored in the SAP 3D Visual Enterprise Generator database encrypted, and it is associated with an ERP system connection using the SAP 3D Visual Enterprise Generator project.

6. Each VDI workflow instance configuration must specify a previously configured SAP Integration or Connection and an existing SAP 3D Visual Enterprise Generator project in its Workflow Settings. Username and password credentials are typically stored at the SAP 3D Visual Enterprise Generator project level.

More Information


2.3.2.1.21.2 Visual Data Integration Processes

You can configure the following processes for the Visual Data Integration controller:


Validate Input Performs basic validation on the input into the workflow. For Upload Client workflows, the uploaded archive is extracted to job workspace. Reports to SAP ERP that the job started.




Prepare for Processing If files must be downloaded, creates the requests for downloading files. The files are actually downloaded in a child job after this step. If the input file is not in the Visual Data Integration input manifest format, the input file is transformed into Visual Data Integration input manifest. You can also enrich the Visual Data Integration input manifest with additional information by connecting to external systems.

Prepare for assembly structure extraction Validates the input manifest and chooses the top-level CAD configurations that are built in the job. If the source file format is PTC or CREO, and all configurations are selected for building, the step starts ProExplorer or CREO to identify available configurations.

Determine Document Structure to Create or Update Creates build structure from Visual Data Integration input manifest, CAD files, or files supplied by upload client. In this step, there are extension points for specifying document structure, materials, characteristics, and document attributes. The build structure holds all data about the structures that are created in SAP ERP and the viewables that are built and stored in SAP ERP.

Validate Document Structure (after preparation) Validates that the document structure determination phase completed successfully. As an extension point, it is possible to add validation related to business logic.

SAP ERP Locking Uses PDM Identifiers from the build structure to obtain locks on documents in SAP ERP

Create new DIRs and read existing DIR Data Enriches the VDI processing structure with data from SAP ERP. If they exist, existing SAP ERP document structures are reused, or if they do not, new ones are created.

Validate Document Structure Validation of the VDI processing structure after synchronizing with SAP ERP

Update DIR Structures and Properties Synchronizes SAP ERP structures with the updated VDI processing structure after viewable creation and creates requests to build derivatives on success

Validate Viewable Files Validates the current build structure in preparation for storage and creates KPRO store requests on success

SAP ERP Unlocking Unlocks documents previously locked in SAP ERP

Finalize job Performs cleanup work, if required, and reports the job outcome back to SAP ERP


For more information about Visual Data Integration, see the Installation Guide at http://help.sap.com/SAP 3D Visual Enterprise Generator SAP 3D Visual Enterprise Generator [version number] Installation

Guide for SAP 3D Visual Enterprise Generator .

2.3.2.1.21.3 Visual Data Integration Processing Steps

Use

The following processing steps are performed by the Visual Data Integration workflow controller:

● Validate Input● Prepare for Processing● Select Configurations● Extract Assembly Structure● Finalize Assembly Structure● Determine Document Structure to create or update● Validate Document Structure● SAP ERP Processing Lock● Create new DIRs and read existing DIR Data● Validate Document Structure● Prepare for Building Viewables● Update DIR Structures and Properties● Validate Viewable Files● Release Processing Locks● Finalize Job

Features

Validate Input

This step validates the input to the job controller. It also reports that the processing job has been started to the ERP instance that the VDI workflow uses to store viewables and document structures.

Process Used

● Visual Data Integration – Input Validation – standard process to be used in all workflow types

Input Transformation

This step differs among different workflow types. If the input file supplied by the external PDM system is not in the form of VDI input manifest xml; for example, the PLMXML and SAP PLM SolidWorks workflows, this step transforms the input file into the VDI input manifest format that can be processed further.

In this step it is also possible to enrich the Visual Data Integration manifest with additional information by connecting to external systems.




Processes Used

Process Description

Visual Data Integration – Input Transformation (Upload Client)

Process to be used with Upload Client workflow type

Visual Data Integration – Input Transformation (PLMXML) Process to be used with PLMXML workflow type

Visual Data Integration – Input Transformation (Resolved Structure)

Process to be used with Resolved Structure workflow type

Visual Data Integration – Input Transformation (Structure Extracted From CAD)

Process to be used with Structure Extracted From CAD workflow type

Visual Data Integration – Input Transformation (SAP PLM) Process to be used with SAP PLM SolidWorks workflow type

Retrieve Files

This optional step is triggered only if SAP 3D Visual Enterprise Generator downloads the CAD files to be used in conversion from an external location. The input transformation step creates a request xml document for the Download Files Workflow controller that is triggered as a child job of the VDI workflow controller job.

Create SAP ERP Build Structure

This step creates the VDI processing xml file. This file can be viewed as the “master blueprint” of what viewables are built by the workflow controller. It details how will they be tagged and ultimately, the DMS document structure in which the viewables are stored. The VDI build structure is created in a different way for each different workflow type, as the input data is different. For example, creating a build structure from VDI input, Visual Data Integration manifest xml, CAD files, or files supplied by upload client.

In this step, there are extension points for specifying document structure, materials, characteristics, and document attributes. For more details, see VDI workflow Integration guide and VDI workflow Quick Start Guide.

Processes Used

Process Description

Visual Data Integration – Build Structure Creation (Upload Client)

Process to be used with Upload Client workflow type

Visual Data Integration – Build Structure Creation (PLM XML)

Process to be used with PLMXML workflow type

Visual Data Integration – Build Structure Creation (Resolved Structure)

Process to be used with Resolved Structure workflow type

Visual Data Integration – Build Structure Creation (Structure Extracted from CAD)

Process to be used with Structure Extracted From CAD workflow type

Visual Data Integration – Build Structure Creation (SAP PLM)

Process to be used with SAP PLM SolidWorks workflow type


Validate SAP ERP Structure

This step validates the VDI processing xml file created that contains the blueprint of the target DMS document structure. Validation ensures that it is well formed and conforms to business rules that can be customized.

Processes Used

Process Description

Visual Data Integration – Build Structure Validation – After Transformation

Process to be used with all workflow types except SAP PLM SolidWorks

Visual Data Integration – Build Structure Validation – After Transformation (SAP PLM)


SAP 3D Visual Enterprise Generator Locking

This step performs locking on PDM identifiers within the SAP 3D Visual Enterprise Generator project configured under Workflow settings. All the external system PDM identifiers used by a job are checked against the specified project folder to determine whether they are in use. If none of the external PDM system identifiers are in use, the job marks all used external system PDM identifiers as used by it in the scope of SAP 3D Visual Enterprise Generator project and continues processing.

If any of the external PDM system identifiers is marked as used, the job waits, and periodically checks the availability of all external PDM identifiers. When they are all available, it continues processing. Locks obtained in this step are released automatically once the job finishes processing.

SAP ERP Locking

This step checks whether all external PDM identifiers are available for processing in the scope of SAP ERP instance SAP 3D Visual Enterprise Generator is using to store viewables and document structures.

This step is necessary if there are multiple instances of SAP 3D Visual Enterprise Generator using the same instance of SAP ERP. If any of the external PDM identifiers is in use, the job fails.

Process Used

● Visual Data Integration – ERP lock – process to be used with all workflow types

Synchronization of SAP ERP structure file with SAP ERP data

This step performs the following tasks:

● associates external system PDM identifiers and DIRs● creates new DIRs if there are no DIRs corresponding to an external system PDM identifier● modifies the VDI processing xml file to include DIR associations and any business data retrieved from SAP

ERP

These actions ensure that the data gets included in viewables that are produced.

Process Used

● Visual Data Integration – Synchronize Build Structure with ERP Data – process to be used with all workflow types



SAP ERP Structure ValidationThis step validates the VDI processing xml file created that contains the blueprint of the target DMS document structure. Validation ensures that the structure is well formed and conforms to business rules that can be customized. The step is repeated to verify that the previous synchronization step did not produce invalid data.

This step can perform a different validation than the one other Build Structure Creation steps by configuring it to use a different process.

Process Used

● Visual Data Integration – Build Structure Validation – After Synchronization – process to be used with all workflow types

Create build viewables requestThis step is responsible for creating an xml request for the Build Viewables Workflow Controller. The request is created based on the VDI processing xml file.

Process Used

● Visual Data Integration – Create Build Viewables Request – process to be used with all workflow types

Build viewablesThis step creates a child job to build viewables corresponding to the VDI processing xml for the job. It uses the request xml created in the previous step as input to it.

Synchronization of SAP ERP with SAP ERP structure fileThis step ensures that information present in the VDI processing xml matches exactly what is stored in ERP. Checks include document structures, materials, and other business data. The ERP side is synchronized with the contents of the VDI processing xml.

Processes Used

Process Description

Visual Data Integration – Synchronize ERP data with Build Structure

Process to be used with all workflow types except SAP PLM SolidWorks

Visual Data Integration – Synchronize ERP data with Build Structure (SAP PLM)


Build derivativesThis optional step builds derivatives configured in the Select Derivatives workflow using viewables built in the previous step.

SAP ERP Structure ValidationThis step validates the VDI processing xml file created that contains the blueprint of the target DMS document structure. Validation ensures that it is well formed and conforms to business rules that can be customized. The step is repeated to verify that the previous synchronization step did not produce invalid data.

This step can perform a different validation than the one other Build Structure Creation step by configuring it to use a different process. Typically, this step would verify that all the viewables have been built correctly.

Process Used


● Visual Data Integration – Build Structure Validation – Before Storage – process to be used with all workflow types

Store viewables

This step creates a KPRO Store workflow controller xml request that references the following:

● the viewables that were built in the Build Viewables step● the derivatives that were built in the Build Derivatives step● the target DIRs to store the viewables and derivatives as defined in VDI processing xml file

It then creates a KPRO Store workflow child job and passes the created request as input.

Release SAP ERP locks

This step releases the locks held by this job obtained in SAP ERP locking step.

Process Used

● Visual Data Integration – ERP Unlock – process to be used with all workflow types

Finalize job

This step performs finalization of the job and any cleanup work that might be required. It also reports that the processing job has finished to the ERP instance that the VDI workflow uses to store viewables and document structures.

Process Used

● Visual Data Integration – Finalize Job – process to be used with all workflow type

More Information

Visual Data Integration Processes [page 190]

2.3.2.1.21.4 Visual Data Integration Input Manifest XML Format

VDI input manifest xml file is the recommended way to specify the input data for the VDI workflow job. It is usually treated as a starting point by the VDI workflow in the process of determining the fully resolved assembly structure and accompanying metadata such as external system PDM ids, SAP material ids and others. In some cases, the VDI input manifest is provided directly to VDI workflow, and in some cases another type of file is provided to VDI workflow and through an extension points it gets converted into the VDI input manifest file. VDI input manifest xml file format has a well-defined xml schema that should be used to validate whether the file is correct.



VDI input manifest xml consists of following elements:

Elements

PDMStructure

This is the root element of the file. It must have one child from the set of following elements: BuildResolvedStructure, BuildCADStructure, BuildAllPdmDocuments. The choice of this element determines the type of the input: BuildResolvedStructure corresponds to fully resolved assembly structure mode, BuildCADStructure corresponds to fully resolved assembly structure needs to be inferred from CAD mode and finally, BuildAllPdmDocuments allows sending a collection of pdm documents that correspond to parts for conversion. PDMStructure element may have a single PdmDocumentsFromFile child element and a single Materials child element.

Attributes


ViewUp and ViewRight No Provides the ability to specifiy the direction of viewable scene up and right axes respectively. The value of these attributes should follow the convention “name of the axis (X or Y or Z)” followed by POS for positive direction or NEG for negative direction resulting in names like XPOS and YNEG. If these attributes are not provided, their values will be ZPOS for ViewUp and YPOS for ViewRight.

UnitOfMeasure. Yes Value is always Millimeter. This is to make it obvious that all the positional data supplied through this xml format will be assumed to be in millimeters.

Currently other units of measure are not supported.



NumberFormatCulture Yes Value is always Invariant. This is to make it obvious that all the number data supplied through this xml format will be assumed to be in en-US culture.

BuildResolvedStructure

The BuildResolvedStructure element should be used to pass fully resolved assembly structure. It has to have a single child element PdmDocumentInstances that is used to specify top level instances for the fully resolved assembly structure. It may have at most one PdmDocumentsWithChildren element that is used to describe fully resolved assemblies in the fully resolved assembly structure.

BuildCADStructure

The BuildCADStructure element should be used to pass information about all the necessary CAD files required to perform extraction of fully resolved assembly structure corresponding to the fully resolved assembly structure inferred from CAD mode.

Attributes


TopLevelDocumentRefs Yes Specifies one or more references to IDs of PdmDocumentFromFile elements.

It is used to specify what are the top level CAD files to be used to extract the fully resolved assembly structure. This way, it is possible to specify multiple top level assemblies in a single VDI input manifest xml

BuildAllPdmDocuments

The BuildAllPdmDocuments element should be used to mark that in the VDI input manifest file where it is present, all PdmDocumentFromFile elements should be treated as fully resolved parts and processed as such. This mode is intended to be used in conjunction with BuildResolvedStructure element.

PdmDocumentsFromFile

The PdmDocumentsFromFile element is used to represent a collection of Pdm documents that are associated with CAD files. This element can have any number of PdmDocumentFromFile child elements.

Materials

Thet Materials element is used to represent a collection of Material elements – it can have any number of Material child elements



Materials

The Material element represents an SAP material. Its parent is Materials element.

Attributes


ID Yes Uniquely identifies each Material element within the scope of the VDI input manifest document. The value of this attribute can be used to reference any Material element.

MaterialID Yes Stores the actual value of SAP Material identifier.

Maximum length is 18 characters.

PdmDocumentInstances

The PdmDocumentInstances element is a child element of BuildResolvedStructure element and it is used to specify instances of PdmDocumentWithChildren or PdmDocumentFromFile to be created as the top-level elements of the fully resolved assembly structure. It can have any number of Child child elements.

PdmDocumentsWithChildren

The PdmDocumentsWithChildren element is a child element of BuildResolvedStructure element and is used to represent a collection of assembly Pdm documents that have child documents. This element can have any number of Child child elements, and it corresponds to fully resolved structure mode.

PdmDocumentFromFile

The PdmDocumentFromFile element is a child element of PdmDocumentsFromFile element. It represents a CAD file to be used in the conversion process. Additional metadata associated to that CAD file can be represented by using any of the child elements: SapCharacteristics, SapDocumentAttributes, Metadata and MaterialRefs. Additional information on how to process this file can be supplied using the ProcessingFlags child element. PdmDocumentFromFile element cannot have children of type PdmDocumentFromFile – this is intentional because PdmDocumentFromFile assumes that the information from the CAD file should be used to resolve viewable assembly structure for that pdm document. If child pdm documents need to be specified for a pdm document explicitly, PdmDocumentWithChildren element should be used, and this is only possible in BuildResolvedStructure mode. PdmDocumentFromFile can have either AbsolutePath child element if the CAD file they are pointing to can be found on a network or local file system location accessible using a specified path, or CustomPath child element if the CAD file they are pointing to needs to be located and retrieved using an extension point.


Attributes


ID ID Yes Uniquely identifies a PdmDocumentFromFile element within the scope of VDI input manifest xml. PdmDocumentFromFile and PdmDocumentWithChildren share the same id space, so it is not possible to have PdmDocumentFromFile and PdmDocumentWithChildren elements with the same value for the id attribute. The value of this attribute is used to reference documents within a VDI manifest xml document.

Name String Yes Specifies a name for a Pdm Document. Maximum length of this attribute is 255 characters.

PdmIdentifier No Specifies the external Pdm system document identifier for a particular PdmDocumentFromFile element

PdmVersion No Specifies the external Pdm system document version for a particular PdmDocumentFromFile element




StoreOriginal Boolean No Stores the CAD original in DMS. The default value for this setting is false, and when the setting is true, the original CAD files are stored on the DMS VED document created. The AbsolutePath or RelativePath element used for specifying the CAD original must specify the WorkstationApplication and MimeType attributes. These should match with the Workstation application settings on ERP system for the CAD file type.

StoreViewable Boolean No Enables storing of viewables built by the workflow. The default value for the setting is true. When this setting is false, the viewable built for that element will not be stored.

PdmConfiguration No Specifies the external Pdm system configuration identifier for a particular PdmDocumentFromFile element

Status String No Supplies additional information about the particular status of the document in the source Pdm system; foe exmple, In work or Released.

The value of this attribute can be handled later in various extension points.

RelatedFiles

The RelatedFiles container element is defined as a child of PdmDocumentFromFile or PdmDocumentWithChildren and enables you to specify any additional files that should be stored in the SAP ERP system. This element can contain any number of child elements of type AbsolutePath or RelativePath. The files referenced by these elements are stored as-is without any modification on the VED DMS document. These path elements must specify WorkstationApplication and MimeType attributes for the files to be stored.


Child

Child element is used to represent a parent relative instance of a PdmDocumentWithChildren or a PdmDocumentFromFile. Child element can be child of PdmDocumentInstances or PdmDocumentWithChildren elements and that means it can be used only in BuildResolvedStructure mode.

Attributes


ID ID Yes Uniquely identifies any Child element within the scope of VDI input manifest xml document. The value of this attribute should not overlap with values of identifiers of other element types. The value of this attribute can be used to refer to a specific Child element.

DocumentRef IDREF Yes References an existing PdmDocumentFromFile or PdmDocumentWithChildren by specifying the value of its Id attribute within the scope of a VDI input manifest xml document.




TMatrix No Specifies parent-relative 3D transformation matrix for that Child element. This transformation matrix will be associated with this particular instance of the PdmDocumentFromFile or PdmDocumentWithChildren. In order to calculate the world position of a particular instance of a PdmDocumentFromFile or PdmDocumentWithChildren, all parent Child element TMatrix attributes beginning at the top-most Child element must be multiplied.

TMatrix is a list of 12 double space delimited values stored in a single string that corresponds to a standard 4x4 3D transformation matrix where the column that represents perspective is omitted. If TMatrix attribute is omitted, the identity transformation matrix is assumed.

If another transformation matrix is multiplied by Identity transformation matrix, the result is the value of the first transformation matrix.

SapCharacteristics

The SapCharacteristics element is used to represent a collection of SAP characteristics associated with a PdmDocumentFromFile or a PdmDocumentWithChildren elements. This element can have any number of Characteristic child elements.

Characteristic

The Characteristic element is used to represent actual SAP ERP characteristics. Note: SAP characteristics have to exist in SAP ERP and they have to be associated with the SAP DMS document type that is used to store viewables (by default, this is VED)


Attributes


ClassType Yes The SAP ERP class type. Maximum length is 3 characters..

ClassName String Yes The SAP ERP class name.


CharacteristicName String Yes Tthe SAP ERP characteristics name.


CharacteristicValue String Yes The SAP ERP characteristics value.

Maximum length is 30 characters

SapDocumentAttributes

The SapDocumentAttributes element is used to represent a collection of SAP DMS document info record attributes associated with a PdmDocumentFromFile or a PdmDocumentWithChildren elements. This element can have any number of Attribute child elements.

Attribute

The Attribute element contains information about SAP DMS document info record attributes.

NoteOnly document attributes that have Category attribute equal to DRAW are supported by the RFC middleware used to manage SAP DMS document structures.

Attributes


Category String Yes Represents the internal category of SAP DMS document info record attributes. Currently, only DRAW is supported.





Name String Yes Represents the name of the SAP DMS document info record attribute.


Value String Yes The value of SAP DMS document info record attribute.


Metadata

The Metadata element is used to represent any other metadata that needs to be associated with a PdmDocumentFromFile or PdmDocumentWithChildren. At a later point in processing, this metadata can be used to enrich the viewables, or it can be associated with some other data in SAP ERP through extension points. Metadata can have one or more MetadataGroup child elements.

MetadataGroup

The MetadataGroup element is used to represent a collection of MetadataKeyValues – it can have one or more child elements of that type.

Attribute


Name String Yes The metadata group or category name.

All MetadataKeyValue elements under a MetadataGroup element have the category name specified by this attribute.

Maximum length 250 characters

MetadataKeyValues

TheMetadataKeyValues element is used to represent a collection of MetadataKeyValue elements – it can have one or more child elements of that type.

MetadataKeyValue

The MetadataKeyValue element is used to represent a metadata key value pair.


Attributes


Key String Yes The metadata key name.


Value String Yes Represents the metadata value.

Type is string, and maximum length is 4000 characters.

MaterialRefs

MaterialRefs is used to represent a collection of references to SAP materials for a PdmDocumentFromFile or PdmDocumentWithChildren elements. It has multiple MaterialRef elements.

MaterialRef

The MaterialRef element is used to reference a specific material by using the value of Material element’s ID attribute. It is a child element of MaterialRefs element.

ProcessingFlags

The ProcessingFlags element is used to reference a collection of ProcessingFlag elements, used to specify additional behaviors for PdmDocumentFromFile and PdmDocumentWithChildren elements. It can have multiple ProcessingFlag child elements.

ProcessingFlag

The ProcessingFlag element is used to specify additional processing behaviours for a specific PdmDocumentFromFile of PdmDocumentWithChildren. Processing flag is much like a property that a document either has or does not have.

Attributes


Name String Yes Specifies the name of the processing flag

Value Boolean No Specifies whether the value of the flag is true or false

AbsolutePath

The AbsolutePath element represents a network or local file system location where a file can be found from the SAP 3D Visual Enterprise Generator machine. This element allows for “any” attribute so that users can add additional custom data to it if required.



Attribute


Path String Yes The file absolute pat

CustomPath

The Custom path element is used for representing references to files that need to be retrieved using an extension point. Custom path element allows for a sequence of “any” elements.

2.3.2.1.21.4.1 Example: BuildResolvedStructure

NoteThe BuildResolvedStructure

Sample Code

<?xml version="1.0" encoding="utf-8" standalone="no"?> <PdmStructure xmlns="http://schemas.sap.com/VE/Generator/ERPIntegration/2015/July/Manifest" NumberFormatCulture="Invariant" UnitOfMeasure="Millimetre" ViewableStorage="MaintainDocumentHierarchy"> <BuildResolvedStructure> <PdmDocumentInstances> <Child DocumentRef="d1" Id="n1"/> <Child DocumentRef="d2" Id="n2"/> </PdmDocumentInstances> </BuildResolvedStructure> <PdmDocumentsFromFile> <PdmDocumentFromFile Id="d1" Name="bike" PdmIdentifier="bike" PdmVersion="00" StoreOriginal="true" StoreViewable="false"> <RelatedFiles> <RelativePath Path="test.txt" WorkstationApplication="TXT" MimeType="text/plain" /> <AbsolutePath Path="c:\temp\test2.txt" WorkstationApplication="TXT" MimeType="text/plain" /> </RelatedFiles> <RelativePath Path="bike.cgm" WorkstationApplication="CGM" MimeType="application/cgm"/> </PdmDocumentFromFile> <PdmDocumentFromFile Id="d2" Name="A1" PdmIdentifier="A1" PdmVersion="00" StoreOriginal="true" StoreViewable="false"> <RelatedFiles> <RelativePath Path="test.txt" WorkstationApplication="TXT" MimeType="text/plain" /> </RelatedFiles> <RelativePath Path="A1.cgm" WorkstationApplication="CGM" MimeType="application/cgm"/> </PdmDocumentFromFile> </PdmDocumentsFromFile> </PdmStructure>


2.3.2.1.21.4.2 Example: BuildCADStructure with AbsolutePath Elements

NoteThe BuildCADStructure with AbsolutePath elements.

Sample Code

<?xml version="1.0" encoding="utf-8" standalone="no"?> <PdmStructure xmlns="http://schemas.sap.com/VE/Generator/ERPIntegration/2015/July/Manifest" NumberFormatCulture="Invariant" UnitOfMeasure="Millimetre" ViewableStorage="MaintainDocumentHierarchy"> <BuildCADStructure TopLevelDocumentRefs="d1"/> <PdmDocumentsFromFile> <PdmDocumentFromFile Id="d1" Name="SampleCGMFile" PdmIdentifier="SampleCGMFile" CreateViewable="false" StoreOriginal="true" StoreViewable="false"> <MaterialRefs> <MaterialRef Material="m2"/> </MaterialRefs> <RelatedFiles> <AbsolutePath Path="C:\OriginalFiles\SampleCGMFile-Overview.pdf" WorkstationApplication="PDF" MimeType="application/pdf" /> </RelatedFiles> <AbsolutePath Path="C:\OriginalFiles\SampleCGMFile.cgm" WorkstationApplication="CGM" MimeType="application/cgm" /> </PdmDocumentFromFile> </PdmDocumentsFromFile> <Materials> <Material Id="m2" MaterialId="200733340"/> </Materials></PdmStructure>

2.3.2.1.21.4.3 Example: BuildCADStructure with CustomPath Elements

NoteThe BuildCADStructure with CustomPath elements and configurations.

Sample Code

<?xml version="1.0" encoding="utf-8"?> <PdmStructure UnitOfMeasure="Millimetre" NumberFormatCulture="Invariant" xmlns="http://schemas.sap.com/VE/Generator/ERPIntegration/2013/February/Manifest"> <BuildCADStructure TopLevelDocumentRefs="d1" /> <PdmDocumentsFromFile> <PdmDocumentFromFile Id="d1" Name="LegComplete3B" PdmIdentifier="SWA0000000000000010000043470000" PdmVersion="00" PdmConfiguration="%ALL%">



</CustomPath> </PdmDocumentFromFile> <PdmDocumentFromFile Id="d3" Name="Leg3B" PdmIdentifier="SWP0000000010000000000002618000" PdmVersion="00"> <SapDocumentAttributes> <Attribute Category="DRAW" Name="DOCUMENTTYPE" Value="SWP" /> <Attribute Category="DRAW" Name="DOCUMENTNUMBER" Value="0000000010000000000002618" /> <Attribute Category="DRAW" Name="DOCUMENTVERSION" Value="00" /> <Attribute Category="DRAW" Name="DOCUMENTPART" Value="000" /> <Attribute Category="DRAW" Name="DESCRIPTION" Value="Leg_Square_000" /> <Attribute Category="DRAW" Name="USERNAME" Value="ARORARA" /> <Attribute Category="DRAW" Name="STATUSEXTERN" Value="WR" /> <Attribute Category="DRAW" Name="STATUSINTERN" Value="AA" /> <Attribute Category="DRAW" Name="STATUSLOG" Value="" /> <Attribute Category="DRAW" Name="LABORATORY" Value="" /> <Attribute Category="DRAW" Name="ECNUMBER" Value="" /> <Attribute Category="DRAW" Name="VALIDFROMDATE" Value="00000000" /> <Attribute Category="DRAW" Name="REVLEVEL" Value="" /> <Attribute Category="DRAW" Name="DELETEINDICATOR" Value="" /> <Attribute Category="DRAW" Name="CADINDICATOR" Value="" /> <Attribute Category="DRAW" Name="STRUCTUREINDICATOR" Value="" /> <Attribute Category="DRAW" Name="PREDOCUMENTNUMBER" Value="" /> <Attribute Category="DRAW" Name="PREDOCUMENTVERSION" Value="" /> <Attribute Category="DRAW" Name="PREDOCUMENTPART" Value="" /> <Attribute Category="DRAW" Name="PREDOCUMENTTYPE" Value="" /> <Attribute Category="DRAW" Name="AUTHORITYGROUP" Value="" /> <Attribute Category="DRAW" Name="DOCFILE1" Value="D:\CAD_Work\SolidWorks\EIC_001\" /> <Attribute Category="DRAW" Name="DATACARRIER1" Value="" /> <Attribute Category="DRAW" Name="WSAPPLICATION1" Value="" /> <Attribute Category="DRAW" Name="DOCFILE2" Value="" /> <Attribute Category="DRAW" Name="DATACARRIER2" Value="" /> <Attribute Category="DRAW" Name="WSAPPLICATION2" Value="" /> <Attribute Category="DRAW" Name="VRLDAT" Value="00000000" /> <Attribute Category="DRAW" Name="USERDEFINED1" Value="" /> <Attribute Category="DRAW" Name="USERDEFINED2" Value="" /> <Attribute Category="DRAW" Name="USERDEFINED3" Value="" /> <Attribute Category="DRAW" Name="USERDEFINED4" Value="SLW:P" /> <Attribute Category="DRAW" Name="SAVEDOCFILE1" Value="" /> <Attribute Category="DRAW" Name="SAVEDATACARRIER1" Value="" /> <Attribute Category="DRAW" Name="SAVEDOCFILE2" Value="" /> <Attribute Category="DRAW" Name="SAVEDATACARRIER2" Value="" /> <Attribute Category="DRAW" Name="CREATEDATE" Value="20140404" /> <Attribute Category="DRAW" Name="REFDOCUMENTNUMBER" Value="0000000010000000000000067" /> <Attribute Category="DRAW" Name="REFDOCUMENTPART" Value="000" /> <Attribute Category="DRAW" Name="REFDOCUMENTVERSION" Value="00" /> <Attribute Category="DRAW" Name="FILESIZE1" Value="000000000000" /> <Attribute Category="DRAW" Name="FILESIZE2" Value="000000000000" /> <Attribute Category="DRAW" Name="CMFIXED" Value="" /> <Attribute Category="DRAW" Name="CMRELEVANCE" Value="" /> </SapDocumentAttributes> <Metadata> <MetadataGroup Name="SAP"> <MetadataKeyValues> <MetadataKeyValue Key="MATERIAL" Value="000000000000002872" /> </MetadataKeyValues> </MetadataGroup> </Metadata> <MaterialRefs> <MaterialRef Material="m3" /> </MaterialRefs> <CustomPath> <KPROInfo p5:SourceDocumentId="SWP000000001000000000000261800000" p5:PhysicalObjectId="E94AC251963DA96EE10000000A428CC7" p5:FileName="Leg3B.SLDPRT" p5:DownloadKind="CADOriginal" xmlns:p5="http://


schemas.sap.com/VE/Generator/KPRODownload" xmlns="http://schemas.sap.com/VE/Generator/KPRODownload" /> </CustomPath> </PdmDocumentFromFile> </PdmDocumentsFromFile> <Materials> <Material Id="m2" MaterialId="000000000000002871" /> <Material Id="m1" MaterialId="000000000000002863" /> <Material Id="m3" MaterialId="000000000000002872" /> </Materials></PdmStructure>

2.3.2.1.22 VDI Metadata Extractor Workflow Controller

Use

The VDI Metadata Extractor workflow controller provides services that analyze graphical data files and provides a textual map of the internal relationships between graphical items and business metadata. The metadata returned in the output is selected by providing a list of metadata names to match; a filter.

Use of the workflow enables caching of the textual data within the ERP database so that it can be used to support improved business processes.

This workflow controller takes as input an XML document describing one or more hierarchies of visualization files to analyze (each hierarchy is analyzed independently). It retrieves all of the files for each hierarchy, and then analyzes each hierarchy. When complete, the results of this analysis are produced as the output, typically in XML format.

Examples:

● Using cached data enables a feature in ERP applications that if an equipment item is replaced, could locate all work instructions that may require update.

● Enable EAM to map the relationship between a maintenance operation in ERP and the step in a work instruction graphical file. A user can then open the work instruction at the correct procedure or step with a single click in SAP 3D Visual Enterprise Viewer or SAP 3D Visual Enterprise Author.



Features

The VDI Metadata Extractor workflow controller configurable settings are the following:

VDI Metadata Extractor: Configurable Settings

Setting Type Mandatory Default Description

Maximum Files Per KPRO Task

Number Yes 5 Maximum number of files each parallel KPRO storage or retrieval task processes. Decrease this value to increase parallelization of KPRO actions.

Maximum KPRO Retrieve Attempts

Number Yes 3 The maximum number of times to retry retrieval of files that failed to retrieve from the KPRO content servers, before stopping

Metadata Filter Enum Path N/A The type of metadata filter. Two options are available:

UseFilterFromInputManifest UseFilterFromLocalFile

If you select the latter, the following parameter is also required:

Metadata Filter File Path Only if UseFilterFromLocalFile

N/A Path of the file that contains the <Filters> definition

The VDI Metadata Extractor workflow controller startup arguments are the following:

Metadata Extractor: Arguments


Input File Path The fully qualified path to the XML document in VDI Metadata Extraction request format describing what is to be downloaded. See Appendix A: VDI Metadata Extraction Request Format for more details on the format

Service Endpoint XML If specified, the result of the analysis and extraction are written to this location, typically in XML format

2.3.2.1.22.1 Configuring a VDI Metadata Extractor Workflow

To configure SAP 3D Visual Enterprise Generator to process VDI Metadata Extractor jobs, proceed as follows:

1. Open 3D Visual Enterprise Generator Administration and navigate to Server ConfigurationWorkflows .



NoteThe name can be the same as the workflow controller name.

4. Enter the VDI Metadata Extractor workflow controller in the Controller field.

2.3.2.1.22.2 VDI Metadata Extractor Processes

The VDI Metadata Extractor workflow controller uses the following processes:

By default, a set of processes is provided that takes a request produced by the ERP system, and sends the output file back to the ERP system.

Process Name Functional Description

VDI Metadata Extractor – Process Input Analyzes the input request, and performs any preparation required for the download step

VDI Metadata Extractor – Download Visualization Files Downloads the visualization files to analyze

VDI Metadata Extractor – Analyze Visualization Files Extracts the metadata and product structure information from the visualization files

VDI Metadata Extractor – Finalize Job Performs finalization of the job by creating the output file and performing any other actions that may be required; for example, sending a response to ERP system

2.3.2.1.22.3 VDI Metadata Extractor Processing Steps

Use

The following processing steps are performed by the VDI Metadata Extractor workflow controller:

● Process Input File● Download Visualization Files● Analyze Visualization Files● Finalize Job● Job Completion



Features

Process Input FileThis step takes the input file provided to the job controller, and performs the following:

1. validates it according to the VDI Metadata Extraction Request format schema2. creates the list of visualization files to retrieve3. determines how and from where to retrieve them

The input is mass-enabled, in other words, the request supports specifying multiple, independent visualization hierarchies to analyze.

Failure Policy

If schema validation fails, or the input request fails a business rule validation, the job is aborted, and no processing is performed.

Download Visualization FilesThis step performs a download of the visualizations files required to perform the analysis for all requested visualization hierarchies.

If the file retrieval mode is KPRO, the KPRO Download workflow is triggered to perform the file download. If the file retrieval mode is Absolute Path, the Download process is triggered to ensure that the files end up in the job workspace.

Failure Policy

If files were not successfully downloaded for a particular hierarchy, the hierarchy is marked as failed. The job continues processing as long as the visualization files for at least one hierarchy were downloaded successfully. Download failures are reported back to the requesting system; for example, ERP.

AuthenticationThe standard 3D Visual Enterprise Generator authentication mechanisms for calling web services (username-password or X.509 client certificates) are used.

Analyze Visualization FilesThis step performs a structural analysis of each requested visualization hierarchy. The analysis involves opening the top-level visualization file for a particular hierarchy, and then executing the analysis extension point (Python), which traverses the hierarchy, extracting metadata and information about the graphical elements, and producing the final results for that hierarchy, typically in XML format.

Failure Policy

If opening of the visualization file, or analysis of the visualization file fails, an error report is produced. The error report correlates the error with the context associated with the hierarchy. This context may be supplied by the requesting system; for example, ERP, and reports the results back to this system for the failing hierarchy. However, failure of one hierarchy does not cause any other hierarchy analyses to fail.

Finalize JobThis step notifies the requesting system; for example, ERP, of the results for each visualization hierarchy for which it requested analysis in the input. Each result notification is a separate call; for example, if analysis was requested for 10 hierarchies, there are 10 result notification calls to the requesting system.


Job Completion

The workflow has a preconfigured job completion call, which notifies the requesting system of the success or the failure of the overall job.

2.3.2.1.22.4 VDI Metadata Extraction Request Format

The Metadata Extraction Request describes the files from which to extract data, and any context information to associate the items in the request with items in the response.

Elements

<Manifest>

The manifest contains one or more <Conversion>specifications. Retrieval is either from KPRO or locally.

Namespace: xmlns='http://schemas.sap.com/2014/VEGenerator/VDIMetadataExtractor/StartManifest'

Attributes


FileRetrievalMode KPRO or AbsolutePath No Indicates whether to retrieve from the KPRO system or from a local disk location

VegId String Yes Identifies the SAP 3D Visual Enterprise Generator set up on the ERP system

<Manifest><Conversion>

This section identifies the files to download. The main file is defined by the FileName property, and dependent files are defined in the DependentFiles child element.

The following items have Mandatory set to Yes if KPRO is selected, or Mandatory set to No if AbsolutePath is selected. The exception is SAPsystemId, which is always Yes.

Attributes


FileName String Yes The main file to be downloaded




SourceDocId String No A string that identifies a single DMS DocInfo record used in all communications with the DS Connector

PhObjId String No The physical file ID from DMS. This is used to retrieve source files.

SAPSystemId String Yes Identifies SAP 3D Visual Enterprise Generator

<Manifest><Conversion><Context>

The context element is provided as a mechanism for the calling application to correlate the response of a metadata extraction job to the request. The key, category, and value can be used by the calling application in any way it sees fit in order to achieve the correct correlation.

Attributes


Key String Yes Used by the calling application

Category String No Used by the calling application

Value String No Used by the calling application

<Manifest><Conversion><Filters><Filter>

A Filter defines which metadata categories and metadata names should be extracted from all the dependent files in the conversion. The filters are positive (whitelist), and only matching data is extracted.

Each piece of metadata found in the CAD files is matched (case-insensitively) against the filter’s Category and the Name. If only the Category is given, that will be the only criterion for selection. Likewise, if only the Name is given, the Category of the metadata is ignored. A match results in extraction of the piece of metadata into the output. If both Category and Name are given, both of these must be matched to result in extraction.

All filters are applied to each instance of metadata. If at least one matches, the metadata is output. With regard to matching metadata, there is an OR relationship between filters, and an AND relationship between the attributes within a filter.

Partial matches, wildcards and regular expressions are not supported.


Attributes


Category String No The metadata category filter to include in output

Name String No The metadata name filter to include in output

<Manifest Conversion><Dependent Files><Files>

Attributes


Source file name Yes The name of the file when downloaded to local disk

SourceDocID String Yes A string that identifies a single DMS DocInfo record used in all communications with the DS Connector

PhObjId String Yes The physical file ID from DMS. This is used to retrieve source files.

2.3.2.1.22.4.1 VDI Metadata Extractor Sample Input File

NoteA sample input file:

Sample Code

<Manifest xmlns='http://schemas.sap.com/2014/VEGenerator/VDIMetadataExtractor/StartManifest' FileRetrievalMode='KPRO' VegId='DEEP_SERV3'> <Conversion FileName='mast_truck.SLDASM' SAPSystemId='QI3002DMS' PhObjId='0000C9D275CA1EE38094D66545B1A028' SourceDocId='SWA000000000000001000002892100000'> <Filters> <Filter Category='CADMetadata' Name='Dimension' /> <Filter Category='CADMetadata' Name='Weight' /> </Filters> <DependentFiles> <File Source='Outer mast.SLDASM' SourceDocId='SWA000000000000001000002891500000' PhObjId='0000C9D275CA1ED3809484F3E1A6BF2B' /> <File Source="Base seat ass'.SLDASM" SourceDocId='SWA000000000000001000002891600000' PhObjId='0000C9D275CA1ED3809484F3E1A89F2B' />



<File Source="Beam.SLDPRT" SourceDocId='SWP000000001000000000000091100000' PhObjId='0000C9D275CA1ED3809484F3E1A93F2B' /> <File Source="Base seat_LT.SLDPRT" SourceDocId='SWP000000001000000000000091200000' PhObjId='0000C9D275CA1ED3809484F3E1A9DF2B' /> <File Source="Base seat_RT.SLDPRT" SourceDocId='SWP000000001000000000000091300000' PhObjId='0000C9D275CA1ED3809484F3E1AA7F2B' /> <File Source="Weldment.SLDPRT" SourceDocId='SWP000000001000000000000090900000' PhObjId='0000C9D275CA1ED3809484F3E1A75F2B' /> <File Source="Seat.SLDPRT" SourceDocId='SWP000000001000000000000090900000' PhObjId='0000C9D275CA1ED3809484F3E1A7FF2B' /> <File Source="Rib plate_02.SLDPRT" SourceDocId='SWP000000001000000000000091400000' PhObjId='0000C9D275CA1ED3809484F3E1AB1F2B' /> <File Source="Support_03.SLDPRT" SourceDocId='SWP000000001000000000000091500000' PhObjId='0000C9D275CA1ED3809484F3E1ABBF2B' /> <File Source="Support_02.SLDPRT" SourceDocId='SWP000000001000000000000091600000' PhObjId='0000C9D275CA1ED3809484F3E1AC5F2B' /> <File Source="Support_01.SLDPRT" SourceDocId='SWP000000001000000000000091700000' PhObjId='0000C9D275CA1ED38094851B115B5F2B' /> <File Source="Rib plate_01.SLDPRT" SourceDocId='SWP000000001000000000000091800000' PhObjId='0000C9D275CA1ED38094851B115BFF2B' /> <File Source="Channel for outer mast_RT.SLDPRT" SourceDocId='SWP000000001000000000000091900000' PhObjId='0000C9D275CA1ED38094851B115C9F2B' /> <File Source="Channel for outer mast_LT.SLDPRT" SourceDocId='SWP000000001000000000000092000000' PhObjId='0000C9D275CA1ED38094851B115D3F2B' /> <File Source="lift cylinder.SLDASM" SourceDocId='SWA000000000000001000002892200000' PhObjId='0000C9D275CA1ED38094854095C73F2B' /> <File Source="piston rod LC.sldprt" SourceDocId='SWP000000001000000000000093000000' PhObjId='0000C9D275CA1ED38094854095C7DF2B' /> <File Source="LC base.SLDPRT" SourceDocId='SWP000000001000000000000093100000' PhObjId='0000C9D275CA1ED38094854095C87F2B' /> <File Source="LC nut cap.SLDPRT" SourceDocId='SWP000000001000000000000093200000' PhObjId='0000C9D275CA1ED38094854095C91F2B' /> <File Source="sleeve for LC left.SLDPRT" SourceDocId='SWP000000001000000000000093300000' PhObjId='0000C9D275CA1ED38094854095C9BF2B' /> <File Source="fork ass'.SLDASM" SourceDocId='SWA000000000000001000002892300000' PhObjId='0000C9D275CA1ED380948565C93F1F2B' /> <File Source="fork.sldprt" SourceDocId='SWP000000001000000000000093400000' PhObjId='0000C9D275CA1ED380948565C93FBF2B' /> <File Source="Inner mast.SLDASM" SourceDocId='SWA000000000000001000002892400000' PhObjId='0000C9D275CA1ED380948565C942DF2B' /> <File Source="Channel for inner mast_RT.SLDASM" SourceDocId='SWA000000000000001000002891400000' PhObjId='0000C9D275CA1ED3809484F3E1A61F2B' /> <File Source="Channel.SLDPRT" SourceDocId='SWP000000001000000000000092600000' PhObjId='0000C9D275CA1ED38094854095C2DF2B' /> <File Source="Stiffener.SLDPRT" SourceDocId='SWP000000001000000000000094100000'


PhObjId='0000C9D275CA1ED380948565C9455F2B' /> <File Source="Channel for inner mast_LT.SLDASM" SourceDocId='SWA000000000000001000002892500000' PhObjId='0000C9D275CA1ED380948565C944BF2B' /> <File Source="upper beam .SLDPRT" SourceDocId='SWP000000001000000000000093900000' PhObjId='0000C9D275CA1ED380948565C9437F2B' /> <File Source="lower beam.SLDPRT" SourceDocId='SWP000000001000000000000094000000' PhObjId='0000C9D275CA1ED380948565C9441F2B' /> <File Source="chain wheel.SLDPRT" SourceDocId='SWP000000001000000000000093500000' PhObjId='0000C9D275CA1ED380948565C9405F2B' /> <File Source="fork arm carrier .SLDPRT" SourceDocId='SWP000000001000000000000093600000' PhObjId='0000C9D275CA1ED380948565C940FF2B' /> <File Source="bolt_20x55.sldprt" SourceDocId='SWP000000001000000000000093700000' PhObjId='0000C9D275CA1ED380948565C9419F2B' /> <File Source="Washer_lock_20.SLDPRT" SourceDocId='SWP000000001000000000000093800000' PhObjId='0000C9D275CA1ED380948565C9423F2B' /> </DependentFiles> </Conversion> </Manifest>

2.3.2.1.22.4.2 VDI Metadata Extractor Sample Output File

NoteA sample output file:

Sample Code

<?xml version="1.0" encoding="utf-8"?> <xs:schema id="SAP_VDI_MetadataExchange" targetNamespace="http://schemas.sap.com/VE/VDI/2014/February/MetadataExchange" attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns="http://schemas.sap.com/VE/VDI/2014/February/MetadataExchange" xmlns:me="http://schemas.sap.com/VE/VDI/2014/February/MetadataExchange" xmlns:mstns="http://schemas.sap.com/VE/VDI/2014/February/MetadataExchange" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="MetadataExchange" type="MetadataExchange"> <xs:keyref name="MetadataRef" refer="me:MetadataIdKey"> <xs:selector xpath="me:Elements/me:Element/me:MetadataReferences/me:Reference"/> <xs:field xpath="@MetadataIdRef"/> </xs:keyref> <xs:keyref name="ParentElementKeyRef" refer="me:ElementIdKey"> <xs:selector xpath="me:Elements/me:Element"/> <xs:field xpath="@ParentElementRef"/> </xs:keyref> <xs:keyref name="ElementKeyRef" refer="me:ElementIdKey"> <xs:selector xpath="me:Elements/me:Element/me:Relationships/me:Relationship"/> <xs:field xpath="@ElementRef"/>



</xs:keyref> <xs:unique name="ElementId"> <xs:selector xpath="me:Elements/me:Element"/> <xs:field xpath="@Id"/> </xs:unique> <xs:key name="ElementIdKey"> <xs:selector xpath="me:Elements/me:Element"/> <xs:field xpath="@Id"/> </xs:key> <xs:unique name="MetadataId"> <xs:selector xpath="me:MetadataValues/me:String | me:MetadataValues/me:Real | me:MetadataValues/me:Integer | me:MetadataValues/me:Boolean | me:MetadataValues/me:DateTime | me:MetadataValues/me:Matrix | me:MetadataValues/me:Custom"/> <xs:field xpath="@Id"/> </xs:unique> <xs:key name="MetadataIdKey"> <xs:selector xpath="me:MetadataValues/me:String | me:MetadataValues/me:Real | me:MetadataValues/me:Integer | me:MetadataValues/me:Boolean | me:MetadataValues/me:DateTime | me:MetadataValues/me:Matrix | me:MetadataValues/me:Custom"/> <xs:field xpath="@Id"/> </xs:key> </xs:element> <xs:complexType name="MetadataExchange"> <xs:sequence> <xs:element ref="Elements" minOccurs="0" maxOccurs="1" /> <xs:element ref="MetadataValues" minOccurs="0" maxOccurs="1" /> </xs:sequence> </xs:complexType> <xs:complexType name="ElementsType"> <xs:sequence> <xs:element name="Element" type="Element" minOccurs="0" maxOccurs="unbounded" /> </xs:sequence> </xs:complexType> <xs:element name="Elements" type="ElementsType"> </xs:element> <xs:element name="MetadataValues" type="MetadataType"> </xs:element> <xs:complexType name="MetadataType"> <xs:sequence> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element name="String" type="StringData" /> <xs:element name="Real" type="RealData" /> <xs:element name="Integer" type="IntegerData" /> <xs:element name="Boolean" type="BooleanData" /> <xs:element name="DateTime" type="DateTimeData" /> <xs:element name="Matrix" type="MatrixData" /> <xs:element name="Custom" type="CustomData" /> </xs:choice> </xs:sequence> </xs:complexType>  <xs:complexType name="Element"> <xs:sequence> <xs:element name="MetadataReferences" type="MetadataReferences" minOccurs="0" maxOccurs="1" /> <xs:element name="Relationships" type="Relationships" minOccurs="0" maxOccurs="1" /> </xs:sequence> <xs:attribute name="Id" type="ElementIdType" use="required" />

<xs:attribute name="Name" type="xs:string" use="optional" /> <xs:attribute name="Type" type="ElementType" use="required" /> <xs:attribute name="ParentElementRef" type="ElementIdType" use="optional" /> <xs:attribute name="Data" type="DataValueStringType" use="optional" /> <xs:anyAttribute /> </xs:complexType> <xs:simpleType name="ElementType"> <xs:restriction base="xs:string"> <xs:enumeration value="Bom"/> <xs:enumeration value="Instance"/> <xs:enumeration value="Procedure"/> <xs:enumeration value="Step"/> <xs:enumeration value="Assignment"/> <xs:enumeration value="AssignmentItem"/> <xs:enumeration value="Portfolio"/> <xs:enumeration value="Modelview"/> <xs:enumeration value="Context"/> <xs:enumeration value="File"/> <xs:enumeration value="Custom"/> <xs:enumeration value="Object"/> </xs:restriction> </xs:simpleType> <xs:complexType name="Relationships"> <xs:sequence> <xs:element name="Relationship" type="Relationship" minOccurs="0" maxOccurs="unbounded" /> </xs:sequence> </xs:complexType> <xs:complexType name="Relationship"> <xs:attribute name="ElementRef" type="ElementIdType" use="required" /> <xs:attribute name="Type" type="RelationshipType" use="required" /> <xs:attribute name="Data" type="DataValueStringType" use="optional" /> <xs:anyAttribute /> </xs:complexType> <xs:simpleType name="RelationshipType"> <xs:restriction base="xs:string"> <xs:enumeration value="Assignment"/> <xs:enumeration value="Custom"/> </xs:restriction> </xs:simpleType> <xs:complexType name="MetadataReferences"> <xs:sequence> <xs:element name="Reference" type="MetadataReferenceType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <xs:complexType name="MetadataReferenceType"> <xs:attribute name="MetadataIdRef" type="MetadataIdType" use="required"/> </xs:complexType>  <xs:complexType name="Metadata"> <xs:choice> <xs:element name="String" type="StringData" /> <xs:element name="Real" type="RealData" /> <xs:element name="Integer" type="IntegerData" /> <xs:element name="Boolean" type="BooleanData" /> <xs:element name="DateTime" type="DateTimeData" /> <xs:element name="Matrix" type="MatrixData" /> <xs:element name="Custom" type="CustomData" /> </xs:choice> </xs:complexType> <xs:complexType name="DataBase" abstract="true"> <xs:attribute name="Id" type="MetadataIdType" use="required" /> <xs:attribute name="Category" type="DataCategoryStringType" use="required" /> <xs:attribute name="Key" type="DataKeyStringType" use="required" />

</xs:complexType> <xs:complexType name="StringData" > <xs:complexContent> <xs:extension base="DataBase" > <xs:attribute name="Value" type="DataValueStringType" /> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="RealData" > <xs:complexContent> <xs:extension base="DataBase" > <xs:attribute name="Value" type="DataValueRealType" /> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="IntegerData" > <xs:complexContent> <xs:extension base="DataBase" > <xs:attribute name="Value" type="DataValueIntegerType" /> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="BooleanData" > <xs:complexContent> <xs:extension base="DataBase" > <xs:attribute name="Value" type="DataValueBooleanType" /> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="DateTimeData" > <xs:complexContent> <xs:extension base="DataBase" > <xs:attribute name="Value" type="DataValueDateTimeType" /> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="MatrixData"> <xs:complexContent> <xs:extension base="DataBase"> <xs:attribute name="Value" type="DataValueTransformationMatrixType" /> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="CustomData" > <xs:complexContent> <xs:extension base="DataBase" > <xs:attribute name="Value" type="DataValueStringType" /> <xs:anyAttribute /> </xs:extension> </xs:complexContent> </xs:complexType> <xs:simpleType name="DataCategoryStringType"> <xs:restriction base="xs:string"> <xs:maxLength value="250"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="DataKeyStringType"> <xs:restriction base="xs:string"> <xs:maxLength value="250"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="DataValueStringType"> <xs:restriction base="xs:string"> <xs:maxLength value="4000"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="DataValueRealType">


<xs:restriction base="xs:double"> </xs:restriction> </xs:simpleType> <xs:simpleType name="DataValueIntegerType"> <xs:restriction base="xs:long"> </xs:restriction> </xs:simpleType> <xs:simpleType name="DataValueBooleanType"> <xs:restriction base="xs:string"> <xs:enumeration value="true"/> <xs:enumeration value="True"/> <xs:enumeration value="false"/> <xs:enumeration value="False"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="DataValueDateTimeType"> <xs:restriction base="xs:dateTime"> </xs:restriction> </xs:simpleType> <xs:simpleType name="DataValueTransformationMatrixType"> <xs:restriction base="DoubleList"> <xs:length value="13"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="ElementIdType" > <xs:restriction base="xs:string"> <xs:pattern value="e[0-9]+" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="MetadataIdType" > <xs:restriction base="xs:string"> <xs:pattern value="m[0-9]+" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="DoubleList"> <xs:list itemType="xs:double"/> </xs:simpleType></xs:schema>

2.3.3 Processes Panel

Use

The Processes panel displays a list of the current processes and related information including the display name and throttle details. You can use it to manage SAP 3D Visual Enterprise Generator processes and their components.

Processes are a series of operations that SAP 3D Visual Enterprise Generator performs when requested through workflows, either manually using SAP 3D Visual Enterprise Generator Administration, or automatically using a client application such as SAP Visual Enterprise Access. For more information about SAP Visual Enterprise Access, see SAP Visual Enterprise Access Help athttp://help.sap.com/ SAP Visual Enterprise Access SAP Visual Enterprise Access 7.1 .

Within SAP 3D Visual Enterprise Generator, you create processes to automatically manipulate 2D and 3D graphical data. When a message arrives in the message queue, SAP 3D Visual Enterprise Generator executes the associated processes.




Note that the only supported message queue is Microsoft Message Queue (MSMQ) (see Initiating and Running Processes [page 541]).

An organization can use many processes, with each process taking various inputs, carrying out different operations, and producing separate results.

For example, you may require a process that converts high-resolution 2D scanned images into a number of smaller-sized images in another file format to use on your Web site. Another process may create thumbnail images from 3D files and convert them into another 3D format to preview on a Web site.

You can do the following:

● View, filter, and monitor the processes● Load and unload processes within the message queues● Stop and start processes● Create and edit processes using Process Designer (see Process Designer [page 228])● Schedule specific processes to run at predetermined intervals● Load processes onto monitored folders using hot folders● Export and import processes between computers● Disable, enable, and throttle processes

Processes are constructed from a series of .xml files: the nature of the XML format means that SAP 3D Visual Enterprise Generator can be configured to perform user-specific actions.

Alternatively, SAP 3D Visual Enterprise Generator can be integrated with an asset management system, so that as soon as a modified asset is checked in, a notification is sent to SAP 3D Visual Enterprise Generator to generate a preview file and upload it into the asset management database.

Features

The following table lists functions available in the Processes toolbar:


Refresh Refreshes the display

New Opens the Process Designer to create a new process

Edit Opens the Process Designer and enables editing

Enable Enables messages on the message queue for the selected process. The process is executed and the processing status is Enabled.

Disable Defers messages on the message queue for the selected process. The process stops before it initializes and the process name displays a disabled icon.

Note that any existing processes that are currently being executed continue to run until completion.



Load Loads multiple processes into SAP 3D Visual Enterprise Generator. The processing status is Loaded.

Reload Reloads the selected process into SAP 3D Visual Enterprise Generator

Unload Unloads the selected process from SAP 3D Visual Enterprise Generator. The processing status is None.

The following Processes menu is displayed when you right-click the Processes node in the Server Configuration area:


Load Processes Loads processes into SAP 3D Visual Enterprise Generator

Import Processes Imports ZIP files containing process and related operation definition files (.xml) into SAP 3D Visual Enterprise Generator. The ZIP files are created using the Export Processes command.

Export Processes Exports selected process and related operation definition files (.xml) into a ZIP file

The following Process menu is displayed when you right-click a process in the Processes viewport:


Edit Opens the Process Designer to edit the selected process (see Process Designer [page 228])

Enable Enables messages on the message queue for the selected process. The process is executed and the processing status is Enabled.

Disable Defers messages on the message queue for the selected process. The process stops before it initializes and the process name displays a disabled icon.

Reload Reloads the selected process into SAP 3D Visual Enterprise Generator

Load Used to load multiple processes into SAP 3D Visual Enterprise Generator. The processing status is Loaded.

Unload Unloads the selected process from SAP 3D Visual Enterprise Generator. The processing status is None.




Run Manually initiates the selected process by sending single or multiple notifications to a message queue

Throttle Limits the number of process instances running across the server farm. For example, if a process is used in multiple jobs but utilizes an application for which there is only one license, you can limit the process to running in one instance. The next instance can only run when the previous instance is complete.

Purge Messages Deletes any messages pending for the selected process. That is, messages that are waiting to be placed on the engine queue.

List of the processes and their attributes are displayed in the following table columns:

Table Column Functional Description

Name The process name

Display Name The user-friendly process name

Throttle The maximum number of process instances that can run in the server farm

Status The processing status. That is, whether the process is loaded in SAP 3D Visual Enterprise Generator and enabled for messages.

Activities

You manage processes in the Process Designer. It provides a graphical display of the structure and information of the current process. Using the Process Designer, you can view process components, create, edit, run, and test processes.

To open Process Designer, do one of the following:

● Double-click a process name● Choose the process and choose Edit on the Processes toolbar● Right-click the process and choose Edit

More Information

Process Designer [page 228]


Creating Processes [page 533]

Throttling Processes and Purging Messages [page 535]

Pausing Processes [page 535]

Testing Processes [page 536]

Loading, Reloading and Unloading Processes [page 538]

Disabling and Enabling Processes [page 539]

Exporting and Importing Processes [page 539]

Initiating and Running Processes [page 541]

2.3.3.1 Process Designer

Use

Process Designer is used to manage processes. It provides a graphical display of the structure and information of the current process.

Process Designer comprises the following:

● Menu bars (see Process Designer Menu Bars [page 230])Provides access to the main menu commands

● Toolbox (see Process Designer Toolbox [page 231])Contains groups of operations depending on the toolbox defined for the operation. The toolbox is displayed by default on the left of the Process Designer, and can be auto-hidden or closed as required.

● Viewport (see Process Designer Viewport [page 232])Used to view and edit operations of the current process

● Operation windows (see Operation Window [page 234])Used to edit operation parameters and are displayed when you double-click an operation. They can be resized, moved, floated, docked, and closed similar to the functionality in most Windows applications.

● Context menus (see Process Designer Context Menus [page 478])

You can use Process Designer to do the following:

● View process components● Create new and edit existing processes● Run and test processes● Find operations that relate to newly installed modules

Activities

To open the Process Designer, do one of the following:

● Choose New on the Processes toolbar.



● Choose a process in the Processes panel and do one of the following:○ Choose Edit on the Processes toolbar.○ Double-click the process.○ Right-click the process and choose Edit.

The following table describes the pre-assigned keyboard shortcuts for the Process Designer:

Process Designer Shortcuts

User Interface Function Keyboard Shortcut

Add instance of last selected operation ALT + click viewport

Create new process CTRL + N

Delete DELETE

Open existing process CTRL + O

Redo last command that was undone CTRL + Y

Run process F5

Save process CTRL + S

Select all CTRL + A

Select or clear selection CTRL + click operation in viewport

Step through process F10

Undo last command CTRL + Z

More Information

Creating Operations [page 542]

Finding and Loading Operations [page 543]

Entering Operation Parameters [page 544]

Adding Parameter Selection Tools [page 545]

Editing Operations [page 548]

Generating Web-Service Operations [page 547]


2.3.3.1.1 Process Designer Menu Bars

Use

The Process Designer menu bars are located directly under the title bar and provide access to the main menu commands: when you click a command name, a dropdown list displays a number of commands.

Activities

The following table lists functions available from the Process Designer menu bars:


File Used to save and close the current process

Edit Used to modify the selected process, undo and redo actions, and select all process components

View Used to adjust the connection lines and to display operations in their execution order. This is helpful to view the operation running order in processes that have many operations.

Connection Line Style Bend: Adjusts the connection lines for easier viewing

Auto-Arrange: Automatically arranges operations in their run order, in the Process Designer window

Operations Used to perform various operation actions. For example, creating new triggers and loading operations.

Generate Web-Service Operations: Creates operations that are Web enabled

New Trigger: Creates trigger operations

New Notification: Creates notification operations

Load Operations: Loads operations into SAP 3D Visual Enterprise Generator. They can then be added to processes.




Debug Used to test the current process

Step: Steps through the current process’s operations one at a time

Run: Manually runs through the current process

Stop: Stops a process from running manually

Clear All Breakpoints: Clears all breakpoints from the current process

View Results Document: Opens the XML results document for the current process

2.3.3.1.2 Process Designer Toolbox

Use

All operations are grouped in the Toolbox. The Toolbox is displayed by default on the left of the Process Designer. The Toolbox can be auto-hidden or closed as required, and you can choose the size of the operation icons that are displayed within it: right-click the toolbox name and select either Large Icons or Small Icons.

When an operation is created, it is placed in a toolbox group that is used to classify the operation type. The following groups are predefined in SAP 3D Visual Enterprise Generator:

● 2D Graphics● 3D Graphics● File/Directory● General● Import/Export Settings● Modules● Repository● SOAP Web● SQL Database● Trigger

When you choose a group name in the toolbox, the group expands to display the operations within.

New toolbox groups can be created when you create new operations.

Note that you cannot delete toolbox groups once they are created.

Toolbox group names are case-sensitive.


Activities

To open and close the toolbox, right-click an operation window title and choose Toolbox. All operations are displayed in their respective groups.

2.3.3.1.3 Process Designer Viewport

Use

In the Process Designer viewport, you can see processes as a graphical diagram, displayed as a network of operation icons and connecting lines that represent the operation relationships (links).

Each operation is indicated by an icon that quickly shows the type of operation it is. For example, , ,

, and . Icons can be changed to display icons that may be more meaningful.

Operations are linked by dragging connections between the operations. When a link is made, a relationship is established between the operations. Links can be deleted as required, and you can undo or redo linking operations and deleting links.

When your cursor hovers over a connection, it changes to for every available input and output, and an icon indicates the connection status:

● : The operation is not linked to any other.

● : The operation is linked to other operations.

When you drag a connection between operations, the cursor changes to a cross and the link is made when you drop the connection onto another: the relationship is only established if the link is valid. When you next move your cursor over the connection, the status is unlocked (green) if it is able to accept further connections, or locked (red) if it cannot accept further connections.

When you move the cursor over a connection, one of the following tooltips is displayed for the connection type:

● Triggers Process: A trigger output connection● Parent: A parent input connection. That is, this operation is the child of the operation to which it connects.● On Success: An on success output connection. That is, the success of this operation starts the operation

to which it connects – the child operation.● On Failure: An on failure output connection. That is, the failure of this operation starts the operation to

which it connects – the child operation.

You can move the operation around the viewport: move the cursor over in the process and when the cursor changes to selection mode, drag and drop operation icon to change its place in the process. Processes can also be auto-arranged and connection lines bent, for easier viewing.

Operations and links must be selected to move and delete them.



You can select multiple operations and links simultaneously.

Selected operations are displayed with a light gray border, and selected links are displayed as dotted lines.

After selecting operations and links, if you click elsewhere in the viewport your selection is cleared.

Operations can be skipped to instruct SAP 3D Visual Enterprise Generator to ignore those operations when executing a process. Additionally, breakpoints can be inserted in operations to stop the process before those operations begin.

Skipped operations are indicated by a blue s at the top left of the operation.

Breakpoints are indicated by a blue b at the top left of the operation: they are helpful when you are testing large processes so you can run through the operations that you know to be configured correctly, and stop where you think errors may occur. You can then step through the processes one at a time to locate any errors or continue running the process manually until the next breakpoint.

Activities

Selecting Operations

● To select a single operation or link, choose the operation or link in the viewport.● To select non-adjacent operations and links, choose the first operation or link you require in the viewport,

press CTRL and choose the other operations and links you require.

To select all operations and links, do one of the following:

● Choose Edit Select All on the menu bar● Press CTRL + A on the keyboard

Copying and Pasting Groups of Operations

Do one of the following:

● Select Edit Copy on the menu bar● Press CTRL + C● Right-click the operations and choose Copy

The operations are now ready to be pasted. To paste operations, proceed as follows:

● Select the operations you want to paste.● Do one of the following:

○ Choose Edit Paste on the menu bar.○ Press CTRL + V .○ Right-click the operations and choose Paste.

The operations are pasted into the process and can now be linked.

Deleting Operations and Links

Groups of operations and links can be deleted from the current process simultaneously: when you delete an operation, it is deleted from the process and remains in the toolbox for later use.


To delete operations and links, select the operations and links you want to delete and do one of the following:

● Choose Edit Delete on the menu bar.● Right-click the operations and links and choose Delete.● Choose the operations and links and press DELETE .

The operations and links are deleted from the process immediately.

Undoing and Redoing Actions

To undo your last action, do one of the following:

● Choose Edit Undo on the menu bar● Press CTRL + Z● To redo your last action, do one of the following:

● Choose Edit Redo on the menu bar● Press CTRL + Y

Skipping Operations and Setting Breakpoints

● To skip an operation, right-click the operation and choose Skip. The operation displays a blue s.● To clear a skip, right-click the operation and choose Skip. The skip is removed from the operation.● To set a breakpoint, right-click the operation and choose Toggle Breakpoint. The breakpoint is applied and

the operation displays a blue b.● To clear breakpoints, do one of the following:

○ Right-click the operation and choose Toggle Breakpoint. The breakpoint is removed from the operation.

○ Choose Debug Clear All Breakpoints in the menu bar. All breakpoints are removed from all operations.

● To bend connection lines, choose View Connection Line Style Bend on the menu bar.

● To auto-arrange a process, choose Tools Auto-Arrange on the menu bar.

2.3.3.1.4 Operation Windows

You can use the Operation Editor to enter operation parameters. To open an Operation window, double-click an operation icon.

All operations have the following properties:

● Unique element ID● Description of the operation● Toolbox group● Parameters

Operations contain parameters into which you enter values that define the operations. Certain parameters are mandatory, while others can be added to define the operation further. By default, the trigger operation includes the filename parameter which can be removed if required. The notification operation includes the queuename and label parameters. These parameters are mandatory for this operation.

The operations that are delivered with SAP 3D Visual Enterprise Generator are called standard operations and are all displayed in the Process Designer. For more information, see http://help.sap.com/ SAP Visual




Enterprise Generator SAP 3D Visual Enterprise Generator 9.0 Operations Reference for SAP Visual Enterprise Generator .

You can do the following with the operations:

● View all existing operations within their toolbox groups● Create new trigger and notification operations● Load and edit operations● Generate Web-service operations for communicating with external applications

Activities

You can view operation components in the operation windows and the Operation Editor.

In operation windows, you can edit operation parameters. To open operation window, double-click an operation.

When you double-click an operation in the viewport, the operation window is docked on the right side of the Process Designer. Parameters can be expanded and their values edited; clicking a parameter displays the parameter description. Operation windows can also be resized, floated, docked, and hidden.

Floating and Docking Windows

You can display Operation windows in the Process Designer by floating in the viewport, and stacked or tabbed on other operation windows in dockable locations. When a location becomes dockable, the window outline changes its shape.

To float an Operation window, do one of the following:

● Drag the docked window by its title bar to the viewport. The window floats in the viewport; you can reposition, resize, or dock it.

● Double-click the docked window title bar. The window is floated to its previous location.

To dock an Operation window, do one of the following:

● Drag the floating window by its title bar to the top, bottom, or right edge of the viewport or another operation window. The window is docked; you can reposition, resize, or float it.

● Double-click the floating window title bar. The window is docked to its previous location.

Showing and Hiding Windows

To hide Operation windows, do one of the following:

● Right-click the window title and click the name of the window you want to hide. The window is hidden.● Right-click the window title and choose Hide All. All windows are hidden.

To show operation windows, do one of the following:

● Right-click the window title and click the name of the window you want to show. The window is displayed in its previous location.

● Right-click the window title and choose Show All. All hidden windows are shown.


2.3.3.1.4.1 Operations Information

2.3.3.1.4.1.1 2D Raster Graphics

go_2d_flip

Flips 2D images horizontally or vertically.

Parameter Name Parameter Type Parameter Description

direction string The direction to flip, must be horizontal or vertical.

Possible values are:

● Horizontal: horiz● Vertical: vert

go_2d_tograyscale

Applies a grayscale mode to a 2D image.

go_2d_getmetadata

Extracts metadata information from an open 2D image.


metadataobject metadataparameter2d The extracted image metadata

outputfilepath filename An optional file to write the data to

go_2d_open

Opens a 2D file so that other 2D operations can run.


filename filename The location of the 2D file to open




width integer The width of the 2D file

height integer The height of the 2D file

go_2d_rotate

Rotates an open 2D image in an anti-clockwise direction by the specified angle.


angle integer The angle to rotate by, must be 90, 180 or 270.


● 90● 180● 270

go_2d_save

Saves an open 2D image to a file in the specified format.


filename filename Specify where to save the file

fileformat string The 2D file type, for example, jpg, bmp

width integer The width in pixels of the image

height integer The height in pixels of the image

go_2d_save_fittopreserveaspectratio

Saves an open 2D image to a file in the specified format and preserves both the aspect ratio of the image and the canvas size of the output.



filename filename Specifies the location to save the file

fileformat string The 2D file type, for example, jpg, bmp

width integer The target width of the image

height integer The target height of the image

background integer The background color of the image

transparency integer The background transparency level (0 is transparent, 100 is opaque)

2.3.3.1.4.1.2 2D Vector and 3D Graphics

go_collapse_matai_scene

Collapses scene hierarchies using smart logic


sourcefilepath string The path to the location in which the source VDS file is located

destinationfilepath string The path to the location in which the VDS file is to be saved

go_hotspots_read_update

Reads and updates hotspots


sourcefilepath string The path to the location in which the source VDS file is located. This parameter is required.

inputparameters string A JSON string that specifies filters and data to be retrieved




destinationfilepath string The path to the location in which the VDS file is to be saved. This parameter is required.

updateparameters string A JSON string that specifies the modifi-cations to be applied to the hotspots. This parameter is required if you wish to update hotspots..

go_animation_setproperties

Sets specific properties for an animation range.


animationrangeindex integer The index of the animation range

starttime float Start time in seconds

endtime float End time in seconds

fps float Frames per second

go_thumbnail_createanimated

Creates an animated GIF file thumbnail from the scene.


outputfilename filename Output animation filename. This value is optional if stream is provided.

outstream stream Output stream. This value is optional if filename is provided.

width integer Width of the GIF file

height integer Height of the GIF file



axis integer Rotation axis.


● X, 0● Y, 1● Z, 2

frames integer Number of frames in animation

delay integer Delay between frames of animation in milliseconds

antialiasing integer Anti-aliasing.


● None, 0● 2x2, 1● 3x3, 2● 4x4, 3

go_object_assigndefaultmaterialtoall

Assigns the default material to all objects in a scene.

go_cadsearchpath_add

Sets additional search path for CAD plug-ins.


path string Additional search path

recurse boolean If true, checks subdirectories for CAD files

go_cadsearchpath_clear

Clears all additional paths for CAD plug-ins.



go_camera_setactiveparams

Sets the camera parameters for the active camera.


Camera string Accepts space delimited list of floats in following order:


● 16 for camera node 3d 4x4 row-major matrix

● 1 for FOV● 3 for camera position● 3 for camera target coordinates● 3 for camera up vector● 1 for camera aspect ratio● 1 for camera zoom factor● 0 if the camera is orthographic

go_camera_setactivefov

Changes the active camera’s field of view binding (minimum, maximum, horizontal, vertical) and angle.


mode integer The field of view mode constant.


● Minimum from width or height● Maximum from width or height● Horizontally● Vertically

fov float Field of view value in degrees (0-90)

go_camera_setactiveview

Changes the view of the active camera to a predefined view.



View integer The camera view.


● Orthographic Left: 1159● Orthographic Right: 1160● Orthographic Top: 1161● Orthographic Bottom:1162● Orthographic Front: 1163● Orthographic Back: 1164● 30° Isometric LTF: 11051● 30° Isometric LTA: 11052● 30° Isometric RTA: 11053● 30° Isometric RTF: 11054● 30° Isometric LBF: 11055● 30° Isometric LBA: 11056● 27° Isometric RBA: 11057● 27° Isometric RBF: 11058● 27° Isometric LTF: 11059● 27° Isometric LTA: 11060● 27° Isometric RTA: 11061● 27° Isometric RTF: 11062● 45° Isometric LBF: 11063● 45° Isometric LBA: 11064● 45° Isometric RBA: 11065● 45° Isometric RBF: 11066● 45° Isometric LTF: 11067● 45° Isometric LTA: 11068● Dimetric RTA: 11069● Dimetric RTF: 11070● Dimetric LBF: 11071● Dimetric LBA: 11072● Dimetric RBA: 11073● Dimetric RBF: 11074● 43° Trimetric LTF: 11075● 43° Trimetric LTA: 11076● 43° Trimetric RTA: 11077● 43° Trimetric RTF: 11078● 43° Trimetric LBF: 11079● 43° Trimetric LBA: 11080● 48°Trimetric RBA: 11081● 48°Trimetric RBF: 11082● 48°Trimetric LTF: 11083




● 48°Trimetric LTA: 11084● 48°Trimetric RTA: 11085● 48°Trimetric RTF 11086

go_camera_setactiveprojectionmode

Toggles the perspective projection mode of the active camera.


perspective boolean Selected: Sets active camera projection mode to Perspective

Cleared: Sets active camera projection mode to Orthographic.

go_plugin_checklicense

Checks the licensing state of the specified plug-in.


pluginguid string GUID of plug-in to check

islicensed boolean Indicates whether the plug-in is licensed

fileformatname string The name of the plug-in file format

go_object_deselectall

Clears the current object selection.

go_context_load

Loads the saved settings from an XML file.



filename filename The path to the file containing the saved context

go_context_save

Creates and saves an XML file that contains the settings used at runtime.


filename filename Specifies where to save the file

go_thumbnail_createstatic

Saves a scene as a 2D thumbnail file.


width integer The width in pixels of the 2D file

height integer The height in pixels of the 2D file

infilename filename The name of the input file

instream stream Input stream

outfilename filename The name of the thumbnail

outstream stream Thumbnail stream

result boolean Result of operation

go_fileformat_getall

Returns a list of the file formats for all current SAP 3D Visual Enterprise Generator plug-ins.


fileformats collectionparameter The collection of loaded plug-ins



go_scene_get2dmodeflag

Gets the current value of the 2D mode flag.


current2dstate boolean Current value of 2D mode flag

go_scene_getexternalfile

Gets an external file from the scene.


filename string Name of the file in scene media folder

outfilename filename The location of the file

outstream stream Data stream

go_fileformat_getbyguid

Gets the name of the file format matching a specified GUID.


guid string File format or plug-in GUID

formatName string The name of the file format matching the specified GUID

go_plugin_getguidandlicensestatus

Retrieves the GUID and licensing status of a plug-in using the file name of the plug-in x3d file.



pluginfilename string File name of the plug-in, without full path and including extension, for example, test.x3d

pluginguid string GUID of specified plug-in

islicensed boolean Indicates whether the plug-in is licensed

go_object_getselectedsurfacearea

Returns the surface area of the selected objects in the scene.


surface double Surface area of selected objects

go_object_getselectedvolume

Returns the volume of selected objects.


volume double Volume of selected objects

invertedvolume double The volume of the selected objects subtracted from the volume of the bounding box for the selected objects

boundbox double The volume of the bounding box for the selected objects

go_view_isorthographic

Determines whether the projection mode of a view is perspective or orthographic.




ViewId integer The ID of the view to check

IsOrtho boolean If true, the view is orthographic

go_layer_create

Creates a new layer in the scene.


name string Name of the new layer

objectid integer ID of the created layer object

go_layer_delete

Deletes a layer from the scene.


name string Name of the layer. This is used to find the layer if objectid parameter name is not specified.

objectid integer ID of the layer object

go_layer_rename

Renames a layer in the scene.


name string Name of the layer

objectid integer ID of the layer object



newname string Name of the layer. This is used to find the layer if objectid parameter name is not specified.

go_layer_getall

Extracts information for all layers in the scene.


objectcollection collectionparameter A collection of objects describing the object ID, name and style of each layer found in the scene

go_scene_getexternalfiles

Gets a list of external files from the scene.


listoffiles collectionparameter A list of external media files in the scene

go_scene_getmaterials

Lists all the materials in the scene.


materials collectionparameter List of materials in the scene

scene_materials boolean Lists materials that are in use (applied to a mesh)

go_material_assign

Applies a specific material to the selected objects in the scene.




materialname string Material name. Used to find the material if materialid is not specified.

materialid integer Material object ID

go_material_getparams

Gets the parameters for a particular material.



ambient integer Ambient light color

diffuse integer Diffuse light color

specular integer Specular light (reflection) color

emissive integer Emissive light (glow) color

opacity float Opacity of the material (0-100)

glossiness float The model’s highlighting (0-100)

speclevel float Intensity of the specular light (0-100).

reflection float Material’s ability to reflect (0-100)

refraction float Determines how much light is bent when traveling through material (0-100)

doublesided boolean The double-sided attribute for the material

rendoutlines boolean Render the thickness of outlines relative to the value of the linesvalue parameter

linesvalue float Thickness of outlines if rendoutlines parameter is set to true (0-100)


go_material_gettexture

Gets a specific texture definition for a specified material.



mapid integer Texture map ID.


● Diffuse: 0● Bump: 1● Opacity: 2● Reflection: 3● Refraction: 4● Specular: 5● Ambient: 6● Self Illumination: 7● Specular Level: 8● Glossiness: 9● Ambient Occlusion: 10● MAP #11: 11● MAP #12: 12● MAP #13: 13● MAP #14: 14● MAP #15: 15● MAP #16: 16● MAP #17: 17● MAP #18: 18● MAP #19: 19● MAP #20: 20● MAP #21: 21● MAP #22: 22● MAP #23: 23● MAP #24: 24● MAP #25: 25

texture materialtextureparameter Material texture definition

go_material_import

Imports materials from an RHM file into the scene.




filename filename Materials file

materialsloaded collectionparameter A collection of objects describing the object ID and name of each imported material

go_material_setambientcolor

Sets the ambient color of a material.



ambient integer Material ambient color

go_material_setdiffusecolor

Sets the diffuse color for a material.



diffuse integer Material diffuse color

go_material_setdoublesidedflag

Sets the double-sided parameter for a material.



doublesided boolean Material double-sided flag


go_material_setemissivecolor

Sets the emissive color for a material.



emissive integer Material emissive color

go_material_setglossinesslevel

Sets the glossiness parameter for a material.



glossiness float Material glossiness level (0-100)

go_material_setopacitylevel

Sets the opacity level for a material.



opacity float Material opacity level (0-100)

go_material_setoutlinethickness

Sets the render outlines parameter for a material.



rendoutlines boolean Material render outline flag




linesvalue float Material outline thickness (0-100)

go_material_setparams

Sets the parameters for a material.



ambient integer Ambient light color

diffuse integer Diffuse light color

specular integer Specular light (reflection) color

emissive integer Emissive light (glow) color

opacity float Opacity of the material (0-100)

glossiness float Determines the model’s highlighting (0-100)

speclevel float Intensity of the specular light (0-100)

reflection float Material’s ability to reflect (0-100)

refraction float Determines how much light is bent when travelling through material (0-100)

doublesided boolean The double-sided attribute for the material

rendoutlines boolean Render the thickness of outlines relative to the value of the linesvalue parameter

linesvalue float Thickness of outlines if rendoutlines parameter is set to true (0-100)

go_material_setreflectionlevel

Sets the reflection parameter of the material.




reflection float Material reflection level (0-100)

go_material_setrefractionlevel

Sets the refraction level parameter of the material.



refraction float Material refraction level (0-100)

go_material_setspecularlevel

Sets the specular level parameter of the material.



speclevel float Material specular level (0-100)

go_material_setspecularcolor

Sets the specular color parameter of the material.



specular integer Material specular color

go_material_settexture

Sets a texture for a specific material.





mapid integer Texture object ID


● Diffuse: 0● Bump: 1● Opacity: 2● Reflection: 3● Refraction: 4● Specular: 5● Ambient: 6● Self Illumination: 7● Specular Level: 8● Glossiness: 9● Ambient Occlusion: 10● MAP #11: 10● MAP #12: 12● MAP #13: 13● MAP #14: 14● MAP #15: 15● MAP #16: 16● MAP #17: 17● MAP #18: 18● MAP #19: 19● MAP #20: 20● MAP #21: 21● MAP #22: 22● MAP #23: 23● MAP #24: 24● MAP #25: 25

texture materialtextureparameter Material texture object

go_material_setwireframelinewidth

Sets wireframe line width for all materials in the scene.



wireframelinewidth float Wireframe line width to be applied to materials (>0)

go_scene_mergeduplicatematerials

Merges any duplicate materials in the scene.

go_scene_mergefile

Merges the specified 3D or 2D vector file into the current scene.


filename filename Specifies the location of the file to merge with the current scene

createfilenode boolean Specifies whether a containing node with the filename should be created

objectpath collectionparameter Output parameter. List of paths for loaded objects

go_scene_mergetransformedfile

Merges the specified 3D or 2D vector file into the current scene, applying a transformation matrix to the imported geometry.


filename filename Specifies the location of the file to merge with the current scene

transformationstring string Specifies the transformation matrix to apply to the imported geometry





objectpath collectionparameter Output parameter. List of paths for loaded objects

partid integer Part ID that will be written in the node’s metadata and used for instancing, must be numeric

instanceid integer Instance ID that will be written in the node’s metadata and used for instancing, must be numeric

instancename string Specifies the name that will be set on the new nodes. If empty, the system keeps original node names.

assettypeid integer Type of asset (Part|Sub-assembly)

createastopnode boolean If true, all existing nodes will be children of merged file

go_scene_getmetadata

Extracts metadata information from the current scene.


metadataobject metadataparameter The extracted scene metadata

externalfiles collectionparameter External files

go_scene_open

Opens a 3D or 2D vector file, creating a new scene, any existing scene is discarded.


filename filename The location of the file to open




warnings collectionparameter A collection of warning messages returned from the plug-in

warningsareerrors boolean Specifies whether operation fails when a plug-in returns warning messages

go_scene_openwithplugin

Opens a 3D or 2D vector file with a specified plug-in, creating a new scene, any existing scene is discarded.


filename filename The location of the file to open

plugin string The GUID of the plug-in to use when opening


warnings collectionparameter A collection of warning messages returned from the plug-in

warningsareerrors boolean Specifies whether operation fails when a plug-in returns warning messages

loadmetadataonly boolean Specifies whether operation loads only metadata in scene hierarchy, without any geometry.

go_scene_openempty

Creates an empty 3D scene. Use in conjunction with go_mergefile to create new scenes.


assetid integer If the AssetID is specified, the asset ID value will be set for the empty scene



go_render_raytrace

Saves a 2D view of a scene to a file using a raytrace rendering method.




dpi integer Bitmap resolution, in DPI

filename filename The name of the file

fileformat string The 2D file format of the saved file

bitmapformat integer Bitmap format (bits/pixel).


● RGB [8 bit per channel]: 24● RGBA [8 bt per channel]: 32● RGB [16 bit per channel]: 48● RGBA [16 bit per channel]: 64● RGBA [floating point HDR image]:

128

antialiasing integer Anti-Aliasing.


● None: 0● Adaptive: 1● 2 x 2: 2● 3 x 3: 3● 4 x 4: 4● 5 x 5: 5● 6 x 6: 6● 7 x 7: 7● 8 x 8: 8

filtertexturemaps boolean Filter texture maps

forcetwosidedpolygons boolean Force 2-sided polygons.

shadows boolean Shadows

softshadows boolean Soft shadows

raytracereflections boolean Raytrace reflections



raytracerefraction boolean Raytrace refraction

multithreading boolean Raytrace multi-threading

go_scene_removeexternalfile

Removes an external file from the scene.


filename filename The name of the media file

go_object_removebytype

Removes all instances of a specific type of object from the scene.


objecttype integer The type of object to remove.


● Object: 1● Mesh: 1● Material: 2● Light: 3● Camera: 4● Bone: 6● Markup: 7● Procedural: 8

go_object_removeselected

Removes the selected nodes from the scene.



go_scene_removeunusedmaterials

Removes any unused materials.

go_scene_resettransform

Resets transformation matrixes in all top level object to identity.

go_scene_save

Saves the current scene to a file in the specified format.


filename filename Specifies where to save the file

fileformat string The format to save the file in, for example, rh, 3ds

options integer Objects to save.


● Save all: 0● Save visible only: 1● Save selected only: 2

go_scene_getanimations

Retrieves all animation sequences in the scene.


animationranges collectionparameter Holds the collection of animation sequences

go_scene_zoom

Sets the scene’s zoom factor.



Zoom integer The new zoom setting


● Default View: 0● View to Visible Objects: 1● View to All Objects: 2● View to Selected Objects: 3

go_object_selectall

Selects or deselects all objects in the scene.


select boolean If set to true, selects all objects in the scene

go_object_selectbymetadata

Selects the first object in the scene that has the specified metadata value.


name string Metadata name

value string Metadata value

category string Metadata category

includehidden boolean Include hidden

go_plugin_selectforfile

Selects the plug-in to use to open a particular file.


filename filename The file name to open




stream stream Unused

guid string GUID of selected plug-in

name string Name of selected plug-in

assemblyheirarchyxmltype string Unused

enginefiletype string The graphics engine classification for this file.


● ft3D● ft2D● ftTypeUnknown.

go_camera_settodefaultview

Sets the active camera view to the default camera position.

go_markup_setvisibilityforall

Shows or hides all markup elements.


Show Markups boolean If true, shows all markup elements

go_object_setmetadatawithtype

Sets a single user or system metadata property value on an object in the scene.


ObjectPath string The path to the object for which this metadata will be applied. If unspecified, the metadata is applied to all top level objects in the scene.



SystemMetadata boolean True: Used to set system metadata

False: Used to set user metadata

MetadataGroup string The metadata group/category

MetadataProperty string The property key of the metadata being set.

MetadataType string The data type of the metadata being set.

MetadataValue string The property value of the metadata being set

ObjectType integer Node (0): Metadata is attached to the object specified by the object path

Reference (1): Metadata is attached to all instances of the object specified by the object path.

go_object_setbatchmetadata

Sets, transforms or removes metadata according to instructions in the input XML document in a batch format.

This operation can be used to set metadata based on object hierarchy in the scene, as well as based on metadata fields already present on the object. Additionally, it can be used to remap metadata from one metadata group into a field with a different name on another metadata group.


inputfile filename The fully qualified path to an XML document in Batch Metadata Request format

responsefile filename The fully qualified path to an XML document to write the response to. The response file will be in Batch Metadata Response format.

enablelogging boolean If true, the operation logs all actions that were taken to the task log



go_object_setmetadata

Assigns the metadata key specified to a single object within a scene.


objectpath string Path that uniquely identifies this object

category string Metadata category

keyname string Metadata key name

keyvalue string Metadata key value

objecttype integer Node (0): Metadata is attached to the node determined by the object path

Reference (1): Metadata is attached to all instances of the object

go_object_setname

Assigns a display name to a single object within a scene.


objectpath string Path that uniquely identifies this object

objectname string Name to be set

go_viewport_setsize

Sets the size (in pixels) of the active viewport.


width integer Required output width

height integer Required output height


go_scene_setviewaxis

Sets the view axis for the current scene.


ViewUp string Defines the xyz-axis to be used for the up orientation of the scene

ViewRight string Defines the xyz-axis to be used for the right orientation of the scene

go_setting_setfloat

Sets the value of a plug-in floating point setting.


plugin string The name of the plug-in

key string The name of the setting

value float The value to use

go_setting_setinteger

Sets the value of a plug-in integer setting.




value integer The value to use

go_setting_setstring

Sets the value of a plug-in string setting.






value string The value to use

go_viewport_setmetadata

Set a metadata field on a viewport.


viewportobjectid integer The viewport object ID

category string The metadata category

fieldname string The metadata field name

fieldvalue string The metadata field value

path string The metadata path

subid string The sub ID

datatype string The data type

go_step_export

Exports a step or procedure from the scene.


objectid integer Step or procedure ID

filename filename Full path to the output file.

Can be in *.avi or any other supported bitmap file format. In case of bitmap file this operation creates one file per frame of animation.

width integer Output width



height integer Output height

subtitles boolean If set to true, subtitles are included

result boolean Result of operation

go_step_getall

Lists all the steps and procedures in the scene.


procedures collectionparameter The steps and procedures found in the scene

go_scene_transform

Applies the transformation information into an open scene.


transformationstring string Specifies the transformation matrix

replacematrix boolean True: Replaces scene matrix

False: Multiplies scene matrix

go_viewport_getall

Extracts all views from scene.


objectcollection collectionparameter Holds a collection of object names



go_viewport_setactive

Sets a viewport as the active viewport.


name string Name of the viewport.

Used to find the viewport if the objectid value is not specified.

objectid integer ID of the viewport object

go_object_setvisibility

Sets the visibility status for the selected objects.


visible boolean If set to true, the status is visible

recursechildren boolean Applies visible status recursively to child nodes

go_scene_getxreferences

Extracts cross-reference information for all texture files associated with a scene.


collection collectionparameter Holds a collection of cross-reference parameters

go_render_zbuffer

Saves a 2D view of a scene to a file using a Z-buffer rendering method.






dpi integer Resolution of output image in dpi


fileformat string The 2D file format of the saved file

bitmapformat integer Bitmap format (bits or pixel).


● RGB [8 bit per channel]: 24● RGBA [8 bt per channel]: 32● RGB [16 bit per channel]: 48● RGBA [16 bit per channel]: 64● RGBA [floating point HDR image]:

128

rendermode integer The rendering mode.


● Bounding Box: 1● Transparent Bounding Box: 2● Transparent Bounding Box Outline:

3● Vertices: 4● Shaded Vertices: 5● Wireframe: 6● Shaded Wireframe: 7● Solid: 8● Transparent: 9● Solid Wireframe: 10● Transparent Wireframe: 11● Line Illustration: 12● Solid Outline: 13● Shaded Illustration: 14● Hidden Wireframe: 15

antialiasing integer Anti-Aliasing.

Possible values are

● None: 0● 2 x 2: 1● 3 x 3: 2● 4 x 4: 3




renderadditnlitems boolean Rendering additional items

goc_bounding_box


Scene_Up_Axis integer Possible values are:

● Z: 0● Y: 4● No change: 6

Set_Grid_Mode integer Possible values are:

● No Grid: 0● Wire Grid: 1● Solid Grid: 2● Transparent Grid: 3

Grid_size integer Possible values are:

● 1x1: 1● 2x2: 2● 3x3: 3● 4x4: 4● 5x5: 5● 6x6: 6● 7x7: 7● 10x10: 10● 15x15: 15

Show_Scene_Bounding_Box boolean

Show_Scene_Axes boolean

Show_Cameras_and_Lights boolean

Show_Vertices boolean

Show_Cross_Section boolean

Show_Intersections boolean

Shadow boolean



Show_Markups boolean

Show_Bones boolean

Show_Depth_Cue boolean

Background_top integer

Background_bottom integer

Bounding_box_of_all_objects integer

goc_hidden_wireframe



● Z: 0● Y: 4● No change: 6




● 1x1: 1● 2x2: 2● 3x3: 3● 4x4: 4● 5x5: 5● 6x6: 6● 7x7: 7● 10x10: 10● 15x15: 15










Shadow boolean


Show_Bones boolean




Show_Back-Facing_Geometry boolean

Outline_width float

Lines_in_Line_Illustration_mode integer

Faces_in_Line_Illustration_mode integer

goc_line_illustration



● Z: 0● Y: 4● No Change: 6






● 1x1: 1● 2x2: 2● 3x3: 3● 4x4: 4● 5x5: 5● 6x6: 6● 7x7: 7● 10x10: 10● 15x15: 15







Shadow boolean


Show_Bones boolean





Outline_width float

Outline_angle float





goc_sceneproperties


Material_Override_Ambient integer

none integer


● Z: 0● Y: 4● No Change: 6

Ambient_percentage float


Specular boolean

Environment_Gamma float

Material_Override_Diffuse integer


Use_Default_Material boolean


Smoothing_angle_ float

Outline_width float

Show_Textures boolean

Use_existing_lights boolean

Global_ambient_color integer

Bone_affect_area___Maximum__ integer

Specular_percentage float

Wire_grid integer

Solid_grid_dark_cell integer

Environment_Exposure float

Material_Override_Emission integer



N2D_Files_Background integer

Output_Size_border__margin integer


● 1x1: 1● 2x2: 2● 3x3: 3● 4x4: 4● 5x5: 5● 6x6: 6● 7x7: 7● 10x10: 10● 15x15: 15

Vertex-cross_color integer

Transparent_grid_dark_cell integer

Viewport_labels integer

Subdivision_control_mesh integer

Y_axis integer

Vertices_in_Vertices_mode integer

Lines_in_Shaded_Illustration_mode integer

Default_material_emissive_color integer

Default_material_diffuse_color integer

Bounding_box_of_scene integer

Position integer Possible values are:

● Auto: 0● Offset: 1● Absolute Position: 2

Custom_Position float

Border_of_selected_face integer

Current_Auto_Position float

Selection_highlight integer



Bones integer

Default_material_specular_color integer


Illustration_background_bottom integer

Cutting_plane integer

Blur_Radius integer

Image_Size integer Possible values are:

● 64● 128● 256● 512● 1024● 2048

Illustration_Viewport_labels integer


Render_Method integer Possible values are:

● Bounding Box: 1● Transparent Bounding Box: 2● Transparent Bounding Box Outline:

3● Vertices: 4● Shaded Vertices: 5● Wireframe: 6● Shaded Wireframe: 7● Solid: 8● Transparent: 9● Solid Wireframe: 10● Transparent Wireframe: 11● Line Illustration: 12● Solid Outline: 13● Shaded Illustration: 14● Hidden Wireframe: 15

Global_illumination_color integer

Material_Override_Specular integer



Show_Transparency boolean

Double-sided boolean

Opacity float


Outline_angle float


Light_type integer Possible values are:

● No Lights: 35● White Lights: 35● Day Light: 35● Hard Lights: 35● Colored Lights Red/Green: 35● Colored Lights Blue/Green: 35● Blue Lights: 35● Marsiano Lights: 35● Cube Lights: 35● CAD Optimized Lights: 35● Single Light From Eye: 35

Emission_percentage float


Smoothing boolean

Transparent_grid_light_cell integer

Selected_faces integer

Transparent_bounding_box integer

Shadow boolean

Diffuse_percentage float






Output_size_outer_area integer

Non_Output_Size_area integer


Show_Bones boolean

Use_Existing_Smoothing boolean

Shadow integer

Bone_influence_area integer

X_axis integer

Bounding_box_of_selected_objects integer

Illustration_detailed_view_border integer


Fog integer

Lines_in_Solid_or_Transparent_mode integer


Detailed_view_border integer

Render_Exposure float

Environment_Rotation float

Render_Gamma float

Bone_affect_area_Minimum integer

Cross_section_outline integer

Z_axis integer

Solid_grid_light_cell integer


Surface_normals integer

Default_material_ambient_color integer

Lines_in_Wireframe_mode integer

Illustration_background_top integer


goc_shaded_illustration



● Z: 0● Y: 4● No Change: 6




● 1x1: 1● 2x2: 2● 3x3: 3● 4x4: 4● 5x5: 5● 6x6: 6● 7x7: 7● 10x10: 10● 15x15: 15







Shadow boolean


Show_Bones boolean










Smoothing boolean






Specular boolean




Material_Override_Ambient integer

Material_Override_Diffuse integer

Material_Override_Specular integer

Material_Override_Emission integer

Outline_width float

Outline_angle float



Ambient_percentage float

Diffuse_percentage float

Specular_percentage float

Emission_percentage float


goc_shaded_vertices



● Z: 0● Y: 4● No Change: 6




● 1x1: 1● 2x2: 2● 3x3: 3● 4x4: 4● 5x5: 5● 6x6: 6● 7x7: 7● 10x10: 10● 15x15: 15










Shadow boolean


Show_Bones boolean




goc_shaded_wireframe



● Z: 0● Y: 4● No Change: 6






● 1x1: 1● 2x2: 2● 3x3: 3● 4x4: 4● 5x5: 5● 6x6: 6● 7x7: 7● 10x10: 10● 15x15: 15







Shadow boolean


Show_Bones boolean




goc_solid



● Z: 0● Y: 4● No Change: 6







● 1x1: 1● 2x2: 2● 3x3: 3● 4x4: 4● 5x5: 5● 6x6: 6● 7x7: 7● 10x10: 10● 15x15: 15







Shadow boolean


Show_Bones boolean









Smoothing boolean






Specular boolean




goc_solid_outline



● Z: 0● Y: 4● No Change: 6







● 1x1: 1● 2x2: 2● 3x3: 3● 4x4: 4● 5x5: 5● 6x6: 6● 7x7: 7● 10x10: 10● 15x15: 15







Shadow boolean


Show_Bones boolean









Smoothing boolean






Specular boolean




Outline_width float

Outline_angle float


goc_solid_wireframe



● Z: 0● Y: 4● No Change: 6







● 1x1: 1● 2x2: 2● 3x3: 3● 4x4: 4● 5x5: 5● 6x6: 6● 7x7: 7● 10x10: 10● 15x15: 15







Shadow boolean


Show_Bones boolean





goc_transparent



● Z: 0● Y: 4● No Change: 6




● 1x1: 1● 2x2: 2● 3x3: 3● 4x4: 4● 5x5: 5● 6x6: 6● 7x7: 7● 10x10: 10● 15x15: 15







Shadow boolean


Show_Bones boolean










Smoothing boolean





Specular boolean




goc_transparent_bounding_box



● Z: 0● Y: 4● No Change: 6






● 1x1: 1● 2x2: 2● 3x3: 3● 4x4: 4● 5x5: 5● 6x6: 6● 7x7: 7● 10x10: 10● 15x15: 15







Shadow boolean


Show_Bones boolean







goc_transparent_bounding_box_outline



● Z: 0● Y: 4● No Change: 6




● 1x1: 1● 2x2: 2● 3x3: 3● 4x4: 4● 5x5: 5● 6x6: 6● 7x7: 7● 10x10: 10● 15x15: 15







Shadow boolean


Show_Bones boolean








goc_transparent_wireframe



● Z: 0● Y: 4● No Change: 6




● 1x1: 1● 2x2: 2● 3x3: 3● 4x4: 4● 5x5: 5● 6x6: 6● 7x7: 7● 10x10: 10● 15x15: 15










Shadow boolean


Show_Bones boolean




goc_vertices



● Z: 0● Y: 4● No Change: 6




● 1x1: 1● 2x2: 2● 3x3: 3● 4x4: 4● 5x5: 5● 6x6: 6● 7x7: 7● 10x10: 10● 15x15: 15









Shadow boolean


Show_Bones boolean




goc_wireframe



● Z: 0● Y: 4● No Change: 6







● 1x1: 1● 2x2: 2● 3x3: 3● 4x4: 4● 5x5: 5● 6x6: 6● 7x7: 7● 10x10: 10● 15x15: 15







Shadow boolean


Show_Bones boolean




2.3.3.1.4.1.3 File/Directory/Path

do_directory_attributes

Retrieves file system attributes for the specified directory.



directoryname string The name of the directory

readonly boolean True if the read-only flag is set for the directory, otherwise false

archive boolean True if the archive flag is set for the directory, otherwise false

system boolean True if the system flag is set for the directory, otherwise false

hidden boolean True if the hidden flag is set for the directory, otherwise false

compressed boolean True if the compressed flag is set for the directory, otherwise false

creationtime string Returns the creation time as reported by the operating system

lastwritetime string Returns the last write time as reported by the operating system

po_path_combine

Creates a new path to a directory or file by combining two paths.


basedirectory string The directory on which the new path is based. This must start with a drive letter or be a UNC path.

combinewith string The path to a file or directory. This must not start with a drive letter or be a UNC path.

resultpath string The combination of the base directory with the path to a file or directory

do_directory_copy

Copies a directory to a different destination. If overwrite is set to true, existing files will be overwritten.




from string The location of the directory to be copied

to string The destination directory where the directory is to be copied to

overwrite boolean Set to true to overwrite the files that already exist

recurse boolean Set to true to copy sub-directories

do_directory_create

Creates a file system directory.


directoryname string Full path to the directory to create

do_directory_delete

Deletes a file system directory.


directoryname string The name of the directory to delete

recurse boolean Set to true to recurse sub-directories

do_directory_deletefiles

Deletes selected files from within a directory.


directory string The directory where the files are going to be deleted



pattern string The search pattern to match files that are to be deleted

recurse boolean If true, recurse sub-directories

do_directory_exists

Tests to see whether or not a directory exists.


directoryname string The name of the directory that is to be tested for existence

exists boolean True if the directory exists, otherwise false

do_directory_getdirectories

Returns the names of all directories matching a search pattern in the specified directory.


directory string The directory to search in

match string The search pattern to use for finding directories

recurse boolean Set to true to search sub-directories

directories collectionparameter The matching directories found

do_directory_getfiles

Returns the names of all files matching a search pattern in the specified directory.




directory string The directory to search in

match string The search pattern to use for finding files

recurse boolean Set to true to search sub-directories

files collectionparameter The matching files found

do_directory_move

Moves a directory to a new location.


from string The location of the directory to move

to string The location to move the directory to

fo_file_findtext

Searches for text in a file.


filename filename The file to look in

texttofind string The text to find

exists boolean True if the text was found

fo_file_append

Appends data to a specified file.



data string String to be appended to the end of the file

filename filename The file to write the data to

fo_file_getattributes

Retrieves file system attributes for a specified file.



readonly boolean True if the read-only flag is set for the file, otherwise false

archive boolean True if the archive flag is set for the file, otherwise false

system boolean True if the system flag is set for the file, otherwise false

hidden boolean True if the hidden flag is set for the file, otherwise false

compressed boolean True if the compressed flag is set for the file, otherwise false

length integer Returns the length of the file in bytes

creationtime string Returns the file creation time as reported by the operating system

po_path_buildfilename

Builds a path from a combination of parts (directory, filename, filename without extension, extension, root)


FileNameParts filename The parts of the file name

FileName string The built file name



fo_file_copy

Copies a file. If overwrite is set to true, any existing file will be overwritten.


from filename The location of the file to be copied

to filename The location the file is to be copied to

overwrite boolean If true, the target file will be overwritten if it already exists

fo_fileordirectory_create

Creates a new file system file or directory.


isfile boolean Set to true if this is a file or false if a directory

filename filename Full path to the file or directory to create

do_directory_createworkspacetempdir

Creates a new temporary folder under a workspace folder and returns the full path.


tempfolder string Returns full path of the temporary folder under workspace folder

uselocalworkspace boolean If true, the temporary folder will be created in the local workspace on the local server, otherwise it will be created in the global workspace in the SAP 3D Visual Enterprise Generator share.


fo_file_delete

Deletes an file system file.


filename filename The file to delete

fo_file_delete_with_retry

Delete a file from disk, with exponential backoff on failure


FileName filename The file to delete

MaxRetries integer Maximum number of retries

fo_file_exists

Tests to see whether or not a file exists.


filename filename The name of the file that is to be tested for existence

exists boolean True if the file exists, otherwise false

fo_file_move

Moves a file to a new location.


from filename The location of the file to move

to filename The location to move the file to



po_path_resolveunc

Checks whether a UNC Path resides on a local drive, and returns the local path.


uncpath string The UNC path to be resolved

localpath string The local path if it could be resolved

resolved boolean True if the UNC path could be resolved to a local path

fo_file_savefromstring

Saves a string to a file. If the file already exists it will be overwritten.


filename filename Output file name

data string Data to save

fo_file_gettempname

Generates a unique temporary file name. This operation replaces the namewithoutextension part of the fromfilename with a system generated GUID.


fromfilename filename The parameter that identifies a file name to base the temporary file name on

tempfilename filename The generated temporary file name

fo_file_unzip

Extracts ZIP archive to specified location.



filename filename The zip file to open

location string The destination folder path

fo_file_zip

Creates ZIP archive in the specified location.


foldername string Folder with files that will be zipped

searchpattern string File search pattern. Multiple patterns must be separated by semicolon (*.bmp; *.jpg). *.* will include all files.

includesubfolders boolean If true, will add files from subfolders

filename filename ZIP archive name

2.3.3.1.4.1.4 Flow Control

er_stopprocessing

Stops further processing.


errmessage string Error message

for-each

Performs specified operations for each object returned defined by an XPath expression.

NoteOne for-each operation cannot be the immediate child of another for-each operation.




currentvalue object The current value of the for-each operation

if

Processes one of two possible sets of child operations. The children of the then branch are executed if the XPath condition evaluates to true, otherwise the children of the else branch are executed.

pause

Pauses process execution for a specified number of seconds.


seconds integer The number of seconds to pause

set

Sets the value of a variable in the process.


name string The variable name

value string The value to set the variable to

standarderror

Captures errors that occur while processing an operation and then determines the course of action to take.


stacktrace string Output parameter. Will be populated with a stack trace for diagnostic purposes.



raisedby string Output parameter. Will be populated with the name of the operation that raised the error.

message string Output parameter. Will be populated with the associated error message.

action string Input parameter

● Raise: The error is thrown to the next level where it may be handled.

● Continue: SAP 3D Visual Enterprise Generator will continue processing the next operation.

● Exit: SAP 3D Visual Enterprise Generator will exit the process.

standardterminatehandler

Standard terminate handler

variable

Creates a process level global variable and sets its initial value.


value string The value of the variable

while

Processes its child operations repeatedly until the XPath condition evaluates to false.



2.3.3.1.4.1.5 General Operations

guid_createnew

Creates a new GUID.


createdguid string The created GUID

datetime_tostring

Formats an input datetime string using the specified format string.


inputstring datetime The input date/time to format. Set to now() for current date/time or any valid date time string format.

formatmask string The format mask

● d: Short date format● D: long date format● t: short time format● T: long time format● g: short date/short time

For more information, see Microsoft help for standard date/time format strings.

outputstring string The formatted output

email_send

Sends an e-mail using an SMTP server.



smtp string The address of the SMTP server that will send the e-mail, for example, smtp.mydomain.com.

subject string The subject line of the e-mail

body string The body text of the e-mail

bodyformat integer The body format of the e-mail.

● TEXT: 0● HTML: 1

from string The sender of the e-mail. Some SMTP servers require that this is a valid e-mail account on the SMTP server.

to string The e-mail addresses of the intended recipient

attachments string A semi colon delimited list of files to attach to the e-mail message

rhz_extractvzxml

Extracts the model.vzxml from the specified .RHZ file to specified file name.


RhzFilePath filename RHZ file containing model.vzxml to extract

OutputFilePath filename Fully qualified path to save the model.vzxml file to

http_download

Download file from URL over HTTP protocol.


Url string Source URL




FilePath filename Target file name

StatusCode integer HTTP status code from download request

http_upload

Upload file to specified URL using HTTP protocol


Url string Target URL

FilePath filename Source file name

ContentType string The MIME type of the file to be stored

StatusCode integer HTTP status code from upload request

log_add

Saves a message of a specified type to the log file.


autoflush boolean True if the log should be automatically flushed and closed when all child operations are complete. If false, then Save and Close should be explicitly called.

filename filename The log file path

level integer The level of message to record.

● Error: 0● Error (0): Logs error messages● Warning (1): Logs warnings and er

ror messages● Info (2): Logs error, warning and

info messages


log_message

Logs a message to the log file.


eventtype integer The type of error message.

● Error: 0● Warning: 1● Info: 2

message string The text to add to the log

filename filename The external text file to add to the log if message is not specified

log_save

Saves the log file to the specified location.


filename filename The log file path

xml_setvalue

Sets a text value in an XML file.


filename filename XML file name

propertyname string XPath expression to use to find nodes to modify

propertyvalue string Value to set as the node’s inner text

serverproperties_getall

Retrieves installation configuration information.




smtp_server string Configured SMTP server

GlobalWorkspace string Path to global farm workspace

LocalWorkspace string Path to local server workspace

InstallPath string Path where SAP 3D Visual Enterprise Generator is installed on the local server

ServerId string Name of the processing engine running this process

ServerVersion string Software version of the processing engine running this process

xml_extract

Inserts the contents of an external XML document into the task results document.


filename filename The name of the XML file to read

data collectionparameter The XML elements that were read from the file, in the same structure as in the file

task_resultsdocument_tomsmq

Enqueues the task results document to an MSMQ queue.


queuename string The MSMQ queue name

label string The MSMQ message label

task_resultsdocument_tofile

Writes the XML task results document to an external file.



outputfile filename The name of the XML file to write the task results document to

transformation string The name of the XSLT transformation file that will be used to format the XML (optional)

pdf_headerfooter

Copies content of existing PDF and add header or footer.


inputfile filename The location of the PDF template.

outputfile filename The resulting PDF file name path. Will be overwritten if already exists.

alignment string Where to align text in the header or footer:

● Left● Right● Center● Justify

pagenumbers boolean True if you want page numbers in header or footer.

headerorfooter string Placement on the document, header or footer

textbefore string Text to be displayed before page number

textafter string Text to be displayed after the page number. Valid only if pagenumbers is set to true.

lmargin integer Sets left margin

tmargin integer Sets top margin

rmargin integer Sets right margin

bmargin integer Sets bottom margin




font string Font name and optional style to use as comma separated. The font name should be first, and the styles following, for example, Arial,bold. Valid style entries include normal, bold, italic, oblique, underline, line-through.

fontsize integer Font point size

pdf_mergefiles

Merges PDF files using iTextSharp library, with options to create a table of contents and set a header for each page.


filelist string List of files to be merged. Files must be separated by semicolon characters.

outfile filename The resulting PDF file name

addtoc boolean Set to true to add table of contents

toctitle string Title of table of contents. This setting only applies if not using a table of contents template PDF document.

tocstartpercent integer The table of contents start. The percentage down the page (between 0 and 100) where the first table of contents row will begin. This setting only applies if a TOC template PDF is specified.

tocwidthpercent integer The table of contents width. A percentage of the width of the page (between 0 and 100). This setting only applies if a TOC template PDF is specified.

toctemplatefilename string Optional. A single page PDF document containing the table of contents to add to the output document.

totalpages integer The total number of pages in the resulting PDF file


pdf_templatemerge

Uses iTextSharp library to load the specified PDF template form and fill values for named fields.


templatefile filename The location of the PDF template

outputfile filename The output PDF file path. Will be overwritten if already exists.

fieldlist string A delimited list of field names and values

namevaluedelimiter string The character between a field name and its corresponding value in the FieldList

fielddelimiter string The character to separate name value pairs in the FieldList

job_start

Starts a new job managed job.


workflow string The name of the workflow to start a job for

parentjobid integer The job ID of the parent job, if applicable

name string The job name

owner string The username of the job owner

notification_email string The e-mail address to notify when the job completes

priority string The job priority


● Normal● Low● High




jobid integer The ID of the new job

task_start

Sends single notification to initiate a process.


queuename string The MSMQ queue name to send the notification to (optional)

process string The name of the process to start

processparams string The process trigger parameters, if any. Use the format <param1>value1</param1><param2>value2</param2>.

transactionalqueue boolean Whether or not the destination queue is a transactional queue

priority string The priority of the process between 1 and 10, where 1 is the highest priority (Optional)

keyvaluepair_response_setvalue

Sets a key/value pair to be used in a SimpleResponse file.


Name string The name of the value

Value string The value to set

os_shellexecute

Executes a shell command.



command string The path to the file to execute

arguments string The arguments to the command to execute. Tokens of the form %NAME% in this string will be replaced with the values of the parameter NAME.

timeout integer The number of milliseconds to wait for the process to finish, after which the process will be terminated. 0 value is equal to no time-out.

returncode integer The exit code returned by the executed command

keyvaluepair_response_writetofile

Writes a set of simple key/value pair results to a specified file.


ResultsFile filename The destination file for the response

keyvaluepair_trigger_loadfromfile

Reads a set of key/value pairs out of a file and stores the values in process variables.


TriggerFile filename The path to a file containing trigger parameters to read

string_tokenize

Splits a string into tokens.




inputstring string The input string

delimiter string The token delimiter

tokens collectionparameter A collection of tokens

os_waitforosprocessexit

Waits for an operating system process to exit.


processname string The name of the operating system process to wait for

machinename string The host name or IP address of the machine that the operating system process is running on

xml_attributeadd

Adds an attribute to an existing element in an existing XML file.


xmlfilepath filename The path to the XML file to modify

attributename string The name of the attribute to add

attributenamespace string The namespace of the attribute to add

attributevalue string The value of the attribute to add

elementxpath string The XPath expression identifying the element to add the attribute to

namespacemappings string A pipe ‘|’ separated list of prefix=name-space pairs


xml_elementadd

Adds an element to an existing XML file.


xmlfilepath filename The path to the XML file to modify

elementname string The name of the element to add

elementnamespace string The namespace of the element to add

parentelementxpath string The XPath expression identifying the parent element of the element to be added

elementposition integer An identifying the position of added element beneath its parent


xml_elementcount

Returns the number of XML elements matched by an XPath expression.


xmlfilepath filename The path of the XML file to read

elementxpath string The XPath expression identifying the elements to find

matchingelementcount integer The number of XML elements matching the XPath expression


xml_elementexists

Returns whether an XPath expression can be resolved to a single XML element.




xmlfilepath filename The path of the XML file to read.

elementxpath string The XPath expression identifying the element to find.

xmlelementexists boolean Returns whether the XPath expression matched a single XML element.

namespacemappings string A pipe ‘|’ separated list of prefix=name-space pairs.

xml_escapestring

Escapes invalid XML characters from the input string.


input_string filename The input string

output_string filename The escaped output string

xml_getattributevalue

Adds an attribute to an existing element in an existing XML file.


xmlfilepath filename The path of the XML file to read

elementxpath string The XPath expression identifying the element to find

attributename string The name of the attribute to find.

attributenamespace string The namespace of the attribute to find

attributevalue string The value of the attribute



xml_xslttransform

Applies and XSLT transformation to an XML file.


xslt_filepath filename The path to the XSLT file to read

input_filepath filename The path to the input XML file

output_filepath filename The path to the output XML file

2.3.3.1.4.1.6 Import/Export Settings

Right_Hemisphere_Binary_ExportOptions


fileformat None Provided N/A

compress boolean Compression

animation boolean Export animation

q_points integer Vertices quality


● 10%: 10● 20%: 20● 30%: 30● 40%: 40● 50%: 50● 60%: 60● 70%: 70● 80%: 80● 90%: 90● 100% (lossless): 100




q_uv integer UV vertices quality


● Off: 0● 10%: 10● 20%: 20● 30%: 30● 40%: 40● 50%: 50● 60%: 60● 70%: 70● 80%: 80● 90%: 90● 100% (lossless): 100

q_normals integer Normals quality


● Off: 0● 10%: 10● 20%: 20● 30%: 30● 40%: 40● 50%: 50● 60%: 60● 70%: 70● 80%: 80● 90%: 90● 100% (lossless): 100

protect integer File protection


● No: 0● Conversion Protected: 1● Read Only: 2

measurements boolean Disable measurements

viewports boolean Export viewports



thm string Thumbnail


● No thumbnail● 32 X 32● 48 X 48● 64 X 64● 72 X 72● 80 X 80● 90 X 90● 100 X 100● 120 X 120● 128 X 128● 150 X 150● 180 X 180● 200 X 200

encrypt boolean Password-encrypted

watermark_action integer Watermark


● Preserve: 0● Add/Overwrite: 1● Remove: 2

watermark string Watermark file

N7zip_Mode integer Compression mode


● Very Fast: –1● Fast: 0● Normal: 1● Best: 2




N7zip_DicSize integer Dictionary size


● 32 KB: 15● 64 KB: 16● 128 KB: 17● 256 KB: 18● 512 KB: 19● 1 MB: 20● 2 MB: 21● 4 MB: 22● 8 MB: 23● 16 MB: 24● 32 MB: 25● 64 MB: 26● 128 MB:27

export_safe_form integer Saving solid objects


● Only solid: 0● Solid and mesh: 1● Only mesh: 2

Autodesk_3D_Studio_ExportOptions



e_UV boolean Texture coordinates

e_ignoreUV boolean Remove UV scale and offset from materials

e_saveh boolean Export hierarchy information

e_savesmooth boolean Export smooth groups data

e_matrix boolean Export local matrix

e_lights boolean Export lights



e_cameras boolean Export cameras

e_defcameras boolean Export default camera

Visual_XML_ExportOptions



export_validate_xml boolean Validate XML

export_using_memory_stream boolean Use memory streams

export_rh_file_compression_level integer RH file compression


● Very Fast: –1● Fast: 0● Norma: 1● Best: 2

export_generate_dsids boolean Generate SAP 3D Visual Enterprise Generator IDs

XAML_ExportOptions



e_root_element_type integer Root element type


● Model3D: 1● Viewport3D: 2




e_animation_behaviour integer Animation behavior


● Play once: 1● Repeat: 2

e_copy_viewer boolean Include standalone viewer with model

e_launch_viewer boolean Launch viewer after export

e_back_materials boolean Export back materials

e_default_lights boolean Export default lights

e_use_quaternions boolean Use quaternions for rotation

e_force_srt boolean Use scale/rotation/translation order for transformations

e_viewport_max_width integer Maximum width

e_viewport_max_height integer Maximum height

e_tex_save boolean Save textures

e_tex_existing integer Overwrite existing


● Replace: 0● Skip: 1● Rename: 2

e_tex_format integer Convert textures to


● PNG – Portable Network Graphics: 1

● JPG – JPEG Image: 2● TIF – Tagged Image File Format: 3● BMP – Windows Bitmap Graphics:

4


DirectX_Model_ExportOptions



ASCII boolean ASCII mode

Materials boolean Export materials

Templates boolean Export templates

TopFrame boolean Add top level frame

LeftHand boolean Flip coordinate system

SaveSkin boolean Export skins

SaveEmptyBones boolean Export empty bones

NoBonesMesh boolean Export bones without meshes

all_nodes boolean Export empty nodes

MaxNodeName integer Maximum object name

Normals boolean Export normals

FlipNormal boolean Invert normals

Textures boolean Texture coordinates

e_maxpoly integer Maximum vertices in polygon

AutoCAD_Design_Web_Format_ExportOptions



DWFExportFormat integer Mode


● Auto-select: 0● 3D model: 2



DICOM_Image_ExportOptions



compression integer Compression


● Raw data: 0● RLE compression: 1

color integer Photometric interpretation


● Monochrome 1: 0● Monochrome 2: 1● RGB: 2

Open_Inventor_File_ExportOptions



Indent boolean Add indents

Lights boolean Export lights

Cameras boolean Export cameras.

DefCamera boolean Export default camera


TxtCrd boolean Export texture coordinates

Lines boolean Export polylines



SOFTIMAGE_XSI_ExportOptions



SaveAsVersion integer Version


● XSI 3.5 Realtime materials: 0● XSI 3.5 Softimage materials: 1● XSI 3.0: 2


Textures boolean Export textures


TopFrame boolean Add top level frame

FlipNormal boolean Invert normals

Indents boolean Add indents

ExportPerVertexColor boolean Export per vertex color

Change_Axes boolean Swap Y and Z axes

UseNulls boolean Create dummy objects

MakeCompatible boolean XSI 2.0 compatibility

anim__rescale boolean Rescale animation

anim__rescaletype integer Rescale type


● Length (cs): 0● By percent: 1

anim__setLengthTo float Centiseconds

anim__rescalepercent float Percent

anim__reverse boolean Reverse animation sequence

anim__mergekeys boolean Remove redundant keys

anim__sampleanimation boolean Sample animation




anim__samplerate integer Sample frames

3ds_Max_File_ExportOptions



e2m_triangulate boolean Triangulate

e2m_normals boolean Export normals

e2m_subd_mode integer SubD mode


● Export control mesh: 1● Export final mesh: 2

e2m_use_skins boolean Export skins

e2m_use_lights boolean Export lights

e2m_use_cameras boolean Export cameras

e2m_use_default_camera boolean Export default camera

e2m_hide_dummies boolean Hide dummy nodes

e2m_group_mode integer Group mode


● Do not create: 0● Create as opened: 1● Create as closed: 2

e2m_conv_inst_2_uniq boolean Convert instances to unique

e2m_pass_metadata boolean Export metadata

mpo_use_remote_server boolean Use remote 3ds Max DCom server

mpo_remote_server_name string Remote 3ds Max DCom server name


VRML_Worlds_ExportOptions



Type integer Version


● VRML 1.0: 1● VRML 2.0: 2

Indent boolean Add indents

e_flip boolean Flip coordinate system

Lights boolean Export lights

Cameras boolean Export cameras

DefCamera boolean Export default camera


TxtCrd boolean Export texture coordinates

Lines boolean Export polylines


e_maxpoly integer Max vertices in polygon

Visual_Design_Stream_ExportOptions



FileExpiration boolean File expiration

ExpirationDays integer Days to expire




MatrixType integer Accuracy


● Float: 0● Double: 1● Autodetect: 2

MatrixTolerance string Tolerance

TextureType integer Texture type


● None: 0● PNG: 1● JPG: 2

ColorsAsBytes boolean Colors accuracy

WriteGlossinessAndSpecularLevel boolean Glossiness and specular level

DetectMaterialInstances integer Detect material instances


● No: 0● Yes: 1● Yes and ignore material names: 2

LODType integer Number of LODs


● None: 0● Points, low (every 16th): 1● Points, medium low (every 8th): 2● Points, medium (every 4th): 3● Points, medium high (every 2nd): 4● Points, high (every square root of

2): 5● Triangles, low (10%, 50%): 6● Triangles, medium (5%, 10%, 25%,

50%): 7● Triangles, high (5%, 10%, 25%,

38%, 50%, 75%): 8

LODMinVertices integer Minimum vertices in LOD

SubmeshMaxTriangles integer Submesh triangle count



SubmeshSplitTries integer Submesh split attempts

PositionQuants integer Vertices quality


● 10%: 256● 20%: 1024● 30%: 4096● 40%: 8192● 50%: 16384● 60%: 32768● 70%: 65536● 80%: 262144● 90%: 524288● 100%: 0

NormalQuants integer Normals quality


● 10%: 359● 20%: 719● 30%: 1439● 40%: 2879● 50%: 5759● 60%: 11519● 70%: 23039● 80%: 32768● 90%: 65536● 100%: 0

TexCoordQuants integer UV vertices quality


● 10%: 256● 20%: 1024● 30%: 4096● 40%: 8192● 50%: 16384● 60%: 32768● 70%: 65536● 80%: 262144● 90%: 524288● 100%: 0




Metadata integer Processing


● Don’t export: 0● No instancing: 1● Partial instancing (sets only): 2● Full instancing (sets and values): 3

MinRecordsForTable integer Minimum records for table

MinDuplicatesForTable integer Minimum duplicates for table

LightWave_Scene_ExportOptions



SaveVersion integer Version


● LightWave 5.6: 1● LightWave 6.0: 2

layered_object boolean Export single layered object

ExportSkin boolean Export skins

oneinstance boolean Export one object instance

e_viewport boolean Export viewport

e_lights boolean Export lights

folder string Copy objects to folder

prefix string Use prefix


JPEG_2000_JPC_ExportOptions



lossy boolean Lossy compression

targetpercentage integer Percentage file size

Rhinoceros_3D_Model_ExportOptions



RhinoExportSkipHiddenObjects boolean Skip hidden objects

RhinoExportPutCurvesInSingleLayer boolean Put all curves in single layer

RhinoExportLights boolean Export lights

RhinoExportCameras boolean Export cameras

Office_Powerpoint_Document_ExportOptions



template string Template


● basic.htm● basic_2007.htm● steps_n_views.htm● steps_n_views_2007.htm

use_external_template boolean Use external template

external_template filename External template

preview boolean Open in browser/program




rh_compress boolean Compression

rh_animation boolean Export animation

rh_q_points integer Vertices quality

● 10%: 10● 20%: 20● 30%: 30● 40%: 40● 50%: 50● 60%: 60● 70%: 70● 80%: 80● 90%: 90● 100% (lossless): 100

rh_q_uv integer UV vertices quality


● OFF: 0● 10%: 10● 20%: 20● 30%: 30● 40%: 40● 50%: 50● 60%: 60● 70%: 70● 80%: 80● 90%: 90● 100% (lossless): 100



rh_q_normals integer Normals quality


● OFF: 0● 10%: 10● 20%: 20● 30%: 30● 40%: 40● 50%: 50● 60%: 60● 70%: 70● 80%: 80● 90%: 90● 100% (lossless): 100

rh_protect integer File protection



rh_measurements boolean Disable measurements

rh_viewports boolean Export viewports

rh_thm string Thumbnail


● No thumbnai● 32 X 32● 48 X 48● 64 X 64● 72 X 72● 80 X 80● 90 X 90● 100 X 100● 120 X 120● 128 X 128● 150 X 150● 180 X 180● 200 X 200

rh_encrypt boolean Password-encrypted




rh_watermark_action integer Watermark



rh_watermark string Watermark file

rh_7zip_Mode integer Compression mode


● Very Fast: –1● Fast: 0● Normal: 1● Best: 2

rh_7zip_DicSize integer Dictionary size


● 32 KB: 15● 64 KB: 16● 128 KB: 17● 256 KB: 18● 512 KB: 19● 1 MB: 20● 2 MB: 21● 4 MB: 22● 8 MB: 23● 16 MB: 24● 32 MB: 25● 64 MB: 26● 128 MB: 27

rh_export_safe_form integer Saving solid objects



AUTHOR string Author

TITLE string Title

DESCRIPTION string Description


HTML_Document_with_3D_ExportOptions





● animation_n_layers.html● ansi_style.html● ansi_style_ex.html● basic.html● catia_pmi_selection.html● java_scripting.html● jt_pmi_selection.html● marsiano_style.html● object_only.html● simple_animation.html● standard_views.html● steps_n_model_views.html● steps_n_parts.html● steps_n_procs.html● test_sample.html











● OFF: 0● 10%: 10● 20%: 20● 30%: 30● 40%: 40● 50%: 50● 60%: 60● 70%: 70● 80%: 80● 90%: 90● 100% (lossless): 100



● OFF: 0● 10%: 10● 20%: 20● 30%: 30● 40%: 40● 50%: 50● 60%: 60● 70%: 70● 80%: 80● 90%: 90● 100% (lossless): 100



● OFF: 0● 10%: 10● 20%: 20● 30%: 30● 40%: 40● 50%: 50● 60%: 60● 70%: 70● 80%: 80● 90%: 90● 100% (lossless): 100


















● Very Fast: -1● Fast: 0● Normal: 1● Best: 2









TITLE string Title


HTML_Document_with_3D_ExportOptions







● animation_n_layers.html● ansi_style.html● ansi_style_ex.html● basic.html● catia.pmi_selection.html● java_scripting.html● jt_pmi_selection.html● marsiano_style.html● object_only.html● simple_animation.html● standard_views.html● steps_n_model_views.html● steps_n_parts.html● steps_n_procs.html● test_sample.html








● 10%: 10● 20%: 20● 30%: 30● 40%: 40● 50%: 50● 60%: 60● 70%: 70● 80%: 80● 90%: 90● 100% (lossless): 100






● OFF: 0● 10%: 10● 20%: 20● 30%: 30● 40%: 40● 50%: 50● 60%: 60● 70%: 70● 80%: 80● 90%: 90● 100% (lossless): 100



● OFF: 0● 10%: 10● 20%: 20● 30%: 30● 40%: 40● 50%: 50● 60%: 60● 70%: 70● 80%: 80● 90%: 90● 100% (lossless): 100


● Possible values are:● No: 0● Conversion Protected: 1● Read Only: 2















● Very Fast: –1● Fast: 0● Norma: 1l● Best: 2










TITLE string Title


LightWave_3D_and_Binary_Object_ExportOptions



SaveVersion integer Version


● LightWave 5.6: 0● LightWave 6.0: 1



SubDExportMode integer Export SubDs


● Final mesh: 0● Control mesh: 1● Control mesh using PTCH chunk: 2

SaveUVfiles boolean Create .uv files

SaveUVIM boolean Export UVs using chunks

SaveUV boolean Export UVs

SaveVMAD boolean Use discontinuous UVs

SaveExtraMaps boolean Export extra maps

OpenFlight_Scene_Description_Database_ExportOptions



e_local boolean Export vertices in local object space

e_uv boolean Export UVs

e_normals boolean Per vertex normals

e_colors boolean Per vertex colors

e_ref boolean Use instances and references

e_colorpal boolean Export color palette

e_empty_nodes boolean Export empty nodes

Maya_ASCII_Scene_ExportOptions






XAxes integer Up axis in Maya


● Y: 1● Z: 0

exp_opt_maximum_vertices_in_polygon

integer Maximum vertices in polygon

XDoubleSided boolean Mark surfaces as double-sided

XBlinn integer Material type


● Phong: 0● Blinn: 1

XSkins boolean Export skins

exp_opt_tessellate_nurbs boolean Tessellate NURBS

opt_maya_version integer Maya version

Possible value is:

None: –1

Adobe_Portable_Document_2D__with_template__ExportOptions





p1_internal_template_filename string Template


● 2D 4 Tab Views: 4_Tab_2D_Views_v1.0.xml● 2D ANSI Size A Landscape 11X8.5: ANSI_Size_A_Land

scape_11_X_8.5_Template.xml● 2D ANSI Size A Portrait 8.5X11: ANSI_Size_A_Por

trait_8.5_X_11_Template.xml● 2D ANSI Size A Portrait 8.5X11 with Title Block:

ANSI_Size_A_Portrait_TB_Template.xml● 2D ANSI Size B Landscape 17X11: ANSI_Size_B_Land

scape_17_X_11_Template.xml● 2D ANSI Size B Landscape 17X11 with Title Block:

ANSI_Size_B_Landscape_TB_Template.xml● 2D ANSI Size B Portrait 11X17: ANSI_Size_B_Por

trait_11_X_17_Template.xml● 2D ANSI Size C Landscape 22X17: ANSI_Size_C_Land

scape_22_X_17_Template.xml● 2D ANSI Size C Portrait 17X22: ANSI_Size_C_Por

trait_17_X_22_Template.xml● 2D ANSI Size D Landscape 34X22:

ANSI_Size_D_Landscape_34_X_22_Template.xml● 2D ANSI Size D Portrait 22X34: ANSI_Size_D_Por

trait_22_X_34_Template.xml● 2D ANSI Size E Landscape 44X34: ANSI_Size_E_Land

scape_44_X_34_Template.xml● 2D ANSI Size E Portrait 34X44: ANSI_Size_E_Por

trait_34_X_44_Template.xml● 2D Arch Size A Landscape 12X9: Arch_Size_A_Land

scape_12_X_9_Template.xml● 2D Arch Size A Portrait 9X12: Arch_Size_A_Por

trait_9_X_12_Template.xml● 2D Arch Size B Landscape 18X12: Arch_Size_B_Land

scape_18_X_12_Template.xml● 2D Arch Size B Portrait 12X18: Arch_Size_B_Por

trait_12_X_18_Template.xml● 2D Arch Size C Landscape 24X18: Arch_Size_C_Land

scape_24_X_18_Template.xml● 2D Arch Size C Portrait 18X24: Arch_Size_C_Por

trait_18_X_24_Template.xml● 2D Arch Size D Landscape 36X24: Arch_Size_D_Land

scape_36_X_24_Template.xml● 2D Arch Size D Portrait 24X36: Arch_Size_D_Por

trait_24_X_36_Template.xml




● 2D Arch Size E Landscape 48X36: Arch_Size_E_Landscape_48_X_36_Template.xml

● 2D Arch Size E Portrait 36X48: Arch_Size_E_Portrait_36_X_48_Template.xml

● 2D Basic Landscape Letter Template: Basic_Horiz_Letter_2D_Template.xml

● 2D Basic Portrait Letter Template: Basic_Vert_Letter_2D_Template.xml

● 2D ISOSize A0 Landscape 1189X841: ISO_Size_A0_Landscape_1189_X_841_Template..xml

● 2D ISOSize A0 Portrait 841X1189: ISO_Size_A0_Portrait_841_X_1189_Template..xml









p1_use_external_template boolean Use external template

p1_external_template_filename filename External template

p1_annot_place_title string 3D model or 2D image target

● Possible values are:● 2D_Annotation1● 2D_Annotation2● 2D_Annotation3● 2D_Annotation4

p1_run_acrobat boolean Start Adobe Acrobat after publishing



p2_2d_image_align integer Align


● Stretch: 0● Fit to Left/Top: 1● Fit to Center/Top: 2● Fit to Right/Top: 3● Fit to Left/Center: 4● Fit to Center/Center: 5● Fit to Right/Center: 6● Fit to Left/Bottom: 7● Fit to Center/Bottom: 8● Fit to Right/Bottom: 9

p3_xfdf_filename filename XFDF file name

p3_attach_filename filename Attachments

p3_js_doc_filename filename Doc Level JS

p3_js_page_filename filename Page Level JS

p3_js_cntx_filename filename 3D Level JS

p3_use_watermark boolean Add watermark with following text

p3_watermark_text string Watermark text

p3_use_md_password boolean Password protect editing of PDF

p3_md_password password Password

p3_use_op_password boolean Password protect opening of PDF

p3_op_password password Password

p3_enable_annots_rename boolean Enable PDF for merging

md_title string Title

md_author string Author

md_subject string Subject

md_keywords string Keywords

md_auto_title boolean Auto-generate title

md_auto_subject boolean Auto-generate subject



Tagged_Image_File_Format_ExportOptions



grayscale boolean Always in greyscale

multipage boolean Save multipage

compression integer Compression


● LZW: 0● Deflate: 1● CCITTFAX3: 2● CCITTFAX4: 3

savecolormgntinfo boolean Save ICC color management info

AutoCAD_Drawing_Object_ExportOptions



FileVersion integer Output version


● AutoCAD 2007: 0● AutoCAD 2004: 1● AutoCAD 2000: 2● AutoCAD R14: 3● AutoCAD R13: 4● AutoCAD R11/R12: 5

Portable_Network_Graphics_ExportOptions





INTERLACE boolean Interlaced

Universal_3D_export_ExportOptions



AcrobatVersionCompatibility integer File format


● U3D ECMA 1st Edition: 1792● U3D ECMA 3rd Edition: 2048

MeshCompression boolean Mesh compression

TextureJPG integer Texture compression type


● PNG: 0● JPEG: 1

Normals boolean Normals

DefaultCamera boolean Default camera

NonUnique boolean Append data to non-unique names

SkinBones boolean Skin and bones

FixBoneHierarchy boolean Fix bone hierarchy

MetadataAsXML boolean Metadata

CompressionPreset integer Compression preset


● Custom: 0● Game: 1● CAD: 2

MeshVertexQuality integer Vertices

MeshNormalQuality integer Normals




MeshDiffuseQuality integer Vertex colors

MeshTexcoordQuality integer Texture coordinates

TextureCompressionQuality integer JPEG quality

JPEG_2000_JP2_ExportOptions



lossy boolean Lossy compression

targetpercentage integer Percentage file size

Maya_Binary_Scene_ExportOptions



XAxes integer Up axis in Maya


● Y: 1● Z: 0

exp_opt_maximum_vertices_in_polygon

integer Maximum vertices in polygon

XDoubleSided boolean Mark surfaces as double sided

XBlinn integer Material type.


Phong: 0

Blinn: 1

XSkins boolean Export skins



exp_opt_tessellate_nurbs boolean Tessellate NURBS


Possible value is:

None: –1

Maya_Interchange_File_Format_ExportOptions



opt_maya_version integer Maya version.

Possible value is:

None: –1

Stereolithography_File_ExportOptions



ascii boolean ASCII mode

Adobe_Portable_Document_3D_ExportOptions





Flex_Web_Application_ExportOptions





● BOM_ImageFlow_Model_Views_And_Portfolios.xml

● BOM_ImageFlow_Steps_And_Procedures.xml

● BOM_Metadata_Model_Views_And_Portfolios.xml

● BOM_Metadata_Steps_And_Procedures.xml

● BOM_Model_Views_And_Portfolios.xml

● BOM_Steps_And_Procedures.xml● BOM_Steps_And_Proce

dures_w_Logo.xml● Model_Views_And_Portfolios_Ba

sic.xml● Steps_And_Procedures_Ad

vanced.xml● Steps_And_Procedures_Basic.xml










● 10%: 10● 20%: 20● 30%: 30● 40%: 40● 50%: 50● 60%: 60● 70%: 70● 80%: 80● 90%: 90● 100% (lossless): 100



● OFF: 0● 10%: 10● 20%: 20● 30%: 30● 40%: 40● 50%: 50● 60%: 60● 70%: 70● 80%: 80● 90%: 90● 100% (lossless): 100



● OFF: 0● 10%: 10● 20%: 20● 30%: 30● 40%: 40● 50%: 50● 60%: 60● 70%: 70● 80%: 80● 90%: 90● 100% (lossless): 100















Preserve: 0

Add/Overwrite: 1

Remove: 2






Very Fast: –1

Fast: 0

Normal: 1

Best: 2



● 32 KB: 15● 64 KB: 16● 128 KB: 17● 256 KB: 18● 512 KB: 19● 1 MB: 20● 2 MB: 21● 4 MB: 22● 8 MB: 23● 16 MB: 24● 32 MB: 25● 64 MB: 26● 128 MB:27





TITLE string Title




JTPMI_Files_ExportOptions



FileExportType integer Type


Monolithic: 0

Per part: 1

Fully Shattered: 2

CompressionSettings integer Compression type


● No compression: 0● Version 7.0: 1● Version 8.0: 2● Automatic: 3● Version 8.1: 4● Version 8.2: 5● Version 9.0: 6● Version 9.1: 7● Version 9.2: 8● Version 9.3: 9● Version 9.4: 10● Version 9.5: 11

ExportLODs boolean Generate lower LODs

ExportPMI boolean Export PMI

Google_SketchUp_Document_ExportOptions



polyline boolean Export polylines

BackMaterial boolean Create back material too

NoSmothEdgeVisible boolean Corner edges are visible



MergeCoplanarFaces boolean Merge all the coplanar faces

OptimizePoints boolean Optimize points

ExportVersion integer File version


● 3● 4● 5● 6● 7● 8

Adobe_Portable_Document_2D_ExportOptions



ExportCompress boolean Compress PDF

ExportLaunchPDF boolean Open PDF after saving

ExportFonts integer Text and fonts


● Geometry only: 0● Geometry with hidden text: 1● Embedded fonts: 2

ExportFlatten boolean Flatten layers

ExportImagePPI integer Bitmap resolution (DPI)

ExportActiveViewOnly boolean Export active view only

ExportIncludeHidden boolean Export hidden objects

Monochrome boolean Black and white

ExportBitmapsOnly boolean Export whole pages as bitmaps




ColorCompensate integer Color compensate for paper


● B&W Swap: 0● Darken: 1● Invert Color: 2● Invert Brightness: 3

IncludeViews integer Viewports to include


● Page layouts only: 0● All: 1

Right_Hemisphere_Material_ExportOptions



compress boolean Compression

protect boolean File protection

defmat boolean Export default material

thm string Thumbnail




Computer_Graphics_Metafile_ExportOptions



Version integer Version


● 1 (most compatible): 0● 3 (best curves): 1● 4 (Hotspots): 2

Precision integer Numeric precision


● 16 bit integer: 0● 32 bit floating point: 1● 32 bit fixed point: 2● Auto select: 3

UseRLE boolean Encode raster images with RLE

XMLCompanion boolean XML Companion file

AutoCAD_Drawing_Interchange_ExportOptions



FileFormat integer Output format


● AutoCAD DXF file: 1● AutoCAD DXF binary file: 2




FileVersion integer Output version


● AutoCAD 2007: 0● AutoCAD 2004: 1● AutoCAD 2000: 2● AutoCAD R14: 3● AutoCAD R13: 4● AutoCAD R11/R12: 5

OpenEXR_Bitmap_ExportOptions



Compression integer Compression type


● None: 0● Run-length encoding: 1● zlib single scan lines: 2● zlib 16 block scan lines: 3● Piz-based wavelet: 4● Lossy 24-bit float compression: 5

LineOrder integer Line order


● Use lowest Y coordinate scan line: 0

● Use highest Y coordinate scan line: 1

JPEG_Image_ExportOptions





e_quality integer Image quality

savecolormgntinfo boolean Save ICC color managemet info

Wavefront_Object_ExportOptions



e_compact boolean Compact data

e_mtl boolean Create material file

e_normals boolean Export vertex normals

e_txt boolean Export texture coordinates

e_flatonly boolean Triangulate non-flat polygons

e_flip boolean Flip coordinate system

e_SubD boolean Create SubD control mesh

e_maxpoly integer Max vertices in polygon

e_FixMaterials boolean Replace material colors

e_string_len integer Max string length before wrap

e_digits_v integer Vertices (v)

e_digits_vn integer Normals (vn)

e_digits_vt integer UVs (vt)

Caligari_trueSpace_Object_ExportOptions






ascii boolean ASCII mode

MoveAxis boolean Move object axis to object centre

Rescale boolean Rescale

ScaleValue float Percent of workplace

Right_Hemisphere_Binary_ImportOptions



i_IgnoreVP boolean Use current viewport settings

Autodesk_3D_Studio_ImportOptions



KeyFrame boolean Import keyframe data

Animation boolean Import animation

FixBadParity boolean Repair mirror transformed objects

CATIA5_Assembly_Files_ImportOptions



loadhidden boolean Import hidden objects

makehiddenvisible boolean Display hidden objects



loadconstruction integer Import construction geometry


● NO: 0● All except partbodies: 1● ALL: 2

displayconstruction boolean Display construction geometry

importconfigurationlevel integer Import representations


● Default: 1● All: 0

importmetadata boolean Import metadata

collectmetadata boolean Collect metadata to geometry

importonlytoplevelmetadata boolean Top level metadata only

partnaming integer Part naming


● Part name: 0● Instance name: 1● Part then instance: 2● Instance then part: 3

importselectionset boolean Import selection sets

import2DSketch integer Import 2D sketch geometry


● No 2D sketch geometry: 0● Both 2D sketch wireframes and

points: 1● Only 2D sketch wireframes: 2● Only 2D sketch points: 3

compacttree boolean Compact scene tree

rulexmlfile filename XML file for collapse rules

importsolid boolean Import splines, surfaces and solids




tesslevel integer Tessellation level


● Very low: 0● Low: 1● Medium Low: 2● Medium: 3● Medium High: 4● High: 5● Very high: 6● User defined: 7

angulartolerance float Angular tolerance

chordheighttolerance float Chord height tolerance

scaletessellationparameters integer Chord height behavior


● Absolute: 0● Scaled: 1

angulartoleranceceiling float Angular tolerance cap

chordheighttoleranceceiling float Chord height tolerance cap

importpmi boolean Import PMI

importhiddenpmi boolean Import hidden PMI

importmodelview boolean Import modelviews

importcapture boolean Import captures

realtimesectiongeometry boolean Create extra section geometry

initialviewwithpmi boolean Create Initial view with PMI

initialviewwithoutpmi boolean Create Initial view without PMI

importcoordinateaxis boolean Import axis systems

importsurfaces boolean Import surfaces

importpoints boolean Import points

importplanes boolean Import planes

importwireframe boolean Import wireframes



wireframeontop boolean Draw wireframes on top

tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z

Visual_XML_ImportOptions



import_validate_xml boolean Validate XML

import_load_child_model_views boolean Load child model views

DirectX_Model_ImportOptions



Animation boolean Import animation data

Camera boolean Use DirectX camera position

JoinMaterials boolean Join equal materials




JoinV boolean Optimize vertices

JoinT boolean Optimize texture points

RightHand boolean Flip coordinate system

UseBones boolean Import skins

OptimizeH boolean Optimize hierarchy

FixAlpha boolean Treat fully transparent materials as opaque

Caligari_trueSpace_Scene_ImportOptions




ReadAnim boolean Import animation

Pro_ENGINEER_Drawing_files_ImportOptions



drawingbkcolor integer Drawing paper color






surfacediscretization float Curve discretization

tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z

AutoCAD_Design_Web_Format_ImportOptions



DWFPagesToImport integer Import pages


● All: 0● First: 1




ShowPaperObject integer Show paper in 2D views


● Always: 1● Never: 0● By file: 2

ImportTTFText integer Import TrueType fonts as


● Polygons: 1● Outlines: 2● Character primitives: 3

ImportEdges boolean Import edges

Open_Inventor_File_ImportOptions



i_Flip boolean Flip coordinate system

i_Collapse boolean Collapsing hierarchy

i_Optimize boolean Optimize hierarchy

i_MeshOptimize boolean Optimize geometry

i_GenUV boolean Create UVs

i_tQuality float Text quality

i_tExtrude float Text extrude

Solid_Edge_Assembly_files_ImportOptions








assemblyoveridecolor boolean Apply assembly-level color














tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y.




tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z

N3ds_Max_File_ImportOptions



m2e_use_pivot boolean Apply pivot data to nodes

m2e_convert_nurbs boolean Convert NURBSes to meshes

m2e_convert_patch boolean Convert patches to meshes

m2e_use_skin boolean Use skin modifiers

m2e_use_morph boolean Use morph modifiers

m2e_wire_color_2_mtl boolean Create materials for wire colors

m2e_conv_inst_2_uniq boolean Convert instances to unique

m2e_pass_metadata boolean Import metadata

m2e_use_animation boolean Import animation

m2e_use_sampling boolean Perform sampling

m2e_sample_frames integer Sample any animation every frame

m2e_sample_vertex boolean Use vertex animation

mpo_use_remote_server boolean Use remote 3ds Max DCom server

mpo_remote_server_name string Remote 3ds Max DCom server name


MicroStation_CAD_Graphic_files_ImportOptions



group integer Grouping


● Level: 0● Individual Element: 1

loadhidden boolean Import hidden objects.

makehiddenvisible boolean Display hidden objects.

loadconstruction boolean Construction geometry



● Very low: 0● Low: 1● Medium Low: 2● Medium: 3● Medium High: 4● High: 5● Very high: 6

importpmi boolean Import PMI.

importmodelview boolean Import modelviews.

tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z



VRML_Worlds_ImportOptions



i_Flip boolean Flip coordinate system

i_Collapse boolean Collapsing hierarchy

i_Optimize boolean Optimize hierarchy

i_MeshOptimize boolean Optimize geometry

i_GenUV boolean Create UVs

i_tQuality float Text quality

i_tExtrude float Text extrude

Visual_Design_Stream_ImportOptions



DeepVision boolean Deep Vision

SuppressBelowTopLevel boolean Suppress top level nodes

LoadThreads integer Stream geometry


● Separate thread● Main thread for first frame● Disabled

StreamMetadata boolean Stream metadata

PreloadIndexTables boolean Preload index tables



PreloadDataTables integer Preload data tables


NO: 0

Metadata only: 1

Everything but nodes and geometry: 2

Everything but geometry: 3

Everything: 4

VramStrategy integer Video RAM strategy


● Non-GPU: 0● GPU: 1● Overclocked GPU (not recom

mended): 2

VramSizeMB integer Video RAM size (MB)

RamSizeMB integer RAM size (MB)

TwoSidedLighting boolean 2-sided lighting for back-facing triangles

UseLODs boolean Use LODs

replicateEnable boolean Enable

replicateX integer X count

replicateY integer Y count

replicateZ integer Z count

replicateSX float X scale

replicateSY float Y scale

replicateSZ float Z scale

EmulateTextureMapping boolean Emulate texture mapping [very slow]

debugMinPixels integer Minimum number of pixels for visible mesh

debugLeafVisibleFrames integer Frames to treat leaf visible




kdTries integer KD tries

kdMaxDepth integer KD max depth

kdMaxTriangles integer KD max triangles in leaf

LightWave_Scene_ImportOptions



joinmat boolean Optimize materials

Folders string Content folders

PromptForMissingFiles boolean Prompt for missing files

Rhinoceros_3D_Model_ImportOptions



RhinoImportSkipObjectsFromHiddenLayers

boolean Skip objects in hidden layers

RhinoImportSkipHiddenObjects boolean Skip hidden objects

RhinoImportPutCurvesInSingleGroup boolean Put all curves in single group

RhinoImportGroupObjectsInRhinoLayers

boolean Group objects in RHINO layers

RhinoImportSurfaceAlwaysDoubleSided

boolean Surfaces always double sided

RhinoImportSplitBrepFaces boolean Split B-Rep faces into separate objects

RhinoImportLights boolean Import lights

RhinoImportCameras boolean Import cameras



RhinoImportMode integer Import mode


● Polygonal Mesh: 0● Nurbs: 1

RhinoImportCurves boolean Import curves

RhinoImportPoints boolean Import points

RhinoImportPointSets boolean Import pointsets

Autodesk_3D_Studio_Project_ImportOptions






Autodesk_3D_Studio_Material_ImportOptions








LightWave_3D_and_Binary_Object_ImportOptions



breakobject boolean Create sub-objects by material names

textures boolean Create texture coordinates

chkwrap boolean Check wrapping

readUView boolean Import .uv files

readSUBD boolean Import SubDs

Pro_ENGINEER_Assembly_files_ImportOptions





















tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z

OpenFlight_Scene_Description_Database_ImportOptions



i_lod boolean Convert distance LOD to scene level LOD

i_normals boolean Read per vertex normals



Maya_ASCII_Scene_ImportOptions



ChangeAxes integer Up axis in Maya


● Y: 1● Z: 0

imp_opt_cameras boolean Import cameras

SaveDefPerspCamera boolean Import perspective camera

SaveLights boolean Import lights

SaveAnimation boolean Import animation

FrameSkip integer Number of frames between samples

ReadNURBS boolean Tessellate NURBS


Possible value is: None (-1)

Gerber_File_ImportOptions



fliphorizontally boolean Flip horizontally

flipvertically boolean Flip vertically

rotate90DegCW boolean Rotate 90 degree CW

rotate90DegACW boolean Rotate 90 degree ACW


Tagged_Image_File_Format_ImportOptions



applycolormgnt boolean Apply ICC color management

colorprofile integer ICC Color Profile


● Default Monitor Profile: 0● sRGB IEC61966-2.1: 1● Adobe RGB (1998): 2● Apple RGB: 3● ColorMatch RGB: 4

rendintent integer Rendering intent


● Perceptual: 0● Relative Colorimetric: 1● Saturation: 2● Absolute Colorimetric: 3

profilefolder string Color profile repository

AutoCAD_Drawing_Object_ImportOptions



AllLayout integer Import


● Active layout: 0● Model and layouts: 1● Model only: 2

ForceToWireframe integer Viewport shading


● From file: 0● 2D wireframe: 1




ImportHiddenLayers boolean Import hidden layers

ImportLineTypes integer Import line types


● Continuous lines: 0● Complex as geometry: 1● All as geometry: 2

ReplaceText boolean Replace text

ImportText integer Import text


● As polylines: 0● As polygons: 1

UseMaterialsForColors boolean Use materials for colors

ModelShadeOverride integer Model shading


From file: 0

2D wireframe: 1

Gouraud shaded: 2

EnableNamedView integer Use named view


● Never: 0● Only if no Paper-Space Layout ex

ist: 1● Always: 2

EnableModelZoomExtent boolean Zoom to extents

EnableModelDarkBackground boolean Dark background palette

ModelBackgroundColor integer Background color

tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X



tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z

Parasolid_Part_and_Assembly_Files_ImportOptions








angulartolerance float Angular tolerance.

chordheighttolerance float Chord height tolerance.











tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z

AutoCAD_Sheet_Set_File_ImportOptions

















Points_File_ImportOptions



import_as integer Import as


Pointset: 0

Mesh: 1

import_as_mesh_if_colors boolean Import as mesh if colors are present

Maya_Binary_Scene_ImportOptions



ChangeAxes integer Up axis in Maya


● Y: 1● Z: 0

imp_opt_cameras boolean Import cameras

SaveDefPerspCamera boolean Import perspective camera

SaveLights boolean Import lights

SaveAnimation boolean Import animation




FrameSkip integer Number of frames between samples

ReadNURBS boolean Tessellate NURBS


Possible value is:

None: –1

Maya_Interchange_File_Format_ImportOptions




Possible value is:

None: –1

Universal_3D_import_ImportOptions


fileformat None Provided No Description Provided.

LOD boolean Import LOD.

ParseMetaData boolean Parse metadata.

ParseNonUnique boolean Remove append data from names.

LODLevels integer Levels.

LODMinVertices integer Create LOD if mesh has minimum vertices.

LODMinVerticesCase2 integer Create LOD if minimum vertices in file.

LODMinFileVerticesForCase2 integer Minimum vertices per mesh.


CATIA4_Part_Files_ImportOptions



load2d3d integer 2D/3D Loading


● Load both 2D and 3D: 0● Load 3D only: 1● Load 2D only: 2

drawingbkcolor integer Drawing




collapselevel boolean Collapse geometry

doublesidedsurfaces boolean Double sided surfaces

importconfigurationlevel integer Workspaces


● All: 0● Master only: 1




















tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z

Collada_ImportOptions



joinequalpoint boolean Join equal points



optimizematerial boolean Remove duplicate material

Step_Part_and_Assembly_files_ImportOptions


















tm__RX float X




tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z

Pro_ENGINEER_Neutral_files_ImportOptions


fileformat None Provided No Description Provided.

loadhidden boolean Import hidden objects.

makehiddenvisible boolean Display hidden objects.

importmetadata boolean Import metadata.

importsolid boolean Import splines, surfaces and solids.











tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z

SolidWorks_Drawing_files_ImportOptions



tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y




tm__PZ float Z

Pro_ENGINEER_Part_files_ImportOptions





















tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z

Protein_Data_Bank_ImportOptions



SphereSegements integer Sphere segments

StickSegements integer Sticks segments

ViewType integer View


● Wire: 0● Balls and sticks: 1● Spacefill: 2● Backbone: 3

ObjectsColor integer Color


● Monochrome: 0● By Atom: 1● By Residue: 2● By Chain: 3● Rainbow: 4



JTPMI_Files_ImportOptions



ImportMetadata boolean Import metadata

LoadSolid integer Import splines, surfaces and solids


● NO: 0● YES: 1









LoadLod integer Level of detail


● All: 0● Highest: 2● Medium 1: 3● Medium 2: 4● Medium 3: 5● Lowest: 1

CollapseSubnodes boolean Collapse subnodes





LoadModelViews integer Load modelviews


● All: 0● Top-level: 1● Assembly: 2● Parts: 3● None: 4

tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z

Inventor_Part_files_ImportOptions



approach integer Approach


● Quick View (Inventor Tesselation): 0

● Load Inventor Solids: 1





importsolid boolean Import splines, surfaces and solids.









tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z


Portable_Graymap_Heightfield_ImportOptions



kX float Scale X factor

kY float Scale Z factor

kZ float Scale Y factor

NX_Parts_and_Assemblies_ImportOptions










importconfigurationlevel integer Import configuration


● All: 0● As Saved: 1● User defined: 2

configurationname string User Specified Name




referencesetselect integer Reference Set


● As Saved: 0● Entire: 1● User Specified: 2

referencesetname string User Specified Name











importmodelview boolean Import model views





sheetbody boolean Import sheet bodies

tm__RX float X



tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z

CATIA4_Assembly_Files_ImportOptions






drawingbkcolor integer Drawing




collapselevel boolean Collapse geometry

doublesidedsurfaces boolean Double sided surfaces




















tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X



tm__PY float Y

tm__PZ float Z

Google_SketchUp_Document_ImportOptions



createEdgesFace boolean Outline faces

LinesSeparateHierarchy boolean Import lines into separate hierarchy

LinesRenderOrder integer Lines render order

useSketchUpTesselate boolean SketchUp tessellation

createDefaultMaterial boolean Create default SketchUp material

createUVW boolean Create UVW texture coordinates

createBackFaces integer Create back faces


● No: 0● as separate node: 1● in same node: 2

SolidWorks_Part_files_ImportOptions





● Quick View (Solidworks Tesselation): 0

● Load Solidworks Solids: 1










configurationname string User specified name











tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X



tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z

Bundled_RH___RHB_files_ImportOptions



fillhole boolean Not translated

ActivateModelview boolean Activate model view

AutoCAD_Drawing_Interchange_ImportOptions



AllLayout integer Import


● Active layout: 0● Model and layouts: 1● Model only: 2
















ModelShadeOverride integer Model shading


● From file: 0● 2D wireframe: 1● Gouraud shaded: 2

EnableModelZoomExtent boolean Zoom to extents

EnableModelDarkBackground boolean Dark background palette

tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z


CATIA5_Drawing_files_ImportOptions







surfacediscretization float Curve discretization

tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z.

Inventor_Assembly_files_ImportOptions








● Quick View (Inventor Tessellation): 0

● Load Inventor Solids: 1











tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y



tm__PZ float Z

Adobe_Portable_Document_ImportOptions



smooth_text boolean Smooth Text

smooth_lines boolean Smooth Lines

smooth_images boolean Smooth Images

output_dpi integer Output DPI


● 60● 96● 150● 300

CATIA5_Part_files_ImportOptions





loadconstruction integer Import construction geometry


● NO: 0● All except partbodies: 1● ALL: 2

displayconstruction boolean Display construction geometry






importselectionset boolean Import selection sets

import2DSketch integer Import 2D sketch geometry


● No 2D sketch geometry: 0● Both 2D sketch wireframes and

points: 1● Only 2D sketch wireframes: 2● Only 2D sketch points: 3

compacttree boolean Compact scene tree

rulexmlfile filename XML file for collapse rules










angulartoleranceceiling float Angular tolerance cap

chordheighttoleranceceiling float Chord height tolerance cap





importmodelview boolean Import model views

importcapture boolean Import captures

realtimesectiongeometry boolean Create extra section geometry

initialviewwithpmi boolean Create Initial view with PMI

initialviewwithoutpmi boolean Create Initial view without PMI







tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z

Solid_Edge_Part_files_ImportOptions






















tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z



tm__PX float X

tm__PY float Y

tm__PZ float Z

Iges_Part_and_Assembly_files_ImportOptions




















tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z

CATIA_Graphical_Representation_Files_CGR__ImportOptions











tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X



tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z

JPEG_Image_ImportOptions



applycolormgnt boolean Apply ICC color management

colorprofile integer ICC Color Profile


Default Monitor Profile: 0

● sRGB IEC61966-2.1: 1● Adobe RGB (1998): 2● Apple RGB: 3● ColorMatch RGB: 4

rendintent integer Rendering Intent


● Perceptual: 0● Relative Colorimetric: 1● Saturation: 2● Absolute Colorimetric: 3

profilefolder string Color Profile Repository



Wavefront_Object_ImportOptions



l_mtl boolean Import material file

l_flip boolean Flip coordinate system

ACIS_Part_and_Assembly_files_ImportOptions



















tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z.

tm__PX float X

tm__PY float Y

tm__PZ float Z

Caligari_trueSpace_Object_ImportOptions




ReadAnim boolean Import animation

SolidWorks_Assembly_files_ImportOptions








● Quick View (Solidworks Tesselation): 0

● Load Solidworks Solids: 1







configurationname string User Specified Name













tm__RX float X

tm__RY float Y

tm__RZ float Z

tm__SX float X

tm__SY float Y

tm__SZ float Z

tm__PX float X

tm__PY float Y

tm__PZ float Z

2.3.3.1.4.1.7 Metadata

filemetadata_extract

Extracts Microsoft Office or XMP metadata from the specified file.


filename filename Full path to the file with metadata

outfilename filename Full path to the output XML file

filemetadata_extractmsoffice

Extracts Microsoft Office metadata from file specified.


filename filename Full path to the MS office file




filemetadata_extractxmp

Extracts XMP metadata from the file specified.


filename filename Full path to the file containing XMP metadata


2.3.3.1.4.1.8 Modules

ApplyModifier


Modifier integer Possible values are:

● e3_mod_axisdir: 101● e3_mod_bend: 102● e3_mod_mirror: 109● e3_mod_noise: 114● e3_mod_wave: 115● e3_mod_skew: 117● e3_mod_inflate: 120● e3_mod_stretch: 124● e3_mod_taper: 122● e3_mod_twist: 124● e3_mod_ripple: 136● e3_mod_spline: 163

bomfactory

Creates an XML file for a given CAD file.


input_file_name filename Input file name



output_xml_file filename Output file name

export_directory string Output directory

file_type_guid string File type GUID

absolute_path boolean Absolute path

Clean_Scene

Cleans the scene and removes unused objects.


Remove_Unused_Animations boolean N/A

Remove_Empty_Nodes boolean N/A

Remove_Unused_Materials boolean N/A

Remove_Model_Views boolean N/A

Remove_Unused_Layers boolean N/A

Remove_Metadata boolean N/A

Remove_Notes_And_Etc boolean N/A

Remove_Mesh_Dupes boolean N/A

Remove_EnvMaps_And_Backplates boolean N/A

Merge_Equal_Materials boolean N/A

Remove_Unused_Hidden_Cameras boolean N/A

cm_createbommodelview

Creates a model view for each BOM in the scene.



cm_removeunwantednodes

Removes unwanted nodes according to defined XML file.


xmlpath filename The input XML file

removewithchild boolean Removes the node even if it has children

removeemptynodes boolean Removes the node if it is empty

cm_renametoplevelnode

Renames the top level node in the scene.


new_name string New name for the top level node

cm_setaxissystemcolors

Sets the axis system colors.


XR integer X axis Red value

XG integer X axis Green value

XB integer X axis Blue value

YR integer Y axis Red value

YG integer Y axis Green value

YB integer Y axis Blue value

ZR integer Z axis Red value

ZG integer Z axis Green value

ZB integer Z axis Blue value


cm_setmetadataunit

Resets the metadata value to scene unit.


xmlpath filename The input XML file for unit conversion

cm_setpmialwaysontop

Sets PMI always on top.


alwaysontop boolean Set always on top status

cm_setpmibillboarding

Sets PMI billboarding.


billboarding integer Set billboarding status


● None: 0● Full: 1● Flip Label: 2

cm_setpmilinecolor

Sets PMI line color.


leaderlineR integer Red value for leader lines

leaderlineG integer Green value for leader lines




leaderlineB integer Blue value for leader lines

cm_setpmitextcolor

Sets PMI text color.


TextR integer Red value for texts

TextG integer Green value for texts

TextB integer Blue value for texts

cm_setpointcolor_style

Sets points color and style.


pointColorR integer Red value for points

pointColorG integer Green value for points

pointColorB integer Blue value for points

pointStyle integer Point style


● Dot: 0● Square: 1● Star: 2● Plus: 3● Cross: 4● Circle: 5● Rhomb: 6


cm_wireframe

Puts wireframe on top.


putwireframesontop boolean Put wireframes on top

cm_wireframe_color

Sets wireframe color.


wireframeColorR integer Red value for wireframes

wireframeColorG integer Green value for wireframes

wireframeColorB integer Blue value for wireframes

convertaitopsd

Converts an .ai file into .pdf.


input_ai_file filename Input .ai file name

output_psd_file filename Output .psd file name

dpi float Target dots-per-inch

CreateDVIS

Creates DVIS data.


dvis_filename filename Path to .dvis file



ct_clippingplane_crosssection

Cross sectioning with clipping plane.

ct_color_objects

Applies different colors to adjacent objects.


ColorSchemeXmlFile filename Color schema XML filename

colors_count integer Colors count

color_0 integer N/A

color_1 integer N/A

color_2 integer N/A

color_3 integer N/A

color_4 integer N/A

color_5 integer N/A

color_6 integer N/A

color_7 integer N/A

color_8 integer N/A

color_9 integer N/A

ObjectColorMode integer Simple cyclic or XML schema


● Simple Cyclic: 0● XML Schema: 1

ct_converttodoublesided

Doubles the number of faces of all objects in the model.


ct_explodeobjects

Breaks out all the objects from the model.


movement_precision float Movement precision

● Best: 0● Fastest: 10

duration float Duration of the animation

parallel boolean Explode parallel to the axes

num_stages integer Number of stages for explode animation

mode integer Explode mode


● All axes: 0● XY axes: 1● XZ axes: 2● YZ axes: 3

sequences boolean Create separate animation for each stage

smart_axis boolean Try to find best axis

group_type integer Object group mode


● Distance: 0● Size: 1

inverse boolean Object grouping direct or inverse

create_layers boolean Create new layer for each stage

ct_healmodel_advanced

Repairs faces, cracks, geometry, and duplicated edges using advanced settings.




skip_hidden_meshes boolean True: skips hidden meshes.

create_new_meshes boolean True: creates new meshes instead reusing existing

output_one_mesh boolean Combine meshes

join_vertices float Join vertices threshold.

join_edges_enable boolean True: to join vertices with edges.

join_edges float Join vertices with edges threshold.

ct_invertfaces

Inverts all faces.

ct_invertfacesandnormals

Inverts all faces and surface normals.

ct_invertnormals

Inverts all surface normals.

ct_joinequalpoints

Joins all the points that have equal (coincident) x, y, z coordinates.


tolerance float Tolerance between points to join

ct_randomizeobjects

Randomizes all object points.



tolerance float Amount of distortion

units_or_percentage integer Distortion mode


● Percentage: 0● Units: 1

ct_realight

Creates realight effect to a model.


store_vertex_colors integer Store ambient occlusion as vertex colors

store_texture_maps integer Store ambient occlusion texture maps

rays_per_sample integer The number of per vertex or per sub-pixel surface samples

brightness float Level of brightness of the ambient occlusion

map_generation integer Source from which maps are generated


● Existing materials: 0● Existing diffuse materials: 1

outcome integer Manner in which maps are generated


● Replace diffuse map: 0● Merge into diffuse map: 1● Add new light map: 2

samples integer The number of per sub-pixel surface samples

prefilter integer Applies color bleed around the polygon groups

noise float Applies white noise to the texture map




blur integer Applies Gaussian blur to the texture map

map_size integer When set to 0, all maps will have a same size. Otherwise, created maps will have size based on the maximum dimension of the largest object.

width integer The width of the maps in pixels

height integer The height of the maps in pixels

max_dimension integer The maximum dimension of the largest map

round_size_power2 integer Rounds up the maximum width and height values to the closest power of two

save_internal_image integer Saves the texture maps in the internal application memory

prefix string The prefix to append to the new map names

path string The location in which to save the maps

format integer The format in which to save the maps


● JPEG image (.jpg): 0● Layered Image Format (.LiF): 1● PNG Image (.png): 2● PPM Image (.ppm): 3● TARGA Image (.tga): 4● TIFF Image (.tif): 5● Windows Bitmap (.bmp): 6

virtual_ground_plane integer When set to 1, use a virtual ground plane to calculate the illumination

distance float The distance between the model and the ground plane

size float The percentage size of the ground plane compared to the size of the model



calc_by_part integer When set to 1, ambient occlusion will be calculated separately for each part.

channel_number integer Number of the UV channel to use

map_mode integer Ambient occlusion map mode


● Modulate: 0● Replace: 1● Additive: 2

ray_length float Limit the test ray length. When set to 0, infinite ray will be used.

ct_reducemodel_advanced

Reduces the number of polygons in a model using advanced settings.


keep_percent float Percentage of polygons to keep

skip_hidden_meshes boolean True: skip hidden meshes

create_new_meshes boolean True: creates new meshes instead reusing existing

normalize_meshes integer Set to 1 or 2 on very small scenes (bounding box less than 1E-3) or for big and thin parts


● Off: 0● On: 1● Auto: 2

enable_postfix boolean True: enable postfix on reduced models names

postfix string Postfix for reduced models names

enable_join_vertices boolean True: enable join vertices




join_vertices float Percent of longest bounding box diagonal

enable_join_normals boolean True: enable join normals

join_normals float Tolerance for join normals

enable_join_uv boolean True: enable join uv

join_uv float Tolerance for join uv

enable_join_colors boolean True: enable join colors

join_colors float Tolerance for join colors

influence_normals float Normals influence

enable_influence_uv boolean True: enable influence uv

influence_uv float Uvs influence

enable_influence_materials boolean True: enable influence materials

influence_materials float Materials influence

enable_influence_colors boolean True: enable influence colors

influence_colors float Colors influence

ct_remove_degenerate_triangles

Removes degenerate triangles.

ct_remove_duplicate_faces

Removes duplicate faces.

ct_remove_duplicate_materials

Removes duplicate materials.


ct_remove_duplicate_meshes

Removes duplicate meshes.


keep_metadata boolean N/A

ct_remove_invisible_polygons

Removes internal polygons from the scene.


quality integer Cannot be negative. Higher values means higher quality.

ct_removeinternalparts

Hides or deletes internal objects in the model.


process_hide boolean True: process hidden objects

method integer Possible values are:

● Hide: 0● Select: 1● Hide and select: 2● Delete: 3

quality integer 1=max speed, 3=max quality

process_transparent boolean True: take transparency of an object into account

ct_removesmallparts

Removes small objects from the model.




percentage float Percentage from scenes bounding box of an object minimum size (0 – 100)

units float Object minimum size in scene’s units

used_type integer Type of value – percentage of scene bounding box or absolute units


● Percentage: 0● Units: 1

ct_separatemesh

Separates meshes.

ct_unifynormals

Aligns all surface normals in the same direction.


highlight_color integer Used if process method set to highlight

process_hide boolean True: process hidden object

method integer Action for suspicious nodes


● Do nothing: 0● Select: 1● Highlight: 2● Make double-sided: 3

quality integer 1=max speed, 5=max quality

polygons boolean True: apply algorithm to polygons

ct_uvmapping

Creates uvs and assigns to all the objects in the scene.



mapper integer The type of UV mapping to apply to the selected objects


● VAMP: 0● Cube: 1● Rigid: 2

packer integer The method of packing the UVs


● Clump: 0● Rectangular: 1● Simple: 2

vamp_tolerance float The angle between the projection plane and the mapped polygon. For example, 0 degrees creates many small UV edges (co-planar polygons are grouped together) to create finer UV mapping. Whereas, 90 degrees creates fewer but larger UV edges (large partitions with distorted polygons) to create more chunky UV mapping.

spacing float The spacing between the packed UVs

preserve_orientation integer If set to true, preserves the UV orientation of the UVs

fill_space integer If set to true, spaces the UVs according to the spacing percentage: resizes the partitions to maximize the use of the texture space of the UVs

pack_per_material integer If set to true, packs UVs that use the same material, separately. For example, if polygons 1 and 2 use material type A, and polygon 3 uses material B, polygons 1 and 2 are packed separately from polygon 3. Otherwise polygons 1, 2, and 3 are packed together, sharing the same texture but retaining their own material.




map_per_element integer If set to 1, keeps mesh elements together when mapping.

If set to 2, keeps mesh Part IDs together when mapping

relaxer integer The method of relaxing the UVs


● None: 0● Knead Even: 1● Knead Aligned: 2● Knead Hybrid: 3● Relax: 4

relax_iterations integer Number of relax iterations to perform for the Relax relaxer

uvchannel integer UV Channel to generate mapping to

texturescale boolean Disable texture scaling

use_texture_size boolean Enable scaling of the UV coordinates according to the texture size

texture_size_u float Texture size in U direction

texture_size_v float Texture size in V direction

texture_units float Texture units


● Generic: 0● Millimeters: 0.001● Centimeters: 0.01● Meters: 1.0● Kilometers: 1000● Inches: 0.0254● Feet: 0.3048● Miles: 1609.344● Points: 0.000352● Picas: 0.00423

dgnhierarchyxml

Creates an XML file for given Microstation file.



input_file_name filename The name of the Microstation assembly file that is used to generate the .xml file

output_xml_file filename The name of the .xml file

export_directory string The directory in which to save additional output files for this operation



ill_advancedsettings

Sets advanced parameters.


hide_back-facing_geometry boolean If set to true, any back-facing geometry is hidden. This option ensures that any faces/polygons that you cannot see are not rendered, therefore increasing processing speed.

multithreading boolean If set to true, rendering is performed in multiple threads. You need to have a multi-threaded processor to use this feature.

multiple_layers boolean If set to true, polylines are grouped into multiple layers (one layer per original mesh). Otherwise, all polylines belong to a single layer. This parameter is only applied if file_type parameter is set to .ai.

cgm_companion_file boolean If set to true, XML companion file is created. This parameter is only applied if file_type parameter is set to .cgm.




cgm_version integer Used to select the version of CGM files. Version 1 is the most compatible. Version 4 has WebCGM hotspots functionality. This parameter is only applied if file_type parameter is set to .cgm.


Version 3: 0

Version 4/WebCGM: 1

thicknthin_method integer Used to select the thick’n’thinning method


● Complete: 0● Pop line: 1● Silhouette: 2

raster_vector_file integer Used to select options relating to the creation of a hybrid image file when rendering to the .svg format. This parameter is only applied if file_type parameter is set to .svg, .ai or .cgm. Flat color fill option is also supported for .swf.


● None: 0● Render Software Z-buffer: 1● Render Raytracer: 2● Flat color fill: 3

raster_image_size_scale float The amount used to scale the hybrid file image. For example, if you enter 1, the new image is the same size as the original viewport image. If you enter 2, the new image is double the size of the original viewport image.

join_different_types boolean If set to true, different edge types may be joined into a single polyline

min_join_angle float If the angle between two adjacent edges is more than min_join_angle, then they may be joined into a single polyline.



filter_approximate_boundary boolean If set to true, shared boundary edges are approximated. This is effective for source scenes where geometry has cracks.

line_filtering_tolerance float Determines the tolerance to apply when filtering lines. It removes any duplicated or unnecessary additional lines that may be displayed in the rendered file. Negative values turn this parameter off.

filter_break_intersections boolean Used to select if lines should be broken at intersections. This is effective for later manual filtering.

contour_detection_accuracy integer Number of pixels used for contour processing


● Low: 0● Medium: 1● High: 2

contour_detection_match_original boolean Try to match to contours from original geometry

rational_approximation_tolerance double Determines the tolerance of converting rational curves to non-rational. Only for scenes with Solids. Only for .svg and .ai formats.

curve_tesselation_tolerance double Determines the tolerance of converting rational curves into polylines. Only for scenes with Solids. All formats except .svg and .ai.

voxel_visibility_detection boolean Used to select if voxel visibility detection should be used instead of polygon detection. Only for scenes with Solids.

fit_splines_on_regions boolean Used to select if fills and hotspot regions should be approximated with splines

use_part_id boolean If set to true, rendering will take into account Part ID information.




lock_font_size boolean If set to true, callout’s font size will be same as in the callout settings, not taking into account viewport scaling

order_lines_by_z boolean If set to true, lines will be ordered by their Z value. Otherwise lines are grouped by objects.

reduce_lines boolean If set to true, Illustrate will try to remove overlapping lines to produce smaller file

reduce_splines boolean If set to true, Illustrate will try to convert lines to splines

reduce_splines_tolerance float Determines the tolerance for converting lines to splines

ill_render

Creates an illustration of the current scene and saves to file.


file filename The name and location to save the output file

file_type integer Used to select the format in which you want to save the scene


● .ai: 0● .dxf: 1● .rh: 2● .cgm binary: 3● .swf: 4● .svg: 5● .tif: 6● .eps: 7

tolerance_angle float The tolerance angle for all rendered outlines



line_thickness float The width for the lines of the rendered image in pixels for .tiff format and in paper_units for all other formats

boundary_thickness float The width for the boundary lines of the rendered image in pixels for .tiff format and in paper_units for all other formats

calculate_intersections boolean If set to true, draws lines along all face-face intersections of the rendered scene

remove_hidden_lines boolean If set to true, removes lines that are hidden by the geometry in the rendered image

show_as_wireframe boolean If set to true, shows the rendered image as a wire frame, all edges are treated as outline edges

paper_units integer Selects the unit of measure for the parameters paper_size_width, paper_size_height, line_thickness and boundary_thickness.


● inches: 0● cm: 1● mm: 2● points: 3● picas: 4

NoteIf the file type is .tiff, this option is ignored. By default, pixels are used as units in .tiff.

paper_size_width float Width for the printed image. This is measured in pixels for .tiff files, and in paper_units for all other formats.

paper_size_height float Height for the printed image. This is measured in pixels for .tiff files, and in paper_units for all other formats.




virtual_window_width integer The range of width coordinates for vector images, or the width dimension in pixels for raster images. You must enter a value greater than 0 for an output file to be created. We recommend entering 1000 for best results, and using the same value for the virtual_window_height parameter.

NoteYou can use this parameter to set the image size for the .tiff format.

virtual_window_height integer The range of height coordinates for vector images, or the height dimension in pixels for raster images. You must enter a value greater than 0 for an output file to be created. We recommend entering 1000 for best results, and using the same value for the virtual_window_width parameter.

object_color boolean Selects the color for the object. If set to true, uses the model’s color for object lines. If set to false, uses the color set in the line_color parameter.

line_color integer Selects the color for rendered image lines. This parameter is only applied if the object_color parameter is set to false.

background_color integer Selects a color for the background if you are saving to the .swf, .cgm or .svg format.



include_bom integer Determines if, and where the BOM is placed on the rendered image. You must include the partlist_drawcallouts operation within the process for this parameter to be applied.


● None: 0● Text file: 1● XML file: 4● Bottom: 2● Right: 3

dpi float The resolution of the illustration in dots per inch

jtassociatepmi

Processes PMI associations on a reconstructed assembly.

jthierarchyxml

Creates an XML file for a specific OpenJT file.


input_file_name filename The name of the JT assembly file that is used to generate the .xml file

output_xml_file filename The name of the .xml file

export_directory string The directory in which to save additional output files for this operation

NeutralXmlGenerator

Creates an XML file for a specific neutral assembly file.




input_file_name filename Input file name

output_xml_file filename Output file name

export_directory string Output directory



pdf_2d_picturing

Inserts a simple 2D image into a .pdf document.


src_filename filename The source template filename

dst_filename filename The output document filename

target_place_title string Title of the annotation where the 2D image will be placed

image_filename string Filename of the image to insert

xfdf_filename string Attaches an XFDF file containing data to autofill fields in the PDF during publishing

enable_for_merging boolean If set to true, annotations and fields are renamed, ready for document merge



N2d_image_align integer Alignment of the 2D image


● Stretch: 0● Fit to Left/Top: 1● Fit to Center/Top: 2● Fit to Right/Top: 3● Fit to Left/Center: 4● Fit to Center/Center: 5● Fit to Right/Center: 6● Fit to Left/Bottom: 7● Fit to Center/Bottom: 8● Fit to Right/Bottom: 9

pdf_2d_picturing_serial

Inserts a list of 2D images into a .pdf document.


src_filename filename The source template filename


images_filenames_list string The list of image filenames to insert



pdf_merge

Performs merging of multiple .pdf documents into a single document.




source_filenames string A list of source filenames, delimited by either ; or ,

result_filename filename Result filename

pdf_print_all_metadata

Prints all metadata into a .pdf document.


output_filename filename The name with which to save the exported .pdf file

template_filename filename The filename of the PDF template

node_annot string Name of the annotation used for node name

child_annot string Name of the annotation used for node name

name_annot string Name of the annotation used for metadata name

data_annot string Name of the annotation used for metadata value

area_annot string Name of the annotation used for area in the template

parent_name string A regular expression, used as parent-name pattern. If empty, all parents are included

node_name string A regular expression, used as node-name pattern. If empty, all children are included, but parent_name cannot be empty.

child_name string Regular expression, used as child-name pattern. If empty, all children are included



include_child boolean Recursive collecting from the founded node for its child

exclude_geometry boolean Use only child with no geometry

pdf_print_metadata

Prints metadata into a .pdf document; for example, the XFDF method, use entries from template.


output_filename filename The name with which to save the exported .pdf file

template_filename filename The filename of the PDF template

node_name string Used as node-name pattern

blocks_per_page integer Count of blocks per page

pdf_protect

Performs a protection process on a .pdf document.


src_filename filename The source document filename


use_md_password boolean Indicates whether PDF editing is password protected

md_password_text string Password for modification

use_op_password boolean Enable for commenting in Adobe Reader

op_password_text string Password for opening

use_watermark boolean Creates text on a printed watermark




watermark_text string The text to print in the watermark

doc_right_print boolean Allows printing of document rights

doc_right_edit boolean Allows editing of document rights

doc_right_copy boolean Allows copying of document rights

doc_right_edit_notes boolean Allows edit notes of document rights

doc_right_fill_n_sign boolean Allows fill and sign of document rights

pdf_xfdf_integrate

Applies .xfdf to a .pdf document.


src_filename filename The source document filename




pmi_settings

Sets global settings for a scene containing PMI.


always_on_top boolean If set to true, draws the markup and markup leaders on top of all the objects in the scene

leader_color integer Selects the color of the markup leaders

text_color integer Selects the vector text color


pmi_visibility

Controls visibility of various PMI types


show_text_markups boolean Display text markups

show_rich_text_markups boolean Display rich text markups

show_gdt_markups boolean Display GDT markups

show_dimension_markups boolean Display dimension markups

show_roughness_markups boolean Display roughness markups

show_welding_markups boolean Display welding markups

affect_only_markups_in_active_view-port

boolean Apply changes only to markups in the active viewport

regenerate_scene_thumbnails

Generates thumbnails for scene step, model, and detail views


regenerate_model_view_thumbnails boolean Generates model view thumbnails

regenerate_step_view_thumbnails boolean Generates step view thumbnails

regenerate_detail_view_thumbnails boolean Generates detail view thumbnails

remove_vzxml_hierarchy_cache

Removes VzXml specific hierarchy cache from the scene


keep_all_metadata_as_selector_metadata

boolean Copies metadata from the VzXml hierarchy to scene nodes

keep_selector_ds_ids boolean Retains VzXml hierarchy selector DS IDs on scene nodes




keep_selector_external_ids boolean Retains VzXml hierarchy selector external IDs on scene nodes

keep_all_metadata_as_entity_metadata

boolean Copies metadata from VzXml hierarchy to entity descriptors associated with scene nodes

RunFileQuery

Runs a query from a file on the specified scene


queryfile filename Query file path

RunQuery

Runs a query on the specified scene.


query string Query text

setsceneunits

Sets scene units.


multiplier double Unit multiplier



units integer Default scene units


● Generic units: 0● MilliMeters: 1● Centimeters: 2● Meters: 3● KiloMeters: 4● Inches: 5● Feet: 6● Miles: 7● Points: 8● Picas: 9

rescale boolean Scale for conversion

ExcludePoints boolean Exclude points from unit conversion

validate_and_fix_scene_hierarchy

Validates scene hierarchy and fixes errors.

validate_and_fix_scene_layers

Validates scene layers and fixes errors.

validate_scene_hierarchy

Validates scene hierarchy.

validate_scene_layers

Validates scene layers.



2.3.3.1.4.1.9 Repository

ro_audit_addrecord

Adds an audit record for an asset.


assetid integer Asset ID to add audit record for

auditmessage string Audit message

ro_asset_removeexternalsystemid

Removes any associated external system ID from a specific asset version.


assetid integer Asset ID

assetversion string Asset version number. Optional, if specified operation will clear partner system Id and version from this version only, else it will clear it from all versions of asset specified.

ro_asset_removespecifiedexternalsystemid

Removes external system IDs that match the external system ID information supplied from the asset versions they are associated with.


partnertype string Partner system name

partnerid string Partner ID

partnerversion string Partner system version (optional)

partnerrevision string Partner system revision (optional)

projectname string Project name


ro_asset_getdetailsbyexternalsystemid

Gets the details of an asset specified by external system ID.


partnersystem string The external system name to look up

partnerid string The external system ID to look up

partnerversion string The External System Version to look up

partnerrevision string The External System Revision to look up

projectid integer The ID of the Project to perform the lookup in

projectname string The name of the project to perform the lookup in

assetid integer The asset ID if found

assetversion integer The asset version if found

processstatus string Processing status (unused)

assettype string The asset type

assetfile string The asset file name

deepserverfolder string The SAP 3D Visual Enterprise Generator folder the asset was uploaded to

ro_asset_getancestorinstances

Gets the asset instance IDs of ancestors of the specified asset.


assetid integer The child asset ID

ancestorinstancecount integer The number of ancestor asset instances found

ancestorinstanceids collectionparameter The list of all the ancestor asset instance IDs



ro_asset_getancestorassetids

Gets the asset IDs of all ancestors of the specified asset.


assetid integer The child asset ID to look up ancestors for

ancestorassetcount integer The number of ancestor assets found

ancestorassetids collectionparameter The list of all the ancestor asset IDs

ro_asset_getexternalsystemid

Gets the external system id for an asset version.


assetid integer The asset ID

assetversion string The asset version

partnerid string The external system name of the asset

externalsystemid string The external system ID of the asset

externalsystemversion string The external system version of the asset

externalsystemrevision string The external system revision of the asset

ro_asset_getparentassetids

Gets the parent asset IDs of a given asset ID.



parentassetcount integer The number of parent assets found

parentassetids collectionparameter The list of all parent asset IDs


ro_asset_getderivativesforversion

Gets the list of all existing derivatives for a specified asset.


assetid integer The asset ID to list derivatives for

assetversion string If specified, the asset version to list derivatives for, otherwise, the current version

extension string If specified, only derivatives with the specified file extension will be listed

derivatives collectionparameter The details of the matching derivatives

ro_asset_setexternalsystemid

Sets the external system ID for a specific asset version.



assetversion string The asset version

partnersystem string The external system name

partnerid string The external system ID

partnerversion string The external system version

partnerrevision string The external system revision

ro_manifest_convertversion

Converts between different versions of file upload manifests.


source filename The source manifest file to convert




sourceversion string The version of the source manifest file (V1 or V2)

destination filename The destination file to place the converted manifest into

destinationversion string The version of the destination manifest file (V1 or V2).

ro_entitydatabag_deletevalue

Deletes an item from the entity data bag.


entityid integer ID of the entity

entitytype string Type of the entity

name string Name of the data property to delete

ro_absoluteinstance_downloadmasterderivative

Downloads the RHZ master derivative of an absolute instance from the repository.


absoluteinstanceid integer The ID of the absolute instance to download.

outputfilepath filename The file to save the downloaded absolute instance to.

addtocache boolean Whether or not to add the output to the download cache.

absoluteinstancename string The name of the downloaded absolute instance.


ro_asset_downloadmasterderivative

Downloads the RHZ master derivative of an asset from the repository.


assetid integer The asset ID of the asset to download

assetversion integer The version of the asset to download (optional)

outputfilepath filename The file to save the downloaded asset to

addtocache boolean Whether or not to add the output to the download cache

assetname string The name of the downloaded asset

ro_asset_downloadoriginalfile

Gets the current version of an asset, and stores it in a specified file system location.


location string The path of a file system folder to save the file to

assetid integer The asset ID to retrieve

filename filename The fully qualified path of the file to save

ro_asset_getassetidfromexternalsystemid

Gets the asset ID of the asset that an external system ID is applied to.


project_id integer The project ID of the project to look in

externalsystem_name string The external system name

externalsystem_uid string The external system uid




asset_id integer The asset ID of the asset identified by the specified external system details

ro_asset_getdetails

Gets information about a particular asset version.



assetversion integer Asset version

masterderivativeid integer Master derivative ID.

masterderivativename string Master derivative name

derivativefilename string Master derivative file name

origfileid integer Original file ID

origfilename string Original file name

origfullpath string Original file full path uploaded from

assettype string Asset type

toplevel boolean Whether asset was uploaded as top level

ro_file_scanforassetbuildinfo

Gets the file processing information to process the specified file as an asset.


filename filename The file to analyze

derivativeprocesshint string The name of the process that the caller wishes to use to create master derivatives for this asset. Is treated as a hint only (optional)



requireplugin boolean Defines whether a plug-in file type is required or not

Default value is: False

filetypename string The human-readable name of the file type that was selected to process this file

filetypeid integer The file type ID, or 0 if no matching file type in the database

pluginguid string The GUID of the plug-in that should be used to process this file

mimetype string The MIME type that should be used when this file is downloaded

assettypes string The asset types that can be used when storing this file as an asset (comma-delimited list)

derivativeprocess string The name of the process that should be used to create the master derivative for this asset

storeoriginals boolean Whether originals should be stored for this asset

thumbnailgenerator string The thumbnail generator that should be used to generate thumbnails for this asset (DeepServer, OperatingSystem, or None)

ro_job_getcreatedassetversions

Gets the asset versions created by a particular job.


jobid string The job ID

versions collectionparameter Collection of the asset versions created by the job



ro_derivative_download

Gets a derivative or a thumbnail for a derivative, saving it to the specified file system location.


location string The location to save file to. The file-name is determined from derivative name.

derivativeid integer The ID of the derivative to retrieve

filename filename The fully qualified path of the saved file

ro_derivative_getdetails

Gets information about a specified derivative.


derivativeid integer The derivative ID to look up details for



derivativetypeid integer Derivative type ID.

derivativefilename string Derivative filename

ro_derivative_getstream

Gets a derivative or a thumbnail for a derivative into a stream in the process.


derivativeid integer The derivative ID to get the stream for

thumbnail boolean Whether to return a stream for the derivative, or its thumbnail

writemode boolean Whether the stream should be writable or not



stream stream The derivative or thumbnail stream

filename filename The file name stored in the database for the derivative

ro_entitydatabag_getvalue

Gets an item from the entity data bag.


entityid integer ID of the entity

entitytype string Type of the entity

name string Name of the data property to get

value string The property value

ro_absoluteinstance_getabsoluteinstancescreatedbyjob

Gets the top-level absolute instances created by a particular job.


jobid string The job ID

instances collectionparameter Collection of the top-level absolute instances created by the job

ro_asset_getassetidandversionfromexternalsystemid

Gets the asset ID and asset version for an external system ID.


externalsystem string External partner name




externalsystemid string External partner ID

externalsystemversion string External partner version

externalsystemrevison string External partner revision

projectid integer Project ID



ro_asset_getmasterderivativeid

Gets the master derivative ID for a given asset ID.



masterderivativeid integer The master derivative ID

ro_file_download

Downloads the file with the specified ID and saves it to a file system file.


fileid integer The ID of the file to retrieve

filename filename The fully qualified path to save the file to

ro_filetype_getforfile

Gets the file type ID with the specified plug-in GUID and asset type.



pluginguid string The plug-in GUID

filename filename The file name of the file to perform the lookup for

assettypeid integer The asset type ID to use as a hint for the file type lookup (optional)

filetypeid integer The ID of the original file type, or 0 if no match found

mimetype string The MIME type of the original file, or an empty string if no match found

ro_view_getname

Returns view name for a given view ID.


viewid integer View ID

viewname string View name

ro_job_getproperty

Gets the value of the job property with the specified name.


jobid integer The job ID

propertyname string The name of the job property to get the value for

propertyvalue string The job property value

ro_job_setproperty

Sets the value of a job property.




propertyname string The name of the job property to set value for

jobid integer The job ID

propertyvalue string The property value to set

ro_asset_setmetadatavalue

Adds or updates metadata on a specified asset.


assetid integer The asset ID to apply the metadata changes to

category integer The category ID. Either category ID or name is required.

categoryname string The category name. Either category ID or name is required.

name string The field name of the metadata value to set

value string The metadata field value to set

subnodeid string The node ID to set metadata for (optional)

subnodepath string The node path on which metadata is being set (optional)

ro_entitydatabag_setvalue

Sets the value of an item in the entity databag.


entityid integer The ID of the entity

entitytype string The type of the entity



name string The name of the property to set

value string The value to set

2.3.3.1.4.1.10 Scriptable Operations

script_execute

Executes a script block.


script scriptblock The script block to execute

sandbox boolean Whether or not to run the script in a sandbox

2.3.3.1.4.1.11 SOAP Web

webservice_methodinvoke

Calls a method on an external application Web service.


assemblyname string The generated Web method proxy assembly

typename string The type of the Web service proxy

methodname string The name of the Web method or operation

endpoint string The Web service endpoint

webservice_operationgenerator

Creates operations to communicate with external application Web services.




wsdllocation string The location of the WSDL, typically an URL

username string Username for accessing the WSDL

password string Password for accessing the WSDL

toolboxgroup string The toolbox group to add the operation to

prefix string A prefix that is added to the operation name to ensure uniqueness. Used when multiple Web services have methods of the same name.

strongnamekeyfile string This is the location of the strong name key file that is used when generating Web service proxy DLL files.

operations collectionparameter The names of all operations that have been generated

messages collectionparameter A log of operations, parameters and errors generated

2.3.3.1.4.1.12 SQL Database

database_executecommand

Runs an SQL server stored procedure and returns the results.


connectionstring string Input parameter, the connection string.

ExampleData Source={servername}

Integrated Security=SSPI

Initial Catalog={databasename;}



commandtimeout integer Input parameter, the maximum number of seconds to wait for a command to execute (0=infinite)

command string Input parameter, the name of the stored procedure to execute, for example, spGetAssetId

dataset db_dataset Output parameter, the results of the executed stored procedure

2.3.3.1.4.1.13 Triggers

filetrigger

A trigger that includes a file parameter.


context contextparameter The task context

filename filename Location of the file to process

generictrigger

A generic trigger that only includes the task context.



simpletrigger

Trigger that supports name/value pair parameters.





request xmi_simpletrigger The input parameter

response xmo_simpletrigger The output parameter

conversiontrigger

A trigger used by conversion server processes.



filename filename The input file name

outputfolder string The output folder path

2.3.3.1.4.1.14 Batch Metadata Request Format

The batch metadata request is an XML file divided into three sections:

● Object Selection: Collecting the scene objects to perform metadata operations on.● Metadata Sources: Sources of metadata that are available to metadata operations.● Metadata Operations: Operations that apply metadata actions (like setting, or remapping) to scene

objects.

The Object Selection section defines criteria for collecting scene objects together into an object group. Multiple groups are allowed and each group has an identifier.

The Metadata Sources section defines the metadata which is available for use by operations in the metadata operations section. Sources can be either disk files or inline. Multiple sources are allowed and each source has an identifier.

The Metadata Operations section defines the actions to take. Supported actions are:

● Merge: Takes as input one or more object groups, and merges one or more metadata sources onto each of the objects in the object groups.

● Remap: Takes as input one or more object groups, and for each object in each object group, remaps metadata fields matching some criteria onto a target field in a target group.

● RemoveAll: Takes as input one or more object groups, and for each object in each object group, removes all metadata.


Listed below is a full request containing all of the above, see the Batch Metadata Examples section for more specific examples.

<Request xmlns="http://schemas.sap.com/VEGenerator/2012/Jun/BatchMetadata"><ObjectGroups><PathMatch Id="g3" Path="1.2.*" OnlyInHierarchy="true" /> <MetadataMatch Id="g6"><Group><Equals Value="SAPMetadata" /> <Equals Value="SAPMetadata2" /> </Group><Name><Matches Expression="(PartNumber|TestPartNumber\d+)" /> </Name> </MetadataMatch></ObjectGroups><Metadata><File Id="md1" Path="e1.xml" /> <Inline Id="md2"><MetadataGroup Name="SAPMetadata"><String Name="String1" Value="Value1" /> <Real Name="Real1" Value="1.23" /> <Boolean Name="Boolean1" Value="true" /> <Integer Name="Integer1" Value="456" /> <DateTime Name="DateTime1" Value="2012-05-15T13:43:01Z" /> </MetadataGroup></Inline></Metadata><Operations><RemoveAll Id="o1" ObjectRefs="g3" /> <Merge Id="o2" MetadataRefs="md1 md2" ObjectRefs="g3 g6" /> <Remap Id="o3" ObjectRefs="g2"><Source><Group><Equals Value="CustomerMetadata" /> </Group><Name><Matches Expression="(PartNumber|AlternatePartNumber)" /> </Name></Source><Target Group="SAPMetadata" Name="MaterialID" Type="String" /> </Remap> </Operations></Request>

2.3.3.1.4.1.14.1 <ObjectGroups>/<PathMatch>

The <PathMatch> element creates a group of scene objects by their position in the scene tree.

Attributes

Attribute Name Description Type

Id Identifier for this object group, must be unique within the XML file

String, Required




Path An object path that specifies the scene objects to match.

May contain a * wildcard character, as the last character in the path.

If empty, will match all top-level scene objects.

Components of the path are positional.

Example● A path of 1.2.3 matches the

third child, of the second child, of the first top-level object.

● A path of 1.5.* matches the object at path 1.5 and all objects below it in the scene tree.

String, Required

OnlyInHierarchy If set to true, the path will refer to objects in the instance reference hierarchy only. The default is false.

Boolean, Optional

2.3.3.1.4.1.14.2 <ObjectGroups>/<MetadataMatch>

Use

The <MetadataMatch> element is used to create a group of scene objects based on metadata values on those objects.

Attributes


Id Identifier for this object group, must be unique within the XML file.

String, Required

The <MetadataMatch> element can contain <Group>, <Name>, <Type> and <Value> child elements, these elements correspond to Metadata Group, Metadata Field Name, Metadata Field Type, and Metadata Field Value, and are known as metadata filters.

Each metadata filter can contain one or more metadata condition elements, which can be one of:

● <Equals Value=”XXX”>Specifies a string equality condition, meaning that the value of the metadata group, field name, type or field value must be equal to the value of the Value attribute, XXX in this example.


● <NotEquals Value=”XXX”>Specifies an inverse string equality condition, meaning that the value of the metadata group, field name, type or field value must not be equal to the value of the Value attribute, XXX in this example.

● <Matches Expression=”XXX”>Specifies a regular expression match condition, meaning that the value of the metadata group, field name, type or field value must match the regular expression given in the Value attribute, XXX in this example. The format of the regular expression is a .NET regular expression.

● <NotMatches Expression=”XXX”>Specifies an inverse regular expression match condition, meaning that the value of the metadata group, field name, type or field value must not match the regular expression given in the Value attribute, XXX in this example. The format of the regular expression is a .NET regular expression.

More information about .NET regular expression formats can be found at http://msdn.microsoft.com/en-us/library/hs600312(v=vs.10).aspx .

Matching is done by first collecting all of the scene objects for which the first metadata filter returns true, then, on this result, getting the remaining scene objects for which the second metadata filter (if any) returns true, and so on, until all filters have been evaluated. All objects remaining after all filters have been evaluated are added to the group.

For a metadata filter to return true, at least one of the conditions in that filter have to evaluate to true.

Example

To create a group of all scene objects having a metadata field named PartNumber, in a metadata group named CustomMetadata, with the field value starting with ABC, the following XML would be used (it creates a group with identifier g1):

<MetadataMatch Id="g1"><Group><Equals Value="CustomMetadata" /> </Group><Name><Equals Value="PartNumber" /> </Name><Value><Matches Expression="^ABC.*" /> </Value> </MetadataMatch>

2.3.3.1.4.1.14.3 <Metadata>/<File>

The <File> element defines a source of metadata where all metadata fields are provided by an external file having a supported metadata format. The format of the external file is automatically detected.



http://help.sap.com/disclaimer?site=http%3A%2F%2Fmsdn.microsoft.com%2Fen-us%2Flibrary%2Fhs600312%28v%3Dvs.10%29.aspx

http://help.sap.com/disclaimer?site=http%3A%2F%2Fmsdn.microsoft.com%2Fen-us%2Flibrary%2Fhs600312%28v%3Dvs.10%29.aspx

Attributes


Id Identifier for this metadata source, must be unique within the XML file.

String, Required

Path The fully qualified path to the file containing the metadata. The file can be in any of the supported metadata formats (see Supported File Metadata Formats)

String, Required

Supported File Metadata Formats

Format Description

Metadata Serialization Serialized form of VZXML metadata, format used internally by VE Generator

Metadata Insert Simplified form of metadata, used by DMS Single Document Converter workflows

Metadata Import/Export Metadata format used by Metadata Import/Export workflows

DE Export VE Author (Deep Exploration) metadata export format

DS Export VE Generator (Deep Server) 5.7 metadata export format

Asset Metadata VE Generator (Deep Server) 5.7 metadata format

Generic XML Metadata Generic XML metadata (any free-form XML document can be used, regardless of schema)

CSV Metadata Generic CSV metadata support, columns are mapped to fields in a CADMetadata metadata group.

Adobe XFDF Metadata XFDF Fields are mapped to metadata in a xfdf metadata group.

2.3.3.1.4.1.14.4 <Metadata>/<Inline>

Use

The <Inline> element defines a source of metadata where all metadata fields are provided inline in the XML request document.

This is a simplified metadata structure, and does not support the full range of metadata types, if more complex metadata is required, use of <File> metadata, and an appropriate format, is recommend.


Attributes


Id Identifier for this metadata source, must be unique within the XML file.

String, Required

NoteThe <Inline> element must contain at least one <MetadataGroup> element, but can contain many.

The <MetadataGroup> element is a container for one or more metadata fields.

<MetadataGroup> Attributes


Name The metadata group name String, Required

A metadata field XML element has a name corresponding to one of the following types: String, Real, Boolean, Integer, DateTime.

Metadata Field Attributes


Name The metadata field name String, Required

Value The value of the metadata field, must be a value that is valid according to the type of the field, see the Inline Metadata Types section below.

(Varies)

Inline Metadata Types

● String values are UTF-8 strings.● Real values have to be valid single or double precision floating point numbers according to the rules of the

current locale that SAP 3D Visual Enterprise Generator is running in, for example, 1.2 (US), or 1,2 (German).

● Boolean values can be true, True, false, or False.● Integer values must be valid integer numbers, up to 64-bit in size, and are signed quantities.● DateTime values must be strings in ISO 8601 format, for example, 2012-12-24T15:35:01Z

Example

This defines a source with ID md2, with five fields in the metadata group SAPMetadata, each field having a value that is valid for its type.

<Inline Id="md2"><MetadataGroup Name="SAPMetadata"><String Name="String1" Value="Value1" /> <Real Name="Real1" Value="1.23" />



<Boolean Name="Boolean1" Value="true" /> <Integer Name="Integer1" Value="456" /> <DateTime Name="DateTime1" Value="2012-05-15T13:43:01Z" /> </MetadataGroup></Inline>

2.3.3.1.4.1.14.5 <Operations>/<Merge>

The <Merge> element specifies an operation that will merge metadata from one or more metadata sources onto one or more scene objects in object groups.

Attributes


Id A unique identifier for the operation, will be used to group results when reporting errors or warnings. Must be unique within the XML file.

String, Required

MetadataRefs A space separated list of metadata source identifiers (this means the value of the ID attribute on <File> or <Inline> element).

String, Required

ObjectRefs A space separated list of object group identifiers (this means the value of the ID attribute on a <PathMatch> or <MetadataMatch> element).

String, Required

Overwrite Whether or not to overwrite existing metadata fields with the same name, in the same group. Defaults to true.

Boolean, Optional

The merging is performed by iterating over each object in all of the specified object groups, and then merging all of the metadata in all of the specified metadata sources onto the target object.

If fields already exist in a metadata group with a given metadata field name, they will be overwritten, unless the Overwrite attribute is set to false.

2.3.3.1.4.1.14.6 <Operations>/<Remap>

Use

The <Remap> element specifies an operation that will remap (copy) metadata from a field matching supplied criteria to a target metadata field in a target metadata group on the same object.


Attributes



String, Required


String, Required

Overwrite Whether or not to overwrite existing metadata fields with the same name, in the same group. Defaults to true.

Boolean, Optional

The <Remap> element must have one <Source> child element. This element must contain one or more metadata filter child elements, which are the same as the children of <MetadataMatch>.

It must also have one <Target> child element.

Attributes


Group The metadata group the remapped field will be added to

String, Required

Name The metadata field name of the remapped field

String, Required

Type If supplied, sets the type of the metadata field to the specified type. If not supplied, leaves the existing metadata field type unchanged. Allowed values for this field: String, Integer, Boolean, Real, DateTime.

String, Optional

Value If supplied, sets the value to use for the remapped metadata field

String, Optional

For each object in the groups referenced by this operation, matching is performed to see if any fields match the criteria.

If no fields match the criteria, the object is skipped and no remapping is performed on fields for that object.

If multiple fields match the criteria, the first matching field is used as the source field for remapping, its value is copied to the metadata group and field name supplied by the <Target> element, overwriting any existing fields (unless the Overwrite attribute is set to false).

If one field matches the criteria, its value is copied to the metadata group and field name supplied by the <Target> element, overwriting any existing fields (unless the Overwrite attribute is set to false).



Example

In this example, all objects in the object group in group g2, where those objects have a field named PartNumber or AlternatePartNumber in metadata group CustomerMetadata, will have those field values copied to a metadata field named MaterialID in group SAPMetadata on the same object.

<Remap Id="o3" ObjectRefs="g2"> <Source> <Group> <Equals Value="CustomerMetadata" /> </Group> <Name> <Matches Expression="(PartNumber|AlternatePartNumber)" /> </Name> </Source> <Target Group="SAPMetadata" Name="MaterialID" Type="String" /></Remap>

2.3.3.1.4.1.14.7 <Operations>/<RemoveAll>

The <RemoveAll> element specifies an operation that removes all metadata from all objects in the referenced object groups.



String, Required


String, Required

2.3.3.1.4.1.15 Batch Metadata Examples

Remapping a metadata field

This request XML will copy the field value of a metadata field named PartNumber in group CustomerMetadata to a field named MaterialID in group SAPMetadata on all objects in the scene that have a metadata field named PartNumber in the group CustomerMetadata.

<Request xmlns="http://schemas.sap.com/VEGenerator/2012/Jun/BatchMetadata"><ObjectGroups><PathMatch Id="g1" Path="*" /></ObjectGroups>


<Operations><Remap Id="o1" ObjectRefs="g1"><Source><Group><Equals Value="CustomerMetadata" /> </Group><Name><Equals Value="PartNumber" /> </Name></Source><Target Group="SAPMetadata" Name="MaterialID" /> </Remap></Operations></Request>

Merging metadata from a file

This request XML will merge metadata from the file named PartMetadata.xml, to all objects in the scene that have a metadata field named Classification in group CADMetadata that has the value Part.

<Request xmlns="http://schemas.sap.com/VEGenerator/2012/Jun/BatchMetadata"><ObjectGroups><MetadataMatch Id="g1"><Group><Equals Value="CADMetadata" /></Group><Name><Equals Value="Classification" /></Name><Value><Equals Value="Part" /></Value></MetadataMatch></ObjectGroups><Metadata><File Id="md1" Path="PartMetadata.xml" /></Metadata><Operations><Merge Id="o1" ObjectRefs="g1" MetadataRefs="md1" /></Operations></Request>

2.3.3.1.5 Process Designer Context Menus

Use

Various context-sensitive menus are available when you right-click in Process Designer, with which you can perform a variety of functions. The menus that appear depend where your cursor is positioned when you click. For example, if you right-click a toolbox group name, you can display operations with large or small icons. If you right-click operations in the viewport, you can copy and paste them.



Activities

Process Designer Viewport Menu

The Process Designer Viewport menu appears when you right-click in the Process Designer viewport with nothing selected.

Menu Option Functional Description

Process Properties Used to modify the current process’s properties. For example, the process name and time out settings

Toolbox Menus

The Toolbox menus appear when you right-click a group or operation name in the toolbox. For example, you can right-click the General or 3D Graphics group names, or operations names within those groups.


Large Icons Displays operation names with a large icon

Small Icons Displays operation names with a small icon

Edit Opens the Operation Editor and is used to edit the selected operation

Operation Menu

The Operation menu appears when you right-click an operation in the Process Designer viewport.


Copy Copies the selected operations and links

Paste Pastes the selected operations and links into the current process

Delete Deletes the selected operations and links from the current process

Rename Used to rename the selected operation

Edit Comment Used to add and remove operation comments

Skip Applies or removes a skip on the selected operation: SAP 3D Visual Enterprise Generator then ignores that operation during process execution



Toggle Breakpoint Sets or clears a breakpoint on the selected operation: SAP 3D Visual Enterprise Generator then stops the process before the operation begins

Operation Link Menu

The Operation Link menu appears when you right-click one or more links in the Process Designer viewport.


Delete Deletes the selected links from the current process

Operation Window Menu

The Operation Window menu appears when you right-click the title of an operation window.


Toolbox Displays the toolbox

[operation window name] Displays and hides the selected operation window

Show All Displays all operation windows that have been hidden previously

Hide All Hides all operation windows

2.3.3.1.6 XPath Editor

Use

You can use the XPath Editor to generate XPath statements: the statements are stored in XML format within the process and operation definition files. You can also view the results document.

If a parameter requires an XPath statement, a selection button is displayed within that cell: it opens the XPath Editor from where you can enter the statement manually. You can also drag information between parameter cells in the operation windows to create XPath statements automatically. Values can also be edited and deleted using the XPath Editor.

NoteXPath statements must be XPath version 1.0 compliant.

If you enter an XPath statement by typing it in a parameter cell, it is recognized as a string when the process runs and not an XPath statement.



The XPath boolean function boolean(string(//somenode/someboolean)) always resolves to true if the somebooean value is a string. For example, if you enter true, false, or fred, the statement always resolves to true. The boolean function boolean(//somenode/someboolean) resolves to true if the node exists in the XPath document. This is part of the W3C specification for XPath statements. This is important when using XPath statements associated with the if operation as SAP 3D Visual Enterprise Generator XPath statements usually compare strings.

Features

The XPath Editor window comprises the XPath Statement and XML Results Document tab pages, used to manage XPath statements and view the results document.

Fields Functional Descriptions

XPath Statement field The XPath statement that defines the parameter value

Compile Validates that the expression is valid as an XPath statement. If invalid, a message is displayed.

Test Tests that the statement returns a correct value

Activities

To create an XPath statement, do one of the following:

● Chose the XPath Editor button in the parameter cell, enter the XPath statement in the statement field, choose Compile, and then choose Test. The statement results and any errors are reported in the XPath window below the statement field.

● Drag a parameter to a parameter in another operation. The first parameter is entered as an XPath statement and you can edit the new statement as required.

To edit an XPath statement, do one of the following:

● Choose the XPath Editor button in the parameter cell, edit the XPath statement, choose Compile, and then choose Test. The statement results and any errors are reported in the XPath window below the statement field.

● Drag a parameter to a parameter in another operation. The XPath statement is updated with the new parameter.

To delete an XPath statement, proceed as follows:

1. Choose the XPath Editor button in the parameter cell for the statement you want to delete.2. Select the XPath statement in the XPath Editor statement field.3. Press DELETE and then choose OK.

Viewing the Results Document

You can view the results document after running a process in the Process Designer: it is docked at the bottom of the Process Designer viewport.


You can also view the results document after running a process.

To view the results document, run a process and then choose Debug View Results Document on the menu bar.

2.3.4 Derivative Types Panel

Use

The Derivative Types panel displays a list of the current derivative types and related information including the class, system type, and extension. You can use it to manage SAP 3D Visual Enterprise Generator derivative types and their components (see Configuration of Derivatives [page 595]).

SAP 3D Visual Enterprise Generator uses original files (assets) to create specific files (derivatives) with preset scene and display settings.

Asset refers to the original file. This can be a single asset, an assembly, or a part file.

Derivative refers to the files that are created either automatically with SAP 3D Visual Enterprise Generator or manually through client applications such as SAP Visual Enterprise Access, from the original 3D file. For example, a 3D derivative that displays an exploded view of the model, or a 2D derivative that displays the model as a solid rendering with outlines overlaid on top.

Base derivative refers to the Default RH Preview .rh file and thumbnail files that are created automatically in SAP 3D Visual Enterprise Generator, from the original file. Note that the thumbnails are displayed when you search for assets.

An item is any type of file. For example, 3D derivatives, 2D derivative, associated files, and the base derivative.

You can create both 2D and 3D derivatives using client applications such as SAP Visual Enterprise Access. For more information, see SAP Visual Enterprise Access help at http://help.sap.com/ SAP 3D Visual Enterprise Access SAP Visual Enterprise Access 7.1 .

2D derivatives are created through the 2D derivative types. For example, the Line Illustration type.

3D derivatives are created through the 3D derivative types. For example, the RH Exploded type.

NoteWhen viewing items in client applications, certain components can be utilized through the SAP 3D Visual Enterprise Viewer. For example, the Information panel, measurement tools, and animation toolbar. For more information, see SAP 3D Visual Enterprise Viewer help at http://help.sap.com/ SAP 3D Visual Enterprise Viewer SAP 3D Visual Enterprise Viewer 9.0 .

Derivative Types

SAP 3D Visual Enterprise Generator uses derivative types mechanisms to create derivatives: derivative types define the outputs created by SAP 3D Visual Enterprise Generator as part of a workflow. You can also use them in client applications such as SAP Visual Enterprise Access to create default derivatives, or on demand derivatives through interactive sessions within your client application.





You can create new derivative types using the following:

● File format extension● Default process● Grouping class

After it has been created, each derivative type is defined for user access and utilization within client applications.

Each derivative type includes a process that controls how derivatives are created. For example, the JPEG derivative type’s default process is Derivative-JPEG. When SAP 3D Visual Enterprise Generator builds a JPEG derivative type, this process is used to create the derivative according to the process structure.

Each derivative type is also defined with a class that groups the derivative types based on the type’s characteristics.

For example, all 2D derivative types should be classified as either 2D Drawing or 2D Image, and all 3D derivative types should be classified as 3D.

Derivative types can be defined for user access and utilization within client applications such as SAP Visual Enterprise Access. For example, you can allow users to view and download derivatives, or prevent users from deleting derivatives that are built using the type.

By default, derivative type properties are defined by the parameters of the process selected for the derivative type. Additional properties can be created for a derivative type.

Property of the derivative type can have one of the following data type:

● Boolean● DateTime● Decimal● Integer● String● Picklist

The Picklist data type limits the values that can be defined for the property to those of the selected pick list. For example, if you select the 2D Raster pick list, the default values can be one of the following:○ JPEG Image○ Portable Network Graphics (png)○ Portable Pixelmap Graphic (ppm)○ Tagged Image File Format (tif)○ Windows Bitmap Graphic (bmp)

Derivatives on demand (DoDs) are derivatives created on the fly using unique property values rather than the standard derivative type values. They can be created through interactive client application sessions or through derivative groups.

Activities

The Derivative Types panel comprises the following:

● Derivative Types toolbar



Edit DoD Definition Opens the Derivative on Demand window, and is used to generate and design the property definitions that determine the look of the SAP Visual Enterprise Access input screen for derivative types

● Derivative Type menu

The Derivative Type menu is displayed when you right-click a derivative type in the Derivative Types viewport.


Edit Opens the Edit Derivative Type window to modify the selected derivative type

Delete Used to delete the selected derivative type

Edit DoD Definition Opens the Derivative on Demand window, and is used to generate and design the property definitions that determine the look of the SAP Visual Enterprise Access input screen for derivative types

Remove DoD Definition Removes the DoD definition form the selected derivative type

● List of derivative types and their attributes displayed in the following table columns:


Name The derivative type name

Class The group to which the type belongs

For example, a derivative type based on the .rh format should belong to the 3D class.

System Type Defines whether the type is system-based. If Yes, it cannot be edited.

Extension The extension of the file format in which derivatives are built

Can Show Defines whether the derivative type display is enabled for SAP Visual Enterprise Access

Can Download Defines whether downloading of derivatives created with the type is enabled in SAP Visual Enterprise Access

User Create Defines whether derivative creation using the type is enabled in SAP Visual Enterprise Access




User Delete Defines whether deletion of derivatives created with the type is enabled in SAP Visual Enterprise Access.

Has DoD Data If Yes, indicates that user can create DoD in SAP Visual Enterprise Access for this derivative group (this group has properties)

More Information

Creating Derivative Types [page 550]

Derivatives On Demand Definition [page 552]

Generating and Removing DoD Definitions [page 553]

2.3.5 Derivative Groups Panel

The Derivative Groups panel displays a list of the current derivative groups. You can use it to manage SAP 3D Visual Enterprise Generator derivative groups and their components.

A derivative group is a container for derivative type instances that are used to create multiple derivatives on the fly. These derivatives are called derivatives on demand (DoDs).

NoteSingular DoDs can be created through interactive client application sessions.

By default, derivative type properties are defined by the process parameters selected for the derivative type. When you add a derivative type instance to a group, you enter unique values for the instance. This enables you to use derivatives types to create derivatives using unique property values rather than the standard derivative type values.

For example, the default CAD Assemblies and Parts derivative group contains numerous vector derivative type instances. You could create another group that uses the same vector derivative types but with different values for each instance.

Integration

Using derivative groups, multiple derivatives can be created in client applications such as SAP Visual Enterprise Access, in two ways:

● Based on individual assets when uploading assets


● When derivatives are created from an individual asset, you select the asset on which the derivatives are based

● Based on a collection of assets through the Collections pane

When creating derivatives from an asset collection, workflows are used to select the assets from which derivatives are created. Using asset collections, you can create derivatives for each view (step, procedure, model view, or portfolio) within a file; or simply one derivative for each instance in the derivative group, for each asset in the collection.

NoteSee the SAP Visual Enterprise Access Help for more information on using derivative groups and workflows with individual assets and asset collections at http://help.sap.com/ SAP Visual Enterprise AccessSAP Visual Enterprise Access 7.1 .

Certain conditions apply to the derivative groups and the asset files used when creating view derivatives. See Installation Guide at http://help.sap.com/ SAP 3D Visual Enterprise Generator SAP 3D Visual Enterprise Generator 9.0 Installation Guide for SAP 3D Visual Enterprise Generator 9.0 for more information.

Features

The Derivative Groups panel comprises the following:

● Derivative Group toolbar● Derivative Group menu


New Adds a new derivative group

Edit Modifies the selected derivative group

Delete Deletes the selected derivative group

● List of derivative group names

Activities

CautionYou cannot delete derivative types that are in use. For example, if derivatives have been created by SAP 3D Visual Enterprise Generator using a derivative type that belongs to a group.





To edit a derivative group, proceed as follows:

1. Do one of the following in the Derivative Groups panel:○ Select the group and choose Edit on the Derivative Groups toolbar.○ Right-click the group and choose Edit.○ Double-click the group.

2. Make the changes and choose OK. The changes are saved.

To delete derivative groups, proceed as follows:

1. Do one of the following in the Derivative Groups panel:○ Select the groups and choose Delete on the Derivative Groups toolbar.○ Right-click the groups and choose Delete.○ Select the groups and press DELETE .

2. Choose Yes. The groups are deleted immediately.

More Information

DoD Group for Individual Asset [page 555]

DoD Group for Asset Collection [page 556]

Creating Derivative Groups [page 556]

2.3.6 Pick Lists Panel

Use

The Pick Lists panel displays a list of the current pick lists and related information including the storage type and table name. You can use it to manage SAP 3D Visual Enterprise Generator pick lists and their components.

You can use pick lists to limit the values that can be defined for derivative type properties and metadata attributes.

Once the Picklist data type is selected for a property or attribute, you select the pick list you want for the property or attribute.

The pick list values can then be selected in the client application such as SAP Visual Enterprise Access to apply them as one of the following:

● Directly to derivatives when creating them, using the derivative type● As asset metadata when uploading assets

For example, if you create an attribute with the Picklist data type, and then select the 2D Raster pick list, the default values can be the following:

● JPEG Image● Portable Network Graphics (png)


● Portable Pixelmap Graphic (ppm)● Tagged Image File Format (tif)● Windows Bitmap Graphic (bmp)● Default Pick Lists

SAP 3D Visual Enterprise Generator is delivered with the following default pick lists:

● 2D drawingValues for 2D vector images, and can be modified directly

● 2D rasterValues for 2D raster images, and can be modified directly

● 3D convertValues for 3D files, and can be modified directly

● Asset typesValues for all asset types. For example, CAD assemblies and parts.

● Derivative typesValues for all derivative types, and are modified through the Derivative Types panel

● DS process statusValues for the task processing status. For example, the Not Ready and Pending Update.

● File extensionsValues for all file extensions, for example, .pdf

● File formatsValues for all file formats, for example, Adobe Portable Document (.pdf)

● Metadata fieldsValues for all metadata attributes. Customized metadata are modified through the Metadata Attributes panel.

● Partner systemsValues for all external partner data to distinguish between identical data in both SAP 3D Visual Enterprise Generator and external applications

● PDF templatesValues for PDF templates; can be added and removed directly

● ProjectsValues for all projects, and are modified through the Projects panel

● Render typesValues for all render methods, for example, Bounding Box and Hidden Wireframe

● ViewsValues for views; can be modified directly

Importing PDF Templates

A number of PDF templates that can be used to publish various types of PDF documents are delivered with SAP 3D Visual Enterprise Generator. These templates are stored in the default location: C:\Program Files\SAP AG\SAP 3D Visual Enterprise Generator\plugins\PDF_Publishing\Templates.

You can also create your own PDF templates in Adobe Acrobat 3D v8.0, or Adobe Acrobat Professional v8.0 using the PDF Template Designer. The RH Acrobat Controls are accessed through the Advanced Editing toolbar. These templates can then be added to the PDF Templates pick list for later use.



Integration

To define values for them in client applications such as SAP Visual Enterprise Access, metadata attributes must be activated to Display at upload. For more information, see the SAP Visual Enterprise Access Help at http://help.sap.com/ SAP Visual Enterprise Access SAP Visual Enterprise Access 7.1 .

Features

The Pick Lists panel comprises the following:

● Pick Lists toolbar● Pick Lists menu


Edit Used to modify the selected pick list

Delete Used to delete the selected pick list

● List of pick lists and their attributes displayed in the following table columns:

Column Functional Description

Name The pick list name

Storage Type The storage method used for the pick list: the standard storage type can be modified, the external type is managed by the system and cannot be modified.

Table Name The SAP 3D Visual Enterprise Generator database table in which the pick list is managed by the system

More Information

Creating, Editing, and Deleting Pick Lists [page 558]



2.3.7 Metadata Categories Panel

Use

The Metadata Categories panel displays a list of the current metadata category and related information including the classification. You can use it to manage SAP 3D Visual Enterprise Generator metadata categories and their components.

Features

The Metadata Categories panel comprises the following:

● Metadata Categories toolbar● Metadata Categories menu


Edit Used to modify the selected metadata category

Delete Used to delete the selected metadata category

● List of names and descriptions of metadata categories

Activities

Creating Metadata Categories

To add a metadata category, proceed as follows:

1. Choose New on the Metadata Categories toolbar. The Create Metadata Category window opens.2. Enter a name for the metadata category.3. If required, type a description for the category.4. Choose OK. The metadata category is saved.

Editing and Deleting Metadata Categories

To edit a metadata category, proceed as follows:

1. Do one of the following in the Metadata Categories panel:○ Select the category and choose Edit on the Metadata Categories toolbar.○ Right-click the category and choose Edit.○ Double-click the category.




To delete metadata categories, proceed as follows:

1. Do one of the following in the Metadata Categories panel:○ Select the categories and choose Delete on the Metadata Categories toolbar.○ Right-click the categories and choose Delete.○ Select the categories and press DELETE .

2. Choose Yes. The categories are deleted immediately.

2.3.8 Metadata Attributes Panel

Use

The Metadata Attributes panel displays a list of the current metadata and related information including the display name, data type, and default value. It is used to manage SAP 3D Visual Enterprise Generator metadata and their components.

Metadata allows you to associate information with assets for use in client applications such as SAP Visual Enterprise Access. By associating information with assets, the quality of the asset files can be greatly increased.

Customized metadata can be created and assigned to a metadata category to be organized easily.

Metadata can have one of the following data types:

● Boolean● DateTime● Decimal● Integer● String● Picklist

The Picklist data type limits the values that can be defined for the property to those of the selected pick list). For example, if you select the 2D Raster pick list, the default values can be the following:

● JPEG Image● Portable Network Graphics (png)● Portable Pixelmap Graphic (ppm)● Tagged Image File Format (tif)● Windows Bitmap Graphic (bmp)● Customized Metadata

You can define various settings when creating customized metadata to determine how the metadata functions in client applications, including the following:

● If metadata is displayed in advanced searches● If metadata is displayed at upload● If metadata can be updated● If metadata is mandatory when uploading assets, and values must be entered

Customized attributes are modified through the Metadata Attributes panel.


Features

The Metadata Attributes panel comprises the following:

● Metadata Attributes toolbar


Category Filters metadata based on the metadata’s assigned category

● Metadata Attributes menu


Edit Used to modify the selected derivative group, metadata category, metadata, pick list, extenstion, and hot folder

Delete Used to delete the selected derivative group, metadata category, metadata, pick list, extension, and hot folder

● List of metadata attributes displayed in the following table columns:


Name The metadata name

Data Type The metadata’s data type

Default Value The metadata’s default value

Required at Upload Indicates if a value is mandatory for the attribute in client applications

Display at Upload Indicates if the attribute is displayed when uploading assets in client applications

Can Update Indicates if updates are enabled for the attribute in client applications

Advanced Search Indicates if the attribute is displayed in client application advanced searches

NoteFor more information on functionality that applies to client applications, see the SAP Visual Enterprise Access help at http://help.sap.com/ SAP Visual Enterprise Access SAP Visual Enterprise Access 7.1 .




Activities

To filter metadata, click in the Category field in the Metadata Attributes toolbar and choose the category on which you want to filter metadata. All metadata that has been assigned that category are shown.

To edit a metadata attribute, proceed as follows:

1. Do one of the following in the Metadata Attributes panel:○ Select the attribute and choose Edit on the Metadata Attributes toolbar.○ Right-click the attribute and choose Edit.○ Double-click the attribute.


To delete metadata attributes, proceed as follows:

1. Do one of the following in the Metadata Attributes panel:○ Select the attributes and choose Delete on the Metadata Attributes toolbar.○ Right-click the attributes and choose Delete.○ Select the attributes and press DELETE .

2. Choose Yes. The attributes are deleted immediately.

More Information

Creating Metadata [page 557]

2.3.9 File Types Panel

Use

The File Types panel displays a list of the current file types and related information including the extension and the selection mode. It is used to manage SAP 3D Visual Enterprise Generator file types and their components.

You can use the File Types panel to do the following actions with file types and extensions:

● Create file types● Add different extensions● Add multiple versions of the same extension to the type

This helps to manage file format conflicts where more than one file has the same file extension.

For example, an .3dm file may be a Rhinoceros 3D Model or a Quicktime 3D Metafile. The .3dm file type delivered by default with SAP 3D Visual Enterprise Generator, contains two instances of the same extension, one for Rhinoceros 3D files and one for Quicktime 3D files, so that client applications can recognize both file types for processing and previewing files.

Original files are stored by default when a file type is created; however, you can choose to not store them if required. You can also assign file types with a priority to always use that type when uploading files of the type.


Integration

When files are previewed in client applications such as SAP Visual Enterprise Access, files can be previewed using SAP 3D Visual Enterprise Viewer or an application chosen by the client application browser.

If SAP 3D Visual Enterprise Viewer is installed, you can choose to associate it with each file type extension. When previewing files, the client application then checks for the appropriate file type plug-ins and, if they are available, uses SAP 3D Visual Enterprise Viewer to preview the file. Otherwise, the current browser searches for an application with which to preview the file.

For more information, see SAP 3D Visual Enterprise Viewer Help at http://help.sap.com/ SAP 3D Visual Enterprise Viewer .

Features

The File Types panel comprises the following:

● File Types toolbar● List of file types and their attributes displayed in the following table columns:


Extension The file type’s extension

Store Originals Stores original asset files, and the .rh files created from the originals, in the database before uploading assets. You can then download the original files from client applications such as SAP Visual Enterprise Access.

File Type Selection Mode The method used to determine if the file type is always used when uploading files of the type

Auto: Allows SAP 3D Visual Enterprise Generator determine the appropriate type to upload files of the type

Priority: Always selects the file type to upload files of the type

Note that if the file type includes more than one extension, the Priority 1 extension is used.

● Extensions subpanelThe Extensions subpanel is used to add, edit, and delete extensions within file types, and to reorder the priority extension list.The Extensions subpanel comprises the following:○ Extensions toolbar

Used to refresh the Extensions panel





Move Up Moves the extension up the priority list

Move Down Moves the extension down the priority list

○ Extension iconThe image selected for the file type’s icon

○ Extensions context menu


Edit Used to modify the selected extension

Delete Used to delete the selected extension

○ File type attributes displayed in the following table columns:


Name The file type extension name

Plug-In The extension’s associated plug-in

Default Master Derivative Process The default process used to upload files of the type. This process is displayed as the default import option when uploading files of the type.

Asset Type The type of asset produced by file’s of this type. For example, a 3D scene.

MIME Type MIME type that designates the file format to identify the way it will be displayed by SAP 3D Visual Enterprise Viewer

Priority The order in which file types are used to upload files if the selection mode is set to Priority. That is, when the file type includes more than one extension, the Priority 1 extension is used.

SAP 3D Visual Enterprise Viewer Complete Indicates if file format can be opened in SAP 3D Visual Enterprise Viewer Complete

SAP 3D Visual Enterprise Viewer Minimum Indicates if file format can be opened in SAP 3D Visual Enterprise Viewer Minimum


Activities

To open the Extensions subpanel, open the File Types panel and select a file type.

More Information

Adding File Types [page 560]

Adding, Editing, Deleting Extensions [page 562]

2.3.10 Hot Folders Panel

Use

The Hot Folders panel displays a list of the folders being monitored for changes to files within them, and related information including the directory path and action to take if a change is discovered. It is used to manage hot folders and their components.

SAP 3D Visual Enterprise Generator workflows can be configured to run when files are placed in nominated, local folders. This is useful and simple way of initiating SAP 3D Visual Enterprise Generator processing. When files are placed into these hot folders, the related workflows run automatically to process the files, and an E-mail notification is sent to the system administrator when a file is placed in a monitored folder. E-mail notification is configured using SAP 3D Visual Enterprise Generator Configuration.

NoteWorkflows can also be used to process certain files when a job is scheduled to run.

SAP 3D Visual Enterprise Generator supports two types of processing from hot folders:

● Single file processingSingle files that are placed in hot folders are processed as single work units without external dependencies, using the Start Workflow Job action, for example, a 3D file that does not have external file references. When single files are processed in SAP 3D Visual Enterprise Generator, the name of the dropped file is the only data that can be passed to the process.

NoteFiles with external file dependencies cannot be resolved using this workflow method and must be loaded using the manifest file processing method.

● Manifest file processingFiles that are placed in the hot folder are structured manifest files that the associated workflow can interpret, using the Start Manifest Workflow Job action.



Features

The Hot Folders panel comprises the following:

● Hot Folder toolbar● Hot Folder menu● List of hot folders and their attributes displayed in the following table columns:


Path The directory path of the hot folder

Action The processing action taken when changes are discovered in the hot folder

Enabled The monitoring status of the hot folder

● Hot Folder Log sub-panelThe Hot Folder Log sub-panel is used to view hot folder logs and associated jobs.


Date The date that action was taken if changes were discovered in the hot folder

Filename The name of the monitored file

Processed The processing status of the log

Job ID The ID of the job that was executed

Activities

To open the Hot Folder File sub-panel, open the Hot Folders panel and click a hot folder.

Displaying the Hot Folder Log menu and Associated Jobs

1. To display the Hot Folder Log menu, right-click a log in the Hot Folder Log sub-panel.2. To view an associated job, choose a hot folder in the Hot Folders panel, right-click a log in the Hot Folder Log

panel, and then choose View Associated Job. The log is displayed in the Job Report window.

Editing and Deleting Hot Folders

You can define settings that control how the hot folder functions. For example, you can deactivate hot folders and modify the workflow parameters for processing files.

Editing a Hot Folder


To edit a hot folder, proceed as follows:

1. Do one of the following in the Hot Folders panel:○ Select the hot folder and choose Edit on the Hot Folders toolbar○ Right-click the hot folder and choose Edit○ Double-click the hot folder

2. Make the changes you require and choose OK. The changes are saved.

Deleting a Hot Folder

To delete hot folders, proceed as follows:

1. Do one of the following in the Hot Folders panel:○ Select the hot folders and choose Delete on the Hot Folders toolbar○ Right-click the hot folders and choose Delete○ Select the hot folders and press DELETE

2. Choose Yes. The hot folders are deleted immediately.

More Information

Adding Hot Folders [page 563]

Manifest File Processing [page 566]

Workflow Variables [page 568]

2.3.11 Scheduled Activities Panel

Use

The Scheduled Activities panel displays a list of the jobs that have been scheduled to run at specified times, and related information including the workflow that processes files when the job starts. It is used to manage scheduled activities and their components.

Jobs can be scheduled to run at predetermined intervals: the job runs a single instance of a workflow on a specific set of data, and the specified workflow defines what processing occurs. For example, you could schedule to upload assets weekly over three months.

Workflows can also be used to process files when they are placed in a hot folder.

Features

The Scheduled Activities panel comprises the following:

● Scheduled Activities toolbar



● Scheduled Activities menuThe Scheduled Activity menu is displayed when you right-click an activity in the Scheduled Activities panel.


Edit Used to modify the selected activity

Delete Used to delete the selected activity

Run Now Executes the selected activity immediately

● List of scheduled activities and their attributes displayed in the following table columns:


Name The activity name

Action The processing action taken when the activity is run

Status Indicates whether the activity is currently running

Last Run At The data and time that the activity was last run

Enabled Current status of scheduled activity

● The Scheduled Activity Log subpanelThe Scheduled Activity Log subpanel is used to view scheduled activity logs and associated jobs.


Date The date that action was taken if changes were discovered in the scheduled activity


Activities

To open the Scheduled Activity Log subpanel, open the Scheduled Activities panel and click a scheduled activity.

The Scheduled Activity Log menu is displayed when you right-click a log in the Scheduled Activity Log subpanel.

Editing and Deleting Scheduled Activities

You can define settings that control how the activity functions. For example, you can deactivate activities and modify the workflow parameters for processing files.


To edit a scheduled activity, proceed as follows:

1. Do one of the following in the Scheduled Activities panel:○ Select the scheduled activity and choose Edit on the Scheduled Activities toolbar○ Right-click the activity and choose Edit○ Double-click the activity


To delete scheduled activities, proceed as follows:

1. Do one of the following in the Scheduled Activities panel:○ Select the activities and choose Delete on the Scheduled Activities toolbar○ Right-click the activities and choose Delete○ Select the activities and press DELETE

2. Choose Yes. The activities are deleted immediately.

Viewing Associated Jobs

You can view jobs that are scheduled to run in the Job Report, where they can then be filtered and searched, and the details copied and exported.

To view an associated job, proceed as follows:

1. Choose a scheduled activity in the Scheduled Activities panel.2. Right-click a log in the Scheduled Activity panel.3. Choose View Associated Job.

The log is displayed in the Job Report.

More Information

Adding Scheduled Activities [page 569]

2.3.12 Plug-In Manager

Use

The Plug-In Manager is a utility that lists plug-in information. You can use it to do the following:

● View current plug-ins and files● Establish global import and export settings● Resolve plug-in conflicts

Plug-in conflicts are highlighted in the File Formats tab page.

NoteMenu options for the Plug-In Manager are not available on slave computers.



Features

Plug-Ins Tab Page

The Plug-Ins tab page displays the following:

● Plug-in name● Version● Description● Status● Size● Extensions● All supported import and export formats (see Import Settings [page 502] and Export Settings [page

505])

When SAP 3D Visual Enterprise Generator starts for the first time, each plug-in status is recorded as Loaded and a system file is created informing SAP 3D Visual Enterprise Generator which plug-ins are used. Next time you start the application, this file is used to reference the plug-ins, existing plug-ins are recorded as Defer, and the application opens without delay.

After that, only new plug-ins and plug-ins you choose to view in the application are recorded as Loaded, indicating the following:

● New plug-ins have yet to be added to the system file for future reference● The plug-ins selected for viewing have been loaded into the application

Field Name Description

Import/Export Filters Displays the file formats that are associated with the selected plug-in

Extensions Displays the extensions that are associated with the selected plug-in

File Formats Tab Page

The File Format tab page displays all supported formats including the following information:

● Format name● Extension● Type● Related plug-in

You can use this tab page do the following:

● Resolve any plug-in or format conflicts (highlighted in pink)● Modify global import and export settings for each file format

You can reorder the format rows to view any conflicts easily. Most file extension conflicts are resolved automatically; if one plug-in cannot load a file with the supported file extension, the other plug-in tries to load this file.

There are many file formats that can be imported and exported, but that do not have import or export (goi_ or goe_) operations. Furthermore, some import and export operations do not display all of the import/export


settings. These settings are standard to SAP 3D Visual Enterprise Author and are not plug-in specific: they are unavailable for SAP 3D Visual Enterprise Generator. For more information, see SAP 3D Visual Enterprise Author help at http://help.sap.com/ SAP 3D Visual Enterprise Author .

For an overview of the import and export settings available in SAP 3D Visual Enterprise Generator, see Import Settings [page 502] and Export Settings [page 505]. For detailed information about all supported file formats, see SAP 3D Visual Enterprise Import and Export Options.

Field Name Description

Up Moves the selected row up one level

Down Moves the selected row down one level

Reset Restores the rows to their original order

Import Settings Modifies the import settings of the selected format

Export Settings Modifies the export settings of the selected format

Activities

To resolve conflicts, deselect the relevant plug-in or format checkbox. The file format is not loaded when you next start SAP 3D Visual Enterprise Generator.

To move a row in the list, select it and choose Up or Down buttons to move the row to a new location.

To edit import and export settings, proceed as follows:

1. Select the format for which you want to modify, and do one of the following:○ Choose Import Settings○ Choose Export Settings

2. Make the selections you require and choose OK twice.

2.3.12.1 Import Settings

Use

If a file contains import properties, you can modify the global settings and apply them to the format. They are then applied to all files of the same format when you process the files in SAP 3D Visual Enterprise Generator. You can also process files in SAP 3D Visual Enterprise Generator with different settings to the global settings by using import (goi_) operations.

When modifying import settings, certain tab pages and the options differ depending on the selected file format; others are identical across different file formats. For further information, see SAP 3D Visual Enterprise Import and Export Options [page 631].




Integration

You can reduce the time required to retrieve a part or assembly file by saving the file instance in an instance accelerator file with the Pro/ENGINEER software. Each instance is saved in its own unique accelerator file.

Part instance files are called instance[name].xpr.

Assembly instance files are called instance[name].xas.

For more information, see Saving Parts and Assembly Instances [page 572].

Note that the following information relates to Pro/ENGINEER only.

Features

General Tab Page

On the General tab page, you can define the import properties for the selected file format.

The tab pages and the options displayed when importing a file differ depending on the selected file format. However, many tab pages and options are identical across different file formats.

Tessellation Settings

Tessellation can be used to modify the arrangement and density of model polygons. In doing so, a finer mesh is created for models as the curvature gets tighter. Note that finer meshes with more faces and detail use more resources and may take longer to render.

There are a number of tessellation parameters that define the model tessellation including tessellation level, angular tolerance, and chord height tolerance.

Tessellation Levels

The following table describes the standard settings for tessellation levels:

Standard Tessellation Level Settings

Tessellation Level Angular Tolerance Chord Height Tolerance

Very Low Off 3.1622

Low Off 1.7782

Medium Low Off 1.0

Medium 45 0.025

Medium High 22.50 0.01

High 11.25 0.005

Very High 5.63 0.001


These values are exact, but are by default scaled to the size of the objects as they are tessellated. This behavior is described in the description for chord height behavior. The chord height values work as a percentage.

User-Defined TessellationYou can define tessellation values, including the following:

Setting Description

Angular Tolerance Determines the maximum angular deviation (in degrees), allowed between an analytical surface and its triangulation

Pairs of triangles do not incorporate a dihedral angle greater than this amount. This setting dictates the minimum number of facets around a smaller circle or cylinder regardless of the Chord Height Tolerance setting, and gives you added control over faces with very small radii. Lower values result in finer tessellations, while higher values give coarser tessellations.

Chord Height Tolerance Determines the value between the analytical surface and its triangulation that defines the distance and accuracy of the tessellation.

The lower value is the Chord Height Tolerance value, the more accurate is the result. 0.00001 is the minimum unit (High detail), and 1 000 000 is the maximum unit (Low detail).

Chord Height Behavior Determines how accurately the chord height tolerance is applied.

● Absolute: Indicates that the chord height tolerance is applied exactly as is

● Scaled: Indicates that the values may be adjusted depending on the scale of the object being tessellated.

Angular Tolerance Cap Determines the minimum value that is applied to angular tolerance, irrespective of other settings.

For example, an angular tolerance cap of 45 degrees which ensures that a circle is tessellated to have at least 8 sides.

Chord Height Tolerance Cap Determines the minimum value that is applied to chord height tolerance, irrespective of other settings



2.3.12.2 Export Settings

Use

If a file contains export properties, you can modify the global settings and apply them to the format. They are then applied to all files of the same format when you process the files in SAP 3D Visual Enterprise Generator.

You can also process files in SAP 3D Visual Enterprise Generator with different settings to the global settings by using export (goe_) operations.

When modifying export settings, certain tab pages and the options differ depending on the selected file format; others are identical across different file formats. For unique settings and detailed information about supported file formats, see SAP 3D Visual Enterprise Import and Export Options.

Features

General Tab Page

You use the General tab page to define the export properties for the selected file format.

The tab pages and the options displayed when exporting a file differ depending on the selected file format.

Animation Tab Page

The Animation tab page is used to define the animation export properties for the selected file format:

Field Name Field Description

Export Animation Saves the animation to file

Rescale Animation Establishes the length of the animation

● Set animation length to: The length of the animation in seconds

● Change animation to: Scales the animation length relatively by the specified percentage

Reverse Animation Sequence Reverses the animation sequence from moving forward to backward

Remove Redundant Keys Removes duplicate animation keys from the exported file. The exported animation plays with the same or similar behavior, but with fewer keys.

Materials Tab Page

The Materials tab page is used to define the export properties for the selected file format materials.



Change all materials before export Activates the material property fields for the file, and applies the settings when the file is saved.

Substitute color of textured material to If a diffuse texture is present, sets the diffuse color to the selected color.

Set ambient color to: Applies the selected color as the ambient color. Ambient light is the general light that illuminates the entire scene. It has uniform intensity and is uniformly diffuse. It has no discernible source and no discernible direction.

Or scale by: Multiplies the ambient color by the specified value

Set diffuse color to: Applies the selected color as the diffuse color. Diffuse color describes how a material reflects diffuse light in a scene. Because most scenes contain much more diffuse light than ambient light, diffuse reflection plays the largest part in determining overall color. Additionally, because diffuse light is directional, the angle of incidence for diffuse light affects the overall intensity of the reflection. Diffuse reflection is greatest when the light strikes a vertex parallel to that vertex normal. As the angle of reflection increases, the effect of diffuse reflection diminishes. The amount of light reflected is the cosine of the angle between the incoming light and the vertex normal.

Or scale by: Multiplies the diffuse color by the specified value

Set specular color to: Applies the selected color as the specular color. Specular reflection creates highlights on objects, making them appear shiny. You establish the color of the specular highlights by setting this color.

Or scale by: Multiplies the specular color by the specified value

Set emissive color to: Applies the selected color as the emissive color. This parameter models glowing objects. This setting can be useful for displaying pre-lit models (where the light energy of the room is computed explicitly), or for displaying scientific data.

Or scale by: Multiplies the emissive color by the specified value

Set opacity of all transparent objects to: If the material opacity is less than one, replace the opacity value by the specified value

Set glossiness to: Changes the glossiness of the materials to the specified value



Texture Maps Tab PageThe Texture Maps tab page is used to define the export properties for the selected file format textures.


Save textures Saves textures either as separate files, or within the 3D file depending on your selection in the Include textures in 3D file field.

Include textures in 3D file Saves textures within the 3D file. This option is only available for certain formats, for example, the rh format.

NoteWhen saving to therh format, this option used in conjunction with the Convert textures to option only converts new textures; any existing textures are not modified. As a result, internal PNG ambient occlusion maps and internal JPG textures can be present in the samerh file.

Keep original textures format: Maintains the original texture format.



Convert textures to: Selects the format in which to export the textures. When saving .rh files that include Realight maps, we recommend that you choose the Portable Network Graphics format (.png). This choice helps to avoid JPG artifacts in shadow maps.

NoteWhen saving to therh format, this option used in conjunction with the Include textures in 3D file option only converts new textures; any existing textures are not modified. As a result, internal PNG ambient occlusion maps and internal JPG textures can be present in the same .rh file.

● Settings: Defines settings for the texture files for the selected format.

● Include selected textures: Saves each texture image in the 3D file for all the formats that are selected in the list box.Textures for any unselected formats are converted to the type defined in the Convert texture file extensions to field. This option is available only if you select the Include textures in 3D file checkbox.

● Include all textures: Saves each texture image that already exists as a separate file in the 3D file in its original format.Textures without a predefined format; for example, ones created by the Realight tool, are converted to the type defined in the Convert Texture File Extensions to field.




Store links to all existing images of following types Links each texture image to the 3D file for all the formats that are selected in the list box.

Textures for any unselected formats are converted to the type defined in the Convert textures to field. This option is only available if you choose to save textures as separate files.

● Store links to all existing images: Links each texture image that already exists as a separate file to the 3D file. Only embedded textures are exported to new 2D files.

● Relative path: Saves each link as a relative path. Relative paths change depending upon the location of the image.

● Full path: Saves each link as a full path to the location of the image. For example, F:\My Images\Category\animage.bmp.

● Local short name: Saves each link with the name of the file. For example, animage.bmp.

Overwrite existing Selects the action if the texture map being exported already exists in the destination folder.

● Replace: Overwrites the existing map.● Skip: Retains the existing map.● Rename: Opens a window if the map already exists, to

enable you to rename the map.

Scale textures Resizes large textures so that the longest edge of each texture file is the specified length.

Maximum edge Length: The length of the longest edge in each texture file

Convert texture file extensions to: Converts the extensions of all texture files to the specified extension. This option is only available if you choose to save textures as separate files.

Copy textures to folder Copies the textures to the specified folder. This option is only available if you choose to save textures as separate files.

Browse: Selects the folder in which to save the textures

Prefix The prefix to append to the new texture file names. Prefixes are helpful in identifying any new maps that are created. This option is only available if you choose to save textures as separate files.


2.3.13 Activate Modules Window

Before SAP 3D Visual Enterprise Generator can run any processes that use purchased modules, you must activate the modules on the master computer.

Caution● If modules have not been activated in the master computer, you may receive error messages in the

Tasks panel for any processes that use those modules.● As modules are updated, they can be upgraded in your server environment.● Before activating modules on a master computer:

○ You must ensure that SAP 3D Visual Enterprise Generator is started.● After activating modules on a master computer:

○ If you are using SAP 3D Visual Enterprise Generator in a farm environment, the server farm must be restarted.

NoteSee your Systems Administrator for further information on server environments and module activation. For further information on activating modules, refer to the SAP 3D Visual Enterprise Generator Installation and Upgrade Guide.

2.4 Security Management

Definition

The area displays the area nodes to control SAP 3D Visual Enterprise Generator security.

This administrative area comprises the following panels:


The top-level area node; it can be minimized and maximized as required

(see Users Panel [page 513])

Manages all users of the server farm

(see Groups Panel [page 515])

Manages all groups of the server farm




(see Projects Panel [page 518])

Manages all projects within the server farm

(see LDAP Servers Panel [page 521])

Manages LDAP server connections

Structure

The Security Management toolbars are displayed when you click the Security Management nodes. They are context-sensitive depending on the selected node. For example, the Groups toolbar is displayed when you click the Groups node in the Security Management area.

The following table describes toolbar buttons available for all Security Management toolbars:


Refresh Depending on the panel selected, displays the most current information about one of the following:

● Users● Groups● Projects● LDAP servers

New Depending on the panel selected, can be used to create one of the following:

● User● Group● Project● LDAP server

Edit Depending on the selected panel, can be used to modify one of the following:




Delete Depending on the selected panel, can be used to delete one of the following:


Filter Depending on the selected panel, filters one of the following within the panel, based on the user full name:

● Users● Groups● Projects● LDAP servers

Various context-sensitive, context menus are available when you right-click in the Security Management panels, with which you can perform a variety of functions. The menus that appear depend where your cursor is positioned when you click. For example, if you right-click a user in the Users panel, you can edit and delete the selected user.

The following table describes menu options available for all Security Management toolbars:


Edit Depending on the selected panel, can be used to modify one of the following:


Delete Depending on the selected panel, can be used to delete one of the following:


More Information

Security Management in SAP 3D Visual Enterprise Generator [page 584]

Permission Levels [page 586]



Asset Management [page 588]

2.4.1 Users Panel

Use

The Users panel displays a list of the current users and related information including the full name and user e-mail. It is used to manage SAP 3D Visual Enterprise Generator users and their components.

Permissions for SAP 3D Visual Enterprise Generator and client applications, such as SAP Visual Enterprise Access, are granted at the group level: users within groups receive the maximum permissions (union of all permissions) from all the groups to which they belong.

Note that you can import LDAP server users into SAP 3D Visual Enterprise Generator.

The following rules apply to users:

● The default installation creates the Security Administration group, containing the SecurityAdministrator user.

● Users receive the maximum permissions (union of all permissions) from all the groups to which they belong.

● Users can only view and manage objects (projects, folders, and assets) to which their group has permission. This allows for separation of user administration and data access.

● During installation, organizations can choose not to separate user administration and data access.● User access is configurable through group permissions. For example, an organization may want a user to

have read and write permission only. Typically users will always have read and update permissions even if they do not have that permission through their group membership.

User Access

Users require different permissions so that they can perform their individual tasks. The following table describes differing permissions for the standard user types:

Standard User Permissions

User Type Description Applications

Security Administrator Manages user permissions for projects and groups

Does not have data, job, or process control

SAP 3D Visual Enterprise Generator Administration only

SAP 3D Visual Enterprise Generator Administrator

Manages jobs (start and stop jobs), queues, debug issues

Creates, edits, and deletes processes

SAP 3D Visual Enterprise Generator Administration only



Project Administrator Manages projects and their user permissions

SAP Visual Enterprise Access

Note that it uses SAP 3D Visual Enterprise Viewer for viewing.

Owner Folders and assets have owners: either the system or an individual user.

Needs specific permissions within groups, for assets that require separate permissions from those groups



RecommendationThe following table describes other types of users that may be useful to your organization:


Content author Needs write access to certain objects to at least to folders and assets


Note that it uses SAP 3D Visual Enterprise Author for authoring, and may use SAP 3D Visual Enterprise Viewer for viewing.

Reviewer Needs read and collaboration access to some objects



Features

The Users panel comprises the following:

● Users toolbar


Import Used to import LDAP server users

● Users menu



● List of users and information about them displayed in the following table columns:


User Name The user’s user name

Full Name The user’s full name

Email The user’s e-mail address

Is LDAP User Whether the user was imported from an LDAP server

More Information

Managing Users [page 588]

2.4.2 Groups Panel

Use

The Groups panel displays a list of the current groups and related information including the group name and description. It is used to manage SAP 3D Visual Enterprise Generator groups and their components.

The default SAP 3D Visual Enterprise Generator installation creates the Security Administration group, containing the SecurityAdministrator user. This group has the System Administration functional permission, which allows administrative system to access SAP 3D Visual Enterprise Generator. Only members of the Security Administration group can do the following:

● Administer security● Create, edit, and delete users and groups● Import and edit LDAP server users● Remove users from groups

Different groups may have different permissions within the same folder in client applications. For example, a group may have read-only access to certain folders or assets in a project, read and write access to some folders, and no access at all to others. Or, two groups could have access to the same object, with one group having read-only access, and the other having read and write access.

Features

Group Rules


The following rules apply to groups:

● The Security Administration group is a system group. System group must contain the SecurityAdministrator user and cannot be renamed or deleted.

● The System Administration functional permission is only recognized for the group if the group has a low-level security.

● A group (instancing group) with project administrative permissions is required for every project: instancing groups are used to manage parts where more than one model uses the same part.

The Groups panel comprises the following:

● Groups toolbar● Groups menu● List of groups’ names and their descriptions

Create/Edit Groups Window

The Create/Edit Groups window is used to create new, edit existing groups, and apply permissions to perform functional procedures in SAP 3D Visual Enterprise Generator and SAP Visual Enterprise Access.

Tab Pages, Fields, Checkboxes and Buttons Functional Descriptions

General Used to define the settings common to all groups

Name The group’s name

Description The group’s description

Users Used to add users to the group and remove them from it

Filter Filters the list to find the users you want

Add User Adds users to the group

Use SHIFT to select adjacent users, or CTRL to select nonadjacent users.

Remove User Removes the selected users from the group

Functional Permissions Used to define permissions for the group

SAP 3D Visual Enterprise Generator Administration The SAP 3D Visual Enterprise Generator administrative permissions

System Administration Gives permission to perform administrative procedures for the SAP 3D Visual Enterprise Generator system

SAP Visual Enterprise Access The SAP Visual Enterprise Access functional permissions

Asset search Gives permission to search for assets in SAP Visual Enterprise Access

Browse page Gives permission to browse for assets in SAP Visual Enterprise Access



Tab Pages, Fields, Checkboxes and Buttons Functional Descriptions

Checked out assets page Gives permission to check out and check in assets within SAP Visual Enterprise Access

Create and edit derivatives page Gives permission to create and edit derivatives in SAP Visual Enterprise Access

Dashboard page Gives permission to use SAP Visual Enterprise Access dashboard functionality

Jobs page Gives permission to use manage jobs in SAP Visual Enterprise Access

Reports page Gives permission to manage reports in SAP Visual Enterprise Access

Subscription list page Gives permission to manage subscriptions in SAP Visual Enterprise Access

Activities

Creating Groups

You can define settings that control group functionality. For example, you set group permissions to allow one group to perform system administration on SAP 3D Visual Enterprise Generator, and another to only upload and manage assets within SAP Visual Enterprise Access.

Once created, groups can be edited and deleted.

To create a group, proceed as follows:

1. Choose New on the Groups toolbar. The Create Group window opens.2. Enter a name for the group and its description.3. Choose the Users tab page, choose Add User, and select the users you want to add to the group.

NoteYou can filter the list when adding groups to find the groups you want. Use SHIFT to select adjacent users, or CTRL to select nonadjacent users.

4. Choose the Functional Permissions tab page and select the check boxes for the permissions you want to give the group.

5. Choose OK. The group is saved.

Editing and Deleting Groups

When editing a group, you can define settings that control group functionality. For example, you can modify the users within the groups, and change the permissions given to groups.


To edit a group, proceed as follows:

1. Do one of the following in the Groups panel:○ Select the group and choose Edit on the Groups toolbar.○ Right-click the group and click Edit.○ Double-click the group.

2. Make the changes you require and choose OK.

To delete groups, proceed as follows:

1. Do one of the following in the Groups panel:○ Select the groups and choose Delete on the Groups toolbar.○ Right-click the groups and choose Delete.○ Select the groups and press DELETE on the keyboard.

2. Choose Yes. The groups are deleted immediately.

2.4.3 Projects Panel

Use

The Projects panel displays a list of the current projects and related information including the project name and instancing group. You can use it to manage SAP 3D Visual Enterprise Generator projects and their components.

SAP 3D Visual Enterprise Generator projects are viewed as top-level folders in client applications such as SAP Visual Enterprise Access.

Typically, the security administrator assigns a Project Administration group to a project giving that group full access.

The following rules apply to projects:

● Only a security administrator can create projects.● A group (instancing group) with project administrative permissions is required for every project: instancing

groups are used to manage parts where more than one model uses the same part (see Groups Panel [page 515]).

● You cannot change the project’s instancing group after it has been applied.

Features

The Projects panel comprises the following:

● Projects toolbar● Projects menu



● List of projects and their attributes displayed in the following table columns:


Name The project name

Description The project description

Instancing Group The project’s instancing group. Instancing groups are used to manage parts where more than one model uses the same part.

Each column can be sorted in ascending and descending order.

Fields and Buttons Functional Descriptions

General Used to define the settings common to all projects

Name The project name

Instancing Group Used to apply an instancing group to the project. Instancing groups are used to manage parts where more than one model uses the same part.

Create New: Creates and applies a new instancing group to the project. Once the project is created, that new group is available for other new projects.

Default Group: Applies the default instancing group to the project

<name> groups: Applies the selected existing group to the project

Description The project description

Create new project admin group Creates a new group, and sets it as the administrator for the project. If selected, you can view the new group in the Groups panel.

Admin Groups Used to add and remove groups to/from the project

Note that you can filter the list when adding groups to find the groups you want. Use SHIFT to select adjacent groups, or CTRL to select nonadjacent groups.

Activities

Creating Projects


You can define settings that control project functionality. For example, you can select the project’s instancing group.

Once created, projects can be edited and deleted.

To create a project, proceed as follows:

1. Choose New on the Projects toolbar. The Create Project window opens.2. Enter a name for the project and its description.3. Select the instancing group you want to manage parts for models in the project.

NoteIf you select the default Create New option, a new instancing group is created, applied to the current project, and becomes available for other new projects.

4. Select the Create new project admin group checkbox to create a new group, and set this group as the administrator for the project.If you select this option, the new group is created under the Groups node.

5. Choose the Admin Groups tab, choose Add Group, and then select the groups to add to the project.You can filter the list when adding groups to find the groups you want. Use SHIFT to select adjacent groups, or CTRL to select non-adjacent groups.

6. Choose OK twice. The project is saved.

Editing and Deleting Projects

When editing a project, you can define settings that control project functionality. For example, you can modify the groups that are defined for the project.

NoteYou cannot change the project’s instancing group.

To edit a project, proceed as follows:

1. Do one of the following in the Projects panel:○ Select the project and choose Edit on the Projects toolbar.○ Right-click the project and choose Edit.○ Double-click the project.

2. Make the changes and choose OK.

To delete projects, proceed as follows:

1. Do one of the following in the Projects panel:○ Select the projects and choose Delete on the Projects toolbar.○ Right-click the projects and choose Delete.○ Select the projects and press DELETE on the keyboard.

2. Choose Yes. The projects are deleted immediately.



2.4.4 LDAP Servers Panel

Use

The LDAP Servers panel displays a list of the current LDAP servers and related information including the server authentication type and base domain name for LDAP servers. You can use to manage LDAP servers and their components.

SAP 3D Visual Enterprise Generator provides support for SAP 3D Visual Enterprise Generator managed user accounts and Lightweight Directory Access Protocol (LDAP) user accounts. LDAP is an Internet protocol that e-mail servers and other programs use to look up information from a server.

LDAP servers index all the data in their entries: you can use filters to select only the user or group you want, then return only the information you want.

LDAP is not limited to contact information, or information about individual users. LDAP is used to look up encryption certificates, pointers to printers and other services on a network, and provide single signon where one user password is shared between many services. LDAP is appropriate for any kind of directory-like information, where fast lookups and less-frequent updates are standard.

If you have an e-mail program (as opposed to Web-based e-mail), it probably supports LDAP. Most LDAP clients can only read from a server. Client search capabilities (as seen in e-mail programs) vary widely. A few can write or update information; LDAP does not include security or encryption, so updates usually require additional protection such as an encrypted SSL connection to the LDAP server.

LDAP Definitions

As a protocol, LDAP defines the language used for client programs to talk to servers (and also servers to servers). It does not define how programs function on either the client or server side.

A client may be an e-mail program, a printer browser, or an address book.

Servers may speak only LDAP, or have other methods of sending and receiving data; LDAP may just be an add-on method.

LDAP also defines the following:

● Permissions

Set by the administrator to allow certain people access to the LDAP database, and optionally to keep certain data private

● Schema

Describes the format and attributes of data in the server

CautionLDAP domains must be configured using the Create LDAP Server window. Contact your system administrator for further information.


Features

The LDAP Servers panel comprises the following:

● LDAP Servers toolbar● LDAP Servers menu● List of projects and their attributes displayed in the following table columns:


Server The LDAP server name

Authentication Scheme The authentication scheme used to authenticate the user that will query the LDAP server

Base DN The server-base domain name (base DN): the top level of the LDAP directory tree that describes the location from where users are imported

Each column can be sorted in ascending and descending order.

Activities

Editing and Deleting LDAP Servers

When editing a server, you can select options when defining the LDAP server connections. For example, the authentication scheme used to authenticate the user that will query the LDAP server, and whether to connect to the LDAP server SSL protocol.

To edit a LDAP server, proceed as follows:

1. Do one of the following in the LDAP Servers panel:○ Choose the server and choose Edit on the LDAP Servers toolbar.○ Right-click the server and choose Edit.○ Double-click the server.

2. Make the changes and choose OK.

To delete LDAP servers, proceed as follows:

1. Do one of the following in the LDAP Servers panel:○ Choose the servers and choose Delete on the LDAP Servers toolbar.○ Right-click the servers and choose Delete.○ Choose the LDAP servers and press DELETE on the keyboard.

2. Choose Yes. The servers are deleted immediately.



More Information

Creating LDAP Server Connections [page 591]

2.5 SAP Integration

The SAP Integration area is displayed only if you work in or connect to SAP 3D Visual Enterprise Generator that is installed in the Integrated mode. For more information about the Integrated mode, see the Installation Guide at http://help.sap.com/ SAP 3D Visual Enterprise Generator SAP 3D Visual Enterprise Generator [version number] Installation Guide for SAP 3D Visual Enterprise Generator .

The SAP Integration administrative area comprises the following panels:

● Connections (see Connections Panel [page 523])● SAP Cache (see SAP Cache Panel [page 524])● User Names and Passwords (see User Names and Passwords Panel [page 525])

2.5.1 Connections Panel

Use

You use this panel to manage pre-configured connections to SAP ERP system. SAP 3D Visual Enterprise Generator supports configuration of SAP RFC connections.

Prerequisites

● You have installed and configured SAP ERP system.● You have installed SAP Logon system.● You have used SAP Logon to define connections to the target SAP ERP systems.

Features

The Connections panel comprises the following:

● Connections toolbar



Toolbar Options Functional Description

Refresh Displays the most current connections information

New Adds a new connection to SAP system you have config-ured on your PC

Edit Edits connection settings

Delete Deletes connection to SAP system from the Connections panel

● List of connections to SAP ERP systems displayed in the following table columns:


Name Name of SAP ERP system that SAP 3D Visual Enterprise Generator is connected to

Display Name Name of SAP ERP system to be shown to administrator when specifying the SAP System Connection setting in a workflow configuration

Activities

To add a new connection to SAP ERP, proceed as follows:

1. Choose New on the Connections toolbar. The Create Connection window opens.2. Select type of your connection. If you select RFC connection, do the following:

○ Enter your RFC connection details, such as SAP ERP system you have configured in your SAP Logon, its display name, and your SAP client.

3. Choose OK to save your entries.

2.5.2 SAP Cache Panel

Use

You can use this panel to clear cache of the local version of SAP 3D Visual Enterprise Generator.



Features

The SAP Cache panel comprises the following:

● SAP Cache toolbar


Refresh Displays the most current cache information

Clear Cache Clears cache of the local version of SAP 3D Visual Enterprise Generator

● SAP Cache context menu


Clear Cache Clears cache of the local version of SAP 3D Visual Enterprise Generator

● List of SAP systems and cached items displayed in the following table columns:


SAP System Indicates SAP ERP system that SAP 3D Visual Enterprise Generator is connected to

Cached Item Count Number of cached items available

Activities

To delete cached items from your local version of SAP 3D Visual Enterprise Generator, do one of the following:

● Select the cached item and choose Clear Cache on the SAP Cache toolbar.● Right-click the item and choose Clear Cache.

2.5.3 User Names and Passwords Panel

Use

The User Names and Passwords panel displays a list of the current users that are used for secure communication between integrated SAP system and SAP 3D Visual Enterprise Generator through SAP Web services. You can use the panel to manage these users and their passwords.


Features

The User Names and Passwords panel comprises the following:

● User Names and Passwords toolbar


Refresh Displays the most current user information

New Used to create new a new user

Edit Used to modify selected user

Test Used to test the communication with SAP Web services

Delete Used to delete selected user

● User Names and Passwords context menu


Edit Used to modify selected user

Test Used to test the communication with SAP Web services

Delete Used to delete selected user

● List of projects and users displayed in the following table columns:


Project Project to which user name applies

Note that you can create only one user name for each project.

User Name User name that is used for secure communication with SAP Web services

Description Description of the user name

Enabled If Yes, indicates that the user name is enabled

You enable a user name by selecting the Enabled checkbox when creating a new user or editing the existing one.

Note that if you disable a communication user name and password, installed client certificates will be used for the project when communicating with SAP Web services.



2.5.4 Visual Data Integration Upload Tool

You can use this upload component of SAP 3D Visual Enterprise Generator to upload CAD assemblies and their parts to SAP ERP and to monitor the status of jobs started in SAP 3D Visual Enterprise Generator. The Visual Data Integration upload tool allows you to perform multiple simultaneous uploads. If an upload is interrupted, it is resumed automatically.

When upload is complete, an SAP 3D Visual Enterprise Generator job is started automatically to process the upload (see Jobs Panel [page 11]).

Integration

To log onto SAP 3D Visual Data Integration, you must provide the URL to the Visual Data Integration Web service you will be using, as well as the name of the workflow that will be used. The user name should be a user name in the SAP ERP system configured for the workflow selected. This SAP ERP system is configured by modifying the SAP system connection workflow setting in SAP 3D Visual Enterprise Generator.

NoteTo change the web service URL to which to connect, click the drop-down list on the Login window and choose Use new URL.

You can connect to multiple combinations of the Visual Data Integration Web service and workflow by opening up a new instance of the Visual Data Integration upload tool and changing these details, however, you can only start one instance of the upload tool for each URL and workflow combination.

Prerequisites

1. You have installed SAP 3D Visual Enterprise Generator in Integrated mode (see Installation Guide at http://help.sap.com/ SAP 3D Visual Enterprise Generator SAP 3D Visual Enterprise Generator [version number] Installation Guide for SAP 3D Visual Enterprise Generator ).

2. SAP 3D Visual Enterprise Generator service is running.3. You have configured a Structure from CAD Visual Data Integration workflow (see Visual Data Integration

Workflow Controller [page 179]).4. The Visual Data Integration (Web service) has been configured and is accessible from the client running

Visual Data Integration upload tool – anonymous access must be enabled as authentication is handled by SAP logon connection on the SAP 3D Visual Enterprise Generator server. The default URL for the Web service is: http://[SAP3DVisualEnterpriseGeneratormachinename]/SAPERPIntegrationService/ERPIntegrationService.svc.This web service is configured by the SAP 3D Visual Enterprise Generator Configuration tool when in Integrated mode.




Features

Upload List

The Upload List is the main screen with which you will interact. It contains a toolbar of actions that can be performed, as well as a list of current and previous uploads.

You can right-click an upload in the list to display a context menu for performing additional actions on the selected upload or uploads. You can select multiple uploads to perform actions on them as a group.

The Upload List has the following columns:


Job Name The name of the job that was executed in SAP 3D Visual Enterprise Generator


File Name The name of the CAD file being uploaded

Upload Progress The progress of upload job

Started The time that the upload job started

Completed The time that the upload job completed




Status The following statuses are displayed:

● Packaging: The CAD files for the upload are being packaged into a ZIP file

● Uploading: The upload is currently in process● Files Uploaded: The upload has completed, but the job

has not yet started● Processing Job Queued: Job is in the SAP 3D Visual En

terprise Generator processing queue, but has not yet started processing

● Processing Job Running: SAP 3D Visual Enterprise Generator is currently processing the job

● Completed Successfully: Files have been uploaded and SAP 3D Visual Enterprise Generator has finished processing

● Cancelled: Uploading of files or job processing has been cancelled

● Retrying in X: There is currently a problem communicating with the Visual Data Integration web service, and communication will be retried when X has elapsed.

NoteYou can force a retry by right-clicking the upload and selecting Retry Now.

● Failed: Uploading of files or job processing has failed. For more information, double-click the upload, or right-click the upload and choose Job Report. This job report is also available from the Jobs panel (see Jobs Panel [page 11]).

● The Upload List toolbar:

Toolbar Option Functional Description

Refresh Refreshes current view

Upload Opens the Start New Upload window

Settings Opens the Settings window


3 Working with SAP 3D Visual Enterprise Generator

Use

SAP 3D Visual Enterprise Generator Administration connects to the master computer, which is the central point of communication in the SAP 3D Visual Enterprise Generator farm configuration. It comprises three administrative areas:

● Server Configuration● Server Monitoring● Security Management

Once you have opened SAP 3D Visual Enterprise Generator Administration, you can use the administrative areas to perform the various actions that you require. For example, use the Server Configuration area to create and manage workflows, Server Monitoring to manage the server farm, and Security Management to control security.

Features

If a keyboard shortcut is available for a command, it is displayed to the right of the command name on the menu.

The following table describes the preassigned keyboard shortcuts for general procedures within the main user interface:

User Interface Function Keyboard Shortcut

Display the online help F1

Open control center CTRL + SHIFT + C

Open graphics administration CTRL + SHIFT + G

Open Process Designer: create new process CTRL + SHIFT + P

Open Process Designer: open existing process CTRL + SHIFT + O


Working with SAP 3D Visual Enterprise Generator

3.1 Viewing, Filtering and Refreshing Information

Use

Once you have started SAP 3D Visual Enterprise Generator Administration, various information is displayed within the administrative area panels and windows. As SAP 3D Visual Enterprise Generator processes jobs and performs tasks, the most current information is displayed by refreshing the panels and windows. For example, as jobs are processed, you can refresh the Jobs panel information.

Simple filtering is available in many of the panels through a ‘quick filter’ to filter on the item’s name. Advanced filtering can be applied to certain items such as jobs and tasks, and you can view user action details for individual jobs.

Filtering is very useful in large server farms, where a full list of items may be very long. For example, displaying all processes in a farm can be very slow, and can prove difficult to locate a specific process. Filtering speeds up these procedures.

Note that filtering of tasks is based on the associated process name.

Activities

To filter items, proceed as follows:

1. Click in the Filter field in the panel’s toolbar.2. Type the text on which you want to filter items. All items that include the text in their name are shown.

Processes are filtered on their display name, and users are filtered on their full name.

To sort column items, click a column title. The items are sorted in the selected column, and clicking a second time switches the sort order.

3.2 Server Configuration

The Server Configuration area opens by default when you log onto SAP 3D Visual Enterprise Generator Administration. Here you can do the following:

● Create and manage workflows, derivative types and groups, metadata and metadata categories, and pick lists

● Monitor processes that are loaded and running● View process execution results in XML form● Create new, and modify existing processes● Create and manage file types, hot folders, and scheduled activities● Create and manage file types, hot folders, and scheduled activities● Create trigger and notification operations

SAP 3D Visual Enterprise GeneratorWorking with SAP 3D Visual Enterprise Generator P U B L I C 531

● Load discovered operations● Filter and refresh information

3.2.1 Creating Workflows

Use

You create workflows using the Workflows panel (see Workflows Panel [page 27]). You can define settings that control how the workflow functions. For example, selecting the controller on which the workflow is based, and defining other jobs to run at certain period of time.

Once created, workflows can be edited and deleted.

Procedure

To create a workflow, proceed as follows:

1. Choose New on the Workflows toolbar. The Create Workflow window opens.2. On the General tab page, which is used to define settings common to all workflows, enter a name for the

workflow and its description.3. If required, select the Enabled checkbox to activate the workflow for asset processing.4. Select a controller to use as the workflow template.5. If you want to apply workflows before and after the current workflow ends, do the following:

○ Select a workflow that starts before the current workflow ends, choose Arguments, enter the required parameters, add further parameters, and then choose OK. This workflow is not sent to a queue for processing.

○ Select a workflow that starts after the current workflow ends, click Arguments, enter the required parameters, and then choose OK. This workflow will be queued for processing.

6. Choose the Processes tab and select the processes to determine how the workflow functions during processing.Depending on the selected workflow controller, different settings are available for definition, including selecting the processes that the controller runs to perform specific tasks.For example, by default the Assembly Upload workflow contains the Extract BOM process to define the way the BOM is extracted when an assembly is uploaded. Whereas, the Build Derivatives workflow contains the store the build derivatives process for saving derivatives that are created when assets are uploaded.

7. Choose the Child Workflows tab and select a workflow to process as a child of the current workflow.You can apply workflows as children of other workflows.Child workflows allow for reusing of common set of functionality. One example is derivative creation – several different controllers might need to create derivatives after performing their part of the work that might have created or changed assets.For example, if you are creating a workflow based on the PLM Asset Publish controller, you can select the Select Published Asset Derivatives workflow as a child.Note that only the workflows that accept the same input (are compatible) can be selected as children.

8. Choose the Settings tab and select any additional settings for the workflow. For example, you can select a default derivative group to process only those derivative types within the group.



Note that the available settings differ for every controller. For more information about controller settings, see Workflow Controllers [page 29].

9. Save your entries.

3.2.2 Creating Processes

You create processes in the Process Designer by dragging operations into the Process Designer viewport from the toolbox, where they are displayed with the operation name and associated icon, and adding and linking one or more operations that instruct SAP 3D Visual Enterprise Generator to perform specific procedures (see Process Designer [page 228]). When creating processes, you can also do the following:

● Apply breakpoints on operations to stop the process before those operations begin (see Process Designer Viewport [page 232])

● Apply a skip on operations to ignore that operation during process execution (see Process Designer Viewport [page 232])

● Create and remove operations (see Creating Operations [page 542])● View and edit the operation parameters (see Editing Operations [page 548] and Process Designer

Viewport [page 232])● Undo and redo your actions (see Process Designer Viewport [page 232])● Automatically arrange the operations to display them in their execution order● Test the process by running or stepping through it (see Testing Processes [page 536])

The first operation in a process is always the trigger, which identifies the type of notification SAP 3D Visual Enterprise Generator requires to run the process. Only one trigger operation can be added to any process.

The results of each operation within each process are maintained as a temporary XML document. For each operation that is executed, a corresponding entry is entered in the XML document and as such, the document is a reflection of the process.

A number of processes and operations are delivered with SAP 3D Visual Enterprise Generator. Pre-configured operations are available to create and edit processes.

See the SAP 3D Visual Enterprise Generator Installation Guide at http://help.sap.com/ SAP Visual Enterprise Generator SAP Visual Enterprise Generator 9.0 for more information.

You can customize processes provided with SAP 3D Visual Enterprise Generator.

Procedure

To create a process, proceed as follows:

1. Choose New on the Processes toolbar. The Process Designer opens and the Process Settings window is displayed (see Process Designer [page 228]).

2. Enter a name and display name for the process.



RecommendationWhen creating processes, we recommend you practice a consistent naming methodology similar to the information in the following table:

Process Type Prefix

Example ex_

Repository rp_

Repository Process Derivative rpd_

3. Enter a description for the process and choose OK.4. Expand the Trigger group in the toolbox, and drag the trigger operation you want into the viewport. The

Operation Name window is displayed.Note that only one trigger operation can be added to any process.

5. Enter a name for the operation and choose OK. If required, create new operations.

RecommendationWhen operations are added to a process, they can be renamed. We recommend that you practice the following naming methodology when adding operations:

○ Operations names cannot begin with a number or special character. For example, you cannot use !, @, $, or #.

○ To change the name of an operation once it has been added to the process, you must delete the operation from the process and add it again with the name you require.

6. Select a timeout period that, when the process is executing, SAP 3D Visual Enterprise Generator waits for it to finish. If the process does not complete by the end of the timeout period, the process is terminated.

7. Continue dragging operations from the groups into the viewport and link them to form the process: move your cursor over an unlocked output connection and drag it to another unlocked input connection.

NoteA relationship can only be established with a valid link as follows:

○ Triggers can only link to parent input connections. That is, they can only link to child operations.○ On success, connections can only have one parent operation but can link to multiple child

operations.○ On failure, connections can only have one parent operation and can only link to the

standarderror operation.

8. To display operations in their execution order, choose View Auto-Arrange . The operation parameters are displayed on the right of Process Designer.

9. Set operation breakpoints as required.10. Save the process by doing one of the following:

○ Choose File Save on the Process Designer menu bar. The file is saved with the same name.○ In the Process Designer, press CTRL + S .



○ To save a new process, choose File Save As on the Process Designer menu bar. The Save As window is displayed. Enter a name for the process and choose Save.

11. Test the process.You can test processes after they have been saved to ensure they are configured correctly. You can then view the XML results document to see the outcome and check for possible errors.

3.2.3 Throttling Processes and Purging Messages

Use

You can throttle the number of process instances running across the server farm. For example, if a process is used in multiple jobs but utilizes an application for which there is only one license, you can limit the process to running in one instance. The next instance can only run when the previous instance is complete.

Additionally, pending messages can be purged for individual processes.

Activities

● To throttle messages, right-click the process in the Processes panel and choose Throttle.● To purge messages, right-click the process in the Processes panel and choose Purge Messages. Any

messages pending for the selected process are deleted.

3.2.4 Pausing Processes

You can pause processes that are long-running in non-error situations by adding the pause operation from the Flow Control group to a process. The operation notifies the process to stop for specified time period. For example, you could locate a process and pause until a script has ended.

This ensures that processes are stopped in a logical manner, and that they are allocated the time to organize and clean up any resources. You can use this function when processes take a long time to execute, and to indicate when plug-ins become suspended from processing.

Note that you can also stop receiving messages from the queues.


3.2.5 Testing Processes

Use

Using the Process Designer (see Process Designer [page 228]), you can check if processes have been configured correctly by doing the following:

● Running the entire process manually● Stepping through the individual operations

When stepping through a process, each operation steps through to the next only if the process is configured correctly.

After that you can view the XML results document to see the process outcome or check for possible errors. Editing operation parameters can correct false configuration.

If you have set breakpoints in a process, the process runs until the first breakpoint is reached. You can then either continue running the process manually or step though each operation until the second breakpoint is reached and so on.

Integration

The first time that SAP 3D Visual Enterprise Generator processes a 3ds max file, 3ds max window opens. To ensure that SAP 3D Visual Enterprise Generator continues to function correctly when this window appears, the SAP 3D Visual Enterprise Generator foreground process must be running on the client computer so that the 3ds max plug-in can interact with the computer’s desktop. In this case, we recommend using two SAP 3D Visual Enterprise Generator computers: one to process normal files and the other to process the 3ds max files. Contact your system administrator for further information.

Features

When manually running a process, you must enter values for the trigger and response parameters. These values are based on the selected process, and must be valid for the process to execute correctly.

All filename values must be UNC paths for SAP 3D Visual Enterprise Generator to be able to locate the file. The location must be visible and shared to all computers, including the slaves. Every computer must also have permission to access this location.

The following placeholders are supported:

Placeholder Description Example

$fullname$ Full name of the file \\server\3d\cars\bmw.3ds

$name$ File name excluding directory information

bmw.3ds



Placeholder Description Example

$extension$ File extension .3ds

$namewithoutextension$ File name excluding the extension bmw

$directoryname$ Directory name including root information

\\server\3d\cars\

$root$ Root directory \\server\3d

NoteThis command uses the sendnotification operation to function.

You can keep the window open when running the process, if you want to run the process multiple times.

After you have run the process, the results of process execution are maintained as a temporary XML document detailing the results of each operation. For each operation executed, there is a corresponding entry in this document. After the process is completed, the results document is sent back to the master computer, which saves the file to one of the following folders:

● Completed● Error● Job Manager

The format of the XML file is <server_id>_<processname>_<taskid>.xml.

During processing, operations can reference the results of previous operations by examining the XML document, and searching for specific elements using the standard XPath (XML Path) language. XPath statements can be automatically generated using the XPath Editor or by dragging information between parameters (see XPath Editor [page 480]).

The results document reflects the process; for each operation executed there is a corresponding entry in the results document.

For example, the external messaging system might send a notification with the name of the file as the input. The open 3D file operation, go_open uses the file name as a trigger to open the appropriate file.

Using this system, it is possible to configure complex processes involving many operations without writing any software.

If SAP 3D Visual Enterprise Generator is providing two-way integration with another system, it is possible to send the results document to the other system. This is done using an operation at the end of the process that places the results document onto a specified queue. The other system can parse the XML results to obtain information, such as metadata, about the files that were opened and the location of any 2D or 3D files that were created during the process.

Note

You can also view the Results document after running a process through the Task Details window.

If an error occurs when running a process manually, the process stops and a message may be displayed identifying the error. If the process stops without a message appearing, check the results document.


Activities

To run a process manually, proceed as follows:

1. Right-click the process in the Processes panel and choose Run. The Run Process window is displayed.2. Enter the value for the request parameter. The value depends on the current process; typically this is a file

used by the process.3. Enter the value for the response parameter. This is the file to which the process writes results.4. Do one of the following:

○ Choose Run to start the process and keep the window open.○ Choose Run and Close to start the process and close the window.

To step through a process, proceed as follows:

1. Open the process you want to step through.2. Do one of the following:

○ Choose Debug Step on the menu bar○ Press F10

3. Repeat step 2 as many times as required.

To stop a process running manually, choose Debug Stop on the menu bar.

3.2.6 Loading, Reloading and Unloading Processes

Use

If your job requirements change and you update your processes, you can use SAP 3D Visual Enterprise Generator Administration to do the following:

● Load multiple processes into the incoming message queue● Unload specific processes from the engine queue● Reload specific processes to ensure any changes are reflected in the incoming queue

NoteYou can only reload processes that are already loaded.

Activities

To load processes, do one of the following in the Processes panel:

● Choose the processes and choose Load on the Processes toolbar.● Right-click the processes and choose Load.● Choose the not loaded processes you want to load and choose Load.



NoteUse SHIFT to select adjacent processes, or CTRL to select nonadjacent processes.

The processes are loaded into the incoming queue, and their status is Loaded.

To unload a process, choose the loaded process in the Processes panel (see Processes Panel [page 224]) and do one of the following:

● Choose Unload on the Processes toolbar.● Right-click the process and choose Unload.

The process is unloaded from the engine queue and its status is Unloaded.

To reload a process, choose the loaded process in the Processes panel and do one of the following:

● Choose Reload on the Processes toolbar.● Right-click the process and choose Reload.

The process is reloaded into the incoming queue and its status is Loaded.

3.2.7 Disabling and Enabling Processes

Use

You can disable processes that are currently in the engine queue. SAP 3D Visual Enterprise Generator stops the processes before they initialize; any existing processes that are currently being executed continue to run until completion.

You can also choose to disable specific processes that are currently running: SAP 3D Visual Enterprise Generator stops process from running for any future jobs to which it is associated.

Activities

To disable or enable a process, select the process in the Processes panel (see Processes Panel [page 224]) and do one of the following:

● Choose Disable or Enable on the Processes toolbar.● Right-click the process and choose Disable or Enable.

3.2.8 Exporting and Importing Processes

Use

When you want to copy a complex process that includes custom operations and trigger operations between various SAP 3D Visual Enterprise Generators, you can save XML process definition files and the operation


definition files relating to those processes, to a ZIP file in a location of your choice. For example, you could export all process and operation definition files belonging to the delivery process to another computer. You can then import the ZIP file into another server.

Note that only one set of definition files for the current process can be exported at a time.

Features

The following rules apply for exporting and importing process ZIP files:

● Export ZIP files do not include binaries (DLL files). These are required for operations to function correctly. If you export a process that uses custom operations, they must be installed manually. Contact your system administrator for more information.

● If a process definition file with the same elementid attribute exists in the server into which you are importing, the ZIP file version is imported and the existing version is overwritten.

● If no operation with the same elementid attribute exists in the server into which you are importing, the ZIP file version is imported and an attempt is made to load it.

● If an operation with the same elementid attribute exists in the server into which you are importing, and is loaded into the SAP 3D Visual Enterprise Generator Manager, the existing version is used and not the ZIP file version.

● If an operation with the same elementid attribute exists in the server into which you are importing, but is not loaded into the SAP 3D Visual Enterprise Generator Manager, the existing version is loaded and not the ZIP file version.

Activities

To export processes, proceed as follows:

1. Right-click the Processes node in the Server Configuration menu and choose Export Processes. The Export Processes window opens.

2. Select the processes you want to export and choose Export.

NoteUse SHIFT to select adjacent processes, or CTRL to select nonadjacent processes.

3. Navigate to, and select the folder where you want to save the file.4. Enter a name for the file and save your entry.

The selected processes and related operation definition files (.xml) are saved in a ZIP file.

To import processes, proceed as follows:

1. Right-click the Processes node in the Server Configuration menu and choose Import Processes. The Import processes from: window opens.

2. Navigate to, and select the folder where the ZIP file containing the processes is saved.3. Select the file you want and choose Open.

The ZIP file is imported into SAP 3D Visual Enterprise Generator.



3.2.9 Initiating and Running Processes

Use

SAP 3D Visual Enterprise Generator executes processes when messages arrive through the Microsoft Message Queue (MSMQ). When SAP 3D Visual Enterprise Generator runs the process that is associated with an incoming message, it sends a notification to one of its slaves through the Internal Engine queue.

SAP 3D Visual Enterprise Generator uses the following primary message queues:

● Incoming queue● Used by the SAP 3D Visual Enterprise Generator middle tier to add processing tasks to the internal

processing queue● Engine queue● Mechanism by which the processing engine controller notifies engines of processing tasks to execute. All

farm servers monitor this queue for work that is required to be performed.● Job Manager queue● Mechanism by which SAP 3D Visual Enterprise Generator manages all jobs● Response queue● Mechanism by which a slave computer notifies the controller of the status or outcome of a task that it was

assigned to execute

Notification and Trigger Operations

The notification operation defines the data you send to a message queue.

Trigger operations define the notification operations and as such, are always the first operations in a process.

We recommend you practice a consistent naming methodology when creating operations, similar to the information in the following table.

Operation names cannot begin with a number or special character. For example, you cannot use the !, @, $, or # characters.

Operation Type Prefix

Graphic go_

Graphics core goc_

Import settings goi_

Export settings goe_

Directory do_

File fo_

Database db_

Web web_


Operation Type Prefix

Repository ro_

Repository trigger rot_

Exception reporter er_

Module mo_

Operation Type Suffix

Notification notification

Trigger trigger

Process

The steps for initiating and running a process are the following:

1. An external messaging system sends a message to SAP 3D Visual Enterprise Generator through the Incoming Message queue.

2. The message arrives in MSMQ.3. SAP 3D Visual Enterprise Generator sends a notification through the Internal Engine queue.4. The first of the available slave computers receives and takes the message and runs the process.5. The trigger identifies the notification that the process requires to run.6. One of the slave computers executes the process.7. When the job is completed, the slave sends a completion notification through the Response queue to SAP

3D Visual Enterprise Generator.Notification messages in a queue must be in XML format. The information contained in the message can vary depending on what the process requires, but it is likely to contain the name of the file to process. You can check incorrectly formatted messages that are sent to a message queue in the Tasks panel.Notifications may also include the format to which to convert a file or, for 2D image conversion, the required size for the new image. For example, a process could be to convert a group of objects from the 3ds Max format to the Maya format. In this case, the notification would be the file name, and the trigger would be import options.

3.2.10 Creating Operations

Use

When creating an operation, practice a consistent naming convention.

Specify a toolbox group in which the operation resides: either by choosing an existing group or by creating a new group.



You cannot delete toolbox groups once they are created.

Procedure

To create a trigger or notification operation, proceed as follows:

1. Do one of the following on the menu bar:

○ Choose Operations New Trigger if you want to create a new trigger.

○ Choose Operations New Notification if you want to create a new notification.2. Enter a unique name for the operation in the Operation field. For example, filecollectiontrigger.3. Enter a user-friendly name in the Name field. For example, filetrigger.4. Choose the image icon; navigate to, and select an image for the operation.5. Type a description for the operation.6. Do one of the following in the Toolbox field:

○ If creating a new trigger, enter Trigger to place the operation in the Triggers toolbox.○ If creating a new notification, enter the name of the toolbox group in which to place the operation.

CautionToolbox group names are case-sensitive: if you type a new name, a new group is created and cannot be deleted.

7. Drag parameters from the parameter list into the table on the left. The parameters are added to the bottom of the table.

8. Expand the parameter table and define meaningful values for the parameters.9. Add parameter selection tools, if required.10. If required, right-click parameters and choose Remove to remove them from the operation.11. Choose OK. The operation is displayed in the specified toolbox group.12. Save the process.

More Information


3.2.11 Finding and Loading Operations

Use

When you purchase and activate a new module, the operations relating to that module become available. These are automatically detected by SAP 3D Visual Enterprise Generator; however, you can manually locate them by running the discovery process (dsp_discovery). Once they are detected, you can view the task log to see all discovered operations.


For example, if you activate the Illustration module while SAP 3D Visual Enterprise Generator is running, you can run the dsp_discovery process then view the task log to see the discovered operations.

If a process uses a detected operation that has not yet been loaded, SAP 3D Visual Enterprise Generator loads it automatically when the process executes; however, you can load them into SAP 3D Visual Enterprise Generator Administration manually.

Once found, operations relating to the new module can be loaded into SAP 3D Visual Enterprise Generator manually to be displayed in the Process Designer toolbox and be added to processes.

If a process uses a detected operation that has not yet been loaded, SAP 3D Visual Enterprise Generator loads it automatically when the process executes.

Activities

To find operations, run the dsp_discovery process and view the task log. You can now load the detected operations into SAP 3D Visual Enterprise Generator Administration.

To load operations, proceed as follows:

1. In the Process Designer, choose Operations Load Operations on the menu bar (see Process Designer [page 228]). The Load Operations window is displayed.

2. Select the operations you require to load and choose Load.

The operations are loaded into the Process Designer.

3.2.12 Entering Operation Parameters

Use

All operations comprise parameters. You use parameters to enter values that control how the operations function when processes are executed. Certain parameters are mandatory, while others can be added to define the operation further.

For example, by default the trigger operation includes the filename parameter which can be removed if required. The notification operation includes the queuename and label parameters: both are mandatory for this operation.

Within SAP 3D Visual Enterprise Generator, parameters have the following distinguishing characteristics:

● They are used within operations to define specific values for, and control the operations. For example, an operation that opens a file requires the filename parameter value to be defined with file that you want to open.

● Certain parameters may comprise subparameters. For example, the filename parameter contains the directoryname, extension, fullname, name, namewithoutextension, and root subparameters.

● Parameter selection tools can be added to parameters and subparameters. These enable you to select values to further define the operation. Once a selection tool is added to a parameter, it can be used to select a parameter value when creating or editing the operation to which it belongs or a process that incorporates that operation.



You can enter parameters in the Operation windows, and Operation Editor. When any process that uses the operation is executed, the parameter value you entered is used as the default.

For example, you can enter your company’s SMTP e-mail address in the email operation’s SMTP parameter, and that address is returned for that parameter when related processes executes.

The following methods are used to enter and edit parameter values depending on the parameter type:

● Typing values manually● Using a selection button to select values● Entering XPath statements

Certain parameters are read-only, and as such cannot be modified.

Activities

To enter parameter values, proceed as follows:

1. Do one of the following:○ Type the value in the parameter cell, then click outside the cell to save the value.

○ Click a in the parameter cell, and select a value.○ Drag information between parameter cells in operation window to create XPath statements.○ Use the XPath Editor to create, edit, and delete XPath statements (see XPath Editor [page 480]).

2. Save the process.

3.2.13 Adding Parameter Selection Tools

Use

You can add selection tools to parameters that allow values to be selected more easily. Once a selection tool is added to a parameter, you can use it to select a value when editing the operation to which the parameter belongs, or creating or editing a process that uses the operation.

NoteXPath statements must be XPath version 1.0 compliant.

The selection tools that you can add are the following:

● 2D and 3D file format selectors● Boolean lookup

Used to enter true or false values● Color and font selectors


NoteUse the color selector tool to select color values for all color type parameters. For example, the text_color parameter in the drawcallouts operation.

● File name parameter lookup.● Slider selector

Used to select from three options. These options can be reset if required: maximum, minimum, and units.● Standard options lookup

Enables you to define drop-down list boxes with defined names and default values. This tool displays only the list of defined names in Process Designer, but not the default values.

● XPath EditorUsed to enter and edit XPath statements

Default Parameters

Certain selection tools include default parameters. For example, the Slider Selector tool comprises the maximum, minimum, and units parameters. The values for these parameters can be added and edited as required.

Parameter options can also be added to certain selection tools, and default values can be added to those options.

For example, you could add the Standard Options Lookup selection tool to a parameter, with the width1 and width2 options that have default values of 100 and 200 respectively. When entering a value for the parameter afterward, you can select either one of the default values using the selection tool drop-down list.

Features

The Advanced Parameters Options window is used to add selection tools to parameters. Once a selection tool is added, it can be used to select a parameter value.


Name The name of the parameter

Description The parameter description

Selector The selection tool that will be used to select default value

The Edit Selection window can be used to edit the names and values that determine parameter selection options.


Name The name of the parameter

Value The parameter’s default value



Activities

To open the Edit Selection window, proceed as follows:

1. Open the Advanced Parameters Options window and right-click the parameter you want to edit.2. Choose Edit.

To add a parameter selection tool, proceed as follows:

1. Open the Operation Editor for the operation you want to edit.2. Right-click the parameter to which you want to add a selection tool, and choose Advanced.3. If required, modify the parameter name and description.

NoteYou cannot modify names of mandatory parameters.

4. Choose a selector tool.5. If the tool includes parameters, modify the parameters as follows:

○ To add parameters, right-click them, choose Add, enter a name and value, and choose OK.○ To edit parameters, right-click them, choose Edit, modify the name and value, and then choose OK.○ To remove parameters, right-click the rows and chose Remove.

You cannot modify names of mandatory parameters.

6. Choose OK. The tool is added to the parameter. The is displayed when you click in the parameter cell where the tool was added: you can now use this tool to select values.

7. Save the process.

More Information

XPath Editor [page 480]


3.2.14 Generating Web-Service Operations

Use

SAP 3D Visual Enterprise Generator operations can be configured to communicate with, or call any external application that is capable of using a Simple Object Access Protocol (SOAP) message; the application is Web enabled. For example, a Web service.

The Web-services command uses the web_serviceoperation and web_serviceoperationgenerator operations to function.


Prerequisites

You have installed Internet Information Services (IIS) server. Contact your system administrator for more information.

Procedure

To create and use a Web-service operation, proceed as follows:

1. Choose Operations Generate Web-Service Operations on the menu bar. The Generate Web-Service Operations window opens.

2. Enter the address where the SOAP-enabled application is located.

NoteThe address that defines the SOAP-enabled application location must end with ?wsdl.

3. Enter a prefix for the operation name. We recommend using the default prefix WS.4. Choose OK. The operation is created and the operation name is generated automatically.

NoteFor SAP 3D Visual Enterprise Generator to be able to call a Web-service operation, the operation’s dll must be strong named. SAP 3D Visual Enterprise Generator automatically assigns a default security strong name to Web-service operations. However, you can generate your own strong name and replace the default, if required. Contact your system administrator for more information.

5. Add the operation to a process and define the parameter values.

Any parameters within the external definition are created within the Web-service operation you generate.

More Information


3.2.15 Editing Operations

Use

Existing operations are edited in the Operation Editor in the same way as they are created. For example, you can enter your company’s SMTP e-mail address in the email operation’s SMTP parameter. Then, when any process that uses the operation is executed, the parameter value you entered is used as the default.

You can right-click operations and remove the comments as required.



Features

The Operation Editor is used to create and edit operations: it displays different field descriptions and parameters depending on the operation type.


Properties Defines the operation’s properties

Operation The unique operation name

Name The operation user-friendly name

Description The operation description

Toolbox The toolbox group in which the operation resides

Icon Changes the operation’s icon: the image used as a graphical representation of the operation in the Process Designer

Icon image Displays the current icon

Change Icon Opens the Open window; used to select an icon to associate with the operation

Parameters Displays the parameter table and list; used to drag parameters into the operation and to define parameter values

Activities

To open Operation Editor, do one of the following in the Process Designer (see Process Designer [page 228]):

● Choose Operations New Trigger on the menu bar.

● Choose Operations New Notification on the menu bar.● Right-click an operation name in the toolbox and choose Edit.● Double-click the operation name in the toolbox.

To edit operation parameters, proceed as follows:

1. Open Operation Editor for the operation you need to edit.2. If required, drag parameters from the parameter list to the parameter table, and enter parameter values.3. If required, add parameter selection tools, and select parameter values.4. Edit the operation further as required.5. Choose OK. The operation is updated.6. Save the process.

To rename operations, proceed as follows:

1. Right-click the operation in the Process Designer and choose Rename.


2. Enter a new name for the operation and choose OK.3. Save the process.

To edit operation comments, proceed as follows:

1. Right-click the operation in Process Designer and choose Edit Comment.2. Enter the comment and press ENTER .3. Save the process.

More Information


3.2.16 Creating Derivative Types

Use

Derivative types are created on the Derivative Types panel (see Derivative Types Panel [page 482]).

For example, you can select the process to use that creates the derivatives, and you can define the file format extension in which derivatives are built.

Procedure

To create a derivative type, proceed as follows:

1. Choose the New icon on the Derivative Types toolbar. The Create Derivative Type window opens. Enter the name for your derivative type, choose a default process to use to create derivatives and a class to which the type belongs.

2. Select the Can Show checkbox to display the derivative type in the client application Derivative Editor.You must also generate the derivative type DoD definition to display it in client applications. If you are using SAP Visual Enterprise Access, see the SAP Visual Enterprise Access Help for more information at http://help.sap.com/ SAP Visual Enterprise Access .

3. Select the Can Download checkbox to enable downloading of derivatives.4. Select the User Can Create checkbox to enable creation of derivatives with this type.5. Select the User Can Delete checkbox to enable deletion of derivatives.6. Choose the Properties tab, and do one or more of the following:

○ Choose Add to add properties to the derivative type and enter necessary data.○ Choose Remove to remove properties from the derivative type.

The Create Property window is used to create properties for the selected derivative type.





Fields and Checkboxes Functional Description

Name The property name

Data Type The property’s data type. That is, the type of data that the field will contain. The metadata value fields displayed in client applications differ depending on the selected data type.

For example, if you select the DateTime data type, the client application displays a Data Time value field. If you select the Picklist data type, the client application displays a list of values for the field based on the selected pick list.

Boolean: Defines the property as a Boolean (logical data type). The value can only be true or false.

DateTime: The value must be a date.

Decimal: The value must be a number.

Integer: The value must be a natural number, not a fraction or decimal. For example, 0, 21, 4, and −2048 are valid, whereas 9.75 and 5½ are not.

String: The value must be a text sequence.

Picklist: The value must be selected from pick list values defined by the selected pick list.

Picklist The pick list that defines the property. This field is only active if you select the Picklist data type.

Default Value The default value for the property. This field reflects the selected data type parameters.

Description The property’s description

7. Choose OK to save your entries.

More Information

Derivative Type [page 598]


3.2.17 Derivatives on Demand Definition

Use

Derivatives on demand (DoDs) are derivatives created on the fly using unique property values rather than the standard derivative type values. You can create DoDs in the following ways:

● Using interactive client application sessions that are used to create singular, on-the-fly derivatives● Using a derivative group based on multiple instances of derivative types and used to create multiple, on-

the-fly derivatives

You can generate a DoD definition for each derivative type. The definitions determine what properties are displayed on the client application session screens that are used to create singular, on the fly derivatives. They also limit the values that can be entered for the derivative type properties.

NoteThe properties defined in DoD definitions for use in client applications, are displayed in the Derivative Editor to the left of the viewport; the asset preview (utilizing SAP 3D Visual Enterprise Viewer) is displayed in the viewport. See the SAP Visual Enterprise Access Help for more information at http://help.sap.com/

SAP Visual Enterprise Access SAP Visual Enterprise Access 7.1 .

The following rules apply to DoD definitions when they are used in the Derivative Editor of client applications:

● Values can be set in both the definition properties and the preview properties of the Derivative Editor.● Update and Write bindings: Changes to definition values are applied immediately to the asset preview in

the viewport.● Read and Write bindings: Changes to asset preview values are applied to the definition values when the

mouse moves outside of the viewport.

Process

1. In SAP 3D Visual Enterprise Generator, generate a derivative type DoD definition using the Derivative on Demand window. This designs the client application session screen and the mandatory input properties (see Creating Derivative Types [page 550] and Generating and Removing DoD Definitions [page 553]).

2. In SAP 3D Visual Enterprise Access or other client application, enter values for the mandatory properties using the Derivative Editor.The job is sent to SAP 3D Visual Enterprise Generator for processing, and the derivative is created.




3.2.18 Generating and Removing DoD Definitions

Use

DoD definitions are generated for each derivative type using the Derivative Types panel: you can define the properties that determine what is displayed in the client application input screen for creating singular, on-the-fly derivatives. That is, the parameter values that must be entered for the derivative type.

Integration

You must select the Can Show security option when creating derivative type for derivative type properties to be displayed in the Derivative Editor. The Can Create security option must be enabled to be able to create derivatives in SAP Visual Enterprise Access.

Activities

To generate a DoD definition, proceed as follows:

1. Choose the derivative type in the Derivative Types panel for the definition you want to generate (see Derivative Types Panel [page 482]).

2. Do one of the following:○ Choose Edit DoD Definition on the Derivative Types toolbar.○ Right-click the derivative type and choose Edit DoD Definition.

Table Columns and Tab Pages Fields, Checkboxes, and Their Functional Descriptionals

Name The derivative type’s property name

Visible Displays the property in the Derivative Editor window, allowing a value to be set for that property

Exlamation icon Indicates either that the property requires a value, or that the value is incorrect

General Used to define the settings common to all properties

Client ID: The property’s system ID

Label: The label displayed above the property in the Derivative Editor window

Default Value: The value entered for the property in the Derivative Editor window, and can be modified if the property is selected in the Visible checkbox.



SAP 3D Visual Enterprise Viewer Used to define property value settings for the DoD defini-tion properties and the asset preview properties within the Derivative Editor. The asset preview is displayed in the Derivative Editor viewport and the DoD definition properties are displayed to the left of the viewport.

Binding Type: The method used to update property values between the DoD definition and the asset preview

Read: Updates the definition values when the preview values are modified

Update: Updates the definition values when the preview is modified, and updates the preview when the definition values are modified

Write: Updates the preview when the definition values are modified

Property: Used to bind an asset preview property with a definition property

Validation: Required Field Used to define required field validation for the property

Enabled: If selected, a value must be entered for the property in the Derivative Editor window.

Error Message: The message displayed if the property value entered is invalid, and validation is enabled.

Validation: RegEx Used to define regular expression validation for the property

Enabled: If selected, a value must be entered for the property in the Derivative Editor window.

Expression: The text (string) that limits the values that can be entered, and on which the property field is validated

Error Message: The message displayed if the property value entered is invalid, and validation is enabled

Note: See Microsoft MSDN documentation for the correct syntax.




Validation: Range Used to define range validation for the property

Enabled: If selected, values must be entered for the property in the Derivative Editor window.

Minimum: Defines the minimum value (integer or decimal) allowed, and on which the property field is validated

Maximum: Defines the maximum value (integer or decimal) allowed, and on which the property field is validated

Error Message: The message that will be displayed if the property value entered is outside the specified range, and validation is enabled.

3. Choose Generate. The definition is generated and you can now use it within client applications.

Note that you can generate the definition without making any changes.

To remove a DoD definition, right-click the derivative type in the Derivative Types panel for the definition you want to remove and choose Remove DoD Definition. The definition is removed immediately.

3.2.19 DoD Group for Individual Asset

Use

You can use this process to create DoD group for individual assets.

Process

1. In SAP 3D Visual Enterprise Generator, create a derivative group by choosing New or Edit button (see Creating Derivative Groups [page 556]). The group becomes available in SAP Visual Enterprise Access. For more information about SAP Visual Enterprise Access, see online help at http://help.sap.com/SAP Visual Enterprise Access SAP Visual Enterprise Access 7.1 .

2. In SAP 3D Visual Enterprise Access, select the derivative group in the Additional Outputs to Generate column when uploading assets.○ The job is sent to SAP 3D Visual Enterprise Generator for processing.○ In SAP 3D Visual Enterprise Generator, the assets are uploaded and the derivatives are created.



3.2.20 DoD Group for Asset Collection

Use

You can use this process to create a DoD group for an asset collection.

Process

1. In SAP 3D Visual Enterprise Generator, create a derivative group by choosing New or Edit button (see Creating Derivative Groups [page 556]). The group becomes available in SAP Visual Enterprise Access. For more information about SAP Visual Enterprise Access, see online help at http://help.sap.com/SAP Visual Enterprise Access SAP Visual Enterprise Access 7.1 .

2. In SAP Visual Enterprise Access, do the following:1. Create derivatives from an asset collection and choose a derivative group.2. Use the Select All Derivatives workflow to create a derivative for each view within each asset, for each

instance in the group.3. Use the Select Step Derivatives workflow to create a derivative for each asset, for each instance in the

group.○ The job is sent to SAP 3D Visual Enterprise Generator for processing.○ In SAP 3D Visual Enterprise Generator, the assets are uploaded and the derivatives are created.

3.2.21 Creating Derivative Groups

Use

You can add derivative type instances used to create derivatives and define the settings that control how the derivatives are created using those derivative types.

Procedure

To create a derivative group, proceed as follows:

1. Choose New on the Derivative Groups toolbar. The Create Derivative Group window is displayed.2. Enter a name for the derivative group and its description.3. Choose the Derivatives tab, and then choose Add to add a derivative type instance to the group.4. Select the type of instance you want to add and enter a name for the instance.5. If required, enter a description for the instance.6. If required, select or enter default values for the instance properties.7. Choose OK to save the instance.




8. Continue adding derivative type instances to the group.9. If required, select instances and choose Remove to remove them from the group.10. Choose OK. The derivative group is saved.

More Information

Derivative Groups Panel [page 485]

Derivative Group [page 612]

3.2.22 Creating Metadata

Prerequisites

You have created metadata category (see Metadata Categories Panel [page 490]).

Procedure

To add ametadata attribute, proceed as follows:

1. Choose New on the Metadata Attributes toolbar. The Create Metadata Attribute window opens.2. Enter a name and display name for the metadata attribute.3. Select a category in which to place the attribute.4. Select a data type to identify the attribute, and then select further options to apply to the attribute if

required. For example, if you selected the Picklist data type, you must select a pick list.5. Select or enter a default value for the attribute. For example, if you select the DataTime data type, you can

select a date value that is displayed when you select an asset to upload.6. Do one or more of the following:

○ Select the Show in advanced search checkbox to display the attribute in advanced searches.○ Select the Display at upload checkbox to display the attribute when uploading assets.○ Select the Can be updated checkbox to enable updates for the attribute.○ Select the Required at upload checkbox to make a value mandatory for the attribute.

7. Save your entries.

Note

See the SAP Visual Enterprise Access Help at http://help.sap.com/ SAP Visual Enterprise AccessSAP Visual Enterprise Access 7.1 for more information on attributes that are displayed in SAP Visual Enterprise Access.



3.2.23 Creating, Editing, and Deleting Pick Lists

Use

You can edit entries within certain pick lists depending on the list type as follows:

● System pick listsCan be modified through the related SAP 3D Visual Enterprise Generator Administration panel. For example, the Projects pick list relates to projects defined in SAP 3D Visual Enterprise Generator and can be edited through the Projects panel (see Projects Panel [page 518]).

● Custom pick listsCan be modified directly. For example, the 2D drawing pick list can be modified by editing the entry names and values, and adding and removing entries.

● Pick lists based on externally defined entitiesCannot be modified. For example, the Render types pick list relates to external rendering methods and cannot be modified.

Features

The Create/Edit Pick List window is used to create new, and edit existing pick lists.

Fields and Columns Functional Descriptions

Name The pick list name

Data Type The data entry type. That is, the type of data that each field can contain in client applications.

For example, if you select Decimal, only a number can be entered in the field.

Boolean: The value can only be true or false.

DateTime: the value must be a date.

Decimal: The value must a number.

Integer: The value must be a natural number, not a fraction or decimal. For example, 0, 21, 4, and, 2048 are valid; 9.75 and 5½ are not.

String: The value must be a text sequence.

Add Adds a data entry to the pick list

Remove Removes the selected data entry from the pick list

Pick List Entries The data entry fields that are displayed in client applications for the pick list



Fields and Columns Functional Descriptions

Name The name of the data entry

Value The default value for the data entry. This field reflects the selected data type. For example, if you select Decimal, only a number can be entered in the field.

Activities

Creating Pick Lists

You can define settings that control how the pick list functions. For example, you can define the pick list data type, and you can add and remove pick list entries.

To create a pick list, proceed as follows:

1. Choose New on the Pick Lists toolbar. The Create Pick List window opens.2. Enter a name for the pick list and select a data type to identify it.3. Choose Add to add a pick list entry.4. Enter a name and default value for the entry.

NoteIf this picklist is displayed on the upload form, the name will be displayed as a list. In the SAP Visual Enterprise Access Metadata tab page, the value corresponding to the name will be displayed.

5. Continue adding entries to the pick list.6. If required, select entries and choose Remove to remove them from the pick list.7. Save your entries.

Editing and Deleting Pick Lists

To edit a pick list, proceed as follows:

1. Do one of the following in the Pick Lists panel:○ Select the pick list and choose Edit on the Pick Lists toolbar○ Right-click the pick list and choose Edit○ Double-click the pick list


To delete pick lists, proceed as follows:

1. Do one of the following in the Pick Lists panel:○ Select the pick lists and choose Delete on the Pick Lists toolbar○ Right-click the pick lists and chose Delete○ Select the pick lists and press DELETE

2. Choose Yes. The pick lists are deleted immediately.


More Information

Pick Lists Panel [page 487]

Pick List [page 595]

3.2.24 Adding File Types

Use

You can define settings that control how the file type and extensions function. For example, you can select the asset type to apply to the file type. For more information, see File Types Panel [page 493].

Add/Edit File Type Window

Details Tab Page

Fields and Checkboxes Functional Descriptions

File Attributes Used to enter the file type’s defining attributes

Name The name of the file type

Extension The file type’s extension

MIME Type The Multipurpose Internet Mail Extensions (MIME) type associated with the file type. This is a two-part identifier for Internet file formats. For example, the default .html format MIME type is text/html.

Asset Type The asset type associated with the file type. For example, whether the file type is a 2D image or a 3D scene.

SAP Visual Enterprise Access Preview in SAP 3D Visual Enterprise Viewer Complete

Associates the file type with SAP 3D Visual Enterprise Viewer Complete: when previewing files of that type, the client application checks for the appropriate plug-ins and, if available, uses SAP 3D Visual Enterprise Viewer Complete to preview the file. Otherwise, the current browser searches for an application with which to preview the file.

SAP Visual Enterprise Access Preview in SAP 3D Visual Enterprise Viewer Minimum

Associates the file type with SAP 3D Visual Enterprise Viewer Minimum: when previewing files of that type, the client application checks for the appropriate plug-ins and, if available, uses SAP 3D Visual Enterprise Viewer Minimum to preview the file. Otherwise, the current browser searches for an application with which to preview the file.




Images Used to select images to associate with the file type icon and default thumbnail

File Type Icon Image that is displayed for the file type’s icon

Change: Selects the image for the file type’s icon

Default Thumbnail Image that is displayed for the file type’s default thumbnail

Change: Selects the image for the file type’s default thumbnail

Processes Tab Page


Process The name of the process that can be used for uploading files of the type.

Note: These processes are displayed as import options when uploading files in client applications.

Is Default The default process used for uploading files of the type

Add Adds a process to the file type

Remove Removes a process from the file type

Procedure

To add a file type, proceed as follows:

1. Choose New on the File Types toolbar. The Add File Type window is displayed.2. Enter a name for the file type and the extension you want for the file type.3. If required, type the MIME type associated with the file type that identifies it as an Internet file format. For

example, the default .html format MIME type is text/html.4. Select an asset type to apply to the file type. For example, the default .html format asset type is

TextDocument.5. If required, select the Supported by SAP 3D Visual Enterprise Viewer Complete or the Supported by SAP 3D

Visual Enterprise Viewer Minimum checkboxes to associate the file type with SAP 3D Visual Enterprise Viewer Complete or Minimum when previewing files of that type.

NoteClient applications checks for the appropriate plug-ins if these options are selected and, if available, uses SAP 3D Visual Enterprise Viewer Complete/Minimum to preview the file. Otherwise, the current browser searches for an application with which to preview the file.


6. If required, choose Change to select the image for the file type’s icon and default thumbnail.7. If required, choose the Processes tab, add and remove processes for the file type, and select a default

process to use for uploading files of the current type.These processes are displayed as import options when uploading files of the current type.

8. Choose OK. The file type is saved.9. If required, select the Store Originals checkbox to store original asset files, and the .rh files created from

the originals, in the database before uploading assets.If you select this option, you can also download the original files from client applications such as SAP Visual Enterprise Access.

10. Do one of the following to determine how the extension is selected for uploading files of the type:○ Select the Auto selection mode for SAP 3D Visual Enterprise Generator to determine the appropriate

extension○ Select the Priority selection mode to select the top level extension displayed in the Extensions panel

You can re-order the list as required.

3.2.25 Adding, Editing, Deleting Extensions

Use

You can define settings that control how the file type extensions functions. For example, you can add new extensions to file types.

Activities

To add an extension to a file type, proceed as follows:

1. Select the file type in the File Types panel (see File Types Panel [page 493]).2. Choose New on the Extensions toolbar. The Add File Type window is displayed.3. Enter the information you require for the extension and choose OK. The new extension is saved within the

file type.4. Choose Move Up and Move Down to reorder the priority list and determine the extension used for

uploading files of the type.

NoteThis priority is only applied if the File Type Selection Mode option is set to Priority.

To edit an extension, proceed as follows:

1. Do one of the following in the Extensions panel:○ Select the extension and choose Edit on the Extensions toolbar○ Double-click the extension




To delete an extension from a file type, proceed as follows:

1. Do one of the following in the Extensions panel:○ Choose the file type and then choose Delete on the Extensions toolbar○ Right-click the file type and choose Delete

2. Choose Yes. The extension is deleted immediately.

3.2.26 Adding Hot Folders

Use

You can define settings that control how the hot folder functions. For example, you can define parameter values for the workflow that processes the hot folder files.

Any associated jobs that run through hot folders, can be viewed and managed using the Hot Folder Log panel.

● Hot folders must be local folders on the SAP 3D Visual Enterprise Generator computer.● You can only have one workflow per monitored folder.● You must place all assembly parts into the hot folder for SAP 3D Visual Enterprise Generator to process the

assembly correctly.● We recommend delaying file processing when building assemblies using hot folders, to ensure that all

assembly parts can be placed into the hot folder.● A process must be triggered by a filename to be suitable for use with hot folders.

You can use the Add/Edit Hot Folder window to add new, and edit existing hot folders. It comprises context-sensitive parameters for the selected workflow within the hot folder.


Hot Folder Details Defines the hot folder directory path, monitored files, action, and delay settings

Path The hot folder’s directory path

Monitored Files The extensions of the file formats to monitor in the hot folder. Any other file types are not monitored nor processed.

NoteThe extensions must be separated by commas and have the following format: *.ext. For example, *.rh or *.3ds.



Action The processing action to apply to the selected workflow

● Start Manifest Workflow Job: Processes structured manifest files. Files dropped in this type of folder must be a manifest file in SAP 3D Visual Enterprise Generator Hot Folder manifest format.

● Start Workflow Job: Processes files as single work units without external dependencies by passing the filename received from the hot folder to the first matching file name parameter of the selected workflow

NoteThis field is enabled only when you edit a hot folder.

Start Delay The time to wait, in seconds, before the files are processed

Enabled If selected, activates monitoring of the hot folder

Action Settings Defines the specific actions taken if a file change is discovered in the hot folder. These settings are context-sensitive depending on the selected action.

Workflow/Assembly Workflow The workflow that is initiated if a file change is discovered in the hot folder

File Name Argument The path to the file that is dropped into the hot folder, and then processed by the workflow

NoteAny value you enter here is overridden by the file path of the system when the file is dropped into the folder

Job Name The job name displayed in SAP 3D Visual Enterprise Generator and any client applications

Job Priority The priority applied to the job’s associated tasks: SAP 3D Visual Enterprise Generator sends tasks from high priority jobs to the processing engine before tasks from low priority jobs. This enables short, high priority jobs to be completed when long, low priority job is using the server.

● Low: Associated tasks are sent to the processing engine after all other priority tasks.

● Medium: Associated tasks are sent to the processing engine before low, and after high priority tasks.

● High: Associated tasks are sent to the processing engine before all other priority tasks.




Workflow Parameters Parameter values that define the selected workflow further. These can be variables that substitute the values with actual values when the job runs.

Parameter descriptions are displayed beneath the parameters.

NoteThe Workflow Parameters (below Job Name and Job Priority fields) that display here are controller-specific fields. These parameters are documented separately in the “Startup Arguments” section of the controller documentation for the selected workflow controller.

See Workflow Controllers [page 29] for further information on your specific workflow.

Input File Path The SAP 3D Visual Enterprise Generator location in which to locate the assets

Target Server Path The SAP 3D Visual Enterprise Generator location in which to store the assets

Add Adds parameters to the workflow

Remove Removes the selected parameter from the workflow

Procedure

To add a hot folder, proceed as follows:

1. Choose on the Hot Folders toolbar. The Add Hot Folder window opens.2. Choose Browse and navigate to, and select the folder you want to monitor.3. Type the file extensions that you want to monitor within the folder.4. The extensions must be separated by commas and have the following format: *.ext. For example,

*.rh,*.3ds.5. Do one of the following in the Action field:

○ Select Start Workflow Job to process files as single work units without external dependencies. For example, a 3D file that does not have external file references.

○ Select Start Manifest Workflow Job to process structured manifest files.

NoteThe associated workflow must be able to interpret the manifest files.


○ If required, enter the number of seconds to wait before files are processed in the Start Delay (Seconds) field.

RecommendationWe recommend delaying file processing when building assemblies using hot folders, to ensure that all assembly parts can be placed into the hot folder.

6. Select the Enabled checkbox to activate monitoring of the hot folder.7. Select the workflow to run if a file change is discovered in the hot folder.

NoteAny value you enter in the File Name Argument field is overridden by the file path by the system when the file is dropped into the folder.

8. Do one of the following in the Job Name field to define the job name:○ Keep the default value○ Type a job name to override the default value

9. Select a job priority to apply to the associated tasks. SAP 3D Visual Enterprise Generator sends tasks from high priority jobs to the processing engine before tasks from low priority jobs.

10. If required, add and remove workflow parameters, and enter parameter values to define the workflow further.These can be variables that substitute the values with actual values when the workflow runs. Parameter descriptions are displayed beneath the parameters.

11. If present for the workflow, set the Target Server Path field to the SAP 3D Visual Enterprise Generator location in which to store the assets.

12. Choose OK. The hot folder is saved.

More Information

Hot Folder Panel [page 496]

Workflow Variables [page 568]

Workflows Panel [page 27]

3.2.27 Manifest File Processing

Use

SAP 3D Visual Enterprise Generator is shipped with the rp_processmanifest process, allowing hot folder processing of assets and assemblies using the same mechanism as SAP Visual Enterprise Access or the DS Soap API upload.

When using a manifest upload mechanism, only the manifest file is placed in the monitored folder. Other files are referenced by the manifest.



The hot folder manifest structure is a simple structure XML file.

<?xml version=“1.0“ encoding=“utf-8“?><manifest><projectname></projectname><folderpath> </folderpath><metadatafile> </metadatafile><file></file><recursesubfolders></recursesubfolders><assemblyfile></assemblyfile></manifest>

The document element (the first xml element) can have any name. It is ignored by the parser.

Features

Code Element Description

<projectname> Optional. The name of the project into which to load the files specified by the manifest. This is case insensitive.

If a project ID is specified, this element is ignored.

<folderpath> Optional. The path within the SAP 3D Visual Enterprise Generator project where the files will be located. If this is not specified, the files will be loaded into the uploaded files folder.

<metadatafile> Optional. This can be used to specify a file containing metadata in either xfdf or SAP 3D Visual Enterprise Generator metadata XML format. The metadata will be applied to all assets loaded as a result of processing the manifest.

<file> Required. This specifies a search pattern to a file or files that should be processed. The search path may include wildcard characters, and may be either in local or unc format. The location specified must be accessible by the account under which the SAP 3D Visual Enterprise Generator service is running.

The file element can be specified multiple times. Examples of the file element:

C:\vault\space\*.asm

C:\vault\cars\wheel.jt

\\servername\share\space\*.*

<recursesubfolders> Optional. Default value is False. If the value passed is a case insensitive match for the word True, the server will recurse subdirectories of each path passed to find additional files that also match the pattern.


Code Element Description

<assemblyfile> Optional. The full path to the top level CAD assembly file. If supplied, the job created to process the manifest will be an assembly processing job; otherwise an asset processing job is used. Only one assembly file can be specified per manifest.

3.2.28 Workflow Variables

A number of variables can be used in workflow startup arguments to change the associated values: when entered in place of a startup argument value, the variable is substituted with the actual value when the job runs.

If you enter a variable that does not relate to the workflow, no substitution occurs and the variable text itself is returned.

Startup Argument Variables

The following variables apply to all workflows:

Variable Substitution Value

$JobId The job ID

$UserId The user ID of the user that owns the job

$WorkspacePath The fully qualified path to the workspace associated with the job

Pre-Completion and Post-Completion Job Arguments

The following variables only apply to pre-completion and post-completion workflows:


$ParentJobId The job ID of the parent job that spawned the completion job

$ParentUserId The user ID of the user that owns the parent job

$startup:NAME The startup argument of the parent job having name NAME

$output:NAME The output argument of the parent job having name NAME

Assembly, PLMTranslation, and PLMAssetPublish Controllers



The following variables only apply to the CAD Assembly, PLM Translation, and PLM Asset Publish workflows:


$TopLevelAssetFileName The file name of the top-level asset

$TopLevelAssetName The name of the top-level asset (may differ from file name)

ExampleThe following example shows a variable placed in the startup argument of a PLM Asset Publish scheduled activity using the Default Publishing workflow containing the PLM Asset Publish controller.

When the job runs, the Default Publishing workflow is executed, and the value of the $TopLevelAssetName variable is replaced with the name of the top-level asset. If the name of the top-level asset is Wheel, the assets are published to a folder called Authoring\Wheel.

3.2.29 Adding Scheduled Activities

Use

You can define settings that control how the activity functions. For example, you can define a time period over which the activity runs, and you can choose the workflow that will process the files.

The associated jobs that run through the activities, can be viewed and managed using the Scheduled Activity Log panel.

The Add/Edit Scheduled Activity window is used to add new, and edit existing scheduled activities. It comprises context-sensitive parameters for the selected workflow within the activity.

Fields,Checkboxes and Buttons Functional Descriptions

Details Used to define the scheduled activity name, action, and recurrence settings

Name The scheduled activity name

Start Time The time that the activity starts running

Recurrence The time and date, and pattern at which the activity repeats

Modify Recurrence Opens the schedule editor to modify activity’s recurrence pattern



Recurrence Pattern Used to modify the pattern for which the activity repeats. Further settings may be required depending on the selected pattern. For example, if you schedule the activity to run monthly, you must select the day of the month on which the activity runs.

Once Daily: Runs the activity once only

Daily: Repeats the activity daily

Weekly: Repeats the activity on the specified days of the week

Monthly: Repeats the activity on the specified day of the month

Periodic: Repeats the activity at intervals for the specified number of minutes

Range of Recurrence Modifies the start and end dates for which the activity repeats

Start The date on which the activity starts running

No end date Repeats the activity infinitely

End by The date on which the activity stops running

Action The processing action to apply to the selected workflow.

Start Workflow Job: Starts a new workflow job, passing the filename received from the hot folder to the first matching file name parameter of the selected workflow

Enabled Activates the activity

Action Settings Used to define the specific actions taken when the activity starts

Workflow The workflow that is initiated when the activity starts

Job Name The job name displayed in SAP 3D Visual Enterprise Generator and any client applications




Job Priority The priority applied to the job’s associated tasks: SAP 3D Visual Enterprise Generator sends tasks from high priority jobs to the processing engine before tasks from low priority jobs. This enables short, high priority jobs to be completed when long, low priority job is using the server.

Low: Associated tasks are sent to the processing engine after all other priority tasks

Medium: Associated tasks are sent to the processing engine before low, and after high priority tasks

High: Associated tasks are sent to the processing engine before all other priority tasks

Workflow Parameters Used to enter parameter values to define the workflow further. These can be variables that substitute the values with actual values when the job runs.

Parameter descriptions are displayed beneath the parameters.

Note that you must select a specific workflow, for example Assembly Upload, to activate this panel.

Target Server Path The SAP 3D Visual Enterprise Generator location in which to store the assets

Add Used to add parameters to the workflow.

Remove Removes the selected parameter from the workflow.

Procedure

To add a scheduled activity, proceed as follows:

1. Choose New on the Scheduled Activities toolbar. The Add Scheduled Activity window opens.2. Enter a name for the activity.3. Enter a time to start the activity in the Start Time field.4. Choose Modify Recurrence and do the following:

1. Select a pattern for which the activity recurs and define any further settings for the pattern. For example, if you schedule the activity to run monthly, you must select the day of the month on which the activity runs.

2. Select the start date at which the activity begins running.3. If required, select the end date at which the activity stops running.

5. Choose Start Workflow Job in the Action field.6. Select the Enabled checkbox to activate the activity.


7. Select the workflow to process files when the activity starts.8. Do one of the following in the Job Name field to define the job name:

○ Keep the default value○ Enter a job name to override the default value

9. Select a job priority to apply to the associated tasks. SAP 3D Visual Enterprise Generator sends tasks from high priority jobs to the processing engine before tasks from low priority jobs.

10. If required, add and remove workflow parameters, and enter parameter values to define the workflow further.

NoteThese can be variables that substitute the values with actual values when the workflow runs. Parameter descriptions are displayed beneath the parameters.

11. If present for the workflow, set the Target Server Path field to the SAP 3D Visual Enterprise Generator location in which to store the assets.

12. Choose OK. The activity is saved.

More Information

Scheduled Activities Panel [page 498]

3.2.30 Saving Parts and Assembly Instances

Use

Saving instances of parts and assemblies is controlled by the Save Instance Accelerator variable. This variable can be modified in Pro/ENGINEER using one of the following methods:

● By setting the configuration file option save_instance_accelerator● By choosing Files Instance Operations Accelerator Options to open the Instance Accelerator

window and establish the settings● To save the accelerator file with the instance, do one of the following:

● Choose Open in the Family Table, and then choose File Save or File Save a Copy on the menu bar. The instance is saved as a separate model file.

● Choose File Save on the menu bar. The entire model file is saved and the instance is saved through a higher level object.


None Saves the accelerator file by saving the generic model and its Family Table




Always Saves the accelerator file when the instance itself is explicitly saved. This can be by opening an instance in a new window, and then saving the instance as a separate model file, or by saving the entire model file and the instance through a higher level object.

Explicit The accelerator file is saved when the instance itself is explicitly saved, as described above.

More Information

Import Settings [page 502]

3.2.31 Activating Modules

Various modules and workflows are available for industry specific translation, authoring and publishing; certain modules workflows can be purchased to enhance the functionality of SAP 3D Visual Enterprise Generator. Others can be purchased for CAD file support.

CAD Modules

CATIA Module: Allows you to view, import, and apply settings to your CATIA supported file formats, and then save them to supported 2D and 3D file formats

CoreCAD Module: Enables you to view, import, and apply settings to your CoreCAD supported file formats, and then save them to supported 2D and 3D file formats

JT Module: Allows you to view, import, and apply settings to your JT supported file formats, and then save them to supported 2D and 3D file formats

Pro/E Module: Used for viewing, importing, and applying settings to your Pro/E and Neutral supported file formats, and publishing them to supported 2D and 3D file formats. Support for additional formats is available when you purchase the Pro/E module.

NX Module: Enables you to view, import, and apply settings to your NX supported file formats, and then save them to supported 2D and 3D file formats

Modules purchased for SAP 3D Visual Enterprise Generator must be activated to function correctly with the processes that use those modules. After activating modules on a master computer, SAP 3D Visual Enterprise Generator automatically detects all of the module-related operations when a related process is run. You are also able to find module-related operations manually.


3.3 Server Monitoring

The Server Monitoring enables you to do the following:

● Monitor and manage the SAP 3D Visual Enterprise Generator server farm● Manage jobs, tasks, and alerts● View server farm information including the server status, and task logs● View and save job reports● Filter and refresh information

3.3.1 Aborting, Pausing, and Resuming Jobs

Use

You can abort, pause, and resume jobs using the Jobs panel. When jobs are aborted, all job tasks are removed from the queue and deleted from the database; tasks that are currently running or that have already sent to the processing engine continue to run, but the results are ignored. All tasks that have not been sent to the processing engine do not run.

When jobs are paused, all job tasks are paused on the queue; tasks that are currently running or that have already sent to the processing engine continue to run, but the results are ignored. All tasks that have not been sent to the processing engine are paused. The pause icon only displays for the job after any tasks have finished running.

NoteAll job report actions can also be applied using the Job Report panel or Job Report window.

Activities

To abort a job, do one of the following in the Jobs panel:

● Select the job and choose Abort Job on the Jobs toolbar● Right-click the job and choose Abort Job

To pause a job, do one of the following in the Jobs panel:

● Right-click the job and choose Pause Job● Select the job and choose Pause Job on the Jobs toolbar

To resume a job, do one of the following in the Jobs panel:

● Select the job and choose Resume Job on the Jobs toolbar● Right-click the job and choose Resume Job

To view job user actions, right-click the job for which you want to view user actions, and choose View User Actions. The action details are displayed in the User Actions window.



More Information

Jobs Panel [page 11]

3.3.2 Filtering and Searching Jobs

Use

Jobs can be filtered to refine their display in the Jobs panel. Additionally, job report details can be searched for specific text. There are two methods for filtering jobs:

● Using a simple filter based on the job name● Using advanced filters

NoteJobs can also be filtered and searched using hot folders and scheduled activities.

Activities

To filter jobs, proceed as follows:

1. In the Jobs panel, do one of the following:○ Enter text in the Name or Workflow fields○ Choose a status in the Status field

2. Choose Apply button to filter the jobs. The filters are applied and only jobs that include the specified criteria are displayed.

3. Choose Reset to clear the filters.

To search a job report, proceed as follows:

1. Do one of the following in the Jobs panel:○ Select the job○ Double-click the job. The Job Report window is displayed

2. In the Filter field in the Job Report toolbar, enter the text for which you want to search. The first instance of the text is highlighted.

3. Choose the Next and Previous buttons to move to the other text instances.

More Information



3.3.3 Copying and Exporting Job Reports

Use

Individual job report steps can be copied using the Job Report panel to the clipboard for further use, and the entire job report can be exported to a text or XML file.

Job report details can also be copied and exported using hot folders and scheduled activities.

Activities

To copy a job step, proceed as follows:

1. Do one of the following in the Jobs panel:○ Select the job○ Double-click the job. The Job Details window is displayed.

2. Select the job step you want to copy.3. Choose Copy to Clipboard on the Job Report toolbar. The selected step details are copied to the clipboard.

To export a job report, proceed as follows:

1. Do one of the following in the Jobs panel:○ Select the job.○ Double-click the job. The Job Details window is displayed.

2. Choose Export on the Job Report toolbar.3. Do one of the following:

○ Choose Plain Text to save the step details as a plain text file○ Choose XML to save the step details as a XML file

4. Navigate to, and select the location where you want to save the file.5. Save your entry. The job report is saved in the selected format.

More Information


3.3.4 Creating Diagnostic Archives

Use

You can save diagnostic information for each job as a ZIP file. For example, you can save configuration data, definition file data, and all log files. This can be helpful if issues arise with a particular job, and the information can be used by SAP support to assist you in resolving issues.



Activities

To create a diagnostic archive, proceed as follows:

1. In the Jobs panel, right-click the job for which you want to create an archive.2. Choose Create Diagnostic Archive. The Create Diagnostic Archive window opens.3. Select the diagnostic details you want to save and choose Create.

The Create Diagnostic Archive window is used to create a ZIP file of diagnostic information for the selected job. This is useful for solving any issues that may have arisen. For example, you can save individual workflow configuration data and definition file data.


Configuration and Logs Used to save configuration information for the selected job

Configuration Data If selected, saves configuration data for the selected job. This includes workflow configuration, workflow process definitions, derivative configuration and plug-in export and import options in the archive.

Logs If selected, saves log files for the selected job. This includes all job logs and state documentation in the archive.

Workspace Used to save workspace files for the selected job

Workspace Files If selected, saves the files from the job workspace into the archive

All Files If selected, saves the entire workspace folder for the selected job. For example, the job request and response details.

Note that this option is only relevant if the workspace folder is not cleared after the job finishes. Contact your system administrator for more information.

Workflow Controller Specified Saves only job workspace files specified by the job controller into the archive (default option)

Crash Memory Dumps Saves all crash memory dump files found in the job workspace into the archive

4. Navigate to, and select the location where you want to save the file, and save your entry.

The ZIP file is saved and you can open the various files to view diagnostic information.

More Information



3.3.5 Viewing and Copying Tasks and Details

Use

In the Task Log window, you can do the following:

● View process-related messages for each task. For example, error, warning, information, and debug messages.

● View the associated process, parameters, operations, attributes, and returned values; and to copy item names and values.

● View the time take for each operation to execute (statistics). This helps to discover why tasks take a long time to process.

● View task results in XML form

NoteYou can also view the results document using the XPath Editor (see XPath Editor [page 480]).

Viewing task actions can also be performed through the Server Tasks panel (see Servers Panel [page 19]).

Task Log Window

The Task Log window is used to view and filter task logs and to view process-related details for individual tasks. This data is stored in the SAP 3D Visual Enterprise Generator database and can be displayed in the window to a maximum of 1000 logs.

If a process is executing while the log is displayed, you can refresh the logs to view the most current information. The level of logging is configured in the SAP 3D Visual Enterprise Generator Configuration. Contact your system administrator for more information.

Fields, Checkboxes, Radiobuttons Functional Descriptions

Filters Opens the Filters subpanel used to create a filter with which to search for tasks

Display Limits the number of tasks displayed to the selected number

Filter Results If selected, activates the filter fields

General Used to filter for tasks based on job, task, server, and process details

Job ID Filters for tasks with a job ID that is equal to, greater than, or less than the specified number

Task ID Filters for tasks with a task ID that is equal to, greater than, or less than the specified number

Computer Filters for tasks with the specified text in the associated server name



Fields, Checkboxes, Radiobuttons Functional Descriptions

Process Filters for tasks with the specified text in the associated process’s name

Exclude scheduled processes Filters out any scheduled processes

Started/Completed Used to filter for tasks based on a time period in which they were queued and completed the queue

All Filters for all tasks in the current session

Last hour Filters for tasks generated in the last hour.

Last two hours Filters for tasks generated in the last two hours.

Between Filters for tasks that were started at, and after the specified date and time.

And Filters for tasks that were completed at, and before the specified date and time.

Click in the hour, minute, and second fields to and use the arrows to select the exact time.

Message Type Used to filter for tasks based on the message type.

Error Displays all error messages.

Warning Displays all warning messages.

Information Displays all general administrative messages including start times, process names, and process status.

Debug Displays all messages that contain debugging information.

Tasks Displays the tasks that meet the specified filters, and is used to view process-related details for the selected task

Messages Displays any messages for the task selected in the Tasks area

Task Log Menu

The Task Log menu is displayed when you right-click a task log in the Task Log window.


View Task Details Opens the selected task’s details in the Task Details window

Task Details Window

The Task Details window is used to view and copy task log details.


Tab Pages Functional Descriptions

Details Used to view the associated process, parameters, operations, attributes, and returned values; and to copy item names and values

Navigation tree: Used to navigate the task items and copy the item names

Navigation pane: Used to view the item attributes and values, and copy the item names and values

Statistics Displays the time taken for each operation to execute

XML Displays the task results in XML form

Note that you can also view the results document using the XPath Editor (see XPath Editor [page 480]).

Task Details Menus

The Task Details menu is displayed when you right-click an item in the Task Details window.


Copy Name Copies the selected item’s name to the clipboard

Copy Value Copies the selected item’s value to the clipboard

Activities

To view task logs, double-click a task in the Tasks panel. The Task Log window is displayed and you can now view the task details.

To display task messages, choose the task for which you want to display related messages in the Task Log window. The messages can be filtered based on the selections made in the window’s message fields.

To view task details, proceed as follows:

1. Double-click a task in the Tasks panel.2. Do one of the following:

○ Double-click the task log in the Task Log window○ Right-click a task in the Tasks panel and choose View Task Details

The Task Details window opens, and you can now view the process details, statistics, and XML results document.

To copy task details, proceed as follows:

1. Click in the Details tab of the Task Details window.



2. Do one of the following:○ Right-click an item in the navigation tree and choose Copy○ Right-click an item in the navigation pane and choose Copy Name○ Right-click an item in the navigation pane and choose Copy Value

The item name or value is copied to the clipboard.

More Information

Tasks Panel [page 16]

3.3.6 Filtering Tasks

Use

There are three methods for filtering tasks:

● Using a simple filter based on the associated process name● Using advanced filters in the Tasks toolbar● Using advanced filters in the Task Log window

Activities

To filter a task using the panels, proceed as follows:

1. Do one of the following in the Tasks toolbar:○ Type text in the Job ID, Process, or Server fields○ Select a status in the Status field○ Select the Start and End checkboxes, and select dates and times on, and between which tasks were

queued2. Choose the Apply button. The filters are applied and only tasks that include the specified criteria are

displayed.3. Choose Reset to clear the filters.

To filter a task using the Task Log window, proceed as follows:

1. Open the Task Log window and expand the Filters area.2. Select the number of tasks to limit the number of logs that are displayed.3. Select the Filter Results checkbox to activate the filter fields.4. Do one of the following:

○ Apply general filters to view tasks based on job, task, server, and process details○ Select the Exclude scheduled processes checkbox to exclude any scheduled processes


○ Use the Started/Completed fields to view tasks based on a time period in which they started or completed


○ Select the Message Type checkboxes to view tasks based on the message type.5. Choose Refresh to refresh the information based on the filters. The filters are applied and only tasks that

include the specified criteria are displayed in the Tasks area.

More Information

Tasks Panel [page 16]

3.3.7 Server Farm

Use

The SAP 3D Visual Enterprise Generator farm consists of one master computer and one or more slave computers. As all computers in a server farm must have the same configuration, including operations and processes, they are kept synchronized using the SAP 3D Visual Enterprise Generator shared folder that is created during installation. Each computer is configured with the location of this folder.

NoteContact your system administrator for more information on server farms.

Features

One master computer does the following:

● Monitors all incoming messages on the incoming message queue● Sends job notifications using the engine queue to all slave computers connected within the farm● Monitors the overall system status of the entire farm through the response queue, including pending jobs

and their completion status● Receives job completion notifications and status through the response queue● Updates its configuration based on the latest SAP 3D Visual Enterprise Generator configuration files that

are stored in the SAP 3D Visual Enterprise Generator shared folder

Slave computers do the following:

● Connect to the associated master computer for the server farm in which they are configured



● Receive job notifications from the master computer through the engine queue and process jobs● Notify the master computer when a request is received from the engine queue so that the master may

begin to monitor the status● Notify the master computer using the response queue of the job completion status

Configuration

The SAP 3D Visual Enterprise Generator shared directory is the central storage location for the complete configuration of SAP 3D Visual Enterprise Generator. It enables the SAP 3D Visual Enterprise Generator farm to maintain a common configuration; when the master starts in the farm, it creates a local copy of the latest SAP 3D Visual Enterprise Generator configuration in the shared directory of both the master and in all existing slaves.

Contact your system administrator for more information on SAP 3D Visual Enterprise Generator Configuration.

Server Tasks

When you choose a server in the Servers panel, the related tasks (information relating to the task’s associated process) are displayed below in the Server Tasks panel. This data is stored in the SAP 3D Visual Enterprise Generator database and can be displayed to a maximum of 1000 logs. Process-related messages and details can also be displayed for each task in the Task Log window including warning, error, information, and debug messages.

If a process is executing while the log is displayed, you can refresh the logs to view the most current information.

Server Management

You can view various information for the master and all slaves within the existing server farm. For example, the server name, status, and directory queue path. You can also start and stop processing, restart each server in the farm, and view and filter server tasks.

Server information is available for as long as it is in the database. Only the most recent info is displayed at first, but you can use the filters to view historical data.

NoteIf you edit a process, you must restart SAP 3D Visual Enterprise Generator Administration on all slaves within the server farm to synchronize the updates.

More Information

Servers Panel [page 19]


3.4 Security Management in SAP 3D Visual Enterprise Generator

Use

Security for SAP 3D Visual Enterprise Generator and client applications, such as SAP Visual Enterprise Access, is controlled through permissions. These are granted at the group level: users receive the maximum permissions (union of all permissions) from all the groups to which they belong.

Functional permissions are also available to allow groups to perform functional procedures in SAP 3D Visual Enterprise Generator and SAP Visual Enterprise Access. For more information, see SAP Visual Enterprise help at http://help.sap.com/ SAP Visual Enterprise Access SAP Visual Enterprise Access 7.1 .

Data Access Rules

Data access in client applications is controlled using user and group permissions for objects (projects, folders, and assets), at folder level through to asset level.

The following rules apply to data access permissions:

● Permissions are granted at the group level (not at the user level).● Asset permissions are the same for every version of that asset.● Derivatives permissions are the same as the parent asset:

○ If you can read an asset, you can read all derivatives○ If you can update an asset, you can create, replace, and delete derivatives

Note that derivative versions are saved in the database, including derivatives created from different asset versions.

○ If you can delete an asset, all associated derivatives and asset versions are also deleted

Features

SAP 3D Visual Enterprise Generator supports the following permissions that are assigned through groups:

Supported Permission Types

Permission Folder Object Asset Object

Grant Can grant any of the permissions in this table to the folder

Can change owners

Has read permission (browse, list, view, and so on)

Can grant any of the permissions in this table on the asset

Can change owners

Has read permission




Permission Folder Object Asset Object

Create Can create subfolders

Can rename folder

Can upload assets to folder

Attempting to upload an asset with the same name as an existing asset, without first checking it out, is a special case. See rules below.

Not applicable

Read Can view folders, and can enumerate visible children where the user also has read permission

Can subscribe to notifications of changes to the folder

Can select assets, and display asset properties and details including metadata and thumbnails

Can view assets in SAP 3D Visual Enterprise Viewer or other installed viewers

Can download asset derivatives except untransformed originals. For example, source CAD files.

Searching returns only assets with read permission.

Can subscribe to notifications of changes to assets

Can create, edit, delete associations

Update Can rename the folder

Can edit the description on the folder

Can check assets out and in

Can upload and check in new versions of checked out assets

Can modify asset display names (not the asset filename)

Can modify, add, create, delete metadata and metadata categories

Delete Can delete a folder

Folders must be empty of all objects before they can be deleted.

An attempt at a cascading delete may leave assets and folders behind which were not able to be deleted

Can delete assets, including all asset versions and derivatives

Download original Not applicable Can download original files. That is, the source file that was used to generate the primary derivative (the .rh file). Typically, this is a CAD file.


More Information

Asset Management [page 588]

Permission Levels [page 586]

Security Management [page 510]

3.4.1 Permission Levels

Use

SAP 3D Visual Enterprise Generator employs granular access control so that permissions can be set at the following levels:

● Project level● Folder level● Asset level

This enables different permissions to be set for different objects within the same project, dictating which user groups can perform which actions within client applications. For example, you can set read-only access for one folder, edit access for another, upload access for yet another.

This is helpful for organizations that manage suppliers, training, and technical documentation departments within a single project structure: it negates the need for multiple logons with different access types for different projects, and prevents data duplication between projects to restrict access.

Functional Permissions

You use functional permissions to allow groups to perform certain procedures for SAP 3D Visual Enterprise Generator and SAP Visual Enterprise Access. For more information, see SAP Visual Enterprise Access help at http://help.sap.com/ SAP Visual Enterprise Access SAP Visual Enterprise Access 7.1 .

For example, the SecurityAdministrator group has the System Administration functional permission, which allows administrative system access for SAP 3D Visual Enterprise Generator. Only members of the Security Administration group can administer users, user groups, and LDAP server users.

Other types of functional permissions can be given for SAP Visual Enterprise Access including the following:

● Asset searching and browsing● Asset checkout in SAP Visual Enterprise Access● Derivative creation and edit● Jobs and report management

Object Permissions

Security for SAP 3D Visual Enterprise Generator and client applications, such as SAP Visual Enterprise Access, is controlled through permissions. These are granted at the group level: users receive the maximum permissions (union of all permissions) from all the groups to which they belong.




Features

The following table describes the object permissions that SAP 3D Visual Enterprise Generator supports:

Supported Object Permissions

Action/Object Rule Description

Projects Groups with the System Administration functional permission are able to configure SAP 3D Visual Enterprise Generator. The Security Administrator assigns a Project Administration group to a project giving that group full access.

Folder/asset Folders and assets have owners: either the system or an individual user.

The user who created or uploaded an asset is the asset’s default owner.

The user who uploads an asset version is the asset’s owner.

An owner can not be a group.

Owners can have different permissions to other users or groups. Usually the owner would have all permissions to an object, but this is not mandatory.

Depending on the system configuration, object ownership can be transferred by either the owner or a user with grant permission.

Check in does not transfer ownership.

NoteContact your system administrator for details on system configuration.

Automatically uploaded assets The permissions on uploaded assets are inherited from the folder to which they are uploaded.

Objects uploaded through a system interface (for example, a hot folder), have the system owner.

Creating/uploading objects within folders (sub-folders and assets)

Users can create or upload any object to a folder for which that user has Create permission.

Created and uploaded objects have the same permissions as the group permissions of the parent folder. For example: if Group 1 has Read permission for a folder, the group will have Read permission for all assets uploaded to the folder. If Group 2 has create, read, and update permission for a folder, the group will have create, read, and update permission for all assets uploaded to the folder.


Action/Object Rule Description

Upload existing asset To upload an asset of the same filename as an existing asset, you must first check out or rename the existing asset.

Viewing objects Only users with read permission can view objects including objects within search results.

This excludes uploading an asset with the same filename as an existing asset on which the user has no read permission.

Data overwrite Users must have update permission to overwrite data.

Object deletion To delete an object, users must be one of the following:

● Be a member of a group with delete permission● Be the owner, with system configuration to allow owner

deletion

3.4.2 Asset Management

SAP 3D Visual Enterprise Generator manages digital assets by storing them in a SAP 3D Visual Enterprise Generator database instance. It provides a standard asset management structure based on the concept of a project, which is a logical grouping of assets: these assets are added to projects through client applications.

Database Instance Rules

The following rules apply to database instances:

● They are structured by objects: either a folder, an asset, or a derivative.● They can contain multiple projects: a top-level folder stored in the root of the instance.● Only users that have access to the instance can create objects at the top level.● Assets are stored in hierarchical groupings within projects, folders, and subfolders.

3.4.3 Managing Users

Use

You can define settings that control user functionality. For example, you can add user password, and select the groups to which the user belongs.

Once created, users can be edited and deleted.

When editing a user, you can define settings that control user functionality. For example, you can modify the user password, and groups to which the user belongs.

Members of the Security Administration group can import users from LDAP servers.



Once created, LDAP users can be edited by members of the same group.

Features

The Create/Edit Users window is used to create new and edit existing users:

Fields and Buttons Functional Description

General Used to define the settings common to all users

User Name The user’s user name

Full Name The user’s full name

E-Mail address The user’s e-mail address

Password The password for the user

Confirm Password The password confirmation

Description The description of the user

Groups Used to add and remove the user to or from groups

Add Group Adds the user to groups

Note that you can filter the list when adding groups to find the groups you want. Use SHIFT to select adjacent groups, or CTRL to select non-adjacent groups.

Remove Group Removes the user from the selected groups

The Import LDAP Users window is used to import users from LDAP servers.


Import Source Used to define the LDAP server and filter users from which to import

LDAP server The LDAP server from which to import users

Filter Refines the display of users from which to import: this must be entered in LDAP form. For example, cn=domain users*.

Load Users Displays users from LDAP server to import

Import Options Used to select the domain into which the users are imported

Domain The domain into which users are imported



Users to Import Used to select the users to import

Activities

Creating Users

To create a user, proceed as follows:

1. Choose New on the Users toolbar. The Create User window opens.2. Enter the user’s user name, full name and password.3. If required, enter the user’s e-mail address and description.4. Choose the Groups tab, choose Add Group, and select the groups to which you want to add the user.

NoteYou can filter the list when adding groups to find the groups you want. Use SHIFT to select adjacent groups, or CTRL to select nonadjacent groups.

5. Choose OK twice. The user is saved.

Editing and Deleting Users

To edit a user, proceed as follows:

1. Do one of the following in the Users panel:○ Choose the user and choose Edit on the Users toolbar.○ Right-click the user and choose Edit.○ Double-click the user.

2. Make the changes you require and choose OK.

To delete users, proceed as follows:

1. Do one of the following in the Users panel:○ Choose the users and choose Delete on the Users toolbar.○ Right-click the users and choose Delete.○ Choose the users and press DELETE on the keyboard.

2. Choose Yes. The users are deleted immediately.

Importing LDAP Users

To import a LDAP user, proceed as follows:

1. Choose Import on the Users toolbar. The Import LDAP Users window opens.2. Select the LDAP server from which to import users.3. If required, enter names in LDAP form on which to filter users. For example, cn=domain users*.4. Choose Load Users. All user results are displayed in the Users to Import area.5. Select the domain into which the users are imported and do one or more of the following:

○ Select the individual checkboxes for the users that you want to import.



○ Choose Select All to select all users.6. Choose Import twice. The LDAP users are imported.

More Information

Users Panel [page 513]

3.4.4 Creating LDAP Server Connections

Use

LDAP server connections are used to store the server connection details for importing LDAP server users into SAP 3D Visual Enterprise Generator. You can select options when defining the LDAP server connections.

For example, the authentication scheme used to authenticate the user that will query the LDAP server, and whether to connect to the LDAP server SSL protocol.

Once created, LDAP servers can be edited and deleted.

CautionWhen creating a LDAP server connection using a directory tree, you must specify the domain location from where users will later be imported. If you have a large domain, you should not expand the location node in the directory tree as this may result in the domain timing out.

We recommend that your system administrator creates a user with permissions to navigate the directory and retrieve attributes, to use for the authentication credentials.

Procedure

To create a LDAP server connection, proceed as follows:

1. Choose New on the LDAP Servers toolbar. The connection screen of the Create LDAP Server window opens.Connection screen:

Fields, Checkboxes and Buttons Functional Descriptions

Server Information Used to define the LDAP server from which to import users

LDAP Server Name The LDAP server name



Authentication Scheme The authentication scheme that authenticates the user that will query the LDAP server

Domains The domains names controlled by the LDAP server and from where users are imported

Use SSL Uses the SSL protocol to connect to the LDAP server

Authentication Credentials Used to define the user that will connect to the LDAP server. We recommend using a SAP 3D Visual Enterprise Generator user with permissions to navigate the directory and retrieve attributes. Contact your system administrator for more information.

Use current user Uses the current user to query the LDAP server

User Name The user name of the user you want to query the LDAP server

Password The password of the user you want to query the LDAP server

Domain The domain of the user you want to query the LDAP server

Test Authenticates the LDAP server against the specified user details

2. Enter the name of the LDAP server and select the authentication scheme used to authenticate the user that will query the LDAP server.

3. Enter the domain names that the LDAP server controls and from where users are imported. Separate the domain names with a semi-colon (;).

4. If required, select the Use SSL checkbox to use the SSL protocol to connect to the LDAP server.5. Do one of the following:

○ Select Use current user to use the current user to query the LDAP server.○ Enter the user name, password, and domain of the user you want to query the LDAP server.

We recommend using a SAP 3D Visual Enterprise Generator user with permissions to navigate the directory and retrieve attributes. See your system administrator for more information.

6. If required, choose Test and choose OK. The LDAP server is authenticated against the specified user details.

NoteThe authentication is performed when you click OK regardless of authenticating manually.

7. Choose Next. The container screen is displayed.Container screen

8. Enter the server base domain name (base DN) that describes the location from where users are imported, and then choose Update Tree.



If you are using a default Active Directory setup, all user accounts are located in the Users folder under your domain.In LDAP form, this is cn=Users;dc=[Your Domain]. For example, if your domain is activedirectory.software.com, the base DN is cn=Users;dc=activedirectory,dc=software,dc=com.

NoteUse the Filter field to update the tree and refine the results.

CautionIf you have a large domain, you should not expand the location node in the directory tree as this may result in the domain timing out.

9. Choose the domain location and then choose Next. The mapping screen is displayed.


Sample User The user from which attributes are mapped. The default sample user is Administrator.

Change Opens the Select a User window to select a sample user for mapping the LDAP system attributes to SAP 3D Visual Enterprise Generator

LDAP Filter The user for which you want to search

User Name The attribute to map to the user name property

Display Name The attribute to map to the display name property

E-Mail The attribute to map to the e-mail property

Select Used to search for and select the attributes to map. The filters search on both the name and value columns.

User Authentication Used to select the scheme to authenticate the user for client applications such as SAP Visual Enterprise Access

Change authentication scheme Activates the Authentication scheme field

Scheme field The scheme used to authenticate the user for client applications

10. If required, choose Change for the Sample User field and select a user to map the user attributes to SAP 3D Visual Enterprise Generator, and then choose OK. The default sample user is Administrator.

11. Do the following:1. Select the appropriate property attribute for the User Name field and choose OK.2. Select the appropriate property attribute for the Display Name field and choose OK.3. Select the appropriate property attribute for the E-Mail field and choose OK.


NoteThe filters search on both the name and value columns.

12. If required, select the Change authentication scheme checkbox, and select an authentication scheme to use for client applications.

NoteA different authentication scheme can be used for client applications such as SAP Visual Enterprise Access.

13. Choose Finish. The server connection details are saved.

More Information

LDAP Servers Panel [page 521]



4 Configuration of Derivatives

Use

You use this process to set up the derivative generation processes within SAP 3D Visual Enterprise Generator environment.

Prerequisites

You have authorization to work with SAP 3D Visual Enterprise Generator Administration.

Process

1. You set up pick lists (see Pick List [page 595]).2. You set up derivative types (see Derivative Type [page 598]).3. You set up derivative groups (see Derivative Group [page 612]).4. You set up derivative workflow (see Derivative Workflows [page 626]).

4.1 Pick List

Definition

A list that is used to limit the values that can be defined for derivative type properties and metadata attributes (see Pick Lists Panel [page 487])

Use

Pick lists are used to enumerate derivative property values so that they are easier to set up and maintain.

The picklists that must be created if they do not exist already are the following:

● 2D DrawingThe 2D Drawing list enumerates supported 2D vector formats.

● 2D RasterThe 2D Raster pick list enumerates supported 2D raster formats.

SAP 3D Visual Enterprise GeneratorConfiguration of Derivatives P U B L I C 595

● PDF TemplatesNote that PDF Template pick lists already exist and you can load and edit PDF templates that apply to your requirements.

● ViewsThis list enumerates scene views.

More Information

Creating and Editing Pick Lists [page 596]

4.1.1 Creating and Editing Pick Lists

Procedure

Creating Pick Lists

1. In SAP 3D Visual Enterprise Generator Administration, navigate to Server Configuration Pick Lists .

2. Choose on the Pick Lists toolbar. The Create/Edit Pick List window is displayed.3. Enter the required pick list name:

○ 2D Drawing○ 2D Raster○ Views

Note that PDF Template pick lists already exist and you can load and edit PDF templates that apply to your requirements.

4. Select a data type to identify the pick list as follows:

Pick List Name Pick List Data Type

2D Drawing String

2D Raster String

Views Integer

5. Choose to add a pick list entry.


Configuration of Derivatives

6. Add the name and value combinations as follows:

2D Raster Picklist

Name Value

Portable Network Graphics (png) png

Portable Pixelmap Graphic (ppm) ppm

Tagged Image File Format (tif) tif

Windows Bitmap Graphic (bmp) bmp

Joint Photographic Experts Group (jpg) jpg

2D Drawing Picklist

Name Value

Adobe Illustrator Vector Graphic (ai) ai

Scalable Vector Graphic (svg) svg

Computer Graphics Metafile (cgm) cgm

AutoCAD Drawing Interchange (dxf) dxf

AutoCAD Drawing (dwg) dwg

AutoCAD Design Web Format (dwf) dwf

Views Picklist

Name Value

Default 0

Top 1160

Front 1163

Left 1159

Right 1161

ISO 30 RTF 11054

7. Choose OK. The pick list is saved.

Editing PDF Template Pick List

The PDF Templates pick list enumerates available PDF templates, and it should already exist. Here you should load PDF templates that apply to your requirements.


1. Select the PDF Templates pick list and choose on the Pick Lists toolbar.

2. Choose to add a pick list entry.3. Add the name and value combinations as follows:

PDF Templates Picklist

Name Value

Basic_Views_Horiz_Letter_3D_Template_v1.0 Basic_Views_Horiz_Letter_3D_Template_v1.0.pdf

Steps_Simple_Template_1.0 Steps_Simple_Template_1.0.pdf

ISO_Size_A4_Landscape_297_X_210_Template ISO_Size_A4_Landscape_297_X_210_Template.pdf

Simple_Animation_Template_v1.0 Simple_Animation_Template_v1.0.pdf

4. Choose OK. The pick list is saved.

More Information

Creating, Editing, and Deleting Pick Lists [page 558]

4.2 Derivative Type

Definition

Derivative types define outputs that can be created as part of a workflow, or on demand through interactive sessions within your client application.

Structure

The derivative types that must be created if they do not exist already are the following:

● 2D Drawings● 2D Image● 3D● PDF Publishing

Each derivative type is also defined with a class that groups the derivative types based on the type’s characteristics.



2D Drawing

The 2D drawing class of derivatives defines outputs for 2D vector formats. The 2D Drawing derivative types that need to be created are the following:

● 3D Translation to Format (see Creating 3D Translation to Format Derivative Type [page 600])● Vector Illustration (see Creating Vector Illustration Derivative Type [page 601])

2D Image

The 2D image class of derivatives defines outputs for 2D raster formats.

The 2D Image derivative types that need to be created are the following:

● Line Illustration (see Creating Line Illustration Derivative Type [page 602])● Shaded Illustration (see Creating Shaded Illustration Derivative Type [page 603])● Solid (see Creating Solid Derivative Type [page 604])

3D

The 3D class of derivatives defines outputs for 3D formats.

The 3D derivative types that need to be created are the following:

● RH Exploded (see Creating RH Exploded Derivative Type) [page 605]● RH Export High Detail (see Creating RH Export High Detail Derivative Type [page 606])● RH Export Medium Detail (see Creating RH Export Medium Detail Derivative Type [page 607])● RH Export Low Detail (see Creating RH Export Low Detail Derivative Type [page 608])● RH Reduced (see Creating RH Reduced Derivative Type [page 608])● RH Removed Internals (see Creating RH Removed Internals Derivative Type [page 609])

PDF Publishing

The PDF Publishing class of derivatives defines outputs for PDF format.

The PDF Publishing derivative types that need to be created are the following:

● PDF Publishing (see Creating PDF Publishing Derivative Type [page 611])● PDF Publishing 2D Drawing (see Creating PDF Publishing 2D Drawing Derivative Type [page 612])

More Information

Derivative Types Panel [page 482]

Creating Derivative Types [page 550]


4.2.1 Creating 3D Translation to Format Derivative Type

Context

The 3D Translation to Format derivative creates 2D or 3D vector formats.

Procedure

1. In SAP 3D Visual Enterprise Generator Administration, navigate to Server Configuration Derivative Types .

2. Choose on the Derivative Types toolbar. The Create Derivative Type window opens.3. Enter the name 3D Translation to Format for the derivative type.4. Select the Derivative Convert 3D default process to use to create derivatives.5. Select a class of 2D Drawing to which the type belongs.6. Set the additional attributes as per your requirements.

7. Choose the Properties tab, and choose to add properties to the derivative type in the Create Property window.

8. Add the properties as follows:

Name Value Data Type Description Pick List

frame 0 Integer Frame N/A

viewid 0 Integer View ID Views

camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

String Camera N/A

format ai Picklist Output Format 2D Drawing

viewname N/A String Name N/A

9. Choose OK to save the properties.10. Choose OK. The derivative type is saved.



4.2.2 Creating Vector Illustration Derivative Type

Context

The Vector Illustration derivative creates vector illustrations.

Procedure


2. Choose on the Derivative Types toolbar. The Create Derivative Type window opens.3. Enter the name Vector Illustration for the derivative type.4. Select the Derivative Vector Render default process to use to create derivatives.5. Select a class of 2D Drawing to which the type belongs.6. Set the security options as per your requirements, but note that the Create Thumbnail value should always

be enabled.

7. Choose the Properties tab, and choose to add properties to the derivative type.8. Add the properties as follows:




animationname Sequence-1 String Animation Name N/A

camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

String Camera N/A

format ai String Output Format 2D Drawing




4.2.3 Creating Line Illustration Derivative Type

Context

The Line Illustration derivative creates line illustrations.

Procedure


2. Choose on the Derivative Types toolbar. The Create Derivative Type window opens.3. Enter the name Line Illustration for the derivative type.4. Select the Derivative Line Illustration default process to use to create derivatives.5. Select a class of 2D Image to which the type belongs.6. Set the security options as per your requirements, but note that the Create Thumbnail value should always

be enabled.





height 512 Integer Height N/A

width 512 Integer Width N/A


camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

String Camera N/A

format jpg String Output Format 2D Raster


9. Choose OK to save the properties.



10. Choose OK. The derivative type is saved.

4.2.4 Creating Shaded Illustration Derivative Type

Context

This derivative creates shaded illustrations.

Procedure


2. Choose on the Derivative Types toolbar. The Create Derivative Type window opens.3. Enter the name Shaded Illustration for the derivative type.4. Select the Derivative Shaded Illustration default process to use to create derivatives.5. Select a class of 2D Image to which the type belongs.6. Set the security options as per your requirements, but note that the Create Thumbnail value should always

be enabled.

7. Choose the Properties tab, and choose to add properties to the derivative type.8. Add the properties in the following table:







camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

String Camera N/A






4.2.5 Creating Solid Derivative Type

Context

This derivative creates solid renders.

Procedure


2. Choose on the Derivative Types toolbar. The Create Derivative Type window opens.3. Enter the name Solid for the derivative type.4. Select the Derivative Solid Render default process to use to create derivatives.5. Select a class of 2D Image to which the type belongs.6. Set the security options as per your requirements, but note that the Create Thumbnail value should always

be enabled.











camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

String Camera N/A




4.2.6 Creating RH Exploded Derivative Type

Context

This derivative creates an exploded animation in RH format.

Procedure


2. Choose on the Derivative Types toolbar. The Create Derivative Type window opens.3. Enter the name RH Exploded for the derivative type.4. Select the Derivative Exploded Object default process to use to create derivatives.5. Select a class of 3D to which the type belongs.6. Set the security options as per your requirements, but note that the Create Thumbnail value should always

be enabled.




animation True Boolean Animate N/A

LOD 1 Decimal Level of Detail N/A



camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

String Camera N/A



4.2.7 Creating RH Export High Detail Derivative Type

Context

The RH Export — High Detail derivative creates high detail output in RH format.

Procedure


2. Choose on the Derivative Types toolbar. The Create Derivative Type window opens.3. Enter the name RH Export High Detail for the derivative type.4. Select the Derivative RH Export default process to use to create derivatives.5. Select a class of 3D to which the type belongs.6. Set the security options as per your requirements, but note that the Create Thumbnail value should always

be enabled.





collapse False Boolean Collapse N/A



4.2.8 Creating RH Export Medium Detail Derivative Type

Context

The RH Export — Medium Detail derivative creates medium detail output in rh format.

Procedure


2. Choose on the Derivative Types toolbar. The Create Derivative Type window opens.3. Enter the name RH Export Medium Detail for the derivative type.4. Select the Derivative RH Export default process to use to create derivatives.5. Select a class of 3D to which the type belongs.6. Set the security options as per your requirements, but note that the Create Thumbnail value should always

be enabled.




LOD 0.75 Decimal Level of Detail N/A



4.2.9 Creating RH Export Low Detail Derivative Type

Context

The RH Export — Low Detail derivative creates low detail output in rh format.

Procedure


2. Choose on the Derivative Types toolbar. The Create Derivative Type window opens.3. Enter the name RH Export Low Detail for the derivative type.4. Select the Derivative RH Export default process to use to create derivatives.5. Select a class of 3D to which the type belongs.6. Set the security options as per your requirements, but note that the Create Thumbnail value should always

be enabled.




LOD 0.35 Decimal Level of Detail N/A


4.2.10 Creating RH Reduced Derivative Type

Context

The RH Reduced derivative creates polygon reduced output in rh format.



Procedure


2. Choose on the Derivative Types toolbar. The Create Derivative Type window opens.3. Enter the name RH Reduced for the derivative type.4. Select the Derivative Poly Reduce default process to use to create derivatives.5. Select a class of 3D to which the type belongs.6. Set the security options as per your requirements, but note that the Create Thumbnail value should always

be enabled.





camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

String Camera N/A



4.2.11 Creating RH Removed Internals Derivative Type

Context

The RH Removed derivative creates polygon reduced output in rh format.

Procedure



2. Choose on the Derivative Types toolbar. The Create Derivative Type window opens.3. Enter the name RH Remove Internals for the derivative type.4. Select the Derivative No Internal Objects default process to use to create derivatives.5. Select a class of 3D to which the type belongs.6. Set the security options as per your requirements, but note that the Create Thumbnail value should always

be enabled.





camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

String Camera N/A



4.2.12 Creating 3D Translation to 3D Format Derivative Type

Context

The 3D Translation to 3D Format derivative creates 3D formats.

Procedure


2. Choose on the Derivative Types toolbar. The Create Derivative Type window opens.3. Enter the name 3D Translation to 3D Format for the derivative type.



4. Select the Derivative - Convert 3D default process to use to create derivatives.5. Select a class of 3D to which the type belongs.6. Set the security options as per your requirements, but note that the Create Thumbnail value should always

be enabled.



format Visual Design Stream (vds)

Picklist Output Format 3D Convert


4.2.13 Creating PDF Publishing Derivative Type

Context

The PDF Publishing derivative creates a default PDF document.

Procedure


2. Choose on the Derivative Types toolbar. The Create Derivative Type window opens.3. Enter the name PDF Publishing for the derivative type.4. Select the Derivative PDF Publish default process to use to create derivatives.5. Select a class of PDF Publishing to which the type belongs.6. Set the security options as per your requirements, but note that the Create Thumbnail value should always

be enabled.




template N/A String PDF Template PDF Template



4.2.14 Creating PDF Publishing 2D Drawing Derivative Type

Context

The PDF Publishing 2D Drawing derivative creates a 2D drawing in PDF format.

Procedure


2. Choose on the Derivative Types toolbar. The Create Derivative Type window opens.3. Enter the name PDF Publishing 2D Drawing for the derivative type.4. Select the Derivative 2D PDF default process to use to create derivatives.5. Select a class of PDF Publishing to which the type belongs.6. Set the security options as per your requirements, but note that the Create Thumbnail value should always

be enabled.7. Choose OK. The derivative type is saved.

4.3 Derivative Group

Definition

A container for derivative type instances that are used to create multiple derivatives as needed



Use

Derivative groups define groups of derivatives that can be applied to workflows.

The derivative groups that must be created if they do not exist already are the following:

● Default (see Creating Default Derivative Group [page 613])● 2D Drawing Tech Illustrations (see Creating 2D Drawing Tech Illustrations Derivative Group [page 614])● 3D Step-by-Step Training (see Creating 3D Step-By-Step Training Derivative Group [page 617])● CAD Assemblies and Parts (see Creating CAD Assemblies and Parts Derivative Group [page 623])

More Information

Derivative Groups Panel [page 485]

Creating Derivative Groups [page 556]

4.3.1 Creating Default Derivative Group

Context

The default derivative group creates default derivatives.

The group must contain the following derivatives:

● Low● RH Export Low Detail Derivative - Property Overrides● Spatial Index

Procedure

1. In SAP 3D Visual Enterprise Generator Administration, navigate to Server Configuration Derivative Groups .

2. Choose on the Derivative Groups toolbar. The Create Derivative Group window opens.3. Enter Default as the name for the derivative group.4. Enter Default Derivatives as a description for the group.


5. Choose the Derivatives tab, and then choose to add a derivative type instance to the group.6. Add the following derivative types to the group:

Derivative Type Derivative Name Description

RH Export Low Detail Low Low Detail

Spatial Index Spatial Index Spatial Index

7. Add the property overrides as follows:

RH Export Low Detail Derivative - Property Overrides

Overridden Name Value

No LOD 0.35

No collapse False

8. Choose OK to save the instance.9. Choose OK. The derivative group is saved.

4.3.2 Creating 2D Drawing Tech Illustrations Derivative Group

Context

The 2D Drawing Tech Illustrations derivative group creates technical illustration derivatives.

The group must contain the following derivatives:

● Shaded Illustration● 3D Translation to Format AI● 3D Translation to Format CGM● 3D Translation to Format DWG● 3D Translation to Format DWF● PDF Publishing 2D Drawing



Procedure


2. Choose on the Derivative Groups toolbar. The Create Derivative Group window opens.3. Enter the name 2D Drawing Tech Illustrations for the derivative group.4. Enter Technical Illustrations as a description for the group.

5. Choose the Derivatives tab, and choose to add a derivative type instance to the group.6. Add the following derivative types to the group:

○ Shaded Illustration○ 3D Translation to Format AI○ 3D Translation to Format CGM○ 3D Translation to Format DWG○ 3D Translation to Format DWF○ PDF Publishing 2D Drawing

7. If required, add the following property overrides:

Shaded Illustration Derivative


No frame 0

No viewid 0

No height 512

No width 512

No animationname Sequence-1

No camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

No format jpg

No viewname N/A

3D Translation to Format AI Derivative


No frame 0

No viewid 0

No camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1



No format Adobe Illustrator Vector Graphics (ai)

No viewname N/A

3D Translation to Format CGM Derivative


No frame 0

No viewid 0

No camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

Yes format Computer Graphics Metafile (cgm)

No viewname N/A

3D Translation to Format DWG Derivative


No frame 0

No viewid 0

No camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

Yes format AutoCAD Drawing (dwg)

No viewname N/A

3D Translation to Format DWF Derivative


No frame 0

No viewid 0

No camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

Yes format AutoCAD Design Web Format (dwf)

No viewname N/A




4.3.3 Creating 3D Step-By-Step Training Derivative Group

Context

This derivative group creates 3D step-by-step training derivatives.

Procedure


2. Choose on the Derivative Groups toolbar. The Create Derivative Group window opens.3. Enter 3D Step-by-Step Training as the name for the derivative group.4. Enter 3D Step-by-Step Training as a description for the group.

5. Choose the Derivatives tab, and then choose to add a derivative type instance to the group.6. Add the following derivative type instances to the group:

○ PDF Publishing – Simple StepsThis derivative creates a document with simple steps in the PDF format.


PDF Publishing PDF Publishing Simple Steps Simple steps

○ PDF Publishing 3D Basic LandscapeThis derivative creates a 3D basic landscape in the PDF format.


PDF Publishing PDF Publishing 3D Basic Landscape Basic 3D

○ Shaded Illustration JPG DefaultThis derivative creates a shaded illustration in the JPG format.


Shaded Illustration Shaded Illustration JPG Default Shaded Illustration

○ RH Exploded


This derivative creates an exploded animation in RH format.


RH Exploded RH Exploded Exploded

○ Vector CGM TopThis derivative creates a top view vector illustration in the CGM format.


Vector Illustration Vector CGM Top Top view vector illustration cgm

○ Vector CGM FrontThis derivative creates a front view vector illustration in the CGM format.


Vector Illustration Vector CGM Front Front view vector illustration cgm

○ Vector CGM LeftThis derivative creates a left view vector illustration in the CGM format.


Vector Illustration Vector CGM Left Left view vector illustration cgm

○ Vector CGM RightThis derivative creates a right view vector illustration in the CGM format.


Vector Illustration Vector CGM Right Right view vector illustration cgm

○ Vector CGM ISO RTFThis derivative creates an ISO 30 RTF view vector illustration in the CGM format.


Vector Illustration Vector CGM ISO 30 RTF ISO 30 RTF view vector illustration cgm

○ Vector DXF TopThis derivative creates a top view vector illustration in the DXF format.




Vector Illustration Vector DXF Top Top view vector illustration dxf

○ Vector DXF FrontThis derivative creates a front view vector illustration in the DXF format.


Vector Illustration Vector DXF Front Front view vector illustration dxf

○ Vector DXF LeftThis derivative creates a left view vector illustration in the DXF format.


Vector Illustration Vector DXF Left Left view vector illustration dxf

○ Vector DXF RightThis derivative creates a right view vector illustration in the DXF format.


Vector Illustration Vector DXF Right Right view vector illustration dxf

○ Vector DXF ISO RTFThis derivative creates an ISO 30 RTF view vector illustration in the DXF format.


Vector Illustration Vector DXF ISO 30 RTF ISO 30 RTF view vector illustration dxf

○ Solid JPG DefaultThis derivative creates a solid render in the JPG format.


Solid Solid JPG Default Solid

○ Line Illustration JPG TopThis derivative creates a top view line illustration in the JPG format.



Line Illustration Line Illustration JPG Top Top view line illustration jpg

○ Line Illustration JPG FrontThis derivative creates a front view line illustration in the JPG format.


Line Illustration Line Illustration JPG Front Front view line illustration jpg

○ Line Illustration JPG LeftThis derivative creates a left view line illustration in the JPG format.


Line Illustration Line Illustration JPG Left Left view line illustration jpg

○ Line Illustration JPG RightThis derivative creates a right view line illustration in the JPG format.


Line Illustration Line Illustration JPG Right Right view line illustration jpg

○ Line Illustration JPG ISO 30 RTFThis derivative creates an ISO 30 RTF view line illustration in the JPG format.


Line Illustration Line Illustration JPG ISO 30 RTF ISO 30 RTF view line illustration jpg


PDF Publishing Simple Steps Derivative


Yes template Steps_Simple_Template_1.0

No viewname N/A



PDF Publishing 3D Basic Landscape Derivative


Yes template Basic_Horiz_Letter_3D_Template_1.0

No viewname N/A

Shaded Illustration JPG Default Derivative


No frame 0

No viewid 0

No height 512

No width 512


No camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

No format jpg

No viewname N/A

RH Exploded Derivative


No animation True

No LOD 1

No frame 0

No viewid 0

No camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

No viewname N/A

Vector CGM Top, Vector CGM Front, Vector CGM Left, Vector CGM Right, Vector CGM ISO 30 RTF Derivatives


No frame 0



Yes viewid Top: 1160 (Top)

Front: 1163 (Front)

Left: 1159 (Left)

Right: 1161 (Right)

ISO 30 RTF: 11054 (ISO 30 RTF)


No camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

Yes format Computer Graphics Metafile (cgm)

No viewname N/A

Vector DXF Top, Vector DXF Front, Vector DXF Left, Vector DXF Right, Vector DXF ISO 30 RTF Derivatives


No frame 0

Yes viewid Top: 1160 (Top)

Front: 1163 (Front)

Left: 1159 (Left)

Right: 1161 (Right)

ISO 30 RTF: 11054 (ISO 30 RTF)


No camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

Yes format AutoCAD Drawing Interchange (dxf)

No viewname N/A

Solid JPG Derivative


No frame 0

No viewid 0

No height 512

No width 512





No camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

No format jpg

No viewname N/A

Line Illustration JPG Top, Line Illustration JPG Front, Line Illustration JPG Left, Line Illustration JPG Right, Line Illustration JPG ISO 30 RTF Derivatives


No frame 0

Yes viewid 1160 (Top)

1163 (Front)

1159 (Left)

1161 (Right)

11054 (ISO 30 RTF)

No height 512

No width 512


No camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

No format jpg

No viewname N/A


4.3.4 Creating CAD Assemblies and Parts Derivative Group

Context

This derivative group creates CAD Assembly and Part derivatives.


Procedure


2. Choose on the Derivative Groups toolbar. The Create Derivative Group window opens.3. Enter CAD Assemblies and Parts as the name for the derivative group.4. Enter CAD Assemblies and Parts as a description for the group.

5. Choose the Derivatives tab, and then choose to add a derivative type instance to the group.6. Add the following derivative type instances to the group:

○ PDF Publishing DefaultThis derivative creates a default PDF document.


PDF Publishing PDF Publishing Default Default PDF

○ PDF Publishing 3D Basic Landscape○ Shaded Illustration JPG Default○ RH Exploded○ Vector CGM Top○ Vector CGM Front○ Vector CGM Left○ Vector CGM Right○ Vector CGM ISO RTF○ Solid JPG Default○ Line Illustration JPG Top○ Line Illustration JPG Front○ Line Illustration JPG Left○ Line Illustration JPG Right○ Line Illustration JPG ISO 30 RTF○ RH Removed Internals

This derivative creates an output in RH format with removed hidden parts.


RH Removed Internals RH Removed Internals Removed Internals




PDF Publishing


Yes template ISO_Size_A4_Landscape_297_X_210_Template

No viewname N/A

RH Removed Internals


No LOD 1

No frame 0

No camera 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1

No viewname N/A


4.3.5 Creating Publishing Derivative Group

Context

This derivative group creates publishing derivatives.

Procedure


2. Choose on the Derivative Groups toolbar. The Create Derivative Group window opens.3. Enter Publishing as the name for the derivative group.4. Enter Multi Derivative Publishing as a description for the group.

5. Choose the Derivatives tab, and then choose to add a derivative type instance to the group.6. Add a derivative type 3D Translation to 3D Format, with the name and description VDS.


7. Add the following property overrides:

VDS


No format Visual Design Stream (vds)

8. Choose OK to save the instance.9. Choose OK. The derivative group is saved.10. Activate VDS plug-in, otherwise the derivative generation will not work past the 90 day trial period.

4.4 Derivative Workflows

Definition

To build derivatives defined in Derivative Types [page 598], you need to create universal workflows. These workflows can then be accessed by other workflows to build derivatives.

Workflows are created using the Workflows panel: you can define settings that control how the workflow functions (see Workflows Panel [page 27]).

The universal workflows that must be created are the following:

● Build Derivatives (see Creating Build Derivatives Workflow [page 626])● Select Derivatives (see Creating Select Derivatives Workflow [page 627])● Select All Derivatives (see Creating Select All Derivatives Workflow [page 628])● Default Publishing (see Creating Default Publishing Workflow [page 629])

More Information

Creating Derivatives on Demand [page 630]

Creating Workflows [page 532]

4.4.1 Creating Build Derivatives Workflow

Context

This workflow builds derivatives.



Procedure

1. In SAP 3D Visual Enterprise Generator Administration, navigate to Server Configuration Workflows .

2. Choose on the Workflows toolbar. The Create Workflow window opens.3. Enter the name Build Derivatives for the workflow.4. Select the Enabled checkbox to activate the workflow for asset processing.5. Select the BuildDerivatives controller to use as the workflow template.

6. Choose OK. The workflow is saved.

4.4.2 Creating Select Derivatives Workflow

Context

This workflow selects derivatives to be built.

Procedure


2. Choose on the Workflows toolbar. The Create Workflow window opens.3. Enter the name Select Derivatives for the workflow.4. Select the Enabled checkbox to activate the workflow for asset processing.5. Select the BuildDerivatives controller to use as the workflow template.

6. Navigate to Processes and double-click the Select Derivatives Derivative Selection process to open it in the Process Designer.

7. Double-click DerivativeGroupName and set its value to Default. This is the name of the default derivative group defined in Default.



4.4.3 Creating Select All Derivatives Workflow

Context

This workflow is exclusively used to enable Derivatives on Demand execution.

Procedure


2. Choose on the Workflows toolbar. The Create Workflow window opens.3. Enter the name Select All Derivatives for the workflow.4. Select the Enabled checkbox to activate the workflow for asset processing.5. Select the SelectAllDerivatives controller to use as the workflow template.

6. Do the following if you want to apply workflows before and after the current workflow ends:○ Select a workflow that starts before the current workflow ends, choose Arguments, enter the required

parameters, add further parameters, and then choose OK. This workflow is not sent to a queue for processing.

○ Select a workflow that starts after the current workflow ends, choose Arguments, enter the required parameters, and then choose OK. This workflow will be queued for processing.

7. Choose the Processes tab and select the processes to determine how the workflow functions during processing.

NoteThe available processes differ for every controller.

8. Choose the Child Workflows tab and select a workflow to process as a child of the current workflow.

NoteOnly workflows that accept the same input (are compatible) can be selected as children.

9. Choose the Settings tab and select any additional settings for the workflow. For example, select a default derivative group to process only those derivative types within the group.

NoteThe available settings differ for every controller.




4.4.4 Creating Default Publishing Workflow

Context

This workflow defines the default asset publishing process that builds default derivatives as its final step.

Procedure


2. Choose on the Workflows toolbar. The Create Workflow window opens.3. Enter the name Default Publishing for the workflow.4. Select the Enabled checkbox to activate the workflow for asset processing.5. Select the PLMAssetPublish controller to use as the workflow template.

6. Do the following if you want to apply workflows before and after the current workflow ends:○ Select a workflow that starts before the current workflow ends, choose Arguments, enter the required

parameters, add further parameters, and then choose OK. This workflow is not sent to a queue for processing.

○ Select a workflow that starts after the current workflow ends, choose Arguments, enter the required parameters, and then choose OK. This workflow will be queued for processing.

7. Choose the Processes tab and select the processes to determine how the workflow functions during processing.

NoteThe available processes differ for every controller.

8. Choose the Child Workflows tab and select a workflow to process as a child of the current workflow.

NoteOnly workflows that accept the same input (are compatible) can be selected as children.

9. Choose the Settings tab and select any additional settings for the workflow. For example, select a default derivative group to process only those derivative types within the group.

NoteThe available settings differ for every controller.



4.4.5 Creating Derivatives on Demand

Use

A derivative on demand (DoD) is an ad hoc workflow that generates derivatives based on a user’s input from SAP Visual Enterprise Access or other client application. Derivatives on demand can be created from a group based on the derivative group set up, or one by one based on the derivative type set up.

Prerequisites

To create derivatives one by one, the following prerequisites are required:

● In SAP 3D Visual Enterprise Generator Administration, a Derivative on Demand definition has been generated for each derivative type (see Generating and Removing DoD Definitions [page 553]).

● The User Can Show and User Can Create security options have been enabled on the derivative type.

Procedure

Creating DoDs from Group

1. In SAP Visual Enterprise Access, navigate to the desired part or assembly and add it to a collection; repeat this for all parts or assemblies required.

2. Choose the Collections tab and choose Create Derivatives from Group.3. Select the derivative group containing the desired derivatives to create.

Creating DoDs One by One

1. In SAP Visual Enterprise Access, navigate to the desired part or assembly and choose the Derivatives tab.2. Choose the Create button, and select the appropriate options.



5 SAP 3D Visual Enterprise Import and Export Options

The following sections contain information on all supported file format options for import and export. They are grouped alphabetically by type.

If a file contains import properties, you can modify those properties using the Import Properties window, either when opening the file or directly from the Plug-In Manager. Once you have modified the import properties for a particular file format, those settings apply to any file of the same format when it is opened or reloaded.

You can save (export or convert) 2D and 3D files to a number of supported file formats. Various settings can be established when saving files depending on the type of file in which you select to save (the output format).

If the file contains export properties when you begin saving a file, you can modify those properties and apply them to the file. For example, if you save a file to the .jpeg format, you can determine the quality of the saved file. If you save a file to the RH format, you can save keyframe animation, normals, skins, and smoothing. Once you have modified the export properties for a particular file format, those settings apply to any file of the same format when it is saved.

Import Options

Some tabs and options are identical across different file formats; for example, the Geometry Transform settings. Any unique settings are described in the individual file format topics.

NoteYou can also access the Import Properties window for each file format using the Plug-In Manager. The settings apply when you next open a file of that particular format.

Export Options

The tabs and the options displayed when exporting a file differ depending on the selected file format. However, many tabs and options are identical across different file formats. The common settings are described here.

Tab Functional Description

General Tab Defines the export properties for the selected file format

Animation Tab Defines the animation export properties for the selected file format

SAP 3D Visual Enterprise GeneratorSAP 3D Visual Enterprise Import and Export Options P U B L I C 631

Tab Functional Description

Geometry Transform Tab Defines the scene transformation matrix that is used to rotate the current scene. It is used to rotate the scene in the X, Y, and Z axes.

NoteGeometry Transform tab is available only in SAP 3D Visual Enterprise Author.

Materials Tab Defines the export properties for the materials associated with the selected file format

Texture Maps Tab Defines the export properties for the textures associated with the selected file format

Show Settings when Opening or Saving this Format

All file formats contain this option, which when checked, displays the import or export settings when a file type is loaded or saved for the first time. You can set this option globally using the File tab in the Preferences window, or individually underneath the actual import or export setting.

Save Options

All file formats contain these options, which when selected, allow you to save a specific set of import or export settings. You can have multiple sets of settings for a particular file type, depending on your requirements. The icons Save Current Options and Load Saved Options appear at the bottom of the Import and windows.

5.1 2D File Formats

The following 2D file formats are supported by SAP 3D Visual Enterprise Author and SAP 3D Visual Enterprise Generator. This list is organized alphabetically by file format.

NoteFor further information relating to supported format versions, refer to 2334841 for SAP 3D Visual Enterprise Author, and 2334827 for SAP 3D Visual Enterprise Generator.


SAP 3D Visual Enterprise Import and Export Options



File Format Extension Notes

Adobe Encapsulated Postscript [page 634] EPS Files that are version 15 and above must have Adobe Illustrator installed to import and process the files.

Export using Vector Illustration

Adobe Illustrator Vector Graphic [page 635] AI Files that are version 15 and above must have Adobe Illustrator installed to import and process the files.


Adobe Photoshop Document [page 636] PSD N/A

Autodesk Animator Graphic [page 636] CEL N/A

Computer Graphics Metafile [page 636] CGM Export: Version 3.0.


Digital Imaging and Communications in Medicine Image [page 638]

DCM Medical MRI file format

EA/Amiga Interchange File Format [page 638] IFF N/A

Enhanced Metafile [page 639] EMF N/A

Flexible Precision Buffer Map [page 639] FLX N/A

FLIC Animator Animation [page 639] FLC, FLI N/A

Graphics Interchange Format [page 640] GIF N/A

JEDMICS C4 Compressed Image [page 640] C4 N/A

JPEG 2000 J2K and JPX [page 640] J2K, JPX N/A

JPEG 2000 JP2 [page 640] JP2 N/A

JPEG 2000 JPC [page 641] JPC N/A

JPEG Image [page 642] JPG, JPEG N/A

Maya Interchange File Format [page 643] IFF Requires Maya to be installed

OpenEXR Bitmap [page 644] EXR N/A

Portable Network Graphics [page 645] PNG N/A

Portable Pixelmap Graphic [page 646] PPM N/A

Publisher's Paintbrush Bitmap Graphic [page 646]

PCX N/A



Radiance Picture Format [page 647] HDR N/A

Scalable Vector Graphics [page 647] SVG Export using Vector Illustration

Silicon Graphics Image [page 647] RGB, RGBA, INT, INTA

N/A

SOFTIMAGE Picture [page 648] PIC N/A

Tagged Image File Format [page 648] TIF, TIFF Multi-page support

TGA File [page 649] TGA N/A

Windows Bitmap Graphic [page 650] BMP, DIB N/A

Windows Cursor File [page 650] CUR N/A

Windows Icon File [page 650] ICO N/A

Windows Metafile [page 651] WMF N/A

Windows Run Length Encoded Bitmap [page 651]

RLE N/A

5.1.1 Adobe Encapsulated Postscript

Use

You can import and view Adobe Encapsulated Postscript (.eps) files. You can also save files to this format.

The .eps format, developed by Adobe, is a standard format for importing and exporting PostScript language files in all environments. It is usually a single page PostScript language program that describes an illustration. The purpose of the .eps file is to be included as an illustration in other PostScript language page descriptions. The .eps file can contain any combination of text, graphics, and images. An .eps file is the same as any other PostScript language page description, but with some restrictions.

Features

This format contains import options. You can use them to customize the way in which your file is imported.

Import Interface



Field Functional Description

Use an Instance of Adobe Illustrator for Processing Files Opens Adobe Illustrator to process files

NoteFiles that are version 15 and above require the installation of Adobe Illustrator, in order to import and process the files.

Adobe Illustrator Folder Specifies the location of Adobe Illustrator

● Browse: Used to browse for and select the location

Temporary Data Exchange Folder Specifies the location of the temporary data exchange folder

5.1.2 Adobe Illustrator Vector Graphic

Use

You can import and view Adobe Illustrator Vector Graphic (.ai) files. You can also save to this format.

The Adobe Illustrator Vector Graphic format is a widely used format for the exchange of 2D objects. It supports Bezier splines as drawing objects. Bezier splines improve the modeling of natural (and some human-made) objects. It is a variation of the Adobe Encapsulated PostScript (.eps) format.

NoteIf you wish to save to a 2D vector file, it is recommended that you use Vector Illustration.

Features

This format contains import options. You can use them to customize the way in which your file is imported.

Import Interface



Use an Instance of Adobe Illustrator for Processing Files Opens Adobe Illustrator to process files

NoteFiles that are version 15 and above require the installation of Adobe Illustrator, in order to import and process the files.

Adobe Illustrator Folder Specifies the location of Adobe Illustrator

● Browse: Used to browse for and select the location

Temporary Data Exchange Folder Specifies the location of the temporary data exchange folder

Stop Illustrator Process after Import Cancels the Adobe Illustrator process once the file is imported

5.1.3 Adobe Photoshop Document

You can view Adobe Photoshop Document (.psd) files.

The .psd file format (Photoshop Document), developed by Adobe, is the native format used by the Adobe Photoshop application. This format contains image information along with layer, layer style, drop shadow and text information. You can open the file for editing in Photoshop and other compatible Adobe software such as Adobe InDesign, but to view in standard applications the images are flattened or merged.

5.1.4 Autodesk Animator Graphic

You can view Autodesk Animator Graphic (.cel) files.

The .cel file format is used in the Animator program developed by Autodesk for the animation of 2D graphics. These files are extensions of the FLIC file formats, with a different extension and one more entry in the prefix data (an optional header).

5.1.5 Computer Graphics Metafile

Use

You can import and view Computer Graphics Metafile (.cgm) files. You can also save files to this format.

The .cgm format is one of the CALS standard formats for representing 2D technical illustrations and is an object-oriented graphic format. It was developed by experts working under the auspices of ISO and ANSI, and



was designed specifically as a common format for the platform-independent interchange of raster (bitmap) and vector data. It is used primarily to store vector graphics information.

CGM files typically contain either vector or raster data, but rarely both. Used in its primary role as a vector format, it offers the advantage of small file size and resolution independence, while not being tied to a specific software package or hardware platform. CGM was adapted by the Department of Defense as one of the CALS initiative standards.

NoteCGM = CALS profile specified in MIL-D-28003A.

NoteIf you wish to save to a 2D vector file, it is recommended that you use Vector Illustration.

Supported

● Binary version

Features

This format contains export options. You can use them to customize the way in which your file is saved.

Export Interface


Version Establishes the version in which to save the file

● 1 (Most Compatible): Saves the files in version 1 of the .cgm format. This version is the most compatible.

● 3 (Best Curves): Saves the files in version 3 of the .cgm format. This version produces the best curves.

● 4 (Hotspots): Saves the files in version 4 of the .cgm format. This version stores hotspot information.

Numeric Precision Establishes the level of precision in which to save numbers in the file

● 16 bit Integer: Saves the numbers as integers. This creates the smallest file size.

● 32 bit Floating Point: Saves the numbers as floats. This is the default setting.

● 32 bit Fixed Point: Saves the numbers as fixed points



Encode Raster Images with RLE Determines whether raster images are written in compressed or uncompressed form. The standard way is to write them as uncompressed. RLE (Run Length Encoding) is the compressed form. This option switches RLE ON or OFF.

XML Companion File Writes information about application structures, (groups), and hotspots to an .xml file. This is created in the same folder as the .cgm file.

5.1.6 Digital Imaging and Communications in Medicine Image

Use

You can view Digital Imaging and Communications in Medicine Image (.dcm) files. You can also save files to this format.

Features


Export Interface


Compression Selects the type of file compression to be used. There are two available options: Raw Data and RLE Compression.

Photometric Interpretation Selects the type of photometric interpretation to be used. There are three available options: Monochrome 1, Monochrome 2, and RGB.

5.1.7 EA/Amiga Interchange File Format

You can view EA/Amiga Interchange File (.iff) files.

The .iff file format (Interchange File Format) is developed by Electronic Arts (EA) and Amiga, and is a general purpose data storage format that can associate and store multiple types of data. It is a generic structured file access mechanism, and is not limited to images. For example, .aiff files are audio .iff.



Interchange File Format images can have 8 or 16-bit per channel RGB, and optionally Alpha, and can optionally contain a 32-bit floating point depth map (sometimes called a Z-buffer).

5.1.8 Enhanced Metafile

You can view Microsoft Enhanced Metafile format (.emf) files.

The Enhanced Metafile is a newer 32-bit version of the original Windows Metafile (.wmf), and contains additional commands.

An .emf metafile is a series of variable-length records, called EMF records, which contain graphics drawing commands, object definitions, and properties. The metafile begins with a header record, which includes the metafile version, its size, the resolution of the device on which the picture was created, and the dimensions of the picture. An .emf metafile is “played back” when its records are converted to a format understood by a specific graphics device. The image defined in an EMF structure maintains its dimensions, shape, and proportions on any output device, including printers, plotters, and desktops, or in the client areas of applications.

5.1.9 Flexible Precision Buffer Map

You can view Flexible Precision Buffer Map (.flx) files.

The .flx file format (FLX) is used in Animator for the animation of 2D graphics, and is developed by Autodesk. The .flx file format is a slight variation on the .flc file format that achieves more flexibility with regard to color depth.

NoteWhen you open a high dynamic range image (HDRI), resolution controls are displayed in the Information bar. These allow you to modify the image.

5.1.10 FLIC Animator Animation

You can view FLIC Animator Animation (.flc and .fli) files.

The .flc and .fli file formats (FLIC) are used in Animator for the animation of 2D graphics, and developed by Autodesk. The formats are used in a variety of animation programs, computer games and CAD applications. FLIC formats do not support audio or video data, but instead store sequences of still image data.

The .flc file format adds configurable resolution and better compression than .fli.


Limitations

● Import is limited to the first frame only● The .fli format is older, and is limited to a resolution of 320×200

5.1.11 Graphics Interchange Format

You can view Graphics Interchange Format (.gif) files.

The .gif file format is an image standard on the World Wide Web, and was originally developed by CompuServe. The format includes compression, transparency, interlacing, and storage of multiple images within a single file which allows for a primitive form of animation.

5.1.12 JEDMICS C4 Compressed Image

You can view JEDMICS C4 Compressed Image (.c4) files.

These are raster (bitmap) image formats developed by the US DoD (Dept. of Defense) for military use.

The JEDMICS C4 compressed image file is very similar in structure to the TIFF 6.0 tiled file format and the TG4 file format. These three file formats differ only in the structure of the header and tile indices. All three file types use CCITT Group 4 encoding, and the structure of the compressed tiles is the same for all three.

Each .c4 image file is capable of storing a single black and white image. It has no capability to store color or grayscale information.

5.1.13 JPEG 2000 J2K and JPX

You can view JPEG (Joint Photographics Experts Group) 2000 (.j2k and .jpx) files.

The .j2k and .jpx file formats (J2K, JPX) are a part of the Joint Photographics Experts Group 2000 (JPEG 2000) committee standard designed to supersede the original JPEG standard. The JPEG 2000 standard makes use of new wavelet technology to allow better compression and lossless retention of images (without distortion or image integrity loss).

5.1.14 JPEG 2000 JP2

Use

You can view JPEG (Joint Photographics Experts Group) 2000 (.jp2) files. You can also save files to this format.



The .jp2 format is the most basic implementation of the JPEG 2000 standard, and contains only essential metadata such as color space information, which is required for accurate rendering. However, this standard features extensible architecture that allows more advanced file formats to be covered under the same implementation.

Features


Export Interface


Export as Grayscale Saves the file in 8-bit grayscale format. Otherwise, standard 24-bit full-color is used.

Lossy Compression Saves the file using lossy compression. Otherwise, lossless compression is used. Lossy (loss of data) compression can be used to compress .rh files; lossy compression treats two vertices that are sufficiently close to each other as one, resulting in a change in image size and quality.

Percentage File Size Determines the size at which to save the file as a percentage of the uncompressed image. A smaller file size results in a lower quality image and a larger size results in a higher quality image.

NoteFiles are saved at the smallest possible size. That is, if a file can be saved using lossless compression at a smaller file size than determined by the spinner.

5.1.15 JPEG 2000 JPC

Use

You can view JPEG (Joint Photographics Experts Group) 2000 JPC (.jpc) files. You can also save files to this format.

Features



Export Interface


Export as Grayscale Saves the file in 8-bit grayscale format. Otherwise, standard 24-bit full-color is used.

Lossy Compression Saves the file using lossy compression. Otherwise, lossless compression is used. Lossy (loss of data) compression can be used to compress .rh files; lossy compression treats two vertices that are sufficiently close to each other as one, resulting in a change in image size and quality.

Percentage File Size Determines the size at which to save the file as a percentage of the uncompressed image. A smaller file size results in a lower quality image and a larger size results in a higher quality image.

NoteFiles are saved at the smallest possible size. That is, if a file can be saved using lossless compression at a smaller file size than determined by the spinner.

5.1.16 JPEG Image

Use

You can import and view JPEG (Joint Photographics Experts Group) Image (.jpeg, .jpg) files. You can also save files to this format.

The .jpg and .jpeg formats were: developed by the Joint Photographics Experts Group (JPEG) committee. They are digital image formats that use compression algorithms defined in the JPEG standard ISO 10918. These formats are primarily used in graphics and image manipulation programs, and are a standard on the World Wide Web.

Features

This format contains both import and export options. You can use them to customize the way in which your file is opened and saved.

Import Interface




Apply ICC Color Management Indicates that ICC color management will be used

ICC Color Profile Selects a color profile to use

Rendering Intent Selects the type of rendering to be used

Color Profile Repository The location of the color profiles. The default path is C:\Windows\system32\spool\drivers\color.

Export Interface


Image Quality Determines the quality of the output image. A higher quality image results in a larger file size and a lower quality image results in a smaller size file.

Save ICC Color Management Info Saves any associated ICC color management information with the file

Overwrite DPI Overwrites the default DPI setting with the setting nominated in the DPI field

DPI The DPI setting to use for the exported file if Overwrite DPI is set to Yes.

This setting determines the resolution of the image or how many pixels are defined in the boundary of a square inch, when printing. This is expressed as dots per inch (DPI).

5.1.17 Maya Interchange File Format

Use

You can import, view, and save Maya Interchange File Format (.iff) files.

NoteThe Maya application must be installed for this functionality to be enabled.

Supported

● 1-24 bpp images


Features


Import and Export Interface


Detected Maya Installations Selects the version of Maya with which to import or export the file. This is active when more than one version of Maya is installed.

Maya Version Selects a specific version of Maya with which to import or export the file

5.1.18 OpenEXR Bitmap

Use

You can view OpenEXR Bitmap (.exr) files. You can also save files to this format.

The .exr format was developed by Industrial Light & Magic (ILM) for OpenEXR. OpenEXR is used by ILM on all motion pictures currently in production.

Supported

● 16-bit floating-point, 32-bit floating-point, and 32-bit integer pixels● Extensibility to include new compression codec and image types● High dynamic range image (HDRI) and color precision. Note that when you open a high dynamic range

image (HDRI), resolution controls are displayed in the Information bar. These allow you to modify the image.

● Multiple lossless image compression algorithms

Features


Export Interface




Compression Type Selects the type of compression to apply when saving the file

● None: Saves the file using no compression● Run-Length Encoding: Saves the file using a run length

encoding compression. Run-length encoding (RLE) is a very simple form of data compression in which repeated data (that is, sequences in which the same data value occurs many consecutive times, or in a run) are stored as a single data value and how many times it occurs.

● zlib Single Scan Lines: Saves the file using a zlib compression performed one scan line at a time

● zlib 16 Block Scan Lines: Saves the file using a zlib compression performed in blocks of 16 scan lines. This option is most effective with images that do not have film grain applied.

● Piz-based Wavelet: Saves the file using a combined wavelet / Huffman compression. This form of compression is quite effective when dealing with grainy images, and will often surpass any of the other options under grainy conditions.

● Lossy 24-bit Float Compression: Saves the file using lossy compression. Lossy compression treats two vertices that are sufficiently close to each other as one, resulting in a change of image size and quality.

Line Order Selects the order in which to perform the compression based on the first scan line

● Use Lowest Y Coordinate Scan Line: Begins the compression using the scan line with the lowest Y coordinate

● Use Highest Y Coordinate Scan Line: Begins the compression using the scan line with the highest Y coordinate

5.1.19 Portable Network Graphics

Use

You can view Portable Network Graphics (.png) files. You can also save files to this format.

The .png format was developed by the PNG Internet Group, and is a bit-mapped (raster) image file format. This file format is primarily used in graphics and image manipulation programs, and is a standard on the World Wide Web.


PNG is capable of storing up to 16-bits (grayscale) or 48-bits (true color) per pixel, and up to 16-bits of alpha data and supports the progressive display of image data and storage of gamma, transparency and textual information, using a lossless form of data compression.

Supported

● All subtypes

Features


Export Interface


Interlaced Sets the image to be downloaded using internet browsers in successive waves of bit streams, allowing the image to be viewed in low resolution until the missing lines arrive




5.1.20 Portable Pixelmap Graphic

You can view Portable Pixelmap Graphic (.ppm) files. You can also save files to this format.

The .ppm file format is a simple color graphics format and serves as the lowest common denominator for converting and exchanging graphics files between different platforms. It uses 24-bit per pixel, 8 for red: 8 for blue, and 8 for green. Unlike most graphics file formats, a .ppm file is plain text and can be processed with text processing tools. It is related to the PBM (black and white) and PGM (grayscale) graphics file formats.

This format is mainly available under UNIX and on Intel-based PCs.

5.1.21 Publisher's Paintbrush Bitmap Graphic

You can view Publisher’s Paintbrush Bitmap Graphic (.pcx) files.



The .pcx file format is a bitmap format developed by PC Paintbrush, and is used to store bitmap (raster) graphics on PCs. PCX can store mapped and unmapped image, supports 4-bit, 8-bit, and 24-bit graphics and can contain uncompressed or RLE compressed image data.

5.1.22 Radiance Picture Format

You can view Radiance Picture Format (.hdr) files.

The .hdr file format provides a high dynamic range image (HDRI) file format for use in the Radiance Software suite. It stores color values in four bytes: three for the red, green and blue color values and one as a common exponent.

NoteThe .hdr file format provides a high dynamic range image (HDRI) file format for use in the Radiance Software suite. It stores color values in four bytes: three for the red, green and blue color values and one as a common exponent.

5.1.23 Scalable Vector Graphics

You can view Scalable Vector Graphics (.svg) files. You can also save files to this format.

The .svg file format (Scalable Vector Graphics) is open source standard vector graphics language based on XML (Extensible Markup Language), developed by the World Wide Web Consortium (W3C). It is primarily used to design Web pages with high-resolution graphics including gradients, transparency, animation, and filter effects.

Supported

● Bezier splines, NURBS curve conversion and embedded fonts

NoteBezier splines improve the modeling of natural (and some human-made) objects.

5.1.24 Silicon Graphics Image

You can view Silicon Graphics Image (.rgb, .rgba, .int, .inta) files.

The .sgi file format is a generic bitmap format used for storing black-and-white, gray-scale, and color images developed at Silicon Graphics. SGI files include color .rgb (.rgb extension), color .rgb with alpha channel data (.rgba extension), and .int images.


Supported

● 8-32 bpp images● RLE or uncompressed

Limitations

● Color maps are not supported

5.1.25 SOFTIMAGE Picture

You can view SOFTIMAGE Picture (.pic) files.

The .pic format is: a bitmap (raster) image file developed by Softimage. The format originated under MS-DOS on Intel-based machines.

5.1.26 Tagged Image File Format

Use

You can import and view Tagged Image (.tif, .tiff) files. You can also save files to these formats.

The .tif and .tiff file formats, developed by Aldus and now controlled by Adobe, are the standard formats for high color depth (32-bit) graphics. They are highly compressed 2-bit formats that can render to a very high resolution; for example, 16,000 x 16,000, are widely used in image manipulation applications such as Photoshop, DTP, and scanning, and can be directly manipulated by PostScript. These formats include a number of options that can be used to indicate the simple geometry of the image, such as its size, but others define how the data is arranged and various image compression options.

Features

These formats contain both import and export options. You can use them to customize the way in which your file is opened and saved.

Import Interface




Apply ICC Color Management Indicates that ICC color management will be used

ICC Color Profile Selects a color profile to use

Rendering Intent Selects a type of rendering to use

Color Profile Repository The location of the color profiles. The default path is C:\Windows\system32\spool\drivers\color.

Export Interface


Always in Grayscale Saves the output image in grayscale

Save Multipage Saves multi-page TIFF files

Compression Determines the type of compression used to save the file

Save ICC Color Management Info Saves any associated ICC color management information with the file




5.1.27 TGA File

You can view TGA (Truevision Advanced Raster Graphics Adapter) (.tga) files. You can also save files to this format.

The .tga file format (TARGA) is one of the most widely used bitmap file formats for storage of 8 to 32-bit truecolor images and is developed by TrueVision.

Supported

● All subtypes● Alpha channel


● Color maps● Developer-definable data● Gamma value● Postage stamp image● RLE compression

5.1.28 Windows Bitmap Graphic

You can view Windows Bitmap Graphic (.bmp, .dib) files. You can also save files to these formats.

Windows Bitmap Graphic is the standard graphic file format for the Windows operating system and is developed by Microsoft. Most graphics and imaging applications support the creation and display of the .bmp format. The files contain either color or black-and-white bitmap (raster) data and the format was developed for storing bitmap files in a device-independent bitmap (DIB) format allowing display on any type of display device.

The Device Independent Bitmap (DIB) is the format used to store bitmaps in .bmp files. However, you are able save DIB files to memory.

These files exist in two different formats:

● OS/2 Format. BMP is the native bitmap file format of OS/2● Windows Format

Supported

● Windows and OS/2● 1/8/16/24/32 bpp● RLE and uncompressed

5.1.29 Windows Cursor File

You can view Windows Cursor File (.cur) files.

5.1.30 Windows Icon File

You can view Windows Icon File (.ico) files.



5.1.31 Windows Metafile

You can view Microsoft Windows Metafile format (.wmf) files.

The .wmf file format (WMF) is used to store vector and bitmap-format image data. WMF is the native vector file format for the Microsoft Windows operating environment. These files are actually a collection of GDI (Graphics Device Interface) function calls also native to the Windows environment. When a file is played back, (typically using the Windows PlayMetaFile function), the graphics are rendered. WMF files are device-independent and have no limit to their size.

5.1.32 Windows Run Length Encoded Bitmap

You can view Windows Run Length Encoded Bitmap (.rle) files.

The .rle file format (Windows RLE Bitmap) is developed by Microsoft and used for compressing run-length encoded (RLE) bitmaps. The format uses 4 bits per pixel and 8 bits per pixel, and the compression reduces the disk and memory storage required for a bitmap.

5.2 3D File Formats

The following 3D file formats are supported by SAP 3D Visual Enterprise Author and SAP 3D Visual Enterprise Generator, unless otherwise indicated. This list is organized alphabetically by file format.



AOFF File Format [page 653] GEO N/A

Autodesk 3D Studio [page 674] 3DS N/A

ASC NoteThis file format is not supported in SAP 3D Visual Enterprise Generator

ASE NoteThis file format is not supported in SAP 3D Visual Enterprise Generator





Autodesk 3D Studio Project [page 676] PRJ N/A

Autodesk FBX [page 677] FBX N/A

Caligari trueSpace Object [page 678] COB N/A

Caligari trueSpace Scene [page 679] SCN N/A

CINEMA 4D [page 680] C4D N/A

COLLADA [page 681] DAE N/A

DirectX Model [page 682] X N/A

Gerber File [page 684] GBR, GBP, GPT, GTL, GTO, GTS, GKO, GBL

All versions supported

Hewlett-Packard Graphics Library [page 686]

HPGL, PLT N/A

Imagine Geometry [page 686] IOB N/A

ISO G Code Format [page 686] ISO, NC N/A

LightWave 3D and Binary Object [page 687]

LWO, LW N/A

LightWave Scene [page 689] LWS N/A

MAX Requires 3ds Max and the DCOM plug-in to be installed in order to use with SAP 3D Visual Enterprise Author

NoteThis file format is not supported in SAP 3D Visual Enterprise Generator

Maya ASCII Scene [page 691] MA Requires Maya to be installed

Maya Binary Scene [page 693] MB Requires Maya to be installed

Object File Format Vector Graphics [page 696]

OFF N/A

Open Inventor File [page 696] IV N/A

OpenFlight Scene Description Database [page 697]

FLT Import: Multigen API DLLs not required.




Points File [page 699] PTS N/A

Polygon Model Format [page 699] PLY N/A

Portable Graymap Heightfield [page 700] PGM 16–bit

POV-Ray RAW Triangle [page 700] RAW N/A

Power Render Object [page 701] PRO N/A

Protein Data Bank [page 701] PDB Medical file format

Rhinoceros 3D Model [page 705] 3DM No support for 3DM files generated using Chem3D

SAP 3D Visual Enterprise Binary [page 707]

RH N/A

Silo3D [page 710] SIA N/A

SketchUp Document [page 711] SKP N/A

SOFTIMAGE|XSI [page 712] XSI N/A

Stereolithography Rapid Prototyping Data [page 715]

STL N/A

Universal 3D [page 716] U3D N/A

Visual Design Stream [page 720] VDS N/A

Visual XML [page 724] VZXML, RHZ N/A

VRML Worlds [page 726] WRL, VRML N/A

Wavefront Object [page 730] OBJ N/A

XAML [page 728] XAML N/A

5.2.1 AOFF File Format

You can save files to the AOFF (.geo) files, with or without process control.

The .geo file format is similar to.off files except that there is no header in .off files, and the points are numbered with 1, instead of 0.


5.2.2 AutoCAD Design Web Format

Use

You can import and view AutoCAD Design Web Format (.dwf) files. You can also save files to this format.

The .dwf format is a binary file used by AutoDesk AutoCAD for publishing models and drawings on the Internet. It is a package file format (based on .zip) and can contain either 2D or 3D files along with resources such as texture maps and BOM/object manifests.

2D files are stored internally as .w2d files, and contain vector-based description of drawings and illustrations. It is common for there to be more than one.w2d page in a .dwf file. 3D files are stored internally as .w3d files (based on the Hoops Stream Format). Currently the only producers of these files (AutoCAD products) store only .w3d per .dwf file.

Because .dwf files are highly compressed, they are smaller and faster to transmit than design files, without the overhead associated with typical CAD drawings (or the management of external links and dependencies). Publishers of design data can select the specific design data and plot styles they want recipients to see, and can publish multi-sheet drawing sets from multiple .dwg source files into a single .dwf file. They can also publish 3D models from nearly every AutoDesk design application.

Supported

● Cameras

Export Limitations

● Exporting 2D-multi page or 3D single page● Export of callouts and sprites● Cameras

Features


Import Interface


Import Pages Determines whether one or all pages are imported for multi-page files

● All: Imports each page as a model view● First: Imports only the first page




Show Paper in 2D Views Determines whether a paper object is created for the scene for 2D pages. Paper objects are similar to the SAP 3D Visual Enterprise Author grid.

● Always: Always creates a paper object according to the paper size specified in the file

● Never: Does not create a paper object● By file: Creates a paper object if the paper is visible in

the file

Import True Type Fonts as Determines the way in which TrueType fonts are imported

● Polygons: Imports fonts as tessellated polygons (solid fill)

● Outlines: Imports fonts as polylines (contours). This is the fastest method for importing text

● Character Primitives: Imports fonts as character primitives. These are able to be edited in the same way as a normal primitive. This is the slowest method for importing text. As each character is a separate object, any editing may take time.

Import Edges Determines whether edges are imported

Export Interface


Mode The method used to export the file

Auto-Select Saves multi-page or obviously 2D files (flat, viewed orthogonally from top) as a 2D file. Otherwise, exports the file as a 3D file.

3D Model Saves the first model view, (or active view if there are no model views), as the 3D file

5.2.3 AutoCAD Drawing Files (.dxf, .dwg, .dst)

You can import, view, and save AutoCAD drawing and sheet set files.


AutoCAD Plug-In Font Search Process for .dxf and .dwg Files

When the AutoCAD plug-in is about to render text, it performs the following searches for an appropriate font file until it is found:

1. The plug-in attempts to locate an AutoCAD Compiled Shape (.shx) font file containing the desired font in the following locations1. The AutoCAD Fonts folder; for example, C:\Program Files\Autodesk\AutoCAD 2013\Fonts2. The AutoCAD Support folder; for example. C:\Program Files\Autodesk\AutoCAD

2013\Support3. The AutoCAD-specific section of the roaming user data folder; for example, C:\Users\<username>

\AppData\Roaming\Autodesk\AutoCAD 2013 English\R19.0\enu\Support2. The plug-in searches for the same font as an AutoCAD Shape file (.shp) in the same locations as above.3. The plug-in attempts to find a matching TrueType font file (.ttf) in the Windows Fonts folder.4. If all else fails, the plug-in uses a default font to render text.

Note● Steps 1. and 2. work only if any version of AutoCAD or AutoCAD LT is installed on your machine● The exact type of the default font depends on many factors. These include, but are not limited to, the

import options being used, OS version, and the current locale settings● If Sandbox is on, it may prevent the plug-in from accessing AutoCAD Compiled Shape (.shx) font files

in the AutoCAD Fonts and/or Support folders (in steps 1./a. and 1./b.). As a workaround, to ensure that access is granted to these locations, add the paths to these folders to the CAD search paths, for example:

Folder Path and Name Sub Folders

C:\Program Files\Autodesk\AutoCAD 2013\Fonts .

C:\Program Files\Autodesk\AutoCAD 2013\Support Recursive

General Limitations

● Solid data and NURBS information not supported● Tessellation control not supported● Animation not supported● BOM support based on part names not supported● Textures and UV mapping not supported● Configurations not supported● Not supported in VZXML. The AutoCAD plug-in produces too many scene artifacts; for example, missing

paper space.● If AutoCAD is not installed on the host machine or the referenced font is not available, text will not look

same as AutoCAD, as the importer will use the closest available matching font.



● Known issues with the export of both .dxf and .dwg files.

5.2.3.1 AutoCAD Drawing Interchange

Use

You can import and view AutoCAD Drawing Interchange (.dxf) files. You can also save files to this format.

This format enables the interchange of drawings between AutoCAD and other programs. They can be in either ASCII or binary format, both of which contain a complete description of the AutoCAD drawing. DXF files contain a number of entities such as curves, lines, solids, and polygons. The entities are read from within the file and are then created as objects.

Supported for Import● Layouts imported as model views:

○ At least one layout (Model) is imported○ Empty paper-space layouts are ignored

● Named views, if any present in the file, imported as model views● Block hierarchy imported as nodes● Block attributes imported as node metadata● Drawing attributes imported as scene metadata● Layers, can be seen in the Layers panel:

○ Frozen layers are ignored● Cameras● 2D and 3D entities and geometry:

○ Geometry representation of entities read as meshes or 3D polylines○ Solids imported as meshes○ Dimensions and leaders, imported as 3D polylines○ Text imported either as native text primitives or geometry. If text is imported as geometry, type (mesh

or 3D polyline) depends on the type of the font being used.● Colors and materials:

○ Entities can use indexed or true color.○ Entities can have materials with values such as specular, reflection, and opacity.○ Materials can be either attached to entities or attached to layers. For example, if a material called

WOOD is attached to entity A, entity A has the WOOD material. Or, if the WOOD material is attached to Layer 1, all the entities under Layer 1 have that WOOD material.

Supported for Export● Each object saved as a separate block.● Materials converted to layers.● Diffuse material color used as layer color number.● The default “INSERT” used to represent hierarchical information in scene.● Meshes and 2D vector data (text, dimensions).● Cameras.


● Parts information.● Assembly hierarchy information.

Features




Import Interface


General Defines the common settings

● Import Layouts: Defines the layouts to import○ All: Imports all layouts (both model- and paper-

space), and makes the last used one active○ Active Only: Imports only the last used layout.○ Model Only: Imports only the model-space layout

(Model).○ Paper Only: Imports only the paper-space layouts.

● Import Layers: Defines the layers to import○ All: Imports all layers○ Visible Only: Imports only the visible layers in each

layout.

NoteEntities on invisible layers are not available using this option.

● Import Metadata: Defines the attributes to import○ None: No attribute is imported○ All: All attributes are imported

● Import Text as: Determines the way in which text is imported○ Automatic: Imports text automatically, using de

faults○ Character Primitives: Imports text as native text

primitives○ Geometry: Imports text either as polyline or poly

gon mesh, depending on the type of the font. This option increases import time and memory usage.

NoteThis option does not allow editing of imported text.

● Import Line Patterns as: Determines the way in which noncontinuous lines are imported○ Line Material: Attempts to load lines with simple

styles; for example, dashed, as polylines with the style attributes stored in their associated material. Lines with complex styles are imported as geometry.



NoteThis option is less accurate but assists in reducing memory usage and import time.

○ Geometry: Imports all lines as polylines without storing style attributes. This setting includes lines with simple styles in addition to the more complex styles.

NoteThis option more accurately represents the original data, however, it increases memory usage and import time.

● Allow Font Substitution: If enabled, missing SHX fonts are substituted with matching TrueType fonts. Font substitution reduces overall CGM file size, but in some cases, substitution may not be an exact match.

● Collapse Objects: Groups similar objects together based on their type and associated layer

NoteThis option can simplify the model hierarchy as well as reducing memory usage, but may increase import time. In addition, the individual members of a group cannot be edited separately.

● Normalize Scene: Scales small objects to reduce the display of geometric artifacts and minimize floating point errors. Normalizing is helpful when a model is tiny or huge, or when the polygon reduction process is slow.




Model Layout Determines the way in which objects are imported and displayed in a model-space layout

● Geometry Import Preference: Determines the way in which the geometry of solid or surface mesh objects is displayed in model-space layouts. Note that this option does not affect the way in which wireframe geometry is displayed.○ As Saved: Uses the original display style○ Prefer Outlines: Displays objects with their outline

only○ Prefer Solids: Displays objects as solids or surfaces○ Prefer Solids with Outlines: Displays objects as sol

ids or surfaces with their outlines highlighted● Initial Zoom: Sets how the model is initially displayed af

ter import○ As Saved: Uses original camera position and zoom

factor○ To Model Extents: Positions the model to the mid

dle of the viewport and zooms the current model to its extents in the viewport so that it fully fills it

● Background Color Preference: Uses a different color palette for displaying entities with indexed colors, depending on whether the background is dark or light.

NoteThis option only functions for objects that use indexed colors, and does not affect entities with true colors. These objects always retain their color regardless of the color of the background.

○ Prefer Dark: Displays the model with a dark (black) background and light foreground colors

○ Prefer Light: Displays the model with a light (white) background and dark foreground colors

○ Use Custom: Displays the model with a user-defined background color. The color of foreground entities depends on the shade of the background color

● Custom Background Color: Sets a user-defined background color. This option only functions if the option Use Custom is effective



Paper Layouts Determines the way in which objects are imported and displayed in paper-space layouts

● Geometry Import Preference: Determines the way in which the geometry of solid or surface mesh objects is displayed in paper-space layouts. Note that this option does not affect the way in which wireframe geometry is displayed.○ As Saved: Uses the original display style○ Prefer Outlines: Displays objects with their outline


ids or surfaces with their outlines highlighted

Geometry Transformation Transforms (rotate, position, and scale) the scene along the X, Y, and Z axes:

● Rotation: Sets the degrees of rotation around each axis from 0 degrees to 360 degrees. The rotation values can be entered with up to 6 decimal places.

● Scale: Scales the object along the X, Y, and Z axes● Position: Sets the position of the scene along the X, Y,

and Z axes

Export Interface


Output Format Establishes the format in which to export the file. You have the option of .dxf or .dxf binary formats.

Output Version Establishes the version of AutoCAD in which to export the file

5.2.3.2 AutoCAD Drawing Object

Use

You can import and view AutoCAD Drawing Object (.dwg) files. You can also save files to this format.

AutoCAD Drawing Object is a binary format only and is the principle data exchange format used by AutoCAD. It contains a complete description of the AutoCAD drawing, including the model and layouts, viewports and layers. A .dwg file contains a number of entities representing the model geometry such as curves, lines, solids,



polygons, and blocks that form a model hierarchy. All this information is read from the file and used to construct a scene that matches the original drawing as closely as possible.

Supported

● Layouts imported as model views○ At least one layout (Model) is imported○ Empty paper-space layouts are ignored

● Named views, if any present in the file, imported as model views● Block hierarchy imported as nodes● Block attributes imported as node metadata● Drawing attributes imported as scene metadata● Layers can be seen in the Layers panel

○ Frozen layers are ignored● Cameras● XRefs● Parts data● 2D and 3D entities and geometry

○ Geometry representation of entities read as meshes or 3D polylines○ Solids imported as meshes○ Dimensions and leaders imported as 3D polylines○ Text imported as either native text primitives or geometry. If text is imported as geometry, type (mesh

or 3D polyline) depends on the type of the font being used.● Colors and materials

○ Entities can use indexed or true color○ Entities can have materials assigned with various attributes such as specular highlight, reflection, and

opacity○ Materials can be either attached to entities or attached to layers. For example, if a material called

WOOD is attached to entity A, entity A has the WOOD material. Or, if the WOOD material is attached to Layer 1, all the entities under Layer 1 have that WOOD material.

Limitations

● Animation● BOM support based on part names● Configurations● NURBS and Solids● Tessellation control● Textures● UV coordinates

Features



Import Interface



● Import Layouts: Defines the layouts to import○ All: Imports all layouts (both model- and paper-

space), and makes the last used one active○ Active Only: Imports last used layout only○ Model Only: Imports only the model-space layout

(Model)○ Paper Only: Imports only the paper-space layouts○ Specified Only: Imports only the layouts specified

in the Layout Name Filter field● Layout Name Filter: Defines a list of layouts to include

during import. List items are separated by commas.

NoteThis field is only available when Import Layouts is set to Specified Only.


layout

NoteEntities on invisible layers are not available using this option.

○ Specified Only: Imports only the layers specified in the Layer Name Filter field

○ Unspecified Only: Excludes only the layers specified in the Layer Name Filter field

● Layer Name Filter: Defines a list of layers to include or exclude during import. List items are separated by commas.

NoteThis field is only available when Import Layers is set to Specified Only or Unpecified Only.

● Import Metadata: Defines the attributes to import○ None: No attribute is imported○ All: All attributes are imported○ Specified Only: Imports only attributes with the

tags specified in the Metadata Name Filter field




● Metadata Name Filter: Defines a list of attributes with the specified tags to include during import. List items are separated by whitespaces..

● Import Text As: Determines the way in which text is imported○ Automatic: Conversion provides best quality de

pending on type of font. For more information, see Font Conversion Rules.

○ Geometry: Imports text either as polyline or polygon mesh, depending on the type of the font. This option increases import time and memory usage.


○ Character Primitives: Imports text as native text primitives

● Import Line Patterns As: Determines the way in which noncontinuous lines are imported○ Line Material: Attempts to load lines with simple










● Normalize Scene: Scales small objects to reduce the display of geometric artifacts and minimize floating point errors. Normalizing is helpful when a model is tiny or huge, or when the polygon reduction process is slow.

● Use Geometry Primitives: If this option is set to Yes, the fields Import Line Patterns and Geometry Import Preference are disabled and Import Line Patterns is by default, Prefer Line Material. Geometry Import Preference defaults to As Saved.




Model Layout Determines the way in which objects are imported and displayed in a model-space layout

● Geometry Import Preference: Determines the way in which the geometry of solid or surface mesh objects is displayed in model-space layouts. Note that this option does not affect the way in which wireframe geometry is displayed.○ As Saved: Uses the original display style○ Prefer Outlines: Displays objects with their outline


ids or surfaces with their outlines highlighted● Import Named Views: If any exist, imports named

model-space layouts in addition to the default one● Initial Zoom: Sets how the model is initially displayed af

ter import○ As Saved: Uses original camera position and zoom

factor○ To Model Extents: Positions the model to the mid

dle of the viewport and zooms the current model to its extents in the viewport so that it fully fills it

○ Fit to Page: Positions the model to the middle of the viewport and zooms to fit the page

● Background Color Preference: Uses a different color palette for displaying entities with indexed colors, depending on whether the background is dark or light

NoteThis option only functions for entities that use indexed colors, and does not affect entities with true colors. These entities always retain their color regardless of the color of the background.

○ Prefer Dark: Displays the model with a dark (black) background and light foreground colors

○ Prefer Light: Displays the model with a light (white) background and dark foreground colors

○ Use Custom: Displays the model with a user-defined background color. The color of foreground entities depends on the shade of the background color

● Custom Background Color: Sets a user-defined background color. This option only functions if the option Use Custom is effective









● Scale: Scales the object along the X, Y, and Z axes● Position: Sets the position of the scene along the X, Y,

and Z axes




Floor Plan Conversion Defines the settings for floor plan conversion

● Enable Floor Plan Conversion: If this information is present in the file, Floor Plan Conversion converts room layouts, on the active (last used) layout into hotspots. Room attributes are assigned as hotspot metadata.If set to Yes, Floor Plan Conversion is enabled.

NoteThe following fields are available only if Floor Plan Conversion is enabled. The Room Outline Layers field is mandatory, and the others are optional. If any of the named layers does not exist in the file (optional or mandatory), loading stops with an error.

CautionFloor Plan Conversion only converts rooms on the active layout, so you must ensure that the active layout is not excluded during import. For more information, see Import Layouts. As a best practice, for the Floor Plan Conversion workflow, set Import Layouts to Active Only to ensure that the active layout is loaded and other layouts are excluded. If the active layout is filtered out, loading stops with an error.

● Room Outline Layers: Defines a list of layers from which to collect room outlines. List items are separated by commas.

NoteThis field is required if Floor Plan Conversion is enabled.

CautionYou must ensure that the required room outline layers are not excluded during import. For more information, see Import Layers. If any of the room outline layers is filtered out, loading stops with an error.

● Load Room Attributes from: Defines from where to load room attributes. If set to Specified Layers, room attributes are loaded from the layers specified in the following field. Otherwise room attributes are collected



from the same room drawing block or AEC space object that defines the room outline.

NoteThis field is used only when room outlines and their corresponding attributes are defined on separate layers in the drawing. The field is not used when:○ the drawing is an architectural drawing and

rooms are defined as AEC space objects○ the same drawing blocks contain both the out

lines and the attributes for the rooms

● Room Attribute Layers: Defines a list of layers from which to collect room attributes. List items are separated by commas.

NoteThis field is only available when Load Room Attributes from is set to Specified Layers.

● Display Room Attributes: Imports and displays room attributes additionally as text.

NoteBy default, room attributes are imported as hotspot metadata only and prevented from being imported as text to reduce memory usage and import time.

● Title Block Layer: Defines the layer from which to collect title block information. Attributes from the title block are imported as scene metadata.

● Room Area Unit: Controls the unit in which the room area for hotspots is calculated. The calculated room area and the room area unit are stored as metadata, with the keys VE_AREA and VE_AREA_UNIT respectively, for each converted hotspot.○ As Saved: If the file is an architectural drawing,

uses the area unit set up in the drawing. Otherwise, calculates room area unit automatically derived from the drawing unit. If the derived area unit is not any of the following units, the best matching area unit is used, honoring metric or imperial settings.

○ Square meters [sq m]: Calculates room area in square meters.

○ Square feet [sq ft]: Calculates room area in square feet.




○ Square millimeters [sq mm]: Calculates room area in square millimeters.

○ Square centimeters [sq cm]: Calculates room area in square centimeters.

○ Square decimeters [sq dm]: Calculates room area in square decimeters.

○ Square kilometers [sq km]: Calculates room area in square kilometers.

○ Square inches [sq in]: Calculates room area in square inches.

○ Square yards [sq yd]: Calculates room area in square yards.

○ Square miles [sq mi]: Calculates room area in square miles.

○ Ares [a]: Calculates room area in ares.○ Hectares [ha]: Calculates room area in hectares.○ Acres [acre]: Calculates room area in acres.

Export Interface


Output Version Establishes the version of AutoCAD in which to export the file

SHX Font Conversion Rules for AutoCAD DrawingsIf SHX fonts are found on the local machine, the following conversion rules are applied:

● If all the characters found in SHX font, use specified SHX font and vectorize to polylines● If there are missing characters in local SHX font, use the following rules:

○ If font substitution is disallowed (default), use specified SHX font and vectorize to polylines. Note that there are surrogate characters.

○ If font substitution is allowed, use fallback TrueType font and create text primitive

If SHX fonts are not found on the local machine, the system uses the corresponding TrueType font and the following conversion rules are applied:

● If corresponding TrueType font found, use corresponding TrueType font and create text primitive● If corresponding TrueType font not found, use SHX fallback font and vectorize to polylines. Note that there

may be surrogate chars.

TrueType Font Conversion Rules for AutoCAD DrawingsIf an AutoCAD drawing contains a TrueType font, use the specified TrueType font and create a text primitive.

NoteIf the requested TrueType font does not exist or there are missing character glyphs, Windows font linking and font mapping mechanisms are used to find an appropriate substitute.


5.2.3.3 AutoCAD Sheet Set File

Use

You can import and view AutoCAD Sheet Set (.dst) files.

The Sheet Set format was introduced with AutoCAD 2005.

Features

This format contains import options. You can use them to customize the way in which your file is opened.

Import Interface






layout

NoteEntities on invisible layers are not available using this option

● Import Metadata: Defines the attributes to import:○ None: No attribute is imported○ All: All attributes are imported

● Import Text as: Determines the way in which text is imported○ Automatic: Imports text automatically, using de

faults○ Geometry: Imports text either as polyline or poly

gon mesh, depending on the type of the font. This option increases import time and memory usage.


○ Character Primitives: Imports text as native text primitives

● Import Line Patterns as: Determines the way in which noncontinuous lines are imported○ Line Material: Attempts to load lines with simple














5.2.4 Autodesk 3D Studio

Use

You can import and view Autodesk 3D Studio (.3ds) files.

This is the native format for Autodesk’s 3ds Max application. 3ds Max is a 3D modeling, animation, and rendering solution used to create 3D animation for game development, design visualization, feature film and television effects, and education. Additionally, it is the industry standard for transferring models between 3D programs, or for storing models for 3D resource catalogs.

X-Axis Transformation



Autodesk 3D Studio files may have had an X-axis mirror transform applied to objects in 3ds Max. This is called “bad parity”; a term used by the company that created the .3ds file format, Discreet. Failure to detect this transformation means that objects may appear in the wrong position within a scene when you import a file.

The Import Properties window includes an option to fix objects with bad parity (mirror transforms); this is selected by default for all .3ds files.

Texture Paths

Autodesk 3D Studio files have a very limited capability to store texture paths (only eight characters). Therefore, if you have a 3D object in another format with long texture path-names, converting it to .3ds makes the textures disappear. To resolve this, you must move all textures to the directory that contains the model.

For example, a Maya file stored in C:\Documents and Settings\[user name]\My Documents\maya\projects\default\scenes would have textures stored in C:\Documents and Settings\[user name]\My Documents\maya\projects\default\images. If this Maya file was converted to a .3ds file, the texture paths would be lost as they are greater than eight characters.

Supported for Import

● 3D objects (mesh): name, top, side, local matrix, texture coordinates, and any materials used● Animation● All other information excluded from import● Cameras● Light sources● Materials: name, diffuse color, specular color, ambient color, texture map names● Only 8 character texture paths supported

Supported for Export

● Animation● All textures converted to 2D bitmap formats● Splitting into sub-objects if an object contains more than 65535 polygons, vertices, and texture

coordinates● Only 8 character texture paths supported● Scenes saved as smoothed triangle meshes● Texture coordinates saved along with the triangular meshes if texture data exists

Features


Import Interface


Import Keyframe Data Imports keyframe animation data



Import Animation Imports the file’s animation

Repair Mirror Transformed Objects Repairs object data that have bad parity. That is, files that have had an X-axis mirror transform applied to objects in 3ds Max. We recommend leaving this option selected, and only disable it if your scene contains animated objects which appear incorrectly positioned when any bad parity is corrected.

Export Interface


Texture Coordinates Saves the texture coordinates (u,v) that are assigned to the polygon’s vertices

Remove UV Scale and Offset from Materials Removes the Offset U and V settings and sets the Scale U and V settings to 1

Export Hierarchy Information Saves the hierarchical relationships in the file

Export Smooth Groups Data Creates and saves smoothing groups in the file. That is, the objects do not appear faceted when rendered

Export Local Matrix Saves transformation and identity matrices for the object

Export Lights Saves the light objects in the file

Export Cameras Saves the camera objects in the file

Export Default Camera Saves the default camera in the file

5.2.5 Autodesk 3D Studio Project

Use

You can import and view Autodesk 3D Studio Project (.prj) files.

The .prj file format is used by Autodesk’s 3ds Max application for Project data.

Features




Import Interface


Import Keyframe Data Imports keyframe animation data

Import Animation Imports the file’s animation

Repair Mirror Transformed Objects Repairs object data that have bad parity. That is, files that have had an X-axis mirror transform applied to objects in 3ds Max. We recommend leaving this option selected, and only disable it if your scene contains animated objects which appear incorrectly positioned when any bad parity is corrected.

5.2.6 Autodesk FBX

You can import and view Autodesk FiLMBOX (.fbx) files. You can also save files to this format.

Supported

● Meshes● Texture and material mapping over a mesh● Normals and vertex colors● Multiple cameras● Multiple lights and gobos● Skeletons● Multiple takes of animation● Global camera, light, and time settings

Limitations

● NURBS and patches converted to mesh on import or export● Any type of constraints● Camera switcher not supported● Markers not supported● Bind and rest poses for a list of nodes (bones, mesh, NURBs, patches)


5.2.7 Caligari trueSpace Object

Use

You can import and view Caligari trueSpace Object (.cob) files (both ASCII and binary). You can also save files to this format.

The .cob file format is a 3D object format generated by trueSpace, a 3D design package from Caligari Corporation. trueSpace has become the 3D design program of choice for artists who are creating complex new objects and avatars for use in Active Worlds.

Both ASCII and binary formats encode the same information and have the same general layout. ASCII files are edited in a text editor while binary files are smaller and faster for programs to load and save.


● Binary and ASCII with animation support● Cameras● The following chunks are read: POLH, GROU, MAT1, Mbal, Nurb, NMes, Lght, Came, Chan, Hidn, Vews,

ROpt


● All geometry and material attributes● Binary and ASCII with animation support● Textures are exported to the selected file type● trueSpace versions 3.0 and 4.0

Features


Import Interface


Join Equal Materials Only unique materials are created, and any redundant materials are removed. All objects pointing to any removed materials are repointed to a new, unique material definition. A unique material definition is useful when importing Caligari files, as trueSpace assigns a different material definition to each and every object, even if the materials use the same parameters.

Import Animation Imports the animation sequence from the trueSpace file



Export Interface


ASCII mode Saves an ASCII .cob file. Otherwise, a binary .cob file is saved.

NoteThe binary file is significantly smaller than the ASCII file.

Rescale Establishes whether to rescale the model

● Rescale: Rescales the model to the value entered in the Percent of Workplace field

● Percent of Workplace: Determines the percentage of the trueSpace workplace to which to rescale the model.

NoteWe recommend using the Fit to option in the Geometry Transform tab to rescale the model, rather than this option. Note that the Geometry Transform tab applies only to SAP 3D Visual Enterprise Author.

Move Object Axis to Object Center Moves the axis to the center of each object

5.2.8 Caligari trueSpace Scene

Use

You can import and view Caligari trueSpace Scene (.scn) files.

This is a format developed by Caligari trueSpace. Both ASCII and binary formats encode the same information and have the same general layout. ASCII files are edited in a text editor while binary files are smaller and faster for programs to load and save.

Supported

● Binary and ASCII with animation support● Cameras● The following chunks are read: POLH, GROU, MAT1, Mbal, Nurb, NMes, Lght, Came, Chan, Hidn, Vews,

ROpt

Features



Import Interface


Join Equal Materials Only unique materials are created, and any redundant materials are removed. All objects pointing to any removed materials are re-pointed to a new, unique material definition. This is useful when importing Caligari files, as trueSpace assigns a different material definition to each and every object, even if the materials use the same parameters.

Import Animation Imports the animation sequence from the trueSpace file

5.2.9 CINEMA 4D

You can view CINEMA 4D (.c4d) files.

This is the native file format for the CINEMA 4D application developed by MAXON.

The original scene hierarchy is completely recreated, including all groupings and their related transformations.

Supported

● Meshes and hierarchy● Materials● Textures● Animation (POS/ROT/SCALE)● Procedural objects (basic set)● Cameras● Lights● Geometry normals

Limitations

● Subdivisions only triangulated (polygon cache can be used)● Skeletal animation not supported● NURBS not supported



5.2.10 COLLADA

Use

You can import and view COLLADA (.dae) files. You can also save files to this format.


● Mesh

● Materials● Lights● UV texture mapping● Cameras● Animation (translate and rotate only)

Limitations for Import

● Support for skin and bone animation● Support for skin & bone animation● Mapping of camera parameters between COLLADA and SAP 3D Visual Enterprise Author not direct

Limitations for Export

● Support for skin and bone animation● Support for skin and bone animation● Mapping of camera parameters between COLLADA and SAP 3D Visual Enterprise Author not direct● No tessellation control● No assembly hierarchy support● No BOM support based on part names● Import/export of simple animated scaling not supported● Files greater than 2MB in size lose geometry or show rogue facets, mainly with models greater than 22K

facets● Image files present within .rh files not exported to the .dae file format

Features


Import Interface


Join Equal Materials Multiple vertices with identical coordinates are replaced with a single instance in the data-set, removing redundancy



Remove Duplicate Material Multiple identical instances of a material are replaced in the Scene Tree with a single instance

5.2.11 DirectX Model

Use

You can import and view Direct X Model (.x) files. You can also save files to this format.

The .x format provides a rich, template-driven format that enables the storage of meshes, textures, animations, and user-definable objects. Hierarchies are used to express relationships between data records.

This format is used natively by the Microsoft Direct3D Retained Mode API, providing support for reading predefined objects into the application or for writing mesh information constructed by the application in real time. It provides low-level data primitives upon which applications define higher-level primitives through templates. This is the method by which Direct3D Retained Mode defines higher-level primitives such as vectors, meshes, matrices, and colors.


● Binary and ASCII with animation● Instancing and hierarchies. Instancing enables multiple references to an object, such as a mesh, while

storing its data only once per file● Support for animation sets enables you to store predefined paths for playback in real time● Importing of all templates defined in version 1 of the format


● Compressed files not supported● Progressive meshes not supported


● Binary and ASCII with animation

Features


Import Interface




Import Animation Data Imports all animation data from the DirectX file

Use DirectX Camera Position Uses the DirectX camera position instead of the default camera position

Join Equal Materials Joins all materials that are identical. For example, if a file contains two identical materials (or mapped images), when this option is checked, then only one material is imported.

Optimize Vertices Reduces the number of vertices in the model by merging all vertices that have equal X, Y, Z coordinates

Optimize Texture Points Reduces the number of texture points in the model by ignoring duplicated texture points

Flip Coordinate System Rotates the model so it uses a right-hand coordinate system. That is, it flips the Y and Z axes.

Import Skins Imports all object skins

Optimize Hierarchy Reduces the number of coordinates in the array of per vertex normals

Treat Fully Transparent Materials as Opaque Displays materials with zero opacity values; that is, materials that are fully transparent. This is checked by default.

Export Interface



Common Establishes general settings

● ASCII Mode: Saves the model in ASCII mode. Otherwise, the model is saved in binary mode.

● Export Materials: Saves the mesh object’s material attributes in the file. These are exported using the DirectX MeshMaterialList structure.

● Export Templates: Saves templates in the file. A template is used to establish how the data stream is interpreted by the next application to view the file.

● Add Top Level Frame: Adds a single frame if more than one frame is without a parent object

● Flip Coordinate System: Rotates the model so it uses a left-hand coordinate system. That is, it flips the Y and Z axes.

● Export Skins: Saves all model skins in the file● Export Empty Bones: Saves the empty bones in the file● Export Bones without Meshes: Exports the bone objects

excluding meshes● Export Empty Nodes: Saves the empty node in the file● Maximum Object Name: Specifies the maximum num

ber of characters in the object names

Geometry Establishes geometry settings

● Export Normals: Saves face vertex normals in the file. They are exported using the DirectX MeshNormals structure.

● Invert Normals: Inverts the direction of each vertex normal so that each normal points in the opposite direction

● Texture Coordinates: Exports face vertex (u,v) texture coordinates. These are exported using the DirectX MeshTextureCoords structure.

● Maximum Vertices in Polygon: Determines the maximum number of vertices in each polygon in the file

5.2.12 Gerber File

Use

You can import and view Gerber (.gbr, .gbp, .gpt, .gtl, .gto, .gts, .gko, .gbl) files.

A Gerber file is a standard file format used by printed circuit board (PCB) fabrication houses that contains data necessary for computer controlled machines to draw exact patterns for circuit boards. These patterns are typically used to electrically connect components in electronics assemblies. The patterns usually contain



features such as land patterns, signal traces, drilled holes, milling and cutting information. The Gerber Format was originally a subset of EIA RS-274-D. Later, the format was extended by the so called “Mass Parameters”, and was then also called RS-274-X.

Some common XGerber extensions are:

Extension File Type

GBL Gerber Bottom Layer

GTL Gerber Top Layer

GBS Gerber Bottom Solder Resist

GTS Gerber Top Solder Resist

GBO Gerber Bottom Overlay

GTO Gerber Top Overlay

GBP Gerber Bottom Paste

GTP Gerber Top Paste

GKO Gerber Keep-Out Layer

GM1 Gerber Mechanical 1

GM2 Gerber Mechanical 2

GPT Gerber Top Pad Master

GPB Gerber Bottom Pad Master

Features


Import Interface


Flip Horizontally Flips the scene horizontally

Flip Vertically Flips the scene vertically

Rotate 90 Degree CW Rotates the scene 90 degrees in a clockwise direction

Rotate 90 Degree ACW Rotates the scene 90 degrees in an anti-clockwise direction


5.2.13 Hewlett-Packard Graphics Library

You can view Hewlett-Packard Graphics Library (.hpgl and .plt) files.

The .plt and .hpgl file formats (HPGL) are the standard language for printing line drawings. PLT and HPGL files are supported by many CAD, charting, and word processing applications.

5.2.14 Imagine Geometry

You can view Imagine Geometry (.iob) files.

The .iob file format, developed by Impulse Inc., is used in the Imagine application which creates models of objects or character in 3D and allows rendering into 2D pictures, 3D anaglyph and animation sequences.

Note that most polygons in Imagine file scenes have inconsistent orientation. That is, some polygons are oriented clockwise while others are oriented anti-clockwise. To correct this, you can convert all normals to double-sided so that each triangle is created twice, in both clockwise and anti-clockwise orientations.

NoteImagine files typically have file extensions of .iob, .obj, or no extension at all. This plug-in expects that the file extension has been renamed to .iob.

Supported

● Imports Imagine or TTDDD binary geometry files● Only surface attributes are properly extracted from the file

5.2.15 ISO G Code Format

You can view ISO G Code Format (.iso, .nc) files.

The .iso file format contains the complete contents of a CD disc or other disk. ISO images are often created to backup a CD or distribute CDs over the Internet or other network. The .nc format contains numeric code files.

These formats are based on the ISO 9660 CD-ROM file system standard.

ISO is an abbreviation of International Organization for Standardization (http://www.iso.org ); founded in 1947, the ISO is a worldwide federation of national standards bodies from some 140 countries. The first ISO standard was published in 1951 with the title, “Standard reference temperature for industrial length measurement.”

The first standard used for data CDs on PC or IBM compatible computers. Unfortunately, in the beginning many manufactures had their own implementation of this loose standard. The ISO 9660 standard is constantly being upgraded and tightened to include new methods. The most important factor of this standard is when



http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.iso.org

having both audio and data on one CD that the data is placed before the audio. This was originally referred to as High Sierra.

5.2.16 LightWave 3D and Binary Object

Use

You can import and view LightWave 3D and Binary Object (.lwo, .lw) files. You can also save files to these formats.

These are native formats for the LightWave 3D application developed by Newtek. The .lw file format is the binary from the LightWave 3D application. These are stored on disk as 3D meshes consisting of points, polygons, (these can include faces, curves or patches), and surfaces. Files can contain a single connected mesh or several disjointed meshes describing a single logical object. An object file may also contain one or more surface definitions with no mesh.

SAP 3D Visual Enterprise Author uses the following order to search object files:

1. Folder of .scn file2. Content folders3. Several last folders, specified when the file is not found4. Prompt from user

NoteWhen you import a .lw or .lwo file, you must add the locations of the associated images used in the file.


● All possible surface information, including smoothing, glossiness and color, are converted● Layers read as separate objects● Surface details and one-point polygons not converted● The following types of LightWave 3D objects

○ LightWave object file○ LightWave layered object file○ LightWave 6.0 object file○ Two-point polygons are converted to lines○ UView files


● Animation including field of view, object transparency, and light colors● When saving:

○ LightWave 3D Object file format (object file format of LightWave 5.6). Texture coordinates are saved to .uv files.

○ LightWave 3D Object file format 2 (object file format of LightWave 6.0). Each object is stored as a separate layer.



● Files with more than 65535 points end faces cannot be saved as version 5.6 of this format

Features

These formats contain both import and export options. You can use them to customize the way in which your file is opened and saved.

Import Interface


Create sub-objects by material names Converts each LightWave object into a separate sub-object. This conversion is based on the surface (material) names assigned to the object polygons.

Create texture coordinates Converts LightWave texture projection methods, including planar, spherical, cylindrical and cubical, into UV texture coordinates. The LightWave texture projection methods are used to map textures onto objects. The type of mapping used should match the shape of the object. For example, cube mapping is used on box-shaped objects.

Check Wrapping Attempts to remove the Wrap bug in spherical and cylindrical projection methods

Import .uv Files Imports objects from UView files. These are UV texture coordinate files that are created by UView/LightWave.

Import SubDs Imports and displays the subdivision control mesh objects on a simple mesh. Otherwise, only the simple mesh is displayed.

Export Interface


Version Saves the file as the selected LightWave version

Export SubDs Establishes subdivision control mesh object settings

● Final Mesh: Creates a highly detailed and a high polygon count mesh

● Control Mesh: Creates a low detailed, low polygon count mesh. This mesh is subdivisible.

● Control mesh using PTCH chunk: Creates a low detail, low polygon count mesh. The mesh is structured with the Subdivision patches (PTCH) chunk.




LightWave 5.6 Saves the model as a LightWave version 5.6 file

NoteIf the file has more than 65535 points end faces, it is automatically saved as version 6.0 of the format regardless of your selection.

● Create .uv Files: Creates and saves .uv files

● Export UVs Using Chunks: Saves all UV texture coordinates that are assigned to polygon vertices. The UV coordinates are saved according to the UVIM and UVCV chunks

LightWave 6.0 Saves the model as a LightWave version 6.0 file

● Export UVs: Saves any UV texture coordinates that are assigned to polygon vertices

● Use Discontinuous UVs: Uses discontinuous UV texture coordinates. That is, additional points are not created for points that have the same UV values.

NoteWe recommend using this for LightWave versions 6.5 and higher.

● Export Extra Maps: Saves diffuse, bump, specular, and emissions maps

5.2.17 LightWave Scene

Use

You can import and view LightWave Scene (.lws) files. You can also save files to this format.

SAP 3D Visual Enterprise Author can read the following types of .lwo objects:

● LightWave object file● LightWave layered object file● LightWave 6.0 object file

LightWave scene files are much like CAD assembly files; CAD assembly files reference associated part files to create the scene. Similarly, .lws files reference .lwo and .lw files to create the scene, and these associated .lwo and .lw files reference various image files. Therefore, when you import a .lws file, you must add the locations of the folders through which SAP 3D Visual Enterprise Author searches for the associated .lwo and .lw files (content folders). You must also add the locations of the images used in the associated files.



● Animation, camera animation, and several envelopes● All cameras and most light types● LightWave 5.6 and 6.0 scene files● Object hierarchy within the original LightWave file is recreated exactly


● Animation, including field of view, object transparency and light colors

Features


Import Interface


Optimize Materials Reduces the number of materials that are imported by ignoring any duplicated materials

Content Folders Specifies the locations of the folders through which SAP 3D Visual Enterprise Author searches for the associated .lwo and .lw files

Prompt for Missing Files Sends a prompt for further action if a file is missing

Export Interface


Version Saves the file as the selected LightWave version

Export Single Layered Object Exports the objects in a single layer. That is, if a model contains more than one layer, these layers are combined to create a single layer.

Export Skins Saves the skin information in the file. This option is only valid for LightWave versions 6.5 and higher

Export One Object Instance Exports one copy of each object in the scene. For example, when a model contains four identical objects, only one object is exported and used four times.

Export Viewport Saves the current view in the file

Export Lights Saves the current light settings in the file




Copy Objects to Folder Copies the objects to the specified folder

Use Prefix Determines a URL prefix for bitmaps assigned to objects in the scene

5.2.18 Maya ASCII Scene

Use

You can import and view Maya ASCII Scene (.ma). You can also save files to this format. You must have the Maya application installed to enable this functionality.

When working with Maya version 2009 and upwards, issues may arise when you import a Maya file into SAP 3D Visual Enterprise Author. This is the result of Maya experiencing difficulties in locating the directory of your Maya installation. To reestablish this directory path, you must set a new environment variable for Maya. To set the environment variable, follow the steps for your operating system.

Windows XP

1. From the Windows Start Menu, choose Settings Control Panel System Advanced Environment Variables

2. Click New under System Variables.3. Set the Variable Name to MAYA_LOCATION, and the Variable Value to the installation location path of the

version of Maya that you are planning to use with SAP 3D Visual Enterprise Author. For example, C:\Program Files\Autodesk\Maya2013.

4. Click OK to exit and apply the changes, and restart SAP 3D Visual Enterprise Author.

Windows 7 and Vista

1. From the Windows Start Menu, choose Control Panel System Security System Advanced System Settings

2. Click Environment Variables under the Advanced tab.3. Click New under System Variables.4. Set the Variable Name to MAYA_LOCATION, and the Variable Value to the installation location path of the




● Keyframe animation. That is, moving, rotating, scaling, and morphing. For example, a morph BlendShape deformer

● NURBS and SubDs● Cameras



● Cameras


● Deformations


● When exporting from Maya to .rh format, the following options are not supported:○ Procedural textures○ Layered textures and shaders○ Third Party shaders○ Area and volume lights○ Light decay○ Subdivision surfaces○ Lattice deformer○ Deformers animation○ Animated visibility

Features


Import Interface


Common Defines the tessellation, (arrangement and density of the polygons), and other common settings

● Up Axis in Maya: Selects the up axis. You can nominate either the Y or the Z axis.

● Import Cameras: Imports the scene cameras● Import Perspective Camera: Imports the perspective

cameras● Import Lights: Imports all lights in the scene● Import Animation: Imports all animation.● Number of Frames between Samples: Determines the

rate at which the animation is sampled when importing the file, minimum 1 maximum 100

● Tessellate NURBS: Defines the arrangement and density of the NURBS




Detected Maya Installations Selects the version of Maya with which to import the file. This is active when more than one version of Maya is installed.

● Maya Version: Selects the version of Maya with which to import the file

Export Interface


Common Establishes the common settings


● Maximum Vertices in Polygon: Sets the number of vertices in a polygon, minimum 3, maximum 65536

● Mark Surfaces as Double-Sided: Sets surfaces as double-sided

● Material Type: Defines the type of material shading with which to save the model○ Phong: Exports the materials using Phong material

shading○ Blinn: Exports the materials using Blinn material

shading● Export Skins: Exports all skins associated with the

model.● Tessellate NURBS: Indicates whether to tessellate

NURBS while exporting to Maya format. The default value is Yes.

Detected Maya Installations Selects the version of Maya with which to export the file. This is active when more than one version of Maya is installed.

● Maya Version: Selects the version of Maya with which to export the file

5.2.19 Maya Binary Scene

Use

You can import and view Maya Binary Scene (.mb) files. You can also save files to this format. You must have the Maya application installed to enable this functionality.

When working with Maya version 2009 and upwards, issues may arise when you import a Maya file into SAP 3D Visual Enterprise Author. This is the result of Maya experiencing difficulties in locating the directory of your


Maya installation. To reestablish this directory path, you must set a new environment variable for Maya. To set the environment variable, follow the steps for your operating system.

Windows XP

1. From the Windows Start Menu, choose Settings Control Panel System Advanced Environment Variables

2. Click New under System Variables.3. Set the Variable Name to MAYA_LOCATION, and the Variable Value to the installation location path of the



Windows 7 and Vista

1. From the Windows Start Menu, choose Control Panel System Security System Advanced System Settings

2. Click Environment Variables under the Advanced tab.3. Click New under System Variables.4. Set the Variable Name to MAYA_LOCATION, and the Variable Value to the installation location path of the




● Keyframe animation. That is, moving, rotating, scaling, and morphing. For example, a morph BlendShape deformer

● NURBS and SubDs● Cameras


● Cameras


● Deformations

Features


Import Interface




Common Defines the tessellation, (arrangement and density of the polygons), and other general settings


● Import Cameras: Imports the scene cameras● Import Perspective Camera: Imports the perspective

cameras● Import Lights: Imports all lights in the scene● Import Animation: Imports all animation.● Number of Frames between Samples: Determines the

rate at which the animation is sampled when importing the file, minimum 1 maximum 100

● Tessellate NURBS: Defines the arrangement and density of the NURBS

Detected Maya Installations Selects the version of Maya with which to import the file. This is active when more than one version of Maya is installed.

● Maya Version: Selects the version of Maya with which to import the file

Export Interface


Common Establishes the general settings


● Maximum Vertices in Polygon: Sets the number of vertices in a polygon, minimum 3, maximum 65536

● Mark Surfaces as Double-Sided: Sets surfaces as double-sided

● Material Type: Defines the type of material shading with which to save the model○ Phong: Exports the materials using Phong material

shading○ Blinn: Exports the materials using Blinn material

shading● Export Skins: Exports all skins associated with the

model.● Tessellate NURBS: Indicates whether to tessellate

NURBS while exporting to Maya format. The default value is Yes.



Detected Maya Installations Selects the version of Maya with which to export the file. This is active when more than one version of Maya is installed.

● Maya Version: Selects the version of Maya with which to export the file

5.2.20 Object File Format Vector Graphics

You can view Object File Format Vector Graphic (.off) files.

You can also save files to the Object File Format Vector Graphics (.off) format.

5.2.21 Open Inventor File

Use

You can import and view Open Inventor (.iv) files. You can also save files to this format.

Supported

● ASCII only, partially supported

Features


Import Interface



Collapsing Hierarchy Merges the selected objects to collapse the hierarchy





Optimize Geometry Reduces the number of coordinates in the array of per vertex normals

Create UVs Creates UV mapping for objects that do not currently have mapping. This enables you to apply texture maps to the object.

Text Quality Determines the quality of the text if any is contained within the scene. The text is converted to polygon face entities. If a high value is specified, more points and lines are used and the vertex count increases.

Text Extrude Defines the depth of the characters (extrusion) in the text. For example, a value of 0 results in the text being flat, and a value of 100 results in the text being the maximum thickness possible.

Export Interface


Add Indents Indents the code within the saved file. This improves file readability.

Export Lights Saves all light sources in the file

Export Cameras Saves all cameras in the file


Export Normals Saves all normals that are assigned to face vertices

Export Texture Coordinates Saves all UV texture coordinates that are assigned to face vertices

Export Polylines Saves all vectors or polylines

Export Materials Saves all materials that are used by mesh objects

5.2.22 OpenFlight Scene Description Database

Use

You can import and view OpenFlight Scene Description Database (.flt) files. You can also save files to this format.


This format is an industry standard real-time 3D scene description format developed, owned and maintained by MultiGen Inc. It was originally developed by MultiGen in response to a need for database transportability within the visual simulation community.

OpenFlight is the most widely used file format for visual simulation databases and is supported by dozens of vendors of real-time 3D tools. Military visual simulation includes: battle simulation, jet fighter flight simulation, tank simulation. Visual simulation also includes geo-specific terrain for accurate real-time fly-through of regions of the planet.

Export Limitations

● All geometry is imported, treating these unsupported nodes as simple group nodes. For example, Switch and LOF

● All polygon sub-faces are grouped into special objects. These objects are rendered with a shift on the Z-axis. The amount of shift depends on the level of hierarchy. You can see this shift value in the Object Properties window

● Any specific texture data, like clamping, and texture type, (modulation, blend, decal), is ignored● LOD nodes convert to application objects/groups. All LOD objects and their sub-objects with a switch-out

distance of more than 0.0 are automatically hidden. You can browse this file type with the highest resolution.

● The morph vertex node is interpreted simply as a vertex node. The first vertex from any pair is used.● Unsupported nodes: Continuously Adaptive Terrain (CAT), Light Point, Binary Separating Planes, Sound,

Road Segment/Path/Zone, Clip, and Text nodes

Features


Import Interface


Convert distance LOD to scene level LOD Converts LOD nodes to application objects and groups

Read per vertex normals Reads the array of per vertex normals in the file

Export Interface


Export Vertices in Local Object Space Saves the vertices as they appear in local object space. Otherwise, they are saved as absolute vertex coordinates.

Export UVs Exports all the UV coordinates

Per Vertex Normals Saves the array of per vertex normals in the file




Per Vertex Colors Saves the array of per vertex color in the file

Use Instances and References Saves all instances and references in the file. This produces a smaller file size if the scene contains multiple copies of the same object. This option is only available when you select Export Points in Local Object Space.

Export Color Palette Saves the color palette in the file

Export Empty Nodes Saves all empty nodes in the file

5.2.23 Points File

Use

You can import and view Point (.pts) files.

Point cloud data is usually created by 3D scanners. The file structure is designed to store the points situated in 3D and 2D space.

Features


Import Interface


Import As Selects the way in which the data will be imported. Available options are Pointset or Mesh.

Import Mesh if Colors are Present Indicates that the model will always be imported as mesh if colors are present

5.2.24 Polygon Model Format

You can view Polygon Model Format (.ply) files.


5.2.25 Portable Graymap Heightfield

Use

You can import and view Portable Graymap Heightfield (.pgm) 16-bit files. You can specify scale factors for each axis when importing these files.

The .pgm file format is very basic, and serves as the lowest common denominator for converting and exchanging graphics files between different platforms. Portable Graymap Heightfield is a simple 16-bit grayscale image file and may be stored in either binary or ASCII format. It is related to the PBM (black and white) and PPM (pixelmap) graphics file formats.

While this is actually a 2D image format, SAP 3D Visual Enterprise Author considers it a 3D scene; when a file of this nature is opened, a 3D plane is constructed and the application then uses the image as a height-map to distort the plane.

Features


Import Interface


Scale X Factor Determines the size of the model along the X axis.

Scale Z Factor Determines the size of the model along the Z axis

Scale Y Factor Determines the size of the model along the Y axis

5.2.26 POV-Ray RAW Triangle

Use

You can view the POV-Ray RAW Triangle (.raw) files. You can also save to this format.

The .raw format is a simple ASCII file that stores a list of triangles without any further topological information. This format is easy to produce so it is widely used in the computer graphics community.

● RAW Triangle files contain one triangle per row● Each row contains nine floating point numbers that represent the coordinates of the three triangle vertices● If in the text there is a non-blank line, which does not contain nine floating point numbers, it is perceived as

the name of the object● A RAW Triangle file must have the file extension .raw for SAP 3D Visual Enterprise Author to process it

properly



● All points within an object that have identical X, Y, and Z coordinates (coincident vertices) are joined

Example

The following example shows a simple RAW Triangle file:

10.0 0.0 0.0 10.0 10.0 0.0 10.0 10.0 10.010.0 0.0 0.0 10.0 10.0 0.0 10.0 10.0 -10.00.0 10.0 0.0 0.0 10.0 10.0 20.0 0.0 10.0

5.2.27 Power Render Object

You can view Power Render Object (.pro) files.

A .pro file is a binary description of a 3D object or scene. It includes information about the 3D mesh, textures, materials, cameras, and animation used to display a scene. The .pro format is chunk-based.

Limitations

● Animation● Cameras not retrieved

5.2.28 Protein Data Bank

Use

You can import and view Protein Data Bank (.pdb) files.

The .pdb file format describes the positions of atoms in a molecular structure. Protein files are used to convey a number of different views of atoms, molecules, and compounds. They can range from simple single atoms through to complex compounds. You can set visual complexity and quality aspects using the import options.

For example, the following images show the carbon dioxide molecule and the insulin compound. The atoms are displayed as “spacefill” and colored by “chain”.


Carbon dioxide molecule

Insulin compound

Functionality

Protein files function in the following manner:

● You can view molecular structures in a number of different ways including as wires and as backbones. This is helpful when viewing the structure of the compounds. For example, the following images show the nitroglycerine compound with the atoms displayed firstly as “wire by residue” and then as “balls and sticks by atom”.

Nitroglycerine compound: Wire by residue



Nitroglycerine compound: Balls and sticks by atom● Components of the molecular structures can be displayed by color and their related materials appear

uniquely in the Materials list. This enables you to identify components easily. For example, you could change the color of all oxygen molecules in a file.

● Compound objects are ordered in a hierarchical manner based on the compound’s hierarchy. For example, chains, and residues. This helps with component selection.

● You can display multiple views simultaneously by merging the same file or different files into the current scene. For example, the following image shows the insulin compound with each chain displayed in a different view, and with water and zinc molecules deleted.

Features


Import Interface


Sphere Segments Indicates the number of pieces into which spheres are divided

Stick Segments Indicates the number of pieces into which sticks are divided



View Determines the structure view of the components

● Wire: Displays components as single connecting lines● Balls and Sticks: Displays components as spheres and

cylinders● Spacefill: Displays components as spheres representing

the Van der Waals radii (http://en.wikipedia.org/wiki/Van_der_Waals_radius ) of the atoms; the radii of imaginary hard spheres that are used to model atoms

● Backbones: Displays components as paths of carbon chains in long chain molecules

NoteMost simple molecules do not have backbones or residues. As such, there may be nothing visible if you select these options. Also, you cannot use the By Atom color option when viewing compounds as backbones. The default setting should be to display as either wire, or as balls and sticks with spheres set to 10 and sticks set to 4, and then color by atom.

Color Identifies the various compound components

● Monochrome: Displays a grayscale view of the components

● By Atom: Displays a color view of the atoms. This option is not available when you view compounds as backbones

● By Residue: Displays a color view of the residue

NoteMost simple molecules do not have residues or backbones. As such, there may be nothing visible if you select these options. The default setting should be to display as either wire, or as balls and sticks with spheres set to 10 and sticks set to 4, and then color by atom.

● By Chain: Displays a color view of the chain● Rainbow: Displays the components in multiple colors.

This is helpful for viewing complex compounds.



http://help.sap.com/disclaimer?site=http%3A%2F%2Fen.wikipedia.org%2Fwiki%2FVan_der_Waals_radius

http://help.sap.com/disclaimer?site=http%3A%2F%2Fen.wikipedia.org%2Fwiki%2FVan_der_Waals_radius

5.2.29 Rhinoceros 3D Model

Use

You can import and view Rhinoceros 3D Model (.3dm) files. You can also save files to this format.

This is the native file format of the Rhino3D modeling application developed by Rhinoceros. Rhino3D can create, edit, analyze, and translate NURBS curves, surfaces, and solids in Windows. There are no limits on complexity, degree, or size. Rhino also supports polygon meshes and point clouds.


● All NURBS and mesh objects● Curves and meshes● Light sources and cameras● Materials converted into SAP 3D Visual Enterprise Author materials. Wire objects (points, points clouds,

and curves) only have color and no materials. Therefore, the color is taken from the object or layer, then converted to a material.

● Object names and visibility● Points and point clouds (cluster of points)● Surfaces and BREPs


● Curves and meshes● Points and point clouds (cluster of points)● Light sources and cameras● Surfaces and BREPs


● BREPs with only one face and one trivial trimming loop imported as a surface with minor optimization● Polycurves imported as one curve if they only have one segment● Viewports converted to cameras

Features


Import Interface


Skip Objects in Hidden Layers Imports only visible objects on visible layers. That is, visible objects on invisible layers are not imported.



Skip Hidden Objects Imports only visible objects on visible layers. That is, invisible objects on visible layers are not imported.

Put All Curves in Single Group Groups all curves into one group. This object is labeled “All Curve Groups”. This option takes priority over the Group Objects by Rhino Layers option if both options are selected.

Group Objects by Rhino Layers Groups all layer information into one group. The Put All Curves in Single Group option takes priority over this option if both options are selected.

Surfaces Always Double Sided Imports surfaces as double-sided

Split BREP Faces into Separate Objects Expands the BREP object groups. That is, expands the object hierarchy tree to display BREP objects, parts, and subparts.

NoteBREPs with only one face are imported as one node and not two, if you select the Split BREP faces into separate objects option.

Import Lights Imports all Rhino lights

Import Cameras Imports all Rhino cameras and uses them to view the model

Import Mode Selects the way in which the file will be imported. The available options are Polygonal Mesh or NURBS.

Import Curves Imports all Rhino curves and uses them to view the model

Import Points Imports all Rhino points and uses them to view the model

Import Pointsets Imports all Rhino pointsets and uses them to view the model

Export Interface


Skip Hidden Objects Does not export objects that are hidden

Put All Curves in Single Layer Groups all curves together in one layer

Export Lights Exports all light sources

Export Cameras Exports the Rhino cameras



5.2.30 SAP 3D Visual Enterprise Binary

Use

You can import and view SAP 3D Visual Enterprise Binary (.rh) files. You can also save files to this format.

You can save keyframe animation information, normals, and skins. You can also choose to compress the exported file, or compress points within the file, apply protection, save the file for different application versions, and create thumbnails of varying sizes.

CautionThe password protect feature should not be used with SAP 3D Visual Enterprise Generator.

“Lossy” (loss of data) compression can be used to compress .rh files; lossy compression treats two vertices that are sufficiently close to each other as one, resulting in a change to the file size and model quality.

Supported for Import and Export

● Cameras

Features


Import Interface


Use Current Viewport Settings Ignores the viewport settings in the saved file, and instead loads the file determined by the last Display Mode set in SAP 3D Visual Enterprise Author. For example, if the Display Mode is set to Bounding Box, every file loaded will have a Display Mode of Bounding Box.

Export Interface


Compression Reduces the file size while maintaining the quality. Compression helps to reduce the amount of storage and transmission bandwidth required for 3D models.



RH4 Compression Defines the compression settings when saving to the 4.0 version of the .rh file

● Compression mode: Determines the type of the compression with which to export the file. The faster the compression, the faster the file is saved but the larger the resulting file.○ Very Fast: Compresses the file using a low level of

compression. This creates the largest file but the compression speed is very fast.

○ Fast: Compresses the file using a medium level of compression

○ Normal: Compresses the file using a high level of compression

○ Best: Compresses the file using the maximum level of compression. This creates a very small file but the compression speed is very slow.

● Dictionary Size: Determines the size of the dictionary to use for compression. The larger the size of the dictionary, the better the compression.

Export Animation Saves the keyframe animation in the file

Vertices Quality Defines the percentage of data about the vertices to keep. Lossy compression is used here. Once you have compressed the vertices data, this information is lost. That is, you cannot reverse this compression. For example, once the data is compressed to 50%, it may as well remain at 50% to keep the file size small. Saving the file again at 100% will make the file larger but add no more resolution.

● [percentage]: Selects the percentage of data to keep

UV Vertices Quality Defines the percentage of data about the UV points to keep. Lossy compression is used here. Once you have compressed the UV point data, this information is lost. That is, you cannot reverse this compression.

● Off: Does not compress the UV points● [percentage]: Selects the percentage of data to keep

Normals Quality Defines the percentage of data about the normals to keep. Lossy compression is used here. Once you have compressed the normals data, this information is lost. That is, you cannot reverse this compression.

● Off: Does not compress the normals● [percentage]: Selects the percentage of data to keep




File Protection Defines the type of protection that the exported file has. This is helpful if you want to distribute a proprietary model to people who need to see the file, but should not edit or copy it. For example, if a company’s Web site features an online parts catalog which displays their parts, and the company does not want their competitors obtaining usable copies of these parts.

NoteThe file name, path, and protection status is displayed in the application title bar

● No: Disables file protection● Conversion Protected: Prevents the file being saved to

any format other than the .rh format

● Read Only: Saves to a state where the file can be viewed, but not saved

NoteYou cannot import Conversion Protected and Read Only .rh files into Max and Maya using the SAP 3D Visual Enterprise third-party plug-in.

Disable Measurements Protects the measurements in the exported file. Once you enable this option, the file cannot be measured by using the SAP 3D Visual Enterprise Author measurement tools.

Export Viewports Saves the current viewport layout in the file. For example, if you currently have three viewports open, this setting is saved in the file, and visible when the .rh file is reloaded.

Thumbnail Creates the specified size thumbnail image of the current model. The thumbnail image displays any setting that have been applied to the model. The thumbnail is displayed in Windows Explorer (with Thumbnail view turned on). Alternatively, you can select to not create a thumbnail image.

● No Thumbnail: Does not create a thumbnail. This is the default option, and saves on file size.

● [size]: Creates a thumbnail of the specified width and height, in pixels



Password Encrypted Sets password-controlled encryption for the file

CautionThe password protect feature should not be used with SAP 3D Visual Enterprise Generator.

Watermark Saves a watermark with the file

Watermark File Selects the watermark image to be saved with the file

Solids These settings applicable only to objects in scene which contain solids. If scene doesn't have any objects with solids, these settings won't affect export at all.

● Only Solid: For objects with solids only solids information is saved to .rh file. Produced .rh file has smaller size but opening takes longer time due to tessellation of solids to build meshes.

● Solid and Mesh: For objects with solids both solids and meshes information is saved to .rh file. Produced .rh file has larger size but opens fast because meshes are present, no tessellation required.

● Only Mesh: For objects with solids only meshes information is saved to .rh file. Produced .rh file has smaller size, solids information is lost.

5.2.31 Silo3D

You can import and view Silo3D (.sia) files. You can also save files to this format.

Silo is a 3D modeling application created by Nevercenter. It has a focus on quick editing, a customizable interface, and a flexible workflow.

Supported

● Meshes (with subdivision)● Material and object names● UV coordinates● Textures



5.2.32 SketchUp Document

Use

You can import and view SketchUp Document (.skp) files. You can also save files to this format.

NoteA skb file is produced along with the .skp file, and is an exact copy and backup of the .skp file.

Features


Import Interface


SketchUp Tessellation Splits every face into triangles

Import UVW Coordinates Creates UV texture coordinates for the model. Activating this feature makes transforming to another format correct. UV coordinates allow a rectangular map to be placed neatly onto a rectangular polygon (or two triangles). If the map is skewed, however, another coordinate (W) must be created to allow interpolation to be correctly interpreted.

Import Textures Imports textures for the model

Create Back Faces Indicates the way in which back faces are addressed on export. This option is required because in SketchUp every face has two sides, and in SAP 3D Visual Enterprise Author, faces have only one side (front only).

● None: Ignores backfaces● As Separate Node: Creates backfaces as an additional

node● In Same Node: Creates backfaces in the same node

Import Components Imports all components



Use Default Material for Backfaces Creates a default SketchUp material that appears at the bottom of the Materials list. The material has the following properties:

● Name: SketchUp Default● Ambient: RGB (30,30,30)● Diffuse: RGB (200,200,200)● Specular: RGB (0,0,0)● Emissive: RGB (0,0,0)● Opacity: 100● Glossiness: 20● Specular level: 33● Raytrace reflection: 30● Index of refraction: 1.5● [ ] Double sided● [ ] Outline

Export Interface


Corner Edges are Smooth Generates smooth corner edges on export. These options are useful if you intend to view the model using the SketchUp tool. The default value is YES.

Corner Edges are Hidden Hides corner lines and edges on export. The default value is YES.

Create Back Material Too Indicates whether a back material is created on export. An object can have a material on the back as well as the front (which is different).

Merge all Coplanar Faces Merges the flat faces into a single representation so that all extra lines are hidden. These lines still exist, but the object is now cleaner to look at. The default value is NO.

File Version Indicates the version of the file

5.2.33 SOFTIMAGE|XSI

Use

You can view SOFTIMAGE|XSI (.xsi) files. You can also save files to this format.



The .xsi format is an ASCII file format defined by Softimage Co. to store SOFTIMAGE 3D and SOFTIMAGE XSI scene data. It allows the import and export of characters, models, and animation for complete customization of any game-development pipeline, and lets you include user data, making it straightforward to introduce new types of custom information.

Supported

● Animation

Features


Export Interface



Common Establishes the general export settings

● Version: Establishes in which version of the format to save the file○ XSI 3.5 Realtime Materials: Saves the model as a

SOFTIMAGE|XSI version 3.5 file with real-time materials. Real-time materials are technically equivalent to real-time shaders

○ XSI 3.5 Softimage Materials: Saves the model as a SOFTIMAGE|XSI version 3.5 file with Softimage materials

○ XSI 3.0: Saves the model as a SOFTIMAGE|XSI version 3.0 file

● Export Materials: Saves the mesh object materials in the file

● Export Normals: Saves any face vertex normals in the file

● Export Textures: Saves any face vertex UV information in the file

● Add Top Level Frame: Adds a single frame to the file if more than one object does not have a parent object

● Invert Normals: Inverts the direction of each vertex normal to point in the opposite direction

● Add Indents: Indents the code in the file. This is used to improve file readability.

● Export per Vertex Color: Exports the “Array of per Vertex Color” geometry item

● Swap Y and Z Axes: Switches the Y axis with the Z axis● Create Dummy Objects: Duplicates the objects in the

Scene Tree to create dummy objects. The dummy objects are not displayed in the viewport and do not have any physical properties. They have the following properties: position, rotation, scale, shear, and transformation matrix.

● XSI 2.0 Compatibility: Saves the model with backward compatibility to version 2.0 of the .xsi file format




Animation Establishes the animation export settings

● Export Animation: Saves the animation to the file● Rescale Animation: Changes the length of the animation● Rescale Type: Selects the way in which the animation is

rescaled○ Length in (cs): Rescales the animation length by the

specified length in centiseconds○ By percent: Rescales the animation length by the

specified percentage. For example, a 50 second animation scaled by 150% would be 75 seconds long.

● Centiseconds: Determines the length of the animation in centiseconds

● Percent: Determines the amount of scaling to apply to the animation as a percentage

● Reverse Animation Sequence: Reverses the animation sequence from moving forwards to backwards

● Remove Redundant Keys: Removes duplicate animation keys from the exported file. The exported animation plays with the same or similar behavior, but with fewer keys.

● Sample Animation: Samples the animation sequence at the specified sampling rate

● Sample Frames: Determines the rate at which the animation is sampled

5.2.34 Stereolithography Rapid Prototyping Data

Use

You can view Stereolithography Rapid Prototyping Data ..stl) files. You can also save files to this format. The STL export plug-in writes out the scene to an ASCII-formatted or binary-formatted Stereoithography .stl file.

The .stl file format is an intermediate data file that allows stereolithography devices to deal with solids made by triangles. It is typically generated as a by-product of geometry rich CAD data. For example, NURBS. While still a means to move around unstructured meshes made by triangles, this file format is growing in popularity due to its simplicity: .stl files are composed of a set of many unsorted triangular facets. An .stl file has two formats: ASCII and binary. When the binary format is used to describe an STL file, the data size is much smaller than the ASCII format. For this reason, most .stl files available now use the binary format.

Supported

● ASCII and binary versions


Features


Export Interface


ASCII Mode Sets the way in which the file is saved. Yes saves the file in ASCII format, and No saves the file as a binary file.

Example

The following example shows the ASCII format of an .stl file:

solid sample.stlfacet normal -1.000000 0.000000 0.000000outer loopvertex 140.502634 233.993075 -38.310362vertex 140.502634 229.424780 -38.359042vertex 140.502634 242.525774 -27.097848endloopendfacetfacet normal 0.903689 0.004563 0.428166outerloopvertex 134.521310 273.427873 30.342009vertex 134.521310 308.505852 30.715799vertex 140.502634 334.576026 18.369396endloopendfacetfacet normal -0.903689 0.004563 0.428166outer loopvertex 140.502634 334.576026 18.369396vertex 140.502634 294.929752 17.946926vertex 134.521310 273.427873 30.342009endloopendfacet... ...endsolid sample.stl

5.2.35 Universal 3D

Use

You can import and view Universal 3D (.u3d) files. You can also save files to this format.

Adopted by Adobe, .u3d is required and used as the 3D publishing format in Adobe Acrobat. It can store meshes in two different ways: as a base mesh or as a progressive continuous level of detail (CLOD) mesh. Base meshes are not compressed, and do not include any level of detail. As such, these files are saved very quickly but are large in size. A progressive mesh is highly compressed and has a continuous level of detail. These files are smaller than base mesh files, however they take much longer to save.

A mesh can consist of multiple parts. For example, a mesh could comprise 80 vertices made up of 50 base vertices and 30 progressive vertices.

For further information about the .u3d file format, please see http://www.3dif.org .


● Cameras


● Cameras



http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.3dif.org

● Textures

Limitations

The .u3d format does not support pivot points so pivot point locations may be incorrect. To correct this, create a group node at the location of the original object pivot point. The original object appears as a child of this node. To rotate the object about its original pivot point, select the new parent node and rotate it.

Features


Import Interface


Import LOD Imports LOD with the current file. Otherwise, the highest level of detail is imported.

Parse Metadata Reads all metadata information including markups and material specular level metadata

Remove Append Data from Names Removes the “##” and the number from the object names if the names contain these characters



Level of Detail Used to define the Level Of Detail (LOD) settings. Universal 3D files store a continuous LOD; that is, every LOD is stored. LOD is a way of displaying models with different numbers of polygons depending on how close they are to the camera using the Level of Detail controls. This can speed up the rendering time by limiting the number of polygons that need to be drawn.

● Levels: The number of LODs that you want to import. The higher the number, the more information is imported.

● Create LOD if Mesh has Minimum Vertices: Creates the LOD if a single mesh has more than this number of vertices. For example, if you enter 200, LODs are created if a mesh has at least 200 vertices. Otherwise, no LODs are created. This is helpful where models comprise very small meshes with a small number of vertices, as LODs created for models such as these would be too small to be visible.

● Create LOD if Minimum Vertices in File: Creates the LOD if the total number of vertices in a file is more than the specified number of vertices

● Minimum Vertices per Mesh: Sets a minimum number of vertices requirement before an LOD is created. For example, the total number of vertices is 50,000, and the number of mesh vertices is 50. The LOD is not created if you import a file with a total of 47,000 vertices and at least 60 vertices per mesh. However, a LOD is created if the file contains a total of 55,000 vertices and at least 55 vertices per mesh.

NoteThe level of detail (LOD) is created for a mesh if one of these two cases is true:

1. The number of vertices in the mesh is greater than or equal to Create LOD if Mesh has Minimum Vertices

2. The total number of vertices in the scene is greater than or equal to Create LOD if Minimum Vertices in File AND the current mesh has at least Minimum Vertices per Mesh vertices

Export Interface




File Format Defines the version to which to export the file

● ECMA 1st edition: Select 1st edition for more compatibility (all U3D readers support it)

● ECMA 3rd edition: Select 3rd edition. 3rd edition may be unsupported by some applications (like Acrobat 7). 3rd edition also has some improvements, so if your application supports 3rd edition, you should use it.

Mesh Compression Defines mesh compression

Compression Quality Defines the quality of compression. 1000 gives best quality, 0 gives worst quality

● Compression Preset: Compresses the file using one of the following options:○ Game: Predefined quality for games applications○ CAD: Predefined quality for CAD applications○ Custom: Provides access to the custom compres

sion quality settings● Vertices: Sets the compression levels for vertices● Normals: Sets the compression levels for vertices● Vertex Colors: Sets the compression levels for vertex

colors● Texture Coordinates: Sets the compression levels for

texture coordinates

Texture Compression Type Selects JPEG or PNG compression for textures

JPEG Compression Exports all textures in the JPEG file format

● JPEG Quality: Compresses the JPEG files to the specified percentage quality

NoteIf the JPEG option is not selected, the default texture format PNG is used.

Normals Exports all surface normals. This option creates more appealing looking models but larger files.

Default Camera Saves the default camera view in the file. For example, if you open a scene, rotate it, and export it to the .u3d format with this option selected, that view is used when you open the .u3d file.



Append Data to Non-Unique Names Appends “##” followed by a number to all the non-unique object names in a scene. This creates a unique name for all the objects in a scene, as the .u3d format requires a unique name for each scene object.

Skin and Bones Writes skin and bones information to U3D; not all scenes with skin and bones can be exported to U3D due to limitations of the U3D file format.

NoteAll bones must be children of the skinned mesh, The option Fix Bone Hierarchy may help to fix this. Also, all bones have to be “bones”, not “groups” or “meshes”. 3ds Max Character Studio uses meshes as bones, so it is not supported by U3D export.

Fix Bone Hierarchy Performs adjustments to the bone hierarchy when converting some scenes with skin and bones

Metadata Embeds metadata in the .u3d file. The metadata is stored internally, in XML format, which increases the file size.

5.2.36 Visual Design Stream

Use

You can import and view Visual Design Stream (.vds) files. You can also save files to this format.

The .vds file is a format recognized by SAP 3D Visual Enterprise Author, SAP 3D Visual Enterprise Generator, and SAP 3D Visual Enterprise Viewer. These files are used for SAP 3D Visual Enterprise Navigator.

CautionWe recommend that all import and export settings maintain their default values.

Do not use the password protect feature with SAP 3D Visual Enterprise Generator.

Features


Import Interface




Common Defines the general settings

● Dynamic Loading: Indicates whether the file is loaded with real-time streaming of data, or in common mode, like all other file formats (including .rh).

● Suppress Top Level Nodes: Loads only top level nodes from a .vds file. You can “resume” nodes by right clicking on the node name in the Scene Tree.

● Stream Geometry: Indicates the way in which geometry streams○ Separate Thread: Displays geometry first as bound

ing boxes, and then gradually becoming real meshes. Use this setting in most cases as it is the default.

○ Main Thread for 1st Frame: Displays the first frame in full detail, and all others gradually resolve into full meshes

○ Disabled: Displays no meshes, only bounding boxes● Stream Metadata: Indicates whether metadata streams

○ Yes: Metadata is loaded on demand when required, and then released

○ No: Metadata is fully loaded during initial file load



Rendering Defines settings for rendering

● Video RAM strategy: Indicates the way in which geometry is stored○ Non-GPU: Conventional RAM is used for storing ge

ometry○ GPU: GPU (Video Card) RAM is used○ Overclocked GPU: Overclocked is used. On some

graphics cards, overclocked is faster than GPU, but the option is not always available.

CautionWe do not recommend this option.

● Video RAM Size: Indicates the amount of VRAM allocated for mesh storage. This amount should be equal to the amount of memory on the graphics card.

● RAM Size: Indicates the amount of conventional RAM allocated for mesh storage. The higher this figure, the better the result.

NoteValues higher than 1 GB are recommended only on computers with 6 GB of RAM or more.

● 2-Sided Lighting for Back-Facing Triangles: Indicates that back-facing triangles receive two-sided lighting. Set this option to YES if some objects are rendered incorrectly.

● Use LODs: Indicates whether multiple levels of detail are used, or full mesh representation always used

Export Interface




File Protection Defines the type of protection that the exported file has. File protection is helpful if you want to distribute a proprietary mode file that people can read, but not edit or copy. For example, if a company Web site features an online parts catalog that displays their parts, and the company does not want their competitors obtaining usable copies of these parts. The file name, path, and protection status is displayed in the application title bar.

CautionThis method does not guarantee absolute protection. There are ways in which to reverse engineer application and file formats, given enough time, and resources.

● No: Disables file protection● Conversion Protected: Prevents the file being saved to

any format other than the .vds format

● Read Only: Saves to a state where the file can be viewed, but not saved

Disable Measurements Protects the measurements in the exported file. Once you enable this option, the file cannot be measured by using the SAP 3D Visual Enterprise Author measurement tools.

Password Encrypted Sets password-controlled encryption for the file

CautionDo not use the password protect feature with SAP 3D Visual Enterprise Generator.

Levels of Detail Generates LODs

Vertices Quality Defines the percentage of data about the vertices to keep. Lossy compression is used here. Once you have compressed the vertices data, this information is lost. That is, you cannot reverse this compression. For example, once the data is compressed to 50%, it may as well remain at 50% to keep the file size small. Saving the file again at 100% makes the file larger but adds no more resolution.




Normals Quality Defines the percentage of data about the normals to keep. Lossy compression is used here. Once you have compressed the normals data, this information is lost. That is, you cannot reverse this compression.


UV Vertices Quality Defines the percentage of data about the UV points to keep. Lossy compression is used here. Once you have compressed the UV point data, this information is lost. That is, you cannot reverse this compression.


5.2.37 Visual XML

Use

You can import the Visual VZXML XML file (.vzxml) format. You can save files to a Visual VZXML XML file (.rhz) format.

VZXML takes advantage of the .rhz format to save a complex file in a flat, shattered manner as compactly as possible. For every object in the scene, a separate .rh file is saved. The .rhz file is an archive format recognized by SAP 3D Visual Enterprise Author and SAP 3D Visual Enterprise Viewer. It must always contain an rhz.manifest file.

An VZXML type .rhz file contains:

● The rhz.manifest○ For .rhz files created with “Visual XML”, the manifest is simple and only points to the model.vzxml

● The model.vzxml. This file defines the scene hierarchy.● The “files” folder

○ All .rh files needed to reconstruct the original scene○ All .rhm (material) files needed in the original scene○ All image files

To view the separate .vzxml and .manifest files, rename the .rhz extension to .zip.

Supported

● Types: mesh objects (each as its own .rh file), nodes, callouts, sprites, cameras, lights, detail views● Attributes:

○ Preserves instancing○ Private attribute serialized○ Closed attribute serialized○ Billboard Mode



○ Markup link URLs● Materials: each as its own .rhm file● Textures: saved as separate image files● Views: only active viewport saved● Animations: all attributes except animated textures● Procedures: including all step attributes and sequence and highlight selection● Portfolios● Snapshots● Metadata: all types, except scene metadata● Effectivity

Limitations for .rhz Export

● Objects and attributes not saved:○ All attributes from the Attributes tab of the Node Properties window, except for “Closed”

● All attributes from the Attributes tab of the Node Properties window, except for “Closed”● Measurements● Render order● Linestyles

Features

The .vzxml format contains import options. You can use them to customize the way in which your file is imported.

The .rhz format contains export options. You can use them to customize the way in which your file is saved.

Import Interface


Validate XML Validates the XML on import

Load Child Model Views All child model views are also loaded

Export Interface


Validate XML Validates the XML on export

Use Memory Streams Indicates whether memory streaming is used

RH File Compression Defines the compression settings when saving to an .rh file

Generate SAP 3D Visual Enterprise Generator IDs Generates IDs for use with SAP 3D Visual Enterprise Generator


5.2.38 VRML Worlds

Use

You can import and view VRML (Virtual Reality Modeling Language Worlds) Worlds (.wrl, .vrml) files. You can also save to these formats.

The .wrl and .vrml file formats are widely used by the Internet community to represent and navigate 3D hyper-linked virtual worlds. VRML is mainly a graphics format that represents simple solid primitives (for example, spheres and cylinders), polygons, polylines, and their visual attributes.

The VRML is a language for describing multi-participant interactive simulations. These are virtual worlds networked using the global Internet and hyper-linked with the World Wide Web. All aspects of virtual world display, interaction, and internet working can be specified using VRML. It is the intention of its designers that VRML become the standard language for interactive simulation within the World Wide Web.

Supported for Import and Export

● Cameras● VRML 1.0 fully supported


● Lights and fog data ignored● Textures not mapped to text objects● Transparency in textures ignored● URL links discarded● VRML 2.0

○ Animation data ignored○ In/Out Events not supported○ Nested PROTO nodes not supported○ ROUTE ignored○ Scripts not supported○ Vertex colors, line colors, and cells in Elevation Grids not supported


Only a single value supported for material ambient color. If the value specified in the Set Ambient Color to field on the Materials tab is not grey, the RGB values are averaged before being exported.

Features


Import Interface




Flip Coordinate System Flips the Y and Z axes

Collapsing Hierarchy Merges the selected objects to collapse the hierarchy


Optimize Geometry Reduces the number of coordinates in the array of per vertex normals

Create UVs Creates UV mapping for objects that do not currently have mapping. This enables you to apply texture maps to the object.

Text Quality Determines the quality of the text if any is contained within the scene. The text is converted to polygon face entities. If a high value is specified, more points and lines are used and the vertex count increases.

Text Extrude Defines the depth of the characters (extrusion) in the text. For example, a value of 0 results in the text being flat, and a value of 100 results in the text being the maximum thickness possible.

Export Interface


Add Indents Indents the code within the saved file. This improves file readability.

Export Lights Saves all light sources in the file

Export Cameras Saves all cameras in the file


Export Normals Saves all normals that are assigned to face vertices

Export Texture Coordinates Saves all UV texture coordinates that are assigned to face vertices

Export Polylines Saves all vectors or polylines

Export Materials Saves all materials that are used by mesh objects

Max Vertices in Polygon Exports polygons containing less than or equal to the specified number of vertices. This reduces the file size.


5.2.39 XAML

Use

You can export XAML (.xaml) files.

XAML (eXtensible Application Markup Language) is a declarative XML-based language that defines objects and their properties in XML. Export allows any 3D content to be translated into 3D XAML. These files can be directly integrated into your application development environment to create rich and engaging user experiences never before possible.

It provides developers and designers with a quick and easy solution for creating 3D content for Vista and 3D interface elements for Microsoft Windows Vista based applications.

XAML syntax focuses upon defining the user interface for the Windows Presentation Foundation (WPF) and is therefore separate from the application code behind it.

Requirements

To view and render 3D XAML files:

● Windows Vista, or XP, Windows Server 2003, w SP2● .NET 3.0

Limitations

● Bone animation, skinning, and morphing not supported● Polylines not supported● Directional light type not supported● Ambient materials not supported● Keyframe animation supports only the “default” sequence● Material export: only diffuse, specular and emissive textures supported● Material animation: only color and transparency animation supported● Cameras: only current active camera exported

Features


Export Interface




Common Establishes the general export settings.

● Root Element Type: Sets the root element. XAML documents are xml based, so there must be a root element in every document. The XAML plug-in currently supports two elements as root elements.○ Viewport 3D: Defines a control which displays 3D

content. XAML documents with this root element can have a camera and an animation definition, and can be displayed by the standard XAML browser shipped with .Net 3 runtime. Internally, Viewport 3D contains Model 3D-derived elements.

○ Model 3D: Defines functionality for 3D models. This is an abstract class so the resulting XAML document contains one of the Model 3D-derived classes: GeometryModel 3D, a 3D model comprised of a mesh and a material, a Light-derived class, or a Model 3D Group comprised of other Model 3D-derived classes. Model 3D cannot contain an animation and a camera definition, and currently cannot be displayed by the standard XAML browser.

● Animation Behavior: Sets the way in which the animation will play○ Play Once: Stops the animation when it reaches the

end○ Repeat: Plays the animation again when it reaches

the end● Include Standalone Viewer with Model: The plug-in cop

ies an executable .exe file with the same name as the result file, to the same directory where the export result is created. You can use this to view the result of the export. To run the viewer, you must have .NET 3.0 installed. The Microsoft .NET Framework 3.0 Redistributable Package can be downloaded from http://go.microsoft.com . If you are using Windows Vista you do not need to install this package, Windows Vista is shipped with .Net 3.0. The default value is Yes.

● Launch Viewer after Export: SAP 3D Visual Enterprise Author launches the copied viewer after exporting the model. The default value is Yes.


http://help.sap.com/disclaimer?site=http%3A%2F%2Fgo.microsoft.com

http://help.sap.com/disclaimer?site=http%3A%2F%2Fgo.microsoft.com


Advanced Options Defines the advanced export settings

● Export Back Materials: Emulates double-sided materials● Export Default Lights: Exports lights that are not present

in the Scene Tree. These lights are those that illuminate the model when there are no specific lights in the Scene Tree. Enable this setting when you export with the Viewport 3D root element to view the model in the standard XAML browser.

● Use Quaternions for Rotation: Sets rotation transformations to use the quaternion notation. Otherwise, the axis/angle notation is used.

● Use Scale/Rotation/Translation Order for Transformations: Exports transformations as a composition of three operations: scaling, rotation and translation, instead of a more compact matrix notation. If you enable animation, this setting is forced.

Viewport 3D Sizes Reduces the maximum size of the Viewport 3D element in a viewer or browser, by setting the Maximum Width and the Maximum Height. By default, the Viewport 3D element occupies the entire window of a viewer.

Texture Maps Saves the texture maps used by the saved scene, as files in the same directory

● Save Textures: Saves the texture maps● Overwrite existing: Overwrites existing textures● Convert textures to: Saves the texture maps as the

specified file type

5.2.40 Wavefront Object

Use

You can import and view Wavefront Object (.obj) files.

The .obj file format was developed for the Wavefront application developed by Alias. The format stores a description of the surface of a 3D object, composed of triangles or higher degree polygons.


The .objf file format, (a derivative of the .obj format), is supported. Stripe files have the following file structure:

● Vertex data: Geometric vertices (v), texture vertices (vt), and vertex normals (vn)



NoteVertices, textures and normals are each sequenced from 1

● Elements data: Triangle strip (t) and triangle strip continuation (q)

NoteThere are no import options associated with the .objf file format


● Associated materials exported as .mtl files● Groups read as separate objects● Polygonal objects and free-form objects. Polygonal geometry uses points, lines, and faces to define objects

while free-form geometry uses curves and surfaces. SAP 3D Visual Enterprise Author reads only polygonal geometry

● Texture coordinates

Features


Import Interface


Import Material File Imports all material information from the .mtl file


Export Interface




● Compact Data: Optimizes all vertices, normals, and texture coordinates by and compresses the data by removing any duplicate items

● Create Material File: Saves all material information in the .mtl file

● Export Vertex Normals: Saves the vertex normals in the .obj file

● Export Texture Coordinates: Saves any (u,v) texture coordinates that are assigned to face vertices in the .obj file

● Triangulate Non-Flat Polygons: Converts all non-flat polygons to triangles

● Flip Coordinate System: Rotates the model so it uses a left-hand coordinate system. That is, it flips the Y and Z axes.

● Create SubD Control Mesh: Creates low detail, low polygon count subdivision control mesh with models that contain SubDs. This mesh is subdivisible.

● Max Vertices in Polygon: Exports polygons containing fewer than or equal to the specified number of vertices. This reduces the file size.

● Replace Material Colors: Replaces material colors (ambient, diffuse, and specular) with white if the same texture is present and if the texture blending mode is set to “Replace”. This ensures the saved file more closely resembles the source scene.

● Maximum String Length Before Wrap: Sets a specific string length before wrapping

Number of Digits after the Decimal Point Manages double precision output

● Vertices (v): Optimizes precision for geometric vertices● Normals (vn): Optimizes precision for vertex normals● UVs (vt): Optimizes precision for texture vertices

Example

The following is an example of a Stripe file:

v 0.000000 0.000000 1.000000 # Vertex 1v 1.000000 1.000000 0.000000 # Vertex 2v 2.000000 0.000000 0.000000 # Vertex 3v 3.000000 1.000000 0.000000 # Vertex 4v 4.000000 0.000000 0.000000 # Vertex 5v 3.000000 -1.000000 0.000000 # Vertex 6v 4.000000 -1.000000 0.000000 # Vertex 7v 2.000000 2.000000 0.000000 # Vertex 8v 3.000000 2.000000 0.000000 # Vertex 9v 3.000000 3.000000 0.000000 # Vertex 10t 10 9 8 # Start of triangle strip 1q 4 # Continuation of triangle strip 1q 2 #



Continuation of triangle strip 1q 3 1 # Continuation of triangle strip 1t 3 4 3 5 # Start of triangle strip 2q 6 7 # Continuation of triangle strip 2

The following is an example of an .obj file:

v 0.000000 2.000000 2.000000v 0.000000 0.000000 2.000000v 2.000000 0.000000 2.000000v 2.000000 2.000000 2.000000v 0.000000 2.000000 0.000000v 0.000000 2.000000 0.000000v 2.000000 0.000000 0.000000v 2.000000 2.000000 0.000000f 1 2 3 4f 8 7 6 5f 4 3 7 8f 5 1 4 8f 5 6 2 1f 2 6 7 3

5.3 Video File Formats

The following video file formats are supported by SAP 3D Visual Enterprise Author and SAP 3D Visual Enterprise Generator, unless otherwise indicated. This list is organized alphabetically by file format.



ASF NoteThis file format is not supported in SAP 3D Visual Enterprise Generator

Audio Video Interleave Animation [page 733] AVI N/A

M1V, MPEG, MPG NoteThis file format is not supported in SAP 3D Visual Enterprise Generator

Moving Pictures Expert Group Video Export [page 735] MP4 N/A

5.3.1 Audio Video Interleave Animation

Use

You can view Audio Video Interleave Animation (.avi) files. You can also save files to this format.

The .avi format is the Microsoft Video for Windows standard, and was developed for storing video and audio information.




Limitations

● To AVI format only; no conversion available

Features


Export Interface


Compressor Selects the type of compression to apply to the file

Compression Quality Determines the quality with which to save the file

NoteNot available for Intel IYUV codec, DiVX® 5.1.1 codec, or Full Frames (uncompressed)

Key Frame every [number] Frames Determines the pixels that comprise each complete frame. The higher this value, the lower the quality and file size of the exported file.

Data Rate [number] KB/Sec Opens the Cinepak for Windows 32 window, and is used to determine the bandwidth requirements of the video and the amount of data to be transmitted for each frame

Configure Opens the window for the selected compressor, and compresses the file to either color or black and white

NoteNot available for Intel Indeo® Video R3.2, Intel R3.2, Intel IYUV, for Full Frames (uncompressed)

About Opens the window for the selected compressor and displays its release information

NoteNot available for Full Frames (uncompressed)



5.3.2 Moving Pictures Expert Group Video Export

Use

You can save files to the Moving Pictures Expert Group Video (.mp4) format.

This is a standard format used on Video CDs and DVDs. MPEG is used to encode audio, video, text, and graphical data within a single, synchronized data stream.

Features


Export Interface


Bitrate Determines the bandwidth requirements of the video, and the amount of data to be transmitted for each frame

5.4 Document File Formats

The following document file formats are supported by SAP 3D Visual Enterprise Author and SAP 3D Visual Enterprise Generator, unless otherwise indicated. This list is organized alphabetically by file format.



Adobe Portable Document Import [page 748] PDF N/A

Adobe Portable Document 2D [page 736] PDF N/A

Adobe Portable Document 2D (Template) [page 737]

PDF N/A

Adobe Portable Document 3D [page 739] PDF Creates a PDF document with 3D content

Requires PDF Publishing to be installed





Flex Web Application [page 749] HTML Must be viewed with SAP 3D Visual Enterprise Viewer

HTML Document with 3D [page 753] HTML Must be viewed with SAP 3D Visual Enterprise Viewer

Office PowerPoint Document [page 756] PPT NoteThis file format is not supported in SAP 3D Visual Enterprise Generator

Web Archived HTML Document [page 759] MHT Must be viewed with SAP 3D Visual Enterprise Viewer

5.4.1 Adobe Portable Document 2D

Use

You can export files to the Adobe Portable Document (.pdf) format.

For information regarding 3D interactivity within PDF documents, please see the Adobe Acrobat Professional Help delivered with Adobe Acrobat 3D.

Features

This format contains export options. You can use them to customize the way in which your file is exported.

Export Interface


Compress PDF Reduces the size of the new PDF document

Open PDF after Saving Opens Adobe Acrobat and displays the PDF document after the file is exported to the .pdf format

Text and Fonts Selects what will be exported

● Geometry Only● Geometry with Hidden Text● Embedded Fonts

Flatten Layers Flattens any 3D layers which may exist in the file

Bitmap Resolution (DPI) Selects the level of resolution in the PDF document




Export Active View Only Exports only the active view

Export Hidden Objects Exports all objects, including those that are hidden

Black and White Exports all objects in black and white

Export Whole Pages as Bitmaps Exports pages as bitmaps

Color Compensate for Paper Sets the type of color compensation for files that will be printed

Viewports to Include Selects whether all viewports are included, or only page layout views

5.4.2 Adobe Portable Document 2D (Template)

Use

You can export files to the Adobe Portable Document (.pdf) format with PDF Publishing.

Developed by Adobe, it is used for representing documents in a manner that is independent of the original application software, hardware, and operating system used to create those documents. A .pdf file can describe documents containing any combination of text, graphics, and images in a device independent and resolution independent format.

Features


Export Interface



PDF Template and Target Used to view and select the template on which to base the new PDF document

● Preview: Displays a preview of the selected template● Name: The names of the available templates● Description: The description of the selected template● Use External Template: Selects the external template on

which to base the PDF document○ File Name: The file name and path of the template○ Browse: Browses for and selects the template

● 3D Model or 2D Image Target: Selects the target location of the model or image in the PDF document○ Field Name: The name of the field in which the

graphic will display. For example, 3D_Annotation1○ Refresh: Refreshes the display

● Start Adobe Acrobat after Publishing: Opens Adobe Acrobat and displays the PDF document after the file is exported to the .pdf format

NoteThe Adobe application that opens depends on what is installed on your computer

Publishing Options Additional settings relating to all publishing

● Align: Sets the page alignment for 2D images




PDF Specific Additional settings relating to all models and images

● XFDF file name: Attaches an XFDF file containing data to auto-fill fields in the PDF during publishing

● Browse: Browses for and selects the file● Attachments: Attaches files to the PDF during publish

ing (Word, PowerPoint, CATIA, any file on disk)● Doc Level JS: Adds custom JavaScripts to the PDF at

document level● Page Level JS: Adds custom JavaScripts to the PDF at

page level● 3D Level JS: Adds custom JavaScripts to the PDF at 3D

level● Add Watermark with the Following Text: Creates text on

a printed watermark● Watermark Text: The text to print in the watermark● Password Protect Editing of PDF: Sets a protection pass

word for editing the PDF● Password: The protection password● Password Protect opening of PDF: Sets a protection

password for opening the PDF● Password: The protection password● Enable PDF for Merging: Creates unique names for all

RH Acrobat controls so that multiple interactive PDF documents can be merged together in Acrobat without causing conflicts

● Metadata: Opens the Metadata window, and is used to add information to the PDF document XMP (Extensible Metadata Platform) properties

5.4.3 Adobe Portable Document 3D

Use

You can publish files to the Adobe Portable Document (.pdf) format with PDF Publishing.

Developed by Adobe, it is used for representing documents in a manner that is independent of the original application software, hardware, and operating system used to create those documents. A .pdf file can describe documents containing any combination of text, graphics, and images in a device independent and resolution independent format

Most 3D content contained within these files is converted to the Universal 3D (.u3d) format. This format was adopted by Adobe and is required and used as the 3D publishing format in Adobe Acrobat.



Features

This format contains export options. You can use them to customize the way in which your file is published.

Export Interface


PDF Template and Target Used to view and select the template on which to base the new PDF document


which to base the PDF document○ File Name: The file name and path of the template○ Browse: Browses for and selects the template

● 3D Model or 2D Image Target: Selects the target location of the model or image in the PDF document○ Field Name: The name of the field in which the

graphic will display. For example, 3D_Annotation1○ Refresh: Refreshes the display

● Start Adobe Acrobat after Publishing: Opens Adobe Acrobat and displays the PDF document after the file is exported to the .pdf format

NoteThe Adobe application that opens depends on what is installed on your computer




Publishing Options Additional settings relating to all publishing

● 3D Publishing Options: Additional settings relating to 3D models. These options determine the way in which the 3D model displays, whether the 3D model is activated when the PDF is opened, and whether associated model views are included.○ Preview Image: Determines what displays in the 3D

model area of the PDF○ Raster Image via Software Z-Buffer Render:

Creates a hybrid file using the Software Z-buffer renderer

○ Raster Image via Ray-Trace Render: Creates a hybrid file using the Raytracer renderer. Note that this option is not suitable for a 3D model with callouts

○ External Raster Image: Displays an external raster image instead of the 3D model

○ External Vector File (in PDF): Displays an external vector image instead of the 3D model

○ Vector Image via Illustration Module: Displays the image as a vector illustration of the current view of the scene. Otherwise, the image is displayed as a raster illustration.

○ Raster Image via DirectX 9 Render: Creates a hybrid file using the DirectX 9 renderer

○ Settings: Opens the appropriate Settings window, and is used to establish settings for the type of publishing option that you have selected. This option is not available when Preview Image is set to either of the external publishing options.

○ External Image File: The file name and path of the external raster image. This option is only available when Preview Image is set to External Raster Image or External Vector File (in PDF).

○ Browse: Used to browse for and select the file. This option is only available when the Preview type is set to External Raster Image

○ Use Optimal U3D Settings: Nominates optimal U3D settings. If unchecked, the current U3D export settings are used for export.

○ Texture Quality: Nominates the quality of the textures in the file

○ Save Normals: Saves all normals. Note that opting to save normals results in an increased file size.



○ Store Metadata: Saves all associated metadata○ Extrude PMI Arrows: When enabled, flat PMI arrow

heads are converted into 3D arrowheads for better visibility.

○ Enable PMI Highlight: When enabled, resulting PDF contains PMI highlight association with faces, lines and points. When user clicks on PMI, the associated object is highlighted. Note that Vectorize Callouts must be set to Vector and Store Metadata enabled.

○ Vectorize Callouts: Selects the way in which callouts display in the PDF○ Standard: Callouts are converted to meshes,

with no further action. Note that callouts will move with the camera.

○ Vector: Converts billboard style callouts to the vectorized equivalent, creating a separate object for each callout

○ Raster: Callout body will be an image of the callout

○ Publish Current 3D Scene Background Image: Publishes an associated background image○ Publish External 3D Scene Background Image:

Publishes a selected external file as a background image for the 3D scene

○ External File: The file name and path of the external raster image. This option is only available when Preview Image is set to External Raster Image or External Vector File (in PDF).

○ Browse: Used to browse for and select the file. This option is only available when the Preview type is set to External Raster Image.

○ Activate 3D model: Automatically activates the 3D model when the PDF document is opened. Otherwise, the 2D image is displayed.

○ Show Toolbar of 3D model: Shows or hides the 3D toolbar in Adobe Acrobat

○ Save Cameras to Adobe Acrobat: Saves all cameras within the file for viewing in Adobe Acrobat

○ Save Model Views to Adobe Acrobat: Saves all model views within the file for viewing in Adobe Acrobat

○ Mark all Callouts as PMI objects: Automatically converts all the callouts in the file into PMIs, to




place the callouts in front of the object in the scene. Note that the Preferred 3D PMI Rendering Mode setting in the Adobe Acrobat Preferences, needs to be set to Always Render 3D PMI in front of Model.

○ Minimize Java Code Generation: Automatically minimizes the amount of Java code generated

● 2D Image Publishing Options: Additional settings relating to 2D images. These options determine the way in which the 2D image displays.○ Image Format: The way in which the 2D image dis

plays in the published PDF○ Raster image via Software Z-Buffer Render:

Creates a hybrid file using the Software Z-buffer renderer

○ Raster image via Ray-Trace Render: Creates a hybrid file using the Raytracer renderer

○ Vector image via 2D PDF Module: Displays the image as a vector image. Otherwise, the image is displayed as a raster image. Note that this option is only available for 2D vector .DWG or .DWF files.

○ Vector image via Illustration Module: Displays the image as a vector illustration of the current view of the scene. Otherwise, the image is displayed as a raster illustration.

○ Raster image via DirectX 9 Render: Creates a hybrid file using the DirectX 9 renderer

○ Settings: Opens the appropriate Settings window, and is used to establish settings for the type of publishing option that you have selected.



PDF Specific Additional settings relating to all models and images

● XFDF file name: Attaches an XFDF file containing data to autofill fields in the PDF during publishing

● Browse: Browses for and selects the file● Attachments: Attaches files to the PDF during publish

ing (Word, Powerpoint, CATIA, any file on disk)● Doc Level JS: Adds custom JavaScripts to the PDF at

document level● Page Level JS: Adds custom JavaScripts to the PDF at

page level● 3D Level JS: Adds custom JavaScripts to the PDF at 3D

level● Add Watermark with the Following Text: Creates text on

a printed watermark● Watermark Text: The text to print in the watermark● Password Protect Editing of PDF: Sets a protection pass

word for editing the PDF● Editing Password: The protection password● Password Protect opening of PDF: Sets a protection

password for opening the PDF● Opening Password: The protection password● Enable PDF for Merging: Creates unique names for all

RH Acrobat controls so that multiple interactive PDF documents can be merged together in Acrobat without causing conflicts

● Metadata: Opens the Metadata window, and is used to add information to the PDF document XMP (Extensible Metadata Platform) properties

5.4.3.1 Metadata Window

Use

You can use the Metadata window to establish the information displayed in the document properties when a model is published to the .pdf format.



Features


Title The document title that is displayed in the Document Title field of the Acrobat 3D Additional Metadata window

Author The name that is displayed in the Author property. The current user name is displayed here by default.

Subject The subject of the scene that is displayed in the Subject property

NoteThis is used in the Description field in the Acrobat 3D Additional Metadata window.

Keywords Additional scene information that is displayed in the Keywords property

Auto-Generate Title Automatically displays the file name and extension in the Title property. Any text entered in the Title field is ignored.

Auto-generate Subject Automatically displays the file name, and associated template name in the Subject property. Any text entered in the Subject field is ignored.

Add Parts List to Keywords The model’s parts list that is displayed in the Keywords property. This information is displayed after any information entered in the Keywords field.

Activities

Opening the Metadata Window

When publishing to the .pdf format, choose Settings PDF Specific tab Metadata Settings

5.4.3.2 Ray-Trace Render Settings Window

Use

You can use the Ray-Trace Render Settings window to establish a number of rendering settings for Ray-Trace. These include antialiasing, double-sided polygons, texture map filtering, and shadow management.


Features


Antialiasing Sets the antialiasing for a raster ray-trace image

Double-sided polygons Renders polygons as double-sided

Filter Texture Maps Filters all texture maps

Ray-Trace Reflections Applies reflections to the image

Refractions Applies refractions to the image

Shadows Renders all shadows

Soft Shadows Applies soft shadows to the image

Use Multithreaded Rendering Renders the image using multithreading

Activities

Opening the Ray-Trace Render Settings Window

When publishing to the .pdf format, choose Settings Publishing Options tab Raster Image via RayTrace Render Settings .

5.4.3.3 Vector Illustration Settings Window

Use

You can use the Vector Illustration Settings window to establish a number of vector rendering settings for use when exporting to PDF. These include line thickness, and wireframe display.



Features


Lines Selects various line output options for the illustration

● Line thickness: Determines the thickness of rendered lines

● Boundary Thickness: Determines the thickness of the object boundaries. The range is 0 to 10.

● Tolerance Angle: Determines the degree of angle tolerance for all rendered outlines. If the angle between two adjacent faces is greater than this value, then the edge between these faces is treated as an outline edge.

● Calculate Intersections: Draws lines along all face-face intersections. Vectors are normally calculated using triangle edges. If the lines of intersection fall outside of triangle edges where geometry or objects intersect each other, this option can be used to calculate the triangle intersections and output them as vectors.

● Remove Hidden Lines: Removes lines that are hidden by the geometry. For example, a Z-buffer. This is usually what is required for rendering. However, at times you may want a see-through effect. We recommend selecting this option.

● Show as Wireframe: Causes all edges to be treated as outline edges. The tolerance angle setting becomes redundant when this is selected.

Colors Selects the colors to use in the illustration

● Use Object Color: Uses the object’s color for each object’s rendered lines

● Line Color: Opens the color selector so you can select a color for rendered lines. This option is only available if the Use Object's Color check box is not selected.

BOM Determines if and where the BOM is placed on the illustration

● None: Excludes the BOM from the illustration● Bottom: Places the BOM at the bottom of the illustra

tion● Right: Places the BOM at the right of the illustration

Activities

Opening the Vector Illustration Settings Window


When publishing to the .pdf format, choose Settings Publishing Options tab Vector Image via Illustration Module Settings .

5.4.3.4 Z-Buffer Render Settings Window

Use

You can use the Z-Buffer Render Settings window to define Z-Buffer rendering settings including antialiasing.

Features


Antialiasing Sets the antialiasing for a raster image

Render Additional Items Renders all additional items

Activities

Opening the Z-Buffer Render Settings Window

When publishing to the .pdf format, choose Settings Publishing Options tab Raster Image via Software Z-Buffer Render Settings .

5.4.4 Adobe Portable Document Import

Use

You can import and view Adobe Portable Document (.pdf) files.


Features




Import Interface


Smooth Text Determines the appearance of the text in the PDF by applying smoothing. Applying smoothing to attributes can be helpful in improving the overall appearance of the file.

Smooth Lines Determines the appearance of the lines in the PDF by applying smoothing.

Smooth Images Determines the appearance of images in the PDF by applying smoothing.

Output DPI Converts inches to pixels

5.4.5 Flex Web Application

Use

You can publish files to the Flex Web Application (.html) format.

When publishing to the Flex Web Application format, you can:

● Select a base template to apply to the published scene● Control other properties relating to the saved .rh file and additional information that may be used by the

template

The export properties continue for each template.

If you want a template that you have created to be discovered by SAP 3D Visual Enterprise Author and displayed in the template list, you must copy your template into the Plugins\FLX_Publishing folder. This is a sub folder of the folder where SAP 3D Visual Enterprise Author is installed. Alternatively, the path to a template can be specified in the Export Properties of Flex Web Application window.

Features


Export Interface



Templates Used to view and select the template on which to base the new HTML document


which to base the HTML document○ File Name: The file name and path of the template○ Browse: Browses for and selects the template

● Start Browsing Program after Publishing: Opens the program and displays the HTML after the file is exported to the .html format




RH File Options Establishes the way in which .rh files are exported

● Compression: Indicates whether file compression is used when exporting files. This reduces the file size while maintaining the quality. Compression helps to reduce the amount of storage and transmission bandwidth required for 3D models.

● RH Compression: Establishes the compression settings, if compression is to be used○ Compression Mode: Determines the type of the

compression with which to export the file. The faster the compression, the faster the file is saved but the larger the resulting file.○ Very Fast: Compresses the file using a low level

of compression. This creates the largest file. However, the compression speed is very fast



○ Best: Compresses the file using the maximum level of compression. This creates a very small file. However, the compression speed is very slow.

○ Dictionary Size: Determines the size of the dictionary size to use for compression. The larger the size of the dictionary, the better the compression.

● Export Animation: Saves the keyframe animation in the file

● Vertices Quality: Establishes the percentage of the data about the vertices to keep. Lossy compression is used here. Once you have compressed the vertices data, this information is lost. That is, you cannot reverse this compression.○ Percentage: Selects the percentage of data to keep

● UV vertices quality: Establishes the percentage of the data about the UV points to keep. Lossy compression is used here. Once you have compressed the UV point data, this information is lost. That is, you cannot reverse this compression.○ Off: Does not compress the UV points○ Percentage: Selects the percentage of data to keep

● Normals quality: Establishes the percentage of the data about the normals to keep. Lossy compression is used here. Once you have compressed the normals data, this



information is lost. That is, you cannot reverse this compression○ Off: Does not compress the normals○ Percentage: Selects the percentage of data to keep

● File protection: Establishes the type of protection that the exported file has. This is helpful if you want to distribute a proprietary model to people who need to see the file, but should not edit or copy it. For example, if a company’s Web site features an online parts catalog which displays their parts, and the company does not want their competitors obtaining usable copies of these parts. Note that the file name, path, and protection status is displayed in the application title bar.○ No: File protection is disabled○ Conversion Protected: Prevents the file being saved

to any format other than this format○ Read Only: The file can be viewed, but not saved

● Disable Measurements: Protects the measurements in the exported file. Once this option is enabled, the file cannot be measured by using the SAP 3D Visual Enterprise Author measurement tools.

● Export viewports: Saves the current viewport layout in the file

● Thumbnail: Creates the specified size thumbnail image of the current model. The thumbnail image displays any setting that has been applied to the model. The thumbnail is displayed in Windows Explorer (with Thumbnail view turned on). Alternatively, you can select to not create a thumbnail image.○ No thumbnail: Does not create a thumbnail○ [size]: Creates a thumbnail of the specified width

and height, in pixels● Password Encrypted: Sets password-controlled encryp

tion for the file● Save watermark: Saves a watermark with the file. Note

that if this field is set to YES, and Watermark file is empty, a default watermark is stored in the file.

● Watermark file: Selects the watermark image to be saved with the file

Additionals Additional settings relating to all models and images

● Author: The name to display in the Web page● Title: The title to display in the Web page● Description: The description to display in the Web page



5.4.6 HTML Document with 3D

Use

You can publish files to the HTML Document with 3D (.html) format.

When publishing to the HTML Document with 3D format, you can:

● Select a base template to apply to the published scene● Control other properties relating to the saved .rh file and additional information that may be used by the

template

The export properties continue for each template.

You can create new HTML templates using any HTML tool or editor. If you want a template that you have created to be discovered by SAP 3D Visual Enterprise Author and displayed in the template list, you must copy your template into the Plugins\HTM_Publishing folder. This is a sub folder of the folder where SAP 3D Visual Enterprise Author is installed.

Alternatively, the path to a template can be specified in the Export Properties of the HTML Document with 3D window. A subdirectory in the same folder as a template can be used to store additional files used by the template. The template resource folder name should be in the form <template name>_files.

You can also modify the HTML of a published scene. For example, you may want to make a one-off modification without creating a new template.

Features


Export Interface








information is lost. That is, you cannot reverse this compression.○ Off: Does not compress the normals○ Percentage: Selects the percentage of data to keep








that if this field is set to YES, and Watermark File is empty, a default watermark is stored in the file.





5.4.7 Office PowerPoint Document

Use

You can export files to the Office PowerPoint Document (.ppt) format.

Features


Export Interface


Templates Used to view and select the template on which to base the new PowerPoint document


which to base the PowerPoint document○ File Name: The file name and path of the template○ Browse: Browses for and selects the template

● Start Browsing Program after Publishing: Opens the program and displays the document after the file is exported to the .ppt format







● Disable Measurements: Protects the measurements in the exported file. Once this option is enabled, the file cannot be measured by using the SAP Visual Enterprise Author measurement tools.




tion for the file● Save Watermark: Saves a watermark with the file. Note


● Watermark File: Selects the watermark image to be saved with the file


● Author: The name to display in the document● Title: The title to display in the document● Description: The description to display in the document



5.4.8 Web Archived HTML Document

Use

You can publish files to the Web Archived HTML Document (.mht) format.

When publishing to the Web Archived HTML Document format, you can:

● Select a base template to apply to the published scene. These templates are stored in the SAP 3D Visual Enterprise Author x\Plugins\HTML_Publishing folder. The file properties, as defined in the export window when publishing to this format, are remembered for each template.

● Modify the published scene. For example, insert images and add text.● Create new templates and save them into the SAP 3D Visual Enterprise Author x\Plugins

\HTML_Publishing folder for use when publishing to HTML. The template name must be unique, (from others in this folder), and the template resources folder name should take the form <template name>.res.

Features


Export Interface







5.5 Material File Formats

The following material file formats are supported by SAP 3D Visual Enterprise Author and SAP 3D Visual Enterprise Generator. This list is organized alphabetically by file format.



Autodesk 3D Studio Material [page 762] MLI N/A

SAP 3D Visual Enterprise Material [page 762] RHM N/A

Wavefront Material [page 763] MTL N/A

5.5.1 Autodesk 3D Studio Material

You can view Autodesk 3D Studio Material (.mli) files:

The .mli format is used in the 3ds Studio Application developed by Autodesk to represent materials that are referenced in .max model files. MLI files contain Material-Library data.

5.5.2 SAP 3D Visual Enterprise Material

Use

You can view SAP 3D Visual Enterprise Material (.rhm) files.

You can also save files to the SAP 3D Visual Enterprise Material file (.rhm) format. Using it you can save the materials that belong to a scene to a separate material file. You can also choose to save the default material, compress the exported file, apply protection, and create thumbnails of varying sizes.

Features


Export Interface






Compression Reduces the file size while maintaining the quality. Compression helps to reduce the amount of storage and transmission bandwidth required for 3D models.

File Protection Protects the exported file. Once the file is protected, you cannot save the file as anything other than an .rhm file format.

Export Default Material Saves the default material in the file

Thumbnail Creates the specified size thumbnail image of the current model. The thumbnail image displays any settings that have been applied to the model. The thumbnail is displayed in Windows Explorer with Thumbnail view turned on. Alternatively, you can select to not create a thumbnail image.

● No Thumbnail: Does not create a thumbnail● [size]: Used to select the width and height of the thumb

nail, in pixels

5.5.3 Wavefront Material

You can view Wavefront Material (.mtl) files.

Wavefront Material files are created by Alias/Wavefront to represent materials that are referenced in .obj model files. They are in the ASCII format.

Comments begin with a # character in column 1. Blank lines may be inserted for clarity. Otherwise, the file consists of a sequence of newmtl statements, followed by a definition of various properties for that material.

5.6 Miscellaneous File Formats

The following miscellaneous file format is supported by SAP 3D Visual Enterprise Author and SAP 3D Visual Enterprise Generator.






Text File [page 764] TXT N/A

5.6.1 WinRAR Compressed Archive

You can view the compressed files contained within WinRAR Compressed Archive (.rar) files. This is the native format of WinRAR archiver. Like other archives, .rar files are data containers; that is, they store one or several files in the compressed form.

NoteWhen you open an archive file, you are able to view the compressed files that are contained within it.

5.6.2 Text File

You can view Text File (.txt) files.

The .txt format is: a pure ASCII text with no formatting. These files can also be opened in Notepad, WordPad, or other text editors.

5.6.3 ZIP Archive

You can view the compressed files contained within ZIP Archive (.zip) files.

This is a format where files are compressed (referred to as “zipped”) using a file compression program such as PKZip for DOS or Winzip for Windows. It is a popular archive format widely used in the Internet. Like other archives, .zip files are data containers, they store one or several files in the compressed form.

After you download the .zip file, you must unpack its contents to use it.

NoteWhen you open an archive file, you are able to view the compressed files that are contained within it.

5.7 CAD File Formats

The following CAD file formats are supported by SAP 3D Visual Enterprise Author and SAP 3D Visual Enterprise Generator. This list is organized alphabetically by file format.



NoteWhile the “Save” window is used to save to most CAD formats, the Vector Illustration tool can also be used to save to additional CAD formats, such as .cgm. Certain formats can be saved using both methods, such as .dxf

RememberFor further information relating to supported format versions, refer to 2334841 for SAP 3D Visual Enterprise Author, and 2334827 for SAP 3D Visual Enterprise Generator.


ACIS Assembly and Part [page 767] SAT N/A

AutoCAD Design Web Format [page 654] DWF N/A

AutoCAD Drawing Object [page 662] DWG NoteAlso a 2D file format.

AutoCAD Drawing Interchange [page 657] DXF Export also using Vector Illustration

NoteAlso a 2D file format.

AutoCAD Sheet Set File [page 672] DST N/A

CATIA V4 Assembly [page 771] SESSION, EXP N/A

CATIA V4 Part [page 774] DLV, MODEL Option to import either 2D or 3D

CATIA V5 Assembly [page 778] CATPRODUCT N/A

CATIA V5 Part [page 786] CATPART, CATSHAPE

N/A

CATIA V5 Drawing File [page 791] CATDRAWING N/A

CATIA V6 (3DXML) [page 793] 3DXML N/A

CATIA Graphical Representation [page 769]

CGR N/A

Creo Parametric (Pro/ENGINEER) Assembly File [page 795]

ASM, XAS NoteNo assembly level features or family tables support in SAP 3D Visual Enterprise Author.





Creo Parametric (Pro/ENGINEER) Neutral File [page 801]

NEU N/A

Creo Parametric (Pro/ENGINEER) Part File [page 798]

PRT, XPR NoteNo family tables support in SAP 3D Visual Enterprise Author.

Creo Parametric (Pro/ENGINEER) Drawing [page 804]

DRW N/A

Industry Foundation Classes [page 808] IFC 2x3 & 2x4

IGES Assembly and Part [page 805] IGES, IGS N/A

Inventor Assembly [page 809] IAM Two reading methods:

● Import Inventor Solid● Quick View: requires free Inventor viewer installed on

machine

Inventor Part [page 812] IPT Two reading methods:

● Import Inventor Solid● Quick View: requires free Inventor viewer installed on

machine

JTPMI File [page 815] JT N/A

MicroStation CAD Graphic [page 821] DGN N/A

NX Parts and Assemblies [page 823] PRT (including drawing files)

Option to import either 2D or 3D

Parasolid Assembly and Part [page 829] X_B, X_T N/A

PLMXML [page 831] PLMXML N/A

Solid Edge Assembly [page 832] ASM N/A

Solid Edge Part [page 835] PAR N/A

Solid Edge Sheet Metal Part [page 838] PSM N/A

Solid Edge Weldment Design Part [page 841]

PWD N/A

Solid Edge Drawing [page 844] DFT N/A

SolidWorks Assembly [page 845] SLDASM, ASM N/A




SolidWorks Part [page 848] SLDPRT, PRT N/A

SolidWorks Drawing [page 851] SLDDRW N/A

STEP Assembly and Part [page 855] STEP, STP N/A

STEP Compressed Assembly and Part [page 852]

STPZ, STP.Z N/A

5.7.1 ACIS Assembly and Part

Use

You can import and view ACIS assembly and part (.sat) files.

The SAT format is the published format of ACIS by Spatial Technology. This format is used by different CAD/CAM-applications such as AutoCAD.

Supported:

● Assembly hierarchy● File properties, Model properties● Object Attributes, color, and object names● Solid or Mesh Import

○ Tessellation control with mesh import and dynamic tessellation option for solid import○ Normals and UV coordinates

Limitations:

● 2D vector data● Animation● Textures

Features


Import Interface



Common Defines the general settings including tessellation (arrangement and density of the polygons).

NoteIf you enter 0 (zero) for any of the tessellation settings, they are not taken into effect during the tessellation process.

Geometry: Defines the geometry settings

● Import Metadata: Imports file metadata from the original CAD file (stored inside the file as the metadata category CADMetadata)

Tessellation Settings: Defines the tessellation settings

● Import Splines, Surfaces, and Solids: Determines whether splines, surfaces, and solids are imported

● Tessellation Level: Applies different resolutions based upon preselected values for chord height ratio and normal tolerances. If you select User Defined, further options become available.○ Angular Tolerance: Determines the maximum angular deviation (in

degrees), allowed between an analytical surface and its triangulation. Pairs of triangles do not incorporate a dihedral angle greater than this amount. For example, this setting dictates the minimum number of facets around a smaller circle or cylinder regardless of the Surface Deviation setting. This parameter gives you added control over faces with small radii. Lower values result in finer tessellations, while higher values produce coarser tessellations.

○ Chord Height Tolerance: The value between the analytical surface and its triangulation that determines the distance and accuracy of the tessellation. The lower the value, the more accurate the result. 0.00001 is the minimum unit (high detail), and 1 000 000 is the maximum unit (low detail).

○ Chord Height Behavior: Determines how accurately the chord height tolerance is applied. Absolute applies the chord height tolerance as it is. Scaled adjusts the values depending on the scale of the object being tessellated.

Construction Geometry: Defines settings for the construction geometry

● Import Surfaces: Imports all construction geometry

NoteIf a file contains sheet bodies, select this option for the file to import correctly.

● Import Points: Imports all 3D point data stored inside the CAD file and draws points as saved in CATIA files

● Import Planes: Imports all infinite 3D plane data stored inside the CAD file and draws planes as transparent mesh




● Import Wireframes: Imports all wireframes if any exist

Geometry Transform Transforms (rotate, position, and scale) the scene along the X, Y, and Z axes:


● Scale: Scales the object along the X, Y, and Z axes● Position: Sets the position of the scene along the X, Y, and Z axes

5.7.2 CATIA Graphical Representation

Use

You can import and view CATIA graphical representation (.cgr) files.

CATIA V5 is the file format used in the CAD applications developed by Dassault Systems, and is one of the most popular CAD applications.

Supported

● Hierarchical Scene Tree● Object Attributes: Color, opacity, visibility, and object names● Mesh import

Limitations

● No Kinematics and animation support● No texture support● PMI not supported● Metadata Properties not supported● Initial view is not respected when loaded in SAP 3D Visual Enterprise Author or SAP 3D Visual Enterprise

Generator● Construction geometry; for example, Points, Coordinate Axis, Curves, planes not supported● 2D drawing file not supported● Embedded geometry as type XVL not supported

Features


Import Interface



Common Defines the general settings including tessellation (arrangement and density of the polygons)



● Import Hidden Objects: Imports all hidden objects. If you modify any visible objects that contain hidden subobjects after import, those hidden objects are also modified.

● Display Hidden Objects: Displays all hidden objects in the viewport after importing the file


● Collect Metadata to Geometry: Determines how metadata is collected. This option is only available if Import Metadata is set to Yes.

○ From Parents: All metadata is collected to the parent geometry node, and there are no metadata nodes solely to store metadata

○ Do Not Merge: There can be empty nodes to store metadata

Geometric Entity Filter: Defines settings for the construction geometry




● Import Wireframes: Imports all wireframes if any exist● Draw Wireframes on Top: Draws wireframes on top of other 3D geometry




5.7.3 CATIA V4 Assembly and Part

You can import and view CATIA V4 assembly and part files (.exp, .session, .dlv, .model).



CATIA is the file format used in the CAD applications developed by Dassault Systems and is one of the most popular CAD applications.

5.7.3.1 CATIA V4 Assembly

Use

You can import and view CATIA V4 assembly files (.exp, .session).

Supported

● Hierarchical structured Scene Tree● File properties, Model properties● Object Attributes color, opacity, visibility, and object names● Solid or Mesh import option


● Multiple workspace support (creates multiBOM in the Visual Enterprise scene)● Construction geometry; for example, Points, Coordinate Axis, Surfaces/Curves, planes (imported as

wireframes) with line-style support● 2D drawing file support

Limitations

● No Kinematics and animation support● No texture support● PMI not supported● Metadata in the Scene Tree sorts in alphabetical order so the original order is not preserved.● Initial view is not respected when loaded in SAP 3D Visual Enterprise Author or SAP 3D Visual Enterprise

Generator● If the model is made up of surfaces, results sometimes have wrong normals and holes in the joint of

patches● 2D drawing files: Not all embedded OLE objects other than bitmaps are imported. Last saved only from

cached geometry● 2D drawing files: Semantic PMI information not supported

Features


Import Interface



Loading Option Defines the options for loading

● 2D/3D Loading: Loads 2D vectors and 3D solids, 3D solids only, or 2D only

Drawing Defines the drawing settings. This option is only available when 2D has been included in the Loading option.

● Drawing: Selects a background color for layout







● Import Filters: Defines the import filter settings○ Import Hidden Objects: Imports all hidden objects. If you modify

any visible objects that contain hidden subobjects after import, those hidden objects are also modified.

○ Display Hidden Objects: Displays all hidden objects in the viewport after importing the file

○ Import Metadata: Imports file metadata from the original CAD file (stored inside the file as the metadata category CADMetadata)

○ Collapse Geometry: Collects all the surfaces, and tessellates collectively, treating loose surfaces as one object. This option is used to avoid seams and gaps, and produce unified normals.

○ Double Sided Surfaces: Makes corrections where incorrect or inverted normals for a given mesh result in gaps in the tessellated geometry


● Import Splines, Surfaces and Solids: Determines whether splines, surfaces, and solids are imported




○ Chord Height Behavior: Determines how accurately the chord height tolerance is applied. Absolute applies the chord height toler



ance as it is. Scaled adjusts the values depending on the scale of the object being tessellated.

PMI Captures Model Views: Defines settings for PMI

● Import PMI: Imports any Product Manufacturing Information (PMI) within the file. You can access the PMI data objects from within the 3D Objects list.


● Import Axis Systems: Imports and draws axis systems as defined in the CAD file. There may be one or more axis systems defined in the CAD file, for one or more nodes.

NoteThere are always default axis systems drawn by SAP 3D Visual Enterprise Author if you have chosen to display the axis in SAP 3D Visual Enterprise Author.









5.7.3.2 CATIA V4 Part

Use

You can import and view CATIA V4 part files (.dlv, .model).



Supported

● Hierarchical structured Scene Tree● File properties, Model properties● Object Attributes color, opacity, visibility, and object names● Solid or Mesh import option


● Multiple workspace support (creates multiBOM in the Visual Enterprise scene)● Construction geometry; for example, Points, Coordinate Axis, Surfaces/Curves, planes (imported as

wireframes) with line-style support● 2D drawing file support

Limitations


Generator● If the model is made up of surfaces, results sometimes have wrong normals and holes in the joint of

patches● 2D drawing files: Not all embedded OLE objects other than bitmaps are imported. Last saved only from

cached geometry● 2D drawing files: Semantic PMI information not supported

Features


Import Interface





● Drawing: Selects a background color for layout










○ Collapse Geometry: Collects all the surfaces, and tessellates collectively, treating loose surfaces as one object. This option is used to avoid seams and gaps, and produce unified normals.

○ Double Sided Surfaces: Makes corrections where incorrect or inverted normals for a given mesh result in gaps in the tessellated geometry

○ Workspaces: Imports the Master workspace (Default), or all the workspaces available. The Master Only option loads only the master workspace of the file. The All option shows the file in SAP 3D Visual Enterprise Author with a MultiBOM option, which allows you to display the required workspace.





○ Chord Height Tolerance: The value between the analytical surface and its triangulation that determines the distance and accuracy of the tessellation. The lower the value, the more accurate the result.




0.00001 is the minimum unit (high detail), and 1 000 000 is the maximum unit (low detail).















5.7.4 CATIA V5 Assembly and Part

You can import and view CATIA V5 assembly and part (.CATpart, .CATproduct, .CATshape) files.


CATIA is the file format used in the CAD applications developed by Dassault Systems and is one of the most popular CAD applications.

5.7.4.1 CATIA V5 Assembly

Use

You can import and view CATIA V5 assembly (.CATproduct) files.


NoteThis format is available with SAP 3D Visual Enterprise Author, or by using the CoreCAD module with SAP 3D Visual Enterprise Generator .

Supported● CATIA V5-style hierarchy support with a structured Scene Tree● Standard Views and Captures (user defined model views in CATIA V5 software)● File properties, Model properties, and Geoset Metadata (creates new nodes with hierarchy to store

metadata)● Object Attributes color, opacity, visibility, and object names (both part number and instance names)● Solid or mesh import

○ Tessellation control with mesh import and dynamic tessellation option for solid import● Normals and UV coordinates● 2D sketches(points and wireframes)● Selection set● PMI (Functional Dimensioning & Tolerancing, Geometric Dimensioning & Tolerancing)● Construction geometry; for example, Points, Coordinate Axis, Surfaces/Curves, Wireframes, planes● Import Dimensions saved in V5 Analyze/Measurement Tool● PMI to surface highlighting and PMI to Edge highlighting● CATIA V5 assembly referencing mixed formats; for example, .model, .vrml, .cgm, .cgr , .catshape● Representation support (Creates multiBOM in the Visual Enterprise scene)● Improved instancing based on geometry and parts● Persistence Identifier and CAD Identifiers

Limitations● No Kinematics support● No texture support● CATIA5 piping not supported● Not all electric features are supported, except for electric splice points● Animations not supported● UV Coordinates from Mesh not supported



● Metadata in the Scene Tree sorts in alphabetical order so the original order is not preserved.● Initial view is not respected when loaded in SAP 3D Visual Enterprise Author or SAP 3D Visual Enterprise

Generator

NoteNot all Extended Workbench features are supported. Contact the SAP 3D Visual Enterprise CAD Product Owner if you are using Extended Workbench features

Features


Import Interface









○ Import Construction Geometry: Imports the construction geometry defined in CATIA software. It could contain solid geometry or polylines.

○ Display Construction Geometry: Displays the imported construction geometry. This option is only available if Import Construction Geometry is set.

○ Import Representations: Imports different representations of an assembly that achieve the same result as the Explode Objects tool○ Default: The main representation of the assembly is the only

one loaded○ All: Various stages of the exploded assembly are loaded, with

each assembly duplicated in the scene tree as multiple BOMs○ Import Metadata: Imports file metadata from the original CAD file

(stored inside the file as the metadata category CADMetadata)

○ Import Hidden Metadata: Imports file metadata that is hidden within the original CAD file

○ Collect Metadata to Geometry: Determines how metadata is collected. This option is only available if Import Metadata is set to Yes.


○ Do Not Merge: There can be empty nodes to store metadata○ Top Level Metadata Only: Imports metadata associated with the top

level node only○ Part Naming: Determines the object name for each part in an as

sembly○ Part Name: The node name is displayed as Part Name○ Instance Name: The node name is displayed as Instance Name○ Part then Instance: The node name is displayed as Part name

<Instance name>




○ Instance then Part: The node name is displayed as Instance name <Part name>

○ Import Selection Sets: Imports selection sets. A Selection set in CATIA5 is a group of filtered selected items that can be saved with the document. Selection sets are represented as model views, and a separate portfolio called “Selection Set” is created to hold selection sets. Each model view refers to a layer of entities in a CATIA5 selection set, and a model view is created for each selection set imported. Default view is used for all of the selection set model views.

○ Import 2D Sketch Geometry: Imports sketch geometry where sketch information is applicable. This geometry can be either points or wireframes, and is controlled by respective import settings. Points and wireframes can be imported together.○ No 2D Sketch Geometry: Do not import sketch geometry○ Both 2D Sketch Wireframes and Points: Import wireframes and

points together○ Only 2D Sketch Wireframes: Import 2D sketch wireframes only○ Only 2D Sketch Points: Import 2D sketch points only

NoteTo achieve the required result, use some import settings together. For example, when importing points, use Import Hidden Objects, Import 2D Sketch Geometry, and Import Points.

○ Compact Scene Tree: Loads a collapsed version of the Scene Tree, and is set to No by default. For further information on this option, see Compact Scene Tree [page 783].

○ XML file for Collapse Rules: Selects an xml file, which determines how the Scene Tree is affected by the collapse. This option is only available if Compact Scene Tree is set to Yes.

● Tessellation Settings: Defines the tessellation settings○ Import Splines, Surfaces and Solids: Determines whether splines,

surfaces, and solids are imported○ Tessellation Level: Applies different resolutions based upon prese

lected values for chord height ratio and normal tolerances. If you select User Defined, further options become available.○ Angular Tolerance: Determines the maximum angular deviation

(in degrees), allowed between an analytical surface and its triangulation. Pairs of triangles do not incorporate a dihedral angle greater than this amount. For example, this setting dictates the minimum number of facets around a smaller circle or cylinder regardless of the Surface Deviation setting. This parameter gives you added control over faces with small radii. Lower values result in finer tessellations, while higher values produce coarser tessellations.





○ Angular Tolerance Cap: The minimum value that is applied to angular tolerance, irrespective of other settings. For example, an angular tolerance cap of 45 degrees, which ensures that a circle is tessellated to have at least eight sides.

○ Chord Height Tolerance Cap: The minimum value that is applied to chord height tolerance, irrespective of other settings



● Import Hidden PMI: Imports any Product Manufacturing Information (PMI) that is hidden within the file

● Import Model Views: Imports any custom model views within the CAD file

● Import Captures: Imports any captures within the file. Captures define a list of PMI and Geometry to display. For each capture, there is a model view in the Scene Tree.

● Create Extra Section Geometry: Imports all associated sectioning information for a geometry node. A cross-section is taken of the geometry that is visible (or included), in this model view, and it is cut to make a cross-section geometry. This option, if set to No (false), creates a real-time cross section that can be removed or reinstated. If set to Yes (true), section geometry creates a separate mesh, and displays in the corresponding capture. The default is No.

NoteThis feature only applies when you are importing captures that contain section views.

● Create Initial View with PMI: Creates a model view with all the PMI in the scene. You can view all the PMI and geometry in default view that may not have been otherwise included in any other views or captures.

● Create Initial View without PMI: Creates a new model view without any PMI, but containing all geometry in the scene















More Information

Compact Scene Tree [page 783]

5.7.4.1.1 Compact Scene Tree

Use

The “Compact Scene Tree” import option is specifically for CATIA files. It collapses and manages the complex Scene Tree from CATIA assemblies and parts, and is active by default.


“Compact Scene Tree” is filtered via an XML file compactscenetree.xml that is located in the Plug-Ins folder. The file applies a set of rules that determine the degree to which the Scene Tree is collapsed. It can be adjusted to collapse only certain nodes, or objects of the Scene Tree.

NoteCollapsing the CATIA Scene Tree can affect certain features or import settings. For example, collapsing PMI into an object places the mesh and the PMI into one node: PMI settings do not function with this PMI node. CADTools such as reducing polygons, may then affect the PMI in uncertain ways when applied to the object. If PMI needs to be an individual node, it should be excluded from collapsing via the XML.

Further Information

In the example below, the root node is called collapserule, and has three children. These are operationenums, entitytypes, and operationrules.

operationenums

Three operations are supported in operationenums. Those are: “Remove”, “Exclude”, and “Include”.

● Remove: Removes nodes that match entity types defined in entitytypes● Exclude: Ignores nodes that match entity types defined in entitytypes● Include: Collapses nodes that match entity types defined in entitytypes

entitytypes

In the entitytypes, the following entities are supported:

● CAD_PMI = 1● CAD_SHEETBODY = 2● CAD_HIDDEN = 4● CAD_WIREFRAME = 8● CAD_CONSTRUCTION_GEOMETRY = 16● CAD_COLLAPSE = 32● CAD_POINT = 64● CAD_PLANE = 128● CAD_REFIT_BBOX = 256● CAD_GLOBAL_HIDDEN = 512● CAD_AXIS_SYSTEM = 1024● CAD_PMI_GLOBAL_HIDDEN = 2048● CAD_PMI_CONSTRUCTION = 4096● CAD_SECTION_NODE = 8192

For example:

<entity name="hidden" value="4" operationenum="0" comment="Hidden entity type (Hidden by node itself)"/>

This means for the entity that is marked as hidden with value 4, it will be applied with the operation defined as 0, which is remove.

operationrules



operationrules is a set of rules that will be applied globally in the scene. The following options are supported:

● name =respectcapture: If set to 1, geometry referenced by Captures is ignored regardless of the nodes entity type and operations defined for the node

● name='generatereport': If set to 1, a collapse report is generated such as which node has been collapsed, removed

● name='keepmetadata': If set to 1, create a metadata tree that represents the original metadata hierarchy before collapsing is created

● name='keepsolid': If set to 1, solid geometry in the scene, if there is any, is retained. Otherwise, all solids are converted into a mesh

NoteThe order of entities entitytypes is important to the final collapse results.

For example:

<entity name="hidden" value="4" operationenum="0" comment="Hidden entity type (Hidden by node itself)"/<entity name="wireframe" value="8" operationenum="1" comment="Wireframe entity type"/>

If an entity has both hidden and wireframe attributes, the collapse rule picks the last defined rule above- exclude (leave it as it is in the tree), rather than deleting it as defined for hidden entity types. A warning message is generated if generatereport is active.

Example

This is an extract from the XML file with comments and short descriptions of each section.


5.7.4.2 CATIA V5 Part

Use

You can import and view CATIA V5 part (.CATPart .CATShape) files.


Supported● CATIA V5-style hierarchy support with a structured Scene Tree● Standard Views and Captures (user defined model views in CATIA V5 software)● File properties, Model properties, and Geoset Metadata (creates new nodes with hierarchy to store

metadata)● Object Attributes color, opacity, visibility, and object names (both part number and instance names)● Solid or mesh import

○ Tessellation control with mesh import and dynamic tessellation option for solid import● Normals and UV coordinates● 2D sketches(points and wireframes)● Selection set● PMI (Functional Dimensioning & Tolerancing, Geometric Dimensioning & Tolerancing)● Construction geometry; for example, Points, Coordinate Axis, Surfaces/Curves, Wireframes, planes● Import Dimensions saved in V5 Analyze/Measurement Tool● PMI to surface highlighting and PMI to Edge highlighting● Persistence Identifier and CAD Identifiers

Limitations● No Kinematics support● No texture support● CATIA5 piping not supported● Not all electric features are supported, except for electric splice points● Animations not supported● UV Coordinates from Mesh not supported● Metadata in the Scene Tree sorts in alphabetical order so the original order is not preserved.● Initial view is not respected when loaded in SAP 3D Visual Enterprise Author or SAP 3D Visual Enterprise

Generator




Features


Import Interface









○ Import Construction Geometry: Imports the construction geometry defined in CATIA software. It could contain solid geometry or polylines.



○ Import Hidden Metadata: Imports file metadata that is hidden within the original CAD file

○ Collect Metadata to Geometry: Determines how metadata is collected. This option is only available if Import Metadata is set to Yes.


○ Do Not Merge: There can be empty nodes to store metadata○ Import Selection Sets: Imports selection sets. A Selection set in

CATIA5 is a group of filtered selected items that can be saved with the document. Selection sets are represented as model views, and a separate portfolio called “Selection Set” is created to hold selection sets. Each model view refers to a layer of entities in a CATIA5 selection set, and a model view is created for each selection set imported. Default view is used for all of the selection set model views.

○ Import 2D Sketch Geometry: Imports sketch geometry where sketch information is applicable. This geometry can be either points or wireframes, and is controlled by respective import settings. Points and wireframes can be imported together.○ No 2D Sketch Geometry: Do not import sketch geometry○ Both 2D Sketch Wireframes and Points: Import wireframes and

points together




○ Only 2D Sketch Wireframes: Import 2D sketch wireframes only○ Only 2D Sketch Points: Import 2D sketch points only

NoteTo achieve the required result, you must use some import settings together. For example, when importing points, use Import Hidden Objects, Import 2D Sketch Geometry, and Import Points.

○ Import 2D Layout: Imports the 2D layout geometry where applicable

○ Compact Scene Tree: Loads a collapsed version of the Scene Tree, and is set to Yes by default. For further information on this option, see Compact Scene Tree [page 783].

○ XML file for Collapse Rules: Selects an XML file, which determines how the Scene Tree is affected by the collapse. This option is only available if Compact Scene Tree is set to Yes.



lected values for chord height ratio and normal tolerances. If you select User Defined, further options become available.○ Angular Tolerance: Determines the maximum angular deviation




○ Angular Tolerance Cap: The minimum value that is applied to angular tolerance, irrespective of other settings. For example, an angular tolerance cap of 45 degrees, which ensures that a circle is tessellated to have at least eight sides.



○ Chord Height Tolerance Cap: The minimum value that is applied to chord height tolerance, irrespective of other settings






● Create Extra Section Geometry: Imports all associated sectioning information for a geometry node. A cross-section is taken of the geometry that is visible (or included), in this model view, and it is cut to make a cross-section geometry. This option, if set to No (false), creates a real-time cross section that can be removed or reinstated. If set to Yes (true), section geometry is created as separate mesh, and displays in the corresponding capture. The default is No.

NoteThis feature only applies when you are importing captures that contain section views.

● Create Initial View with PMI: Creates a model view with all the PMI in the scene. You can view all the PMI and geometry in default view that may not have been otherwise included in any other views or captures.

● Create Initial View without PMI: Creates a new model view without any PMI, but containing all geometry in the scene















More Information

Compact Scene Tree [page 783]

5.7.4.3 CATIA V5 Drawing File

Use

You can import and view CATIA V5 drawing (.CATDrawing) files.

Supported

● Design table entities

Limitations

● PMI to PMI highlighting not supported● To represent text and symbols for FD&T and GD&T, Visual Enterprise software uses its own RHGDT font.

Text and Symbol may display a different size and shape.● Not all embedded OLE objects other than bitmaps are imported. Last saved only from cached geometry.● Semantic PMI information is not supported



Features


Import Interface




Drawing: Establishes the drawing settings

● Drawing Paper Color: Selects a background color for layout

Geometry: Establishes the geometry settings

● Import Filters: Defines the import filter settings○ Import Hidden Drawings: Imports drawings that are hidden within

the original CAD file○ Display Hidden Drawings: Displays drawings that are hidden within

the original CAD file○ Import Hidden Metadata: Imports file metadata that is hidden

within the original CAD file

● Tessellation Settings: Defines the tessellation settings○ Tessellation Level: Applies different resolutions based upon prese

lected values for chord height ratio and normal tolerances. The available options are: Very Low, Low, Medium, High, Very High, User-Defined. If you select User-Defined, a further option becomes available.○ Curve Discretization: The factor used to multiply the smallest

face or hole or minimum dimension of the object (whichever of the tree is smaller). This factor is used to get the minimum distance between the points used upon discretization of the surface.






5.7.5 CATIA V6 (3DXML)

Use

You can import and view 3DXML Format (.3dxml) files.

Supported

● Hierarchical structured Scene Tree● File properties, Model properties● Object Attributes: Color, opacity, visibility, and object names● Mesh Import

Limitations


Generator● Import of Construction geometry; for example, points, coordinate axis, curves, or planes not supported● 2D drawing files not supported● Embedded geometry as type XVL not supported

Features


Import Interface


Import Hidden Objects Imports all hidden objects. If you modify any visible objects that contain hidden subobjects after import, those hidden objects are also modified.

Display Hidden Objects Displays all hidden objects in the viewport after importing the file

Import Metadata Imports user data associated to elements (Instance, Part), and material data






5.7.6 Creo Parametric (Pro/ENGINEER) Assembly and Part

You can import and view Creo Parametric (Pro/ENGINEER) Assembly (.asm, .xas) , and Creo Parametric (Pro/ENGINEER) Part (.prt*, .xpr) files.

Import Rules

The following rules apply when importing Creo (Pro/E) files:

● When a file is first opened with the Creo (Pro/E) Module, a medium to low resolution is used by default for fast file loading, and a window displays these resolution settings.

● The latest version of any part file within the folder is always opened. For example, sprng.prt.3 is opened if the folder contains spring.prt.1, spring.prt.2, and spring.prt.3.

● Creo (Pro/E) searches through folders for part and assembly files and for corresponding accelerator files in the:○ Current directory of the file○ Search paths specified in the CAD Modules tab

● If a part, assembly or accelerator file is not found, and logging is enabled, the information is logged in SAP 3D Visual Enterprise Author or Generator, depending on the application that you are using.

5.7.6.1 Accelerator Files

You can reduce the time required to retrieve a part or assembly file by saving the file instance in an “instance accelerator file” with the Creo Parametric (Pro/ENGINEER) software (http://www.ptc.com/ ). Each instance is saved in its own unique accelerator file: part instance files are called instance[name].xpr and assembly instance files are called instance[name].xas.

NoteThe following information relates to Creo Parametric (Pro/ENGINEER) only.



http://help.sap.com/disclaimer?site=http%3A%2F%2Fwww.ptc.com%2F

Saving Parts and Assembly Instances

Saving instances of parts and assemblies is controlled by the Save Instance Accelerator variable. This variable can be modified in Creo Parametric (Pro/ENGINEER) using one of two methods:

● By setting the configuration file option save_instance_accelerator● By choosing Files > Instance Operations > Accelerator Options to open the Instance Accelerator window

and establish the settings

5.7.6.2 Creo Parametric (Pro/ENGINEER) Assembly File

Use

You can import and view Creo Parametric (Pro/ENGINEER) Assembly (.asm) files.

Supported

● Hierarchical structured Scene Tree● Combined views (user-defined model views in CREO software)● File properties, Model properties● Object Attributes: Color, opacity, visibility● Mesh or Solid Import:

○ Tessellation control option with mesh import and dynamic tessellation option for solid import○ Normals and UV coordinates

● Functional Dimensioning & Tolerancing (Notes, Driven, and Reference Dimension, Tolerances, surface finish)

● Import of Construction geometry; for example, Points, Coordinate Axis, Surfaces, Curves, Wireframes● PMI to surface highlighting and PMI to Edge highlighting● Limited support of Assembly level features● The latest version of any part file within the folder is always opened. For example, sprng.prt.3 opens if the

folder contains spring.prt.1, spring.prt.2, and spring.prt.3.● Creo (Pro/E) searches through folders for part and assembly files and for corresponding accelerator files

in the:○ Current directory of the file○ Search paths specified in the CAD Modules tab

● If a part, assembly, or accelerator file is not found, and logging is enabled, the information is logged in the application that you are using

● PMI (Functional Dimensioning & Tolerancing, Geometric Dimensioning & Tolerancing)

Limitations and Restrictions

● Animation● BOM support based on part names● Not all assembly level features are supported● Textures


● Some transformation issues with GDT PMI in both part and assembly where PMI are not attached to any 3D geometry

● To represent text and symbols for FD&T and GD&T, Visual Enterprise software uses its own RHGDT font. Text and Symbol may display a different size and shape.

● No support of Persistence Identifier and CAD Identifiers● No support for connection points

Features




Import Interface











lected values for chord height ratio and normal tolerances. If you select User-Defined, further options become available.○ Angular Tolerance: Determines the maximum angular deviation








● Import Model Views: Imports any custom model views within the file











5.7.6.3 Creo Parametric (Pro/ENGINEER) Part File

Use

You can import and view Creo Parametric (Pro/ENGINEER) Part (.prt*, .xpr) files.

Supported● Hierarchical structured Scene Tree● Combined views (user-defined model views in CREO software)● File properties, Model properties● Object Attributes: Color, opacity, visibility



● Mesh or Solid Import:○ Tessellation control option with mesh import and dynamic tessellation option for solid import○ Normals and UV coordinates

● Functional Dimensioning & Tolerancing (Notes, Driven, and Reference Dimension, Tolerances, surface finish)

● Import of Construction geometry; for example, Points, Coordinate Axis, Surfaces, Curves, Wireframes● PMI to surface highlighting and PMI to Edge highlighting● The latest version of any part file within the folder is always opened. For example, sprng.prt.3 opens if the

folder contains spring.prt.1, spring.prt.2, and spring.prt.3.● Creo (Pro/E) searches through folders for part and assembly files and for corresponding accelerator files

in the:○ Current directory of the file○ Search paths specified in the CAD Modules tab

● If a part, assembly, or accelerator file is not found, and logging is enabled, the information is logged in the application that you are using

● PMI (Functional Dimensioning & Tolerancing, Geometric Dimensioning & Tolerancing)

Limitations and Restrictions● Animation● BOM support based on part names● Textures● Some transformation issues with GDT PMI in both part and assembly where PMI are not attached to any

3D geometry● To represent text and symbols for FD&T and GD&T, Visual Enterprise software uses its own RHGDT font.

Text and Symbol may display a different size and shape.● No support of Persistence Identifier and CAD Identifiers● No support for connection points

Features


Import Interface



● Import Model Views: Imports any custom model views within the file











5.7.6.4 Creo Parametric (Pro/ENGINEER) Neutral File

Use

You can import and view Creo Parametric (Pro/ENGINEER) Neutral (.neu) files.

Supported

● Hierarchical structured Scene Tree● Combined views (user-defined model views in CREO software)● File properties, Model properties● Object Attributes: Color, opacity, visibility● Mesh or Solid Import

○ Tessellation control option with mesh import and dynamic tessellation option for solid import


○ Normals and UV coordinates● Support of Persistence Identifier and CAD Identifiers● PMI (Functional Dimensioning & Tolerancing, Geometric Dimensioning & Tolerancing)

Limitations● 2D vector data● Animation● BOM support based on part names● Configurations● Textures● PMI

Features


Import Interface












● Tessellation Level: Applies different resolutions based upon preselected values for chord height ratio and normal tolerances. If you select User-Defined, further options become available.○ Angular Tolerance: Determines the maximum angular deviation (in




PMI: Defines settings for PMI




● Import Model Views: Imports any custom model views within the CAD file. You can filter model views associated with different levels of the scene tree. The default setting is Top-Level.

○ All: All model views associated with parts, assembly including top level assembly are imported

○ Top-Level: Only model views for top level (root) assembly are imported

○ Assembly: Only model views associated with assembly nodes are imported

○ Parts: Only model views associated with part (leaf) nodes are imported

○ None: Model views are not imported




5.7.6.5 Creo Parametric (Pro/ENGINEER) Drawing

Use

You can import and view Creo Parametric (Pro/ENGINEER) Drawing (.drw*, .drw) files.

Limitations

● Drawing files do not support storing NURBS and Solids● Drawing files (DRW) : support is limited● To process correctly, all referenced parts and subassembly must be supplied● Semantic information for PMI is limited

Features




Import Interface




Drawing: Establishes the drawing settings


Geometry: Establishes the geometry settings

● Tessellation Settings: Defines the tessellation settings○ Tessellation Level: Applies different resolutions based upon preselected

values for chord height ratio and normal tolerances. The available options are: Very Low, Low, Medium, High, Very High, User-Defined. If you select User-Defined, a further option becomes available.○ Curve Discretization: The factor used to multiply the smallest face or

hole or minimum dimension of the object (whichever is smaller). This setting gets the minimum distance between the points used upon discretization of the surface.




5.7.7 IGES Assembly and Part

Use

You can import and view IGES (Initial Graphics Exchange Specification) Format (.iges, .igs) files.

These formats are used to share high-quality CAD data, and are commonly known as “constructive solid geometry”. They can represent many different types of data, ranging from lines and arcs to complex geometric solids, such as cylinders and cones.

Supported

● Hierarchy support with a structured Scene Tree● File Properties, Model Properties● Object Attributes: Color and object names


● Solid or Mesh import:○ Tessellation control with mesh import and dynamic tessellation option for solid import○ Normals and UV coordinates

● Construction geometry; for example, Points, Coordinate Axis, Surfaces/Curves, planes (imported as Wireframes)

Limitations● No texture support● Metadata in the Scene Tree sorts in alphabetical order so the original order is not preserved.● Initial view is not respected when loaded in SAP 3D Visual Enterprise Author or SAP 3D Visual Enterprise

Generator● BOM support based on part names● Linked IGES files as assembly not supported (only monolithic files are supported)● Line-styles for polylines not supported

Features




Import Interface























5.7.8 Industry Foundation Classes

Use

You can import and view Industry Foundation Classes Format (.ifc, .ifcxml) files.

Supported

● Supports hierarchical tree as represented in the file● Model properties with categories● Object attributes; for example, color, opacity, visibility (components and geometry nodes), and object

names● Mesh Import● IFCSpace supported: Transparent volumetric geometry created to represent this type

Limitations

● Scene tree hierarchy does not group similar entities● Only geometrical representations are imported. No project, process, and operation (task and task

scheduling) related information is imported● Initial view is not respected when loaded in SAP 3D Visual Enterprise Author or SAP 3D Visual Enterprise

Generator● Persistence Identifiers and CAD Identifiers not supported. GlobalID from IFC files for each entity imported

as part of Metadata, which can be used for change management.● IFC format version 2x2 is not supported● IFCTRIANGULATEDFACESET and IFCCARTESIANPOINTLIST3D are not supported (as a result files with

these entities may load incomplete).



Features


Import Interface


Import Metadata Imports categories of properties stored in IFC files

Create Volumes for Interior/Exterior Spaces Enables volumetric geometry creation for IFCSPACE-type objects

Create Volumes for Openings Enables volumetric geometry creation for openings




5.7.9 Inventor Assembly

Use

You can import and view Inventor Assembly (.iam) files.

NoteIf you use the Quick View loading option, you require Autodesk inventor View installed.

Supported● Hierarchical structured Scene Tree● File properties, Model properties● Object attributes; for example, color, opacity, visibility (components and geometry nodes), and object

names● Solid or Mesh Import:


Limitations● Animation● BOM support based on part names● Configurations


● Textures● PMI is not supported● Metadata in the Scene Tree sorts in alphabetical order so the original order is not preserved.● Initial view is not respected when loaded in SAP 3D Visual Enterprise Author or SAP 3D Visual Enterprise

Generator● Drawing format (.idw) is not supported● Construction geometry; for example, Surfaces, Points, Planes, and Wireframes not supported● Assembly level color and assembly level features not supported● Persistence Identifiers and CAD Identifiers not supported● Positional Representations not supported● Flexible Assemblies not supported

Additional Load-specific LimitationsValid for Solids Mode

Where an assembly has subfolders, and files with the same name across different subfolders, conversion fails.

Valid for Quick View

● Surface Bodies not supported● Face color not supported. Part color is applied to all faces.

Features


Import Interface


Load Approach Establishes the way in which to import the file

● Approach: The method in which the file is imported. Each method utilizes differing import options to import the file.○ Quick View (Inventor Tessellation): Imports the file using the last

saved tessellated geometry○ Load Inventor Solids: Imports the file using the solids information,

rather than tessellated geometry











NoteTessellation settings are only available when you use the Load Inventor Solids load approach.











5.7.10 Inventor Part

Use

You can import and view Inventor Part (.ipt) files.

NoteIf you use the Quick View loading option, you require Autodesk inventor View installed.

Supported

● Hierarchical structured Scene Tree● File properties, Model properties● Object attributes; for example, color, opacity, visibility (components and geometry nodes), and object

names● Solid or Mesh Import:


Limitations

● Animation● BOM support based on part names● Configurations● Textures● PMI is not supported● Metadata in the Scene Tree sorts in alphabetical order so the original order is not preserved.● Initial view is not respected when loaded in SAP 3D Visual Enterprise Author or SAP 3D Visual Enterprise

Generator● Drawing format (.idw) is not supported● Construction geometry; for example, Surfaces, Points, Planes, and Wireframes not supported● Assembly level color & assembly level feature not supported● Persistence Identifiers and CAD Identifiers not supported● Positional Representations not supported



● Flexible Assemblies not supported

Additional Load-specific LimitationsValid for Solids Mode

Where an assembly has subfolders, and files with the same name across different subfolders, conversion fails.

Valid for Quick View

● Surface Bodies not supported● Face color not supported. Part color is applied to all faces.

Features


Import Interface


Load Approach Establishes the way in which to import the file

● Approach: The method in which the file is imported. Each method utilizes differing import options to import the file.○ Quick View (Inventor Tessellation): Imports the file using the last

saved tessellated geometry○ Load Inventor Solids: Imports the file using the solids information,

rather than tessellated geometry










NoteTessellation settings are only available when you use the Load Inventor Solids load approach.












5.7.11 JT File

Use

You can import and view JT (.jt) files using the JT import options. You can also save files to this format.

JT is a robust and flexible data format, capable of storing directly renderable geometry, analytical geometry, geometric attributes, user metadata, hierarchical CAD product structure, model views, configuration within model views, and CAD Product Manufacturing Information (PMI) data including Geometric Dimensioning and Tolerance (GD&T) data.

GD&T is also known as Feature Dimensioning and Tolerance (FD&T).

Supported

● Hierarchical structured Scene Tree● File properties and user metadata● Reference Sets● Layers● 2D vector data as wireframes is supported with line styles, width, and color● Object attributes; for example, color, opacity, visibility, and object names● Solid import or mesh import option● Tessellation control with mesh import and dynamic tessellation option with Solid import● UV coordinates● Default and user defined views on parts and assemblies● Level of Detail (Import option provided to choose the LOD to import)● XT embedded entities● PMI (Functional Dimensioning & Tolerancing/Geometric Dimensioning, and Tolerancing)

○ Section views (normal and lightweight sections)○ Explosion views are represented as model views in the 3D Visual Enterprise scene graph

● Export from any other CAD files to JT is also supported

Limitations and Known Restrictions

● Animation● Textures


● PMI to PMI and PMI and face highlighting not supported● To represent text and symbols for FD&T and GD&T, Visual Enterprise software uses its own RHGDT font.

Text and Symbol may display a different size and shape.● Import of Libra entities not supported● JT exporter does not retain the initial view from source● Monolithic files with different unit of subcomponent are not supported with SAP 3D Visual Enterprise

Generator assembly upload mode

NoteTo export multiple levels of details and XTBREP with referenced JT files, source data must contain solids

Features




Import Interface





● Import Filters: Defines the import filter settings○ Import Metadata: Imports file metadata from the original CAD file



surfaces, and solids are imported, or whether meshes are regenerated. If you select this option, the tessellation level settings become available.

○ Tessellation Level: Applies different resolutions based upon preselected values for chord height ratio and normal tolerances. If you select User-Defined, further options become available.○ Angular Tolerance: Determines the maximum angular deviation




○ Level of Detail: Establishes the level of detail (LOD) to import. LOD is a way of displaying models with different numbers of polygons and can be helpful depending on the way in which you view the model; in detail or from a distance. This setting can speed up the rendering time by limiting the number of polygons to draw. The number of LODs in a JT file is not fixed; each part can have any number of LODs from 0 (highest) to (n).



○ Highest: Imports only the highest level of detail. This setting helps to speed up loading time for models that need to be viewed in detail.

○ Medium: Imports a medium level of detail lower than Highest○ Lowest: Imports only the lowest level of detail. This setting

helps to speed up rendering time for models that only need to be viewed from a distance

○ Collapse Subnodes: Loads a collapsed version of the Scene Tree




● Import Model Views: Imports any custom model views within the JT file○ All: Loads all model views○ Top-Level: Loads all model views at level 0 (main node) and level 1

under the root node, and ignore all other model views○ Assembly: Only loads the model views that are attached to

JtkAssembly entities

○ Parts: Only loads the model views that are attached to JtkPart entities

○ None: Does not load any model views






Export Interface


Custom Export Defines optional custom export settings

● Use Configuration File: Uses a default configuration file with recommended settings for exporting files. You can customize the configuration file to suit requirements.

● Configuration File Location: The location at which the configuration file resides

NoteIf this custom export option is used, other export options are disabled. Instead, the process uses the config-uration file supplied.


● Type: Determines the way in which the file hierarchy objects are saved○ Monolithic: Saves one large file that contains the

entire object hierarchy○ Per Part: Saves the scene as a single file, and saves

each object as an individual file located within a folder. The folder has the same name as the scene file. Each object file has the same name as the object, and is referenced by the scene file. This allows objects to be modified without affecting any other objects in the scene.

○ Fully Shattered: Saves a complex file in a flat, shattered manner as compactly as possible



Compression Reduces the file size while maintaining the quality. Compression helps to reduce the amount of storage and transmission bandwidth required for 3D models. The compression versions are related to the version in which the original file was written. Additionally, the compression versions are backwards compatible.

● Compression Type: Selects the type of compression to apply when saving the file○ No Compression: Applies no compression. That is,

version 6.4.○ Version 7.0: Compresses the file into version 7.0 of

the .jt format. The file contents are compressed using standard dictionary compression techniques. This compression is lossless.

○ Version 8.0: Compresses the file into version 8.0 of the .jt format. Compressing the geometry contents is either lossless or lossy, and all other file content compression is lossless. This compression creates potentially the smallest .jt file.

○ Automatic: Compresses the file into the most compatible format

○ Version 8.1: Compresses the file into version 8.1 of the .jt format. Compressing the geometry contents is either lossless or lossy, and all other file content compression is lossless.





○ Version 9.3: Compresses the file into version 9.3 of the .jt format. Compressing the geometry con




tents is either lossless or lossy, and all other file content compression is lossless.




Level of Detail Establishes Level Of Detail (LOD) settings. JT files create separate scene nodes for each LOD. LOD is a way of displaying models with different numbers of polygons depending on how close they are to the camera using the Level of Detail controls. This setting can speed up the rendering time by limiting the number of polygons to draw..

● Generate Lower LODs: Creates the scene LOD

Export PMI Establishes PMI settings

● Export PMI: Indicates whether to export the PMI data

5.7.12 MicroStation CAD Graphic

Use

You can import and view MicroStation CAD Graphic (.dgn) files.

DGN (design) is the name used for CAD file formats supported by Bentley Systems MicroStation and Intergraph Interactive Graphics Design System (IGDS) CAD programs. In MicroStation, a document file is called a .dgn file. A .dgn file is composed of one or more models, each of which is represented using elements such as lines, arcs, and shapes.

Supported

● 2D vector data (text and dimensions)● Assembly hierarchy● Meshes● Material and object names


● Metadata● Tessellation control● Textures● Layers● Views from file● Model view creation

Limitations

● Animation● BOM support based on part names● Configurations● Solids, NURBS● UV coordinates● Protected files not supported● iModel produced DGN files not supported

Features


Import Interface




● Trim Nodes: Collapses all leaf nodes where they exist for a node● Import Hidden Objects: Imports all hidden objects. If you modify any

visible objects that contain hidden subobjects after import, those hidden objects are also modified.


● Construction Geometry: Defines settings for the construction geometry● Import Wireframes: Imports all wireframes if any exist● Import Metadata: Imports file metadata from the original CAD file





Tessellation Settings Defines the tessellation settings

● Tessellation Level: Applies different resolutions based upon preselected values for chord height ratio and normal tolerances. The available options are: Very Low, Low, Medium Low, Medium, Medium High, High, Very High.

PMI Captures Model Views Defines settings for PMI






5.7.13 NX Parts, Assemblies, and Drawings

Use

You can import and view NX Parts, Assemblies, and Drawing (.prt) files.

Supported

● Hierarchical structured Scene Tree● File properties and user metadata● Reference sets● Layers● 2D vector data as wireframes is supported with line-styles, width, and color● Object Attributes: Color, opacity, visibility, and object names● Solid import or mesh import option● Tessellation control with mesh import and dynamic tessellation option with Solid import● UV coordinates● Improved instancing based on geometry and parts● Default and user defined views on parts and assemblies● Assembly level features support: “Deformation” and “Promotion”● Arrangements


● NX Initial View is supported● PMI (Functional Dimensioning & Tolerancing and Geometric Dimensioning & Tolerancing)

○ Section views (normal and lightweight sections)○ Explosion views are represented as model views in 3D Visual Enterprise○ Sheet Metal callout labels are supported○ Center line and Center mark import as PMI

● Support of Persistence Identifier and CAD Identifiers

Limitations● Animation● Textures● Assembly upload and ERP Top Down do not support assembly level visibility on parts and PMI● Assembly level defined views do not work together with exploded views (Configurations)● PMI to PMI highlighting not supported● View-set from NX file not supported● 3D PMI: To represent text and symbols for FD&T and GD&T, Visual Enterprise software uses its own RHGDT

font. Text and Symbol may display a different size and shape.● NX Model views do not support other rendering mode than solid.● NX feature 'Reset Orientation' is not supported● NX feature View-set is not supported● PMI leader lines line-styles are not supported● No support of tabular part list from model-views if part list is not stored as part of CAD file.● If it was created in an arrangement, NX Arrangement contains an exploded model view

Limitations relating only to Drawing Files● NX drawing files imports last saved cached geometry, no semantic information is available● NX drawing PMI leader lines line-style not supported● NX drawing PMI: To represent text and symbols for FD&T and GD&T, Visual Enterprise software uses its

own RHGDT font. Text and Symbol may display a different size and shape.● NX drawing PMI: Semantic information is not supported● 3D PMI: To represent text and symbols for FD&T and GD&T, Visual Enterprise software uses its own RHGDT

font. Text and Symbol may display a different size and shape.

Features




Import Interface












any visible objects that contain hidden subobjects after import, those hidden objects are also modified. The default setting is Yes.


○ Import Construction Geometry: Imports the construction geometry. It could contain solid geometry or polylines.



○ Reference Set: Imports groups of parts in a specific order. The order of preference defines the order in which groups of parts are imported, the first reference set in the Reference Set Type list is read. If it fails, the second reference set in the list is read, and so on. This process continues until the file is successfully imported. This field is used to select which reference set to import. The set order is by import preference.○ As Saved: Imports all the reference sets that were last saved in

the scene○ Entire: Imports all the reference sets in the scene○ User-Specified: Imports the reference set as defined in the

User-Specified Name option○ User-Specified Name: If a user-defined Reference Set is selected,

the name of the reference set to import○ Import Layer: Imports layers from the original CAD file

○ Yes: Imports all layers containing geometry. Empty layers are filtered out.

○ No: Layers are not imported○ Import Arrangement: Imports all arrangements in the scene○ User-Specified Name: If a user-defined arrangement is selected, the

name of the arrangement to import.




○ Loading Mode: Indicates the loading mode. Available options are Internal and External. The default option is Internal, and we recommend that this setting is not changed.







● Collapse Part Geometry: Collects all the surfaces, and tessellates collectively, treating loose surfaces as one object. This option is used to avoid seams and gaps, and produce unified normals. The default setting is Yes.


● Import Standard Views: Imports any standard views within the file. The default setting is Yes.

● Import PMI: Imports any Product Manufacturing Information (PMI) within the file. You can access the PMI data objects from within the 3D Objects list. The default setting is Yes.

● Always Show PMI on Top: Draws the markup and markup lines on top of, and through all the objects in the scene. Markups are drawn on top even if the markup is behind the object or obscured by the geometry. The default setting is Yes.

● PMI Billboarding: Establishes settings for Billboard Mode.○ Default: Draws the dimension in a default manner○ Disable: Draws the dimension as defined in the CAD file



○ Full: Draws the dimension as a billboard. That is, the dimension rotates to face the camera always. When printed to a vector-based file, the measurement is converted to vector line art.

○ Flip Label: Aligns the dimension in the direction of the leader lineThe default setting is Yes.

● Import Model Views: Imports any custom model views within the CAD file. You can filter model views associated with different levels of the scene tree. The default setting is Top-Level.If model views are imported, the initial view is imported as a model-view with “(Work)” suffix in addition to standard or user-created initial views in NX.○ All: All model views associated with parts, assembly including top

level assembly are imported○ Top-Level: Only model views for top level (root) assembly are im

ported○ Assembly: Only model views associated with assembly nodes are

imported○ Parts: Only model views associated with part (leaf) nodes are im

ported○ None: Model views are not imported






● Import Wireframes: Imports all wireframes if any exist. The default setting is Yes.

● Import Sheet Bodies: Imports all construction geometry. Sheet bodies are flat surfaces from which each object is cut








5.7.14 Parasolid Assembly and Part

Use

You can import and view Parasolid (.x_b, .x_t) files.

Parasolid X_T is the exchange format for Parasolid files. The X_T format is used by different CAD/CAM-applications such as NX, SolidWorks, and Solid Edge.

Supported

● Hierarchical structured Scene Tree● File properties, Model properties● Object Attribute: color and object names● Solid or Mesh import:

○ Tessellation control with mesh import and dynamic tessellation for solid import○ Normals and UV coordinates

● Construction geometry; for example, Points, Coordinate Axis, Surfaces/Curves, planes (imported as Wireframes)

Limitations

● Textures● Animation● Configurations

Features



Import Interface
























5.7.15 PLMXML

Use

You can import and view PLMXML (.plmxml, referencing JT files.

Supported● Hierarchical structured Scene Tree● File properties, Model properties● Object Attribute: Color, opacity, visibility, and object names● Solid or Mesh import:

Limitations● Textures● Animation● Metadata in the Scene Tree sorts in alphabetical order so the original order is not preserved.● Initial view is not respected when loaded in Visual Enterprise scene.● 2D Drawing files are not supported● Materials (diffuse, opacity) applied from assembly to parts are not supported

Features


Import Interface





5.7.16 Solid Edge Assembly

Use

You can import and view Solid Edge Assembly (.asm) files.

Supported

● Hierarchical structured Scene Tree● Object Attributes: Color, opacity, visibility (of components and geometry nodes), and object names● Solid or Mesh Import


● Categorized object properties:● ○ Standard file and object properties

○ Occurrence properties○ Custom occurrence properties

● Imports Display Configuration (Creates multiple layers in the Visual Enterprise scene)● Import of “grouped” nodes● Construction geometry; for example, Surfaces, Points, planes, and wireframes● Assembly level color and limited assembly level features● Persistence Identifier and CAD Identifiers

Limitations

● Animation● BOM support based on part names● PMI not supported● Textures● ERP Top Down and SAP 3D Visual Enterprise Generator Assembly Upload mode does not support

assembly-level color and assembly instance metadata● No section view information● Metadata in the Scene Tree sorts in alphabetical order so the original order is not preserved.● Initial view is not respected when loaded in Visual Enterprise scene.



Features



Import Interface





● Import Hidden Component: Imports only the hidden objects that are separate from the hidden geometry

NoteHidden geometry can be imported regularly as Import Hidden Objects




● Apply Assembly-Level Color: If an assembly carries color for parts, retrieves the part color from the assembly, otherwise the part remains its default color. The default setting is Yes.

● Import Display Configuration: Display configuration from Solid Edge assembly files is imported in Visual Enterprise VDS format as a layer. Display configuration-specific information is stored as part of the top level assembly configuration file called Top level assembly file name .cfg files. To load configuration correctly, the corresponding configuration file must exist in the same folder as the assembly file. When sent to a process in SAP 3D Visual Enterprise Generator, this file must also exist.

NoteTo import all display configurations, change the setting Import Hidden Componentto On. By default, the importer imports the last saved configuration.



● Tessellation Level: Applies different resolutions based upon preselected values for chord height ratio and normal tolerances. If you select User-Defined, further options become available.




○ Angular Tolerance: Determines the maximum angular deviation (in degrees), allowed between an analytical surface and its triangulation. Pairs of triangles do not incorporate a dihedral angle greater than this amount. For example, this setting dictates the minimum number of facets around a smaller circle or cylinder regardless of the Surface Deviation setting. This parameter gives you added control over faces with small radii. Lower values result in finer tessellations, while higher values produce coarser tessellations.












5.7.17 Solid Edge Part

Use

You can import and view Solid Edge Part (.par) files.


Supported● Hierarchical structured Scene Tree● Object Attributes: Color, opacity, visibility (of components and geometry nodes), and object names● Solid or Mesh Import


● Categorized object properties:● ○ Occurrence properties

○ Custom occurrence properties● Imports Display Configuration (Creates multiple layers in the Visual Enterprise scene)● Import of “grouped” nodes● Construction geometry; for example, Surfaces, Points, planes, and wireframes● Assembly level color and limited assembly level features● Persistence Identifier and CAD Identifiers

Limitations● Animation● BOM support based on part names● Configurations● PMI not supported● Textures● ERP Top Down and SAP 3D Visual Enterprise Generator Assembly Upload mode does not support


Features




Import Interface

























5.7.18 Solid Edge Sheet Metal Part

Use

You can import and view Solid Edge Sheet Metal Part (.psm) files.

Supported

● Hierarchical Scene Tree● Object Attributes: Color, opacity, visibility (of components and geometry nodes), and object names● Solid or Mesh Import








Features



Import Interface


























5.7.19 Solid Edge Weldment Design Part

Use

You can import and view Solid Edge Weldment Design Part (.pwd) files.

Supported

● Hierarchical structured Scene Tree● Object Attributes: Color, opacity, visibility (of components and geometry nodes), and object names● Solid or Mesh Import







Features




Import Interface


















NoteIf a file contains sheet bodies, this option for the file to import correctly.







5.7.20 Solid Edge Drawing

Use

You can import and view Solid Edge drawing (.DFT) files.

Limitations● Imports cached EMF drawing entities.● Semantic PMI information is not supported

Features


Import Interface


Drawing Paper Color Selects a background color for layout







5.7.21 SolidWorks Assembly

Use

You can import and view SolidWorks Assembly (.sldasm, .asm) files.

The .sldasm and .asm formats display list assembly data.

Supported

● Hierarchical structured Scene Tree● File properties, Model properties● Object Attributes: Color, opacity, visibility, and object names● Solid or Mesh Import:

○ Tessellation control with mesh import and dynamic tessellation option for solid import● Normals and UV coordinates● PMI (Functional Dimensioning & Tolerancing, Geometric Dimensioning & Tolerancing)● PMI to Surface highlighting and PMI to Edge highlighting● Configuration (Creates multiBOM in the Visual Enterprise scene)● Improved instancing based on geometry and parts● Persistence Identifier and CAD Identifiers More

Limitations

● No animation support● No texture support● PMI to PMI highlighting not supported● Construction geometry; for example, Points, Coordinate Axis, Surfaces, Curves, Wireframes planes● UV Coordinates from Mesh not supported● Metadata in the Scene Tree sorts in alphabetical order so the original order is not preserved.● Initial view is not respected when loaded in Visual Enterprise scene.● To represent text and symbols for FD&T and GD&T, Visual Enterprise software uses its own RHGDT font.

Text and Symbol may display a different size and shape.● Missing geometry if no Parasolid data is present in the file● Only Dimension Annotation created by the DimXpert tool in SolidWorks is supported


● Annotation Views, Default, and User-defined views not supported● Textures and animations not supported● Multiple configuration: Only resolved (activated) configurations are loaded● Exploded views within configuration are not supported● Embedded piping not supported (assembly level geometry)● Visibility of subcomponents in a Multilevel Assembly not preserved● No wireframes, points, and coordinate systems● Quick view load approach has been disabled (Visual Enterprise Author and Generator 9.0 FP2 and onward)

Features




Import Interface








● Import Configuration: Imports configuration from the original CAD file○ As Saved: Imports all the configuration that was last saved in the

scene○ All: Imports all the configuration in the scene○ User Defined: Imports the configuration as defined in the User-

Specified Name option● User-Specified Name: If you have selected a user-defined configuration,

the name of the configuration to import● Collapse Part Geometry: Collects all the surfaces, and tessellates collec

tively, treating loose surfaces as one object. This option is used to avoid seams and gaps, and produce unified normals.



● Import Model Views: Imports any custom model views within the file○ All: Loads all model views○ Top-Level: Loads all model views at level 0 (main node) and level 1


Assembly entities○ Parts: Only loads the model views that are attached to Part entities○ None: Does not load any model views















5.7.22 SolidWorks Part

Use

You can import and view SolidWorks Part (.sldprt, .prt) files.

The .sldprt and .prt formats display list part data.



Supported● Hierarchical structured Scene Tree● File properties, Model properties● Object Attributes: Color, opacity, visibility, and object names● Solid or Mesh Import:

○ Tessellation control with mesh import and dynamic tessellation option for solid import● Normals and UV coordinates● PMI (Functional Dimensioning & Tolerancing, Geometric Dimensioning & Tolerancing)● PMI to Surface highlighting and PMI to Edge highlighting● Configuration (Creates multiBOM in the Visual Enterprise scene)● Improved instancing based on geometry and parts● Persistence Identifier and CAD Identifiers More

Limitations● No animation support● No texture support● PMI to PMI highlighting not supported● Construction geometry; for example, Points, Coordinate Axis, Surfaces, Curves, Wireframes, Planes● UV Coordinates from Mesh not supported● Metadata in the Scene Tree sorts in alphabetical order so the original order is not preserved.● Initial view is not respected when loaded in Visual Enterprise scene.● To represent text and symbols for FD&T and GD&T, Visual Enterprise software uses its own RHGDT font.

Text and Symbol may display a different size and shape.● Missing geometry if no Parasolid data is present in the file● Only Dimension Annotation created by the DimXpert tool in SolidWorks is supported● Annotation Views, Default, and User-defined views not supported● Textures and animations not supported● Multiple configuration: Only resolved (activated) configurations are loaded● Exploded views within configuration are not supported● Embedded piping not supported (assembly level geometry)● Visibility of subcomponents in a Multilevel Assembly not preserved● No wireframes, points, and coordinate systems● Quick view load approach has been disabled (Visual Enterprise Author and Generator 9.0 FP2 and onward)

Features



Import Interface








● Import Configuration: Imports configuration from the original CAD file○ As Saved: Imports all the configuration that was last saved in the

scene○ All: Imports all the configuration in the scene○ User Defined: Imports the configuration as defined in the User-

Specified Name option● User-Specified Name: If you have selected a user-defined configuration,

the name of the configuration to import● Collapse Part Geometry: Collects all the surfaces, and tessellates collec

tively, treating loose surfaces as one object. This option is used to avoid seams and gaps, and produce unified normals.



● Import Model Views: Imports any custom model views within the file○ All: Loads all model views○ Top-Level: Loads all model views at level 0 (main node) and level 1


Assembly entities○ Parts: Only loads the model views that are attached to Part entities○ None: Does not load any model views
















5.7.23 SolidWorks Drawing

Use

You can import and view SolidWorks Drawing (.slddrw) files.

The .slddrw format displays 2D drawing data.


Supported

● Multiple sheets import

Limitations

● Imports cached tessellated geometry● Semantic PMI information is not supported● Shaded geometry in a drawing is loaded as wireframes● Embedded bitmaps are not supported

Features


Import Interface


Drawing Establishes the drawing settings





5.7.24 STEP Compressed Assembly and Part

Use

You can import and export STEP (Standard for the Exchange of Product Model Data) Compressed (.stpZ, .stp.z) files.

The .step file format is the ISO standard for exchange of Product Data. It covers much more than part geometry exchange, and is used for bill of material, simulation data, and configuration management. STEP is based on the language Express that allows strict specifications.



Supported● Hierarchical structured Scene Tree● File properties, Model properties● Object Attributes: Color, opacity, visibility, and object names (both part number and instance names)● Solid or Mesh Import:


● Construction geometry; for example, Points, Coordinate Axis, Surfaces/Curves, planes (imported as wireframes) with line-style support

● PMI and Views are supported with AP242 files. Tessellated PMI is supported only for AP2013 ED2.● Linked step files as assembly are supported

Limitations● Metadata in the Scene Tree sorts in alphabetical order so the original order is not preserved.● Initial view is not respected when loaded in SAP 3D Visual Enterprise Author or SAP 3D Visual Enterprise

Generator● Animation● BOM support based on part names● Textures

Features



Import Interface




























Export Interface


Application Protocol Defines the way in which the file saves, and the protocol to use

● AP214: Saves the file using core data for automotive mechanical design processes

● AP242: Saves the file using the managed model based 3D engineering protocol.

● AP203E2: Saves the file using the configuration controlled 3D designs of mechanical parts and assemblies protocol

Convert Offset Surfaces to NURBS Changes offset surfaces to NURBS surfaces

5.7.25 STEP Assembly and Part

Use

You can import and export STEP (Standard for the Exchange of Product Model Data (.step, .stp) files.


The .step file format is the ISO standard for exchange of Product Data. It covers much more than part geometry exchange, and is used for bill of material, simulation data, and configuration management. STEP is based on the language Express that allows strict specifications.

Supported● Hierarchical structured Scene Tree● File properties, Model properties● Object Attributes: Color, opacity, visibility, and object names (both part number and instance names)● Solid or Mesh Import:


● Construction geometry; for example, Points, Coordinate Axis, Surfaces/Curves, planes (imported as wireframes) with line-style support

● PMI and Views are supported with AP242 files. Tessellated PMI is supported only for AP2013 ED2.● Linked step files as assembly are supported

Limitations● Metadata in the Scene Tree sorts in alphabetical order so the original order is not preserved.● Initial view is not respected when loaded in SAP 3D Visual Enterprise Author or SAP 3D Visual Enterprise

Generator● Animation● BOM support based on part names● Textures

Features

This format contains both import and export options. You can use them to customize the way in which your file opens and saves.



Import Interface



























Export Interface


Application Protocol Defines the way in which the file saves, and the protocol to use

● AP214: Saves the file using core data for automotive mechanical design processes

● AP242: Saves the file using the managed model based 3D engineering protocol.

● AP203E2: Saves the file using the configuration controlled 3D designs of mechanical parts and assemblies protocol

Convert Offset Surfaces to NURBS Changes offset surfaces to NURBS surfaces



Important Disclaimers and Legal Information

HyperlinksSome links are classified by an icon and/or a mouseover text. These links provide additional information.About the icons:

● Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your agreements with SAP) to this:

● The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.● SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any

damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.

● Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this information.

Beta and Other Experimental FeaturesExperimental features are not part of the officially delivered scope that SAP guarantees for future releases. This means that experimental features may be changed by SAP at any time for any reason without notice. Experimental features are not for productive use. You may not demonstrate, test, examine, evaluate or otherwise use the experimental features in a live operating environment or with data that has not been sufficiently backed up.The purpose of experimental features is to get feedback early on, allowing customers and partners to influence the future product accordingly. By providing your feedback (e.g. in the SAP Community), you accept that intellectual property rights of the contributions or derivative works shall remain the exclusive property of SAP.

Example CodeAny software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of example code unless damages have been caused by SAP's gross negligence or willful misconduct.

Gender-Related LanguageWe try not to use gender-specific word forms and formulations. As appropriate for context and readability, SAP may use masculine word forms to refer to all genders.

SAP 3D Visual Enterprise GeneratorImportant Disclaimers and Legal Information P U B L I C 859

www.sap.com/contactsap

© 2018 SAP SE or an SAP affiliate company. All rights reserved.

No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP SE or an SAP affiliate company. The information contained herein may be changed without prior notice.

Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary.

These materials are provided by SAP SE or an SAP affiliate company for informational purposes only, without representation or warranty of any kind, and SAP or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP or SAP affiliate company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE (or an SAP affiliate company) in Germany and other countries. All other product and service names mentioned are the trademarks of their respective companies.

Please see https://www.sap.com/about/legal/trademark.html for additional trademark information and notices.

THE BEST RUN

https://www.sap.com/about/legal/trademark.html

SAP 3D Visual Enterprise Generator

Documents

Transcript of SAP 3D Visual Enterprise Generator