Configure WebGL renditions - HxGN SDx - Update 64 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

3D WebGL renditions (BINZ) are required to view the following file formats in standalone HxGN SDx environments:

  • Smart 3D (.zvf)

  • Smart Review (.vue)

The 3D WebGL rendition is generated when the Auto generate WebGL viewer files option is enabled and when:

  • The file is attached to a document.

  • A user attempts to view a Smart 3D (.zvf) or a Smart Review (.vue) file that does not have a 3D WebGL rendition.

How to enable the "Auto generate WebGL viewer files" option

To generate 3D WebGL renditions, the Auto generate WebGL viewer files option must be selected in system options. When selected, load jobs take more time because WebGL rendition generation becomes part of the document loading process. To enable this setting:

If an XML file with the same name as a non-published Smart 3D model file is attached to a design document, a label database file (.mdb2) is automatically generated in addition to the 3D WebGL viewer file (.binz). The label database file (.mdb2) is required for searching tags in a non-published Smart 3D model file using the Web Client. The Show hidden files option in the Change User Preferences dialog box must be selected to show label database files in the Desktop Client.

  1. Log on to the Desktop Client.

  2. Click Find > Administration > File Type to open a list of all defined file type objects.

  3. Drag the Smart 3D (.zvf and .vue) file type objects to the 3D WebGL viewer file (.binz) file type object to create a SPFFileTypeFileType relationship definition.

  4. Select the Auto generate WebGL viewer files option in the system options.

    To learn more about this and other options, see Configure the system options.

What if 3D WebGL rendition generation fails?

If it fails, you must manually generate the 3D WebGL renditions for those files. You can generate in batch using the Create Markup Renditions in Batch command:

  1. Log on to the Desktop Client.

  2. Click File > Create Markup Renditions in Batch.

    SHARED Tip Since batch generation is a time-consuming process, the software generates a scheduled task. When the task is processed, the software generates a notification.

Troubleshooting tips

  • You can right-click the task notification in the List of Notifications and click View Log File to view a summary log that was created with the batch request. The log shows the number of submitted files with a list of any failed files.

  • You can view more logging information by opening the HxGN SDx server log (use the RemoteServices trace switch), the HxGN SDx remote services log, the SmartPlant Markup log, or the SmartPlant Markup Server Status page. For more information on HxGN SDx logging, see HxGN SDx server logging. For more information on SmartPlant Markup Plus logging, see Setting up SmartPlant Markup Plus log files.

More information

The software delivers a SPFFileTypeFileType relationship definition between the file type objects. This relationship definition is required for batch generation to work.

The CreateMarkupRenditionsInBatch method, using the CreateRenditionsInBatch client API, is the basis of the Create Markup Renditions in Batch command. Batch generation is performed only on the class definitions and file types that are specified on the CreateMarkupRenditionsInBatch method. By default, the method is related to the DocControl access group. To learn more about the arguments configured on this method, see CreateRenditionsInBatch client API.

Files will be picked as per the create configuration scope selected by the creator of the batch rendition task.

The ViewBatchRenditionLog method, using the ViewBatchRenditionLog client API, is the basis of the View Log File command. The ViewBatchRenditionLog method must be related to the ISPFBatchRenditionNotification interface and to the VIEWONLY access group. To learn more about the arguments configured on this method, see ViewBatchRenditionLog client API.

How can I generate 3D WebGL renditions for files stored before upgrading?

If the files you need 3D WebGL renditions for were already stored in a database before upgrading to Update 36 or later, you must manually generate the markup renditions for those files. You can generate in batch using the Create Markup Renditions in Batch method:

  1. Log on to the Desktop Client.

  2. Click File > Create Markup Renditions in Batch.

    SHARED Tip Since batch generation is a time-consuming process, the software generates a scheduled task. When the task is processed, the software generates a notification.

Troubleshooting tips

  • You can right-click the task notification in the List of Notifications and click View Log File to view a summary log that was created with the batch request. The log shows the number of submitted files with a list of any failed files.

  • You can view more logging information by opening the HxGN SDx server log (use the RemoteServices trace switch), the HxGN SDx remote services log, the SmartPlant Markup log, or the SmartPlant Markup Server Status page. For more information on HxGN SDx logging, see HxGN SDx server logging. For more information on SmartPlant Markup Plus logging, see Setting up SmartPlant Markup Plus log files.

More information

The software delivers a SPFFileTypeFileType relationship definition between the file type objects. This relationship definition is required for batch generation to work.

The CreateMarkupRenditionsInBatch method, using the CreateRenditionsInBatch client API, is the basis of the Create Markup Renditions in Batch command. Batch generation is performed only on the class definitions and file types that are specified on the CreateMarkupRenditionsInBatch method. By default, the method is related to the DocControl access group. To learn more about the arguments configured on this method, see CreateRenditionsInBatch client API.

Files will be picked as per the create configuration scope selected by the creator of the batch rendition task.

The ViewBatchRenditionLog method, using the ViewBatchRenditionLog client API, is the basis of the View Log File command. The ViewBatchRenditionLog method must be related to the ISPFBatchRenditionNotification interface and to the VIEWONLY access group. To learn more about the arguments configured on this method, see ViewBatchRenditionLog client API.