View relationships in the Document Workbench (retired) - SmartPlant Foundation - SmartPlant Foundation 2020 - Help - Hexagon

SmartPlant Foundation and Web Client Modified and Retired Functionality

SmartPlant Foundation
Search by Category
SmartPlant Foundation / SDx Version
SmartPlant Markup Plus Version
10.0 (2019)

The document workbench in the Data Capture was removed from the Desktop Client in Update 33. However, it is still available if your SmartPlant Foundation uses the Brava! viewer.

  1. On the Resolve Relationship page, select one or more documents from the search results displayed in the list view.

  2. Click Show Document Workbench to view the documents in the Document Workbench.

    SHARED Tip If only one document is selected, then you need not display the list of documents in the Document Workbench.

  3. On the Document Workbench page, click a file name in the Documents pane to view the file in the middle pane. The Tags pane on the right displays all the tags related to the selected document.

  4. Click a tag name to view the tag properties in the table below the Tags pane.

  • RADView control is used to view the 2D drawing file types like .igr, and .pid.

  • There are three viewing commands in Document Workbench:

    • FIT: Resizes the document in the workbench to fit it into the width of the document workbench.

    • Zoom Area: Allows you to zoom the selected area in the drawing.

    • PAN: Allows you to move through the drawing.

  • To view the GraphicsMap file for hotspotting, do the following:

    • Select Auto Generate PDF to allow generation of pdf files for each file during the document discovery task.

    • These pdf files present in the PreProcessedAlternateRenditions folder are given as input to the PDF reader Preprocessor module for generating the Content File and the GraphicsMap file.

View document relations

Click the Relationship Details tab to view the relationship details of the document as shown in the following example:


The central node represents the master object on which the view related items service is based.


The Columset Properties pane displays the properties based on the column set configured for the master object.


The terminal nodes represent the related objects.


Represents the number of the related objects. You can click the hyperlink to view the properties of the object or click View Related Items VRI to view the object related items.


The Additional Properties pane displays the properties configured in the Property Lists module.

  • The terminal nodes displayed are based on the EdgeDefs configured on the view related items client API method. The EdgeDefs can be configured as a parameter (Arg1) for the view related items client API method in SmartPlant Foundation Desktop Client.

  • The View Related Items client API method must be related to the interfaces realized by the selected document. If this method is not related to any of the selected document interfaces, then the terminal nodes in the diagram represent objects expanded from the relationship and user-defined edge definitions related to the master object.

  • When a tag is selected in the Document Workbench, the tag is highlighted in the PDF rendition file if a rendition already exists for the document.

  • If a property created in either the Tag Naming System or in the Property Lists module has a relationship configured against it, that relationship is created during the content discovery task.

  • You can click the View error log hyperlink of the content discovery task in the Summary tab to view the Error Log in the Content Discovery Task.