Options

Compare/Update User Guide

The types of elements that will be compared and how their attributes will be mapped are set using the Options window, from the main toolbar, select Options.

Note:

You must be a member of team CUADMIN to use any of these options.

Manage Configurations and Groups

Click Manage to display the Manage Configurations & Groups window.

Use the Source Databases hierarchy to display the available databases, groups of configurations, parent and child configurations. Select a configuration to display its summary details in the right hand pane of the Manage Configurations & Groups window.

Alternatively, click Summary to display read only configuration summary details.

Right click one of the configurations nodes to create a new configuration with that source database.

Right click one of the configurations to Edit, Copy, Delete or Rename it.

Selecting New Configuration or Edit will display the Configuration Wizard.

Right click one of the groups nodes to create a new group with that source database.

Right click one of the groups to Edit, Copy, Delete or Rename it.

Selecting New Group or Edit will display the Manage Groups window.

Configuration Wizard

The stages to define the configuration consist of:

Define the type of source object

Define the type of destination object

Map the attributes.

Define member element type mappings

Set whether to use advanced rules

Define an expression to identify destination owner objects

Define filters to be applied to the source object population

Note:

Certain out of the box configurations have specific behaviours associated with them which are not available to new created configurations. These out of the box configurations can be edited to add source filters and attribute mappings.

Note:

In Diagrams, select the out of the box AVEVA Instrumentation source for Instruments in order to compare a combined set of SCINSTRUMENTs and SCOINSTRUMENTs.

Note:

In Paragon, select the out of the box AVEVA Instrumentation or Electrical source for Cable Catalogue in order to compare the five destination types.

The source data is the data that will be the basis of comparison.

Set Mode to Local if the source data is to be from a product installed on the same computer.

Set Mode to Service:

•

If the source data is to be from the AVEVA Integration Service. The window changes to show fields for Server Name, Port and Source. These should be set according to the Service configuration. An external relational database source is available (only in the service mode and not in 12.1 SP4) using a suitable configuration of the AVEVA Integration Service.

•

If the source data is to be from an AVEVA ERM source, select a suitable column header for the name attribute, for example: MAT_ID, depending on how the views have been configured. Currently integration with AVEVA ERM does not support unique attribute so None must be selected.

•

If no unique attribute is available for this source select None. When a unique attribute is selected, a UDA SUffix field is displayed, enter a suffix for the UDA name. The full name for the UDA including the suffix is then displayed.

Note:

Text UDAs pmg-engi-edb-<suffix>, pmg-sche-edb-<suffix> should be created where <suffix> is defined in the configuration. These should be set to be indexed and have a length sufficient to hold the unique attribute value length.

Select the Source database from the drop-down list. If the source is AVEVA Electrical, AVEVA Instrumentation or AVEVA P&ID, a Login button will appear. Click this and log in to the source system.

Enter the Display Name that will be used for this source list in the Compare/Update window

Either click on Element Type and select the type of object in the source database or click on Group and select one of the pre-defined source groups. Source groups will be available only in certain contexts such as Design Valves or Design Piping Specials where the group represents a combination of element types.

Select the Name Attribute that is to be used for name matching, and the Unique Attribute that is to be used for internal ids.

These are to be set as follows:


Database	Type	Name Attribute	Unique Attribute
Dabacon	All	Name	RefNo
Aveva Instrumentation and Electrical	Cable	CableNo	CableId
	Cable Catalogue	CatalogNo	CableCatId
	Equipment	EquipmentNo	EquipId
	Instrument	TagNo	InstKEY
	Loop	LoopNo	LoopKEY
Aveva P&ID	All	Label	ID

If the source is an external database, select an appropriate table or view for the source type and select the appropriate columns for the name and unique attributes.

Click Next to continue.

The target data is the data in the default database for the current session, for example: in Tags it will be engineering data. Target data is compared against source data.

In Element Type select the type of object in the target database.

Enter the Display Name that will be used in the Attribute Mapping screen.

If Compare/Update finds unmatched objects, it can create corresponding new objects in the target database. Check Allow insertion if this is to be allowed.

By default, inserted objects take the same name as their source objects. An optional Name Prefix can be specified.

Note:

A name prefix will be required where duplicate naming is not allowed between the source and destination database.

Check Create Reverse Configuration to automatically create a configuration with source and target swapped (this option will be available only when both are Dabacon databases).

Click Next to continue.

Certain out of the box configurations such as AVEVA Instrumentation Instruments and AVEVA Electrical Cable Catalogue have specific behaviours to use multiple destination types. In such cases select each Element Type in turn to define its attribute mappings.

Note:

In AVEVA Electrical and Instrumentation, the administrative user can restrict the list of attributes exposed for integration. Compare/Update will fail if any mapped attributes are not exposed for integration.

Click Add Mapping to add an empty attribute mapping row to the list. On the source side do one of the following:

•

Select an attribute from the drop down list

•

Type the name of a pseudo attribute

•

Type a PML expression, enclosed in brackets, for example: (DESC of OWNE). The expression will not be evaluated at this point but will be evaluated at comparison time against the source object.

•

Type a static value, to set a default value onto a target attribute. Any value entered in this way will not be validated at this point.

Select to un check the Allow Update check box if the attribute is to be compared only and not updated.

Then on the destination side do one of the following:

•

Select an attribute from the drop down list

•

Type the name of a pseudo attribute (if this is to be compared only)

•

Type a PML expression (if this is to be compared only), the expression will be evaluated at comparison time against the destination object.

Select a mapping row and click Delete to remove it.

If this configuration is to include parent/child hierarchy, select one or more member element configurations. For example, a previously defined nozzle configuration can be selected as a member for an equipment configuration.

Note:

When engineering as source, if there are any child configurations with a parts reference in the engineering database and there is an associated attribute, the relationship is displayed. The element in the reference attribute will be shown as a child for the schematic element and is updated as a child element.

For example, an element type called :LINETAG in engineering is mapped with SCPLINE in diagrams, in the Member Element type mapping wizard. Engineering Valves is displayed as a child configuration with a parts reference and associated attribute :LINECODE. In the diagrams, :VALVTAG, present in :LINECODE, will be shown as a member for that element and updated accordingly.

Click Next to continue.

If advanced rules are required for this configuration, select a Project Configuration File (this will usually be the default filename for the project, for example: for Sample project this would be %SAMDFLTS%\ModelManagement\ProjectConfiguration.xml). Then select a Rule Set and check Use Advanced Rules.

Select the Restrict the Configuration to Admin Users only check box, if you want to test this configuration before publishing it for general use on the project.

Click Next to continue.

Select the Make this Configuration available standalone check box to allow end users to be able to run it when it is not part of a group of configurations.

An optional Owner Expression can be entered. This will be evaluated against the appropriate source object during the Update Database process to determine the owner for an inserted object.

Specify an optional owner object for objects inserted from a non-Dabacon source database during Update Database. Browse to select an owner object of the appropriate type from the destination database.

Note:

This sets an expression for that id but where the source is not a Dabacon database, the expression will be read only.

The expression can be tested by selecting an object of the appropriate source type and pressing Test.

During the Update Database process, the precedence of determining the owner for an inserted object will be:

•

From the parent/child hierarchy if updating using a child configuration

•

From a PML callback if defined

•

From the owner expression if defined

•

From the setting in the Update Database dialogue.

Add filters to limit the population of source data that will be used in the comparison.

Note:

The end user will have the option to further filter the source data at run time.

Two types of filters can be entered. The first is on attribute values. The second is on the evaluation of a PML expression. Click the appropriate Add Filter to add a row.

For the attribute filter select the attribute, operator and value. The available operators will be appropriate to the data type of the selected attribute.

For the expression filter enter a PML expression.

Note:

Multiple filters will be joined with AND when generating the query.

Click Finish to complete and save the configuration.

Note:

Configuration files are saved in the project defaults folder, for example: %samdflts%\CUConfigs2.0.

Manage Groups

Use the Manage Groups window to choose which groups of configurations are to be compared.

Enter or modify the name of the group.

Select the Restrict this Group to Admin Users only check box to test it before making it available to the project.

Use the arrow buttons to choose which configurations will be in the group.

A configuration can be in one or more groups and can also be available standalone if marked as such. When running a Compare operation, users will be able to select from the available groups and standalone configurations.

Scope selection is available on groups for certain combinations of data. For example, scope by diagrams can be set on groups with schematic source and is active for engineering users. When set the engineering user will be prompted to select one or more diagrams, limiting the comparison to engineering items that have equivalent schematic objects on those diagrams.

Note:

In scope by source, the user can select one or more diagrams from all available, and this will have the effect of filtering the source objects according to those diagrams.

Note:

In scope by destination, the list of diagrams to select from will be limited to diagrams relevant to the current list selection of engineering items. If this results in a single diagram, the user will not be prompted, and the comparison will proceed automatically.

To enable scope selection click to select the Apply scope selection for this group check box and select the appropriate Scope Criteria from the drop down list.

Click OK to save the group.

If a group contains only Service Mode configurations a common service setting is available for that group. This means the entire group of configurations will use a single login connection in place of the individual logins per configuration. To enable a common service click to select the Use same service and project for all the configurations in this group check box then enter the appropriate Server and Port settings.

Advanced Configuration

Users who are members of team CUADMIN can set up advanced rules by clicking Configuration Explorer. This displays the Project Configuration Explorer shared with Schematic 3D Integrator. There you can configure more elaborate rules for element matching and updating, in particular key attribute mapping to match multiple pipes against schematic or engineering pipelines. An example set of rules using key attributes for engineering to design matching is included in the out of the box ProjectConfiguration.xml file. Refer to the Schematic 3D Integrator User Guide section on How to Configure Rules.

Note:

A target attribute specified in an Assign Action must also be included in the attribute mappings in order to appear in a results column. The source attribute in the mapping will be overridden by the advanced configuration action.

Manage Links

Users who are members of team CUADMIN can click on Manage Links to display this window:

This is an administrative window used to manage Link Worlds. Before using it, create a separate Design Reference database in Admin, and ensure it is current on all MDBs where linking will occur, and all users who need to link can write to it.

Note:

The Manage Links window is shared between Integrator and Compare/Update. Design Reference databases can be written to by 3D, schematic and engineering users.

The list includes all the Design and Design Reference databases available, identifying any that contain links (links created prior to 12.1 reside in Design databases). The following functions are available from the File menu or on a right click context menu.


Create	Create a new Link World in the selected database.
Validate	Output a list of links and any errors to the command line for the selected database. This action will also merge partially populated links, for example: 3D object "A" is linked to schematic object "A" by one link and schematic object "A" is linked to engineering object "A" by another link, as can occur when links are created in separate extract databases.
Validate All	As for Validate for all databases in the list.
Remove invalid references	Remove invalid references from links in the selected database. Invalid references can occur when elements are deleted and the Link World database cannot be updated.
Caution: This operation should be used only when all of the databases holding objects that have been linked are current on the MDB.
Properties	Display the number of links in the selected database.

The Edit menu provides Cut, Copy, Paste and Delete functions to move Link Worlds between databases. You can also drag and drop from one database to another to move or merge a Link World.

Restrict link option to admin users

Use the Restrict link option to admin users functionality to control whether general users can change the Update Engineering Database settings for linking, updating attributes, and unlinking. If the option is checked, these settings are disabled, so that end users must use the default settings for link and update, and are not able to unlink.