Configure markup renditions - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Web Client Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10

This functionality was modified in an update. For more information, see Configure markup rendition files (modified in an update).

What file types require a markup rendition?

Markup renditions (PDF) are required to mark up or compare the following file formats:

File format

Native application

File extension

CAD

AutoCAD Drawing

.dwg

AutoCAD Drawing Interchange Format

.dxf

MicroStation Design File

.dgn

Hexagon 2D Drawings

SmartSketch

.igr

.sma

Smart P&ID

.pid

Smart Orthographic Drawings

.sha

Smart Electrical

.spe

Aspen Basic Engineering

.zyq

Hexagon 3D Models

3D WebGL Rendition

.binz

Smart Review

.vue

Smart 3D

.zvf

Images

Joint Photographic Experts Group

.jpg

Portable Network Graphic

.png

Tag Image File Format

.tif

Microsoft Office

Excel

.xls

Excel (Macros)

.xlsm

PowerPoint

.ppt

PowerPoint (Macros)

.pptm

Word

.doc

Word (Macros)

.docm

Text

Comma Separated Values

.csv

Text

.txt

The markup rendition is generated when:

  • The file is attached to a document.

  • A user attempts to compare or mark up a file that does not have a markup rendition. In this case, the user sees the following messages: "Unable to retrieve the markup rendition" and "Created scheduled task to create markup rendition." For more information, see Unable to retrieve the markup rendition.

Confirm the following in the Desktop Client to ensure that markup renditions are automatically generated:

  • The Auto-generate Markup Rendition flag on the SPFFileTypeFileType relationship definition between the file type objects and the markup rendition file type object is required.

  • The MainScheduler must be set to Start.

What if markup rendition generation fails?

If it fails, you must manually generate the markup 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 SmartPlant Foundation server log (use the RemoteServices trace switch), the SmartPlant Foundation remote services log, the SmartPlant Markup log, or the SmartPlant Markup Server Status page. For more information on SmartPlant Foundation logging, see SmartPlant Foundation 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 markup renditions for files stored before upgrading?

If the files you need markup 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:

A markup rendition is generated for any file requiring one when Create Markup Renditions in Batch is run. The process might take a substantial amount of time the first time it is run after upgrading. This is because the number of file formats requiring markup rendition files has grown. Any subsequent runs after upgrade should take much less time.

  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 SmartPlant Foundation server log (use the RemoteServices trace switch), the SmartPlant Foundation remote services log, the SmartPlant Markup log, or the SmartPlant Markup Server Status page. For more information on SmartPlant Foundation logging, see SmartPlant Foundation 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.