Extract Settings

The Gateway extracts model and engineering data from the Smart 3D API. Therefore, the Gateway should be installed on the same machine that also hosts Smart 3D.

For performance reasons, the extraction is a two-stage process that initially writes the extracted data to an extraction file that can then be updated by subsequent delta extractions. The Gateway’s output EIWM and XGL/ZGL files are then generated from this extraction file.

To specify how to extract the data:

1. Click Extract to display the Extract Smart 3D field.

   Extract settings pages opens with a set of tools for the Extract operation.

2. Click Input menu from the Extract page to define the input source and extract file path.

   

3. In the Plant Selection section, click Connect.

   If successful, a connection is established between the Gateway and Smart 3D. The Active Plant drop-down list is populated with models from the active Smart 3D site.

   Note: The Gateway user must be the same user who has privileges to run the Smart 3D application. During extraction of data, a Smart 3D license is required to allow communication between the Smart 3D API and the Gateway.

4. Click Disconnect to close the connection and release the Smart 3D license.

5. Select the relevant Active Plant to be extracted.

   

   From the Input Source, select the specific data in the plant you want to extract. If you select Model Selector or Filter Selector, then the relevant tab is enabled where you can enter the details of that selector:

   • Model Selector – When you select this option, the Gateway will display a representation of the System Workspace Explorer from which you select the elements to extract.

   • Filter selector – When you select this option, the Gateway will display the filters defined in the Smart 3D project. Only those elements that pass the filter will be extracted.

   • Direct – When you select this option, you can manually enter the relevant Smart 3D UID, which will extract the Database Object ID and its children. This field allows for a list of UIDs.

6. In the Filesystem section, type the details of the extraction file in Extraction Name and Extraction Path boxes. Alternatively, you can use the Browse File Path option to enter the input data location.

   In the Extraction Modes section, select the required option from the following options to either extract an existing or a new Input data.

   • Update – This mode compares the current state of the data in Smart 3D with the data saved in the previous extraction file and only updates the data that has changed; updates of existing objects and new objects; or objects that have been deleted. This mode can greatly reduce the extraction time if only a few changes have been made since the last extraction. If the old data does not exist, update will work as New. The Update mode is the default extraction mode.

     

   • New – This mode creates a new extraction file via a full extraction, any previous extraction file with the same file name will be deleted.

   • Existing – This mode creates the output EIWM and XGL/ZGL files from the existing extraction file. No new extraction is done here. This can save both time and the use of a Smart 3D license if just the transformation needs to be changed or if the extraction file is shared between machines.

7. From the Model Selector option, select the elements to export. You can partially select or deselect elements.

   

   The Show Named Spaces checkbox shows/hides space elements in the Model Selector.

   If you clear the Show Named Spaces checkbox, none of the previously selected space elements will be extracted.

   

8. Press Clear Selection to remove all the selected checkboxes.

   

9. Press Show/Hide button to show or hide additional tab with the attributes of selected component, as shown in the following figures:

   

   

10. Select Filter Selector to apply the Smart 3D filter on the extracted items. The Filter Selector provides the following fields:

    • Filter Path – Indicates the path to the location of the filter in Smart 3D.

    • Filter Name – Displays the name of the applied Smart 3D filter.

      Notes:

    • You can select only one filter for extraction.

    • Filter Path and Filter Name are read-only.

      

11. Select Units of Measure tab to customize the readout and/or precision of selected units. By default, the Gateway reads all the units with default database units.

    

12. Select the Layers tab to define the specific geometry to extract in addition to the Simple Physical geometries.

    

13. Use the Active column to select each relevant Class Type, and for each Class Type select what aspect of that class to extract. By default, the Gateway reads only the geometry that is bounded to the Simple Physical aspect.

14. Use Enter on the keyboard to add a new row or click on another row to insert a new row.

    For example, if column Active is enabled for the Pipe Part Class Type and an Insulation Aspect is selected, then the Gateway will extract Insulation geometries along with Simple Physical geometries.

    Notes:

    • It is possible to extract geometries from more than one additional aspect. For example, if Class Type of CableTray Part is selected and an aspect of Maintenance is chosen, a second row can be created to select the same Class Type and an aspect of Operation can also be chosen, then the Gateway will extract additional geometries from the Operation and Maintenance aspects for CableTray Part objects.

    • The Units of Measure and Layers are defined in the Gateway installation and are specific to that version of the Gateway.

    • Geometries from Simple Physical are always extracted, they cannot be disabled.