Retrieve dialog box - Integration - Update 44 - Help - Hexagon

SmartPlant Integration COM Help

Language
English
Product
Integration
Search by Category
Help
SmartPlant Foundation / SDx Version
10
Smart P&ID Version
9 (2019)
Smart Engineering Manager Version
10 (2019)

Allows you to retrieve information published by other authoring tools.

Plant breakdown structure hierarchy - Displays the plant breakdown structure (PBS) hierarchy to retrieve the corresponding documents. Selecting a node displays the published documents related to that node in the Documents to retrieve section.

In the following examples, the PBS hierarchy is Plant > Area > Unit:

  • Select a plant node: All documents that have the relation with the PBS hierarchy (area/unit) as well as the documents which do not have relation with the PBS hierarchy (area/unit) are listed in the Documents to retrieve section.

  • Select an area node that has multiple units: All documents that correspond to the units in that area are listed in the Documents to retrieve section.

  • Select a unit node: All documents that correspond to that unit are listed in the Documents to retrieve section.

If you have changed or created new icons for your PBS hierarchy, do the following to reflect the new icons in your PBS:

  1. Create a copy of the icons delivered with SmartPlant Client and rename them with the name of the new PBS classes. Sample icons are in the [Product Installation Directory] \SmartPlant\SmartPlant Client\Icons].

  2. Place your icons in the Icons directory, located at [Product Installation Directory] \SmartPlant\SmartPlant Client\Icons].

Icons must be in .gif format.

Document type - Lists the types of documents that you can retrieve. Selecting a document type changes the list view to show only that document type.

Show - Indicates which documents you want to see in the list. Select from the following options:

  • New documents - Provides a list of only the new documents that have not yet been retrieved.

  • New versions of retrieved documents - Provides a list of only those documents that need to be retrieved. In other words, the list will display the documents that have newer versions published since they were last retrieved.

  • Unchanged documents - Provides a list of documents that have not changed from the previous retrieve.

Documents of all owning groups - Provides a list of documents associated with all owning groups. If an owning group is not configured to the user, the documents associated with it are unavailable and cannot be retrieved.

  • To retrieve documents that are unavailable, add the user to the respective owning group. For more information about owning groups in integration, see Using owning groups with Publish and Retrieve.

  • Use As published to retrieve only the data that the authoring tool originally published, along with the selected revision and version of the document at the time of publishing.

  • The Latest data retrieves data by comparing the information in the database with what is in the XML file and will update only the objects that were originally published.

  • The CDW data retrieves the data by updating the property values contained in a published XML with those contained on the corresponding CDW object.

  • To sort the properties alphabetically, click a column header to sort the items in ascending order and click again for descending order.

  • To filter a column, right-click the column header, point to Filter, and click the type of information by which you want to filter the column.

  • To reorder columns, right-click on the column header, point to Manage columns and then select an option:

    • Reorder to move the column positions up or down.

    • Reset to apply the default settings.

Documents to retrieve - Displays a list of the documents available for retrieval. For each document, this list provides the name, type, PBS parent, revision and version numbers, status, date of the last retrieval, source, owning group, publish comment, publish date, and retrieve option. Click the check box beside each document you want to retrieve and then use the Retrieve Option column to specify whether you want to retrieve the document As published, with Latest data, or with the CDW data.

  • By default, the Retrieve Option column is configured to As published.

  • To quickly apply a Retrieve option to multiple documents, point to the cell that you want to select, and then click and drag until all the documents are selected. Right-click the highlighted cells and select Retrieve option to apply the Latest data, As published, or CDW data option. Similarly, you can use the Select to retrieve option to select all or clear the selected documents to retrieve.

Select All - Selects all the files in the Documents to retrieve section.

Clear All - Clears any selected files in the Documents to retrieve section.

Batch retrieve - Indicates that the system will retrieve the selected documents in batch mode, that is, in the background. When you use this feature, an e-mail message alerts you when the process is complete. Otherwise, the retrieval process begins as soon as you click OK.

  • Check for deleted objects no longer on documents option will be checked and disabled if Automatic process of moved objects option is set to TRUE on the Manage Integration Options dialog in the SmartPlant Foundation Desktop Client.See Configure Automatic process of moved objects.

  • The status bar contains four separate areas of information.

    • The first column displays information about the current SmartPlant Foundation connection.

    • The second column indicates whether SmartPlant Integrator has been installed.

    • The third column indicates whether File Mode is on or off.

    • The last column displays whether debug logging is enabled, and to what level. If this section is blank, debug is not enabled.See Debug and Error Logging in SmartPlant Integration for COM environments or Debug and Logging in SmartPlant Integration for .NET environments.