OpenPlant Modeler Help

Consistency Manager

This option lets you view the database consistency between what components are placed in the 2D model vs the 3D model. It also provides options to generate and view reports of the database records stored on PlantSight.

Note: This option is only available when working with a connected project which has been provisioned to an imodel.
Note: The Consistency Manager is for viewing purposes only. No property values can be changed from this interface.

This is a common tool accessed from the Tools group which is available from the Piping, Equipment and Raceway ribbons.

When you first select the command an update is performed to sync with the imodel. If there any new/modified/deleted components the Differencing dialog will display to update the changes.
Note: If you cancel the update, it will not display the Consistency Manager.

Once the update has been performed, the following dialog displays. By default, the Home tab is displayed which is where you can run a query and view the results of the components in the imodel.

The Settings tab contains settings which control what information is displayed and how it is formatted under the Home tab.

Home Tab

SettingDescription
Run Query This option runs the BIM query based on the criteria selected in the Navigation tree. When the query has been run, the results are displayed in the Instances tree.
Save The Save button enables when changes are made in the Consistency Manager. Click to Save the changes.
Reports The Consistency Manager has a list of reports that can be run and viewed. By default the Text and HTML reports are available. The XML and JSON reports can be added from the Settings tab under the Reports section.
  • Text
  • HTML
  • XML
  • JSON
When the report is run it is opened in a view window using the format selected.
Note: When a report option is run, it will also update the Instances pane with the results.

Sample Report

Project Reports Allows for project wide reporting when working with a PlantSight integrated WorkSet. A set of default reports are included with the install but additional reports can be added through the Report Designer available from the OpenPlant Project Administrator.

The display of the Project reports list can be toggled on/off in the Settings tab under the Reports section.

Note: If working locally and not connected to a PlantSight integrated WorkSet you can still run project wide reports which include an referenced drawings. A setting is included in the report Options dialog which lets you include referenced drawings when querying data for a report.

How To

Tree Query Filters Ths options in this section control how the query results are displayed. Two different sets of display options are available:
  • Used: Displays all items.
  • Unused: Displays items that have not been placed.
  • Differences: Displays all items which have property differences between the 2D and 3D models.
  • 2D: Displays only items that have been placed in a 2D (PID) document.
  • 3D: Displays only items that have been placed in a 3D (physical) model.
  • Active Model: Displays components in the active model.
Tree Display Options The hierarchy options determine how the results are displayed:
  • Class: Shows all of the classes:
  • WBS: Shows the items under the Work Breakdown System:
  • Document: Changes the Navigation pane to display documents. Select a document to display the classes in the Instances tree:
For newly added classes, the MappingsTagClass.json file must be modified to display them in the Consistency Manager. This file is found in the following location (using the default OpenPlantMetric Workset as an example):

Note: ...\ProgramData\Bentley\OpenPlant CONNECT Edition\Configuration\Workspaces\WorkSpace\WorkSets\OpenPlantMetric\Standards\OpenPlant\Mapping\MappingsTagClass.json

View Options Provides options to view the selected item in the Instances tree:
  • Zoom: Zooms on the selected instance in the active model.
  • Isolate: Isolates the selected instance in the active model.
  • Highlight: Highlights the selected instance in the active model.
Differences The Consistency Manager allows for global selection of Instances with property differences between the 2D and 3D drawings. Any resolved property items (checked checkbox in property grid) will be saved.
  • Stage All: Click this item to Stage (check all property checkboxes)
Reset All:

Navigation Tree

The navigation tree provides criteria to use to run a query of the imodel database using either Classes or 2D Documents as search criteria:
SettingDescription
Query Classes List the available classes which can be used to query the BIM database. One or more classes can be selected for the query. These are defined in the TaggingScopes section in the following location:

...\Configuration\Workspaces\WorkSpace\WorkSets\%Workset%\Standards\OpenPlant\Mapping\MappingsTagClass.json

When BIM View option is selected, it will display the results found in the Instances pane.

Selection Options The following options are available as toolbar selection options for the Navigation section when the Query Classes:
  • Select All
  • De-Select All
Documents List the available 2D documents as defined by the class DOCUMENT and PID DOCUMENT. When running a BIM query, it will list the components for the selected 2D document in the Instances pane. The Documents are displayed when the Document option is selected in the Tree group.

Unlike when querying classes, only one document can be queried at a time.

Search Options When the Documents tree is displayed a search option is available to filter the display.
  • Search: Enter the search criteria into the field and click this icon to filter the display.
  • Clear: Click to clear the filter and refresh the tree.
  • Expand/Collapse: Expands or collapses the current tree view.

Instances/Properties

When a query is run the results are displayed in the Instances section of the dialog. The tree is displayed using the hierarchy option described above.
SettingDescription
Search Options The following search options are available to filter the results display:
  • Search: Enter the search criteria into the field and click this icon to filter the display.
  • Clear: Click to clear the filter and refresh the tree.
  • Collapse: Click to collapse all nodes in the Instances tree.
Column Indicators The Instances section contains two columns to the left with icons that indicate whether items are placed in a 2D document, 3D model or both:
Placed in 2D document
Placed in 3D model
Placed in 2D document and 3D model
Note: For a full description of all of the symbols used in the Consistency Manager, click Settings tab and view the Legends section.
Color Coded Results The color of the text for the instances have a purpose in defining the placement status of the instance.
  • Red: Identifies an instance that has differences in property values between the 2D document and the 3D model.
  • Green: Identifies an instance with no differences.
  • Blue (Bold): Identifies an instance whose properties have been changed and pending a save.
When you hover the mouse over an instance name a tooltip displays the placement status of the instance as well:
When you click on an item in the Instances tree, its properties are displayed in the Properties section:
SettingDescription
Name Displays the name of the property.
2D Displays the value defined in the 2D document.
3D Displays the value defined in the 3D model.
Comparison The third column displays a icon in the last column if the property values are the same in the 2D document and 3D model. If the values are different then the icon is displayed.
Note: Properties with no differences are also shaded to distinguish them from the properties with different values.
Note: Properties can only be viewed and not changed in the Consistency Manager.

Context Menu

When you right click on an instance in the tree the following context menu displays:
SettingDescription
Report Types By default there are two types of report formats which can be run from the menu.
  • Text
  • HTML

Additional report formats can be added by enabling them under the Reports settings in the Settings tab.

Property Differences Select whether to Stage Items or Reset Staging to apply to the Instances Tree. These options operate the same as the ribbon options detailed above.
Expand/Collapse Expands or collapses the current tree view.
Copy Selected Item Text Copies the currently selected tree node to the clipboard
Filtered on Selected Item Filter display of the Instances tree based on the currently selected node.
Info Displays a popup with property info for the selected node.
Create Custom Component When you click on a component tag which has not been placed in the 3D drawing, you will have the opportunity to use the tag to create a new Custom Component from native elements in the drawing.
This option behaves the same as the Create Equipment option available from the Equipment toolbar. The only difference is when the Tool Settings dialog displays, you are not prompted to select a component class as it is already determined. Once you have selected the element(s) to create the equipment from the following dialog displays:

When you click Create, the new component is created inheriting the properties from the selected tag. These can be modified using the Properties dialog.

Placement Options When you click on a component instance which has been placed in a PID and not placed in the 3D model placement options will display for the component. The placement options are related to the class of component instance selected.

Once you select a placement option continue with the normal placement procedure for the component. The Properties dialog will display so you can define any properties for the property before placing in the model.

If the WBS items defined for the component in the PID drawing have not been defined in the 3D model, the following message displays:

Click OK then define the WBS items using the Standard Preferences dialog.

Nozzle Placement

Nozzles cannot be placed from the Consistency Manager at this time. If you right click on a nozzle the following displays:
If you click on the menu pick the following message displays:
Refer to the links below for nozzle placement:
Key-in: mechaddin ccreport 1