Configuration Wizard

The stages to define the configuration consist of:

1. Define the type of source object.

2. Define the type of destination object.

3. Map the attributes.

4. Define member element type mappings.

5. Set whether to use advanced rules.

6. Define an expression to identify destination owner objects.

7. Define filters to be applied to the source object population.

   Note:
   Certain out of the box configurations have specific behaviors 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 AVEVA Electrical source for Cable Catalog in order to compare the five destination types.

In AIS URL specify the URL where the data API of the AVEVA Integration Service (AIS) is located. The standard format is https://<hostname>:<portno>.

From the Authentication type options, specify the user authentication method to be used:

• If AIS is available at on-premises, select NTLM.

• If AIS is available at on-cloud, select AVEVA Connect.

Once the AIS URL and Authentication type have been specified, click Connect. The available projects for the selected source are then listed in the Source field.

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 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 DB source is available (only in the service mode and not in 12.1 SP4) using a suitable configuration of the AVEVA Integration Service 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 DB 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 into 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 DB, 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:

If the source is an external DB, 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 DB 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 DB.

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 DB. 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 DB.

Check Create Reverse Configuration to automatically create a configuration with source and target swapped (this option will be available only when both are DAtaBAse CONtrol Program (DABACON) DBs).

Click Next to continue.

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

Note:
In AVEVA Electrical and AVEVA 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 uncheck the Allow update checkbox 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 destination, if there are any child configurations with a parts referenced in the engineering DB 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. Schematic Pipelines is displayed as a configuration with a parts reference and associated attribute :FROMITEM.

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 checkbox, if you want to test this configuration before publishing it for general use on the project.

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

Click Next to continue.

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.

Or

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

Note:
This sets an expression for that ID but where the source is not a DABACON DB, 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 runtime.

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.