This functionality allows administrators to update many drawings in one go without opening them where the user may request to update the drawings according the master shape changes, defaults, catalogue defaults and/or Diagrams Options. The option is available from the Batch Job command in Tools tab.

Select the diagram to be updated and using the

Add button, ensure the diagram is displayed in the Selection list. Then click Update Diagrams


Make sure the selected diagram is closed before proceeding, otherwise a warning will be displayed and it won’t be possible to update an open diagram.

The Update Diagram Options form will be displayed. The form contains options with which the user can select which actions to be carried out, e.g. type of data to be updated, category of updates to be undertaken,

Update symbols according to master shapes This option will replace shape symbols if the shape master that is located in document master, has any difference than master selected by user.

Update symbols according to catalogue information This option replaces symbol shape according to data in specification. Symbol from SPREF will replace existing one. SPREF attribute must point to element that has valid SYMGROU and SYMNAME attribute values.

Update annotation formats This option allows the user to update auto labels and presentation text according to Diagrams Options or master settings. If master was selected then labels and text rule is taken from master instance. In case when master is not selected then system will check if shape that should be updated took its setting from master or default. If settings were taken from master and master is not selected then some shape settings will not be updated. If settings were taken from Diagrams Options then system will update them.

Update attribute presentation settings This option allows the user to update Shape Data order, presentation texts, visibility etc. according to Diagrams Options or master settings. This option’s behaviour can be controlled globally for each type separately by checking Allow individual shapes to override default settings in Diagrams Options for the data from selected master will be used. Otherwise the shapes will be updated according to Diagrams Options. When master was not selected, system checks if the shapes that should be

updated took their settings from the master or Diagrams Options. If the settings were taken from the master and the master is not selected then the shapes will not be updated. If settings were taken from Diagrams Options then system will update the shapes. During update all Shape Data that exist in shape instance but does not exist in current settings will be removed.

If an attribute is removed using Batch Update, the system will not remove it but will give a warning if other attributes are using this data, i.e. where Instrument type is used as shown, it will not be possible to update the shape not to show this attribute in Shape Data

Ignore stencil settings This option allows the user to update the shapes according to Diagrams Options and not the master settings.

Refresh shapes This option calls a refresh on each shape.

Ignore stencil settings option will not work for autolabels‟ layer. The layer for autolabel is taken from

master that is used to create autolabel

Shapes that do not have settings in Diagrams Options will require master to be selected, i.e. Title blocks and Multi labels

Batch Update cannot be used to set any default values to shape data

Once the desired settings are checked on the Update Diagrams Options, it is possible to select the masters for the update to be applied to. Click on the Browse button which is next to Select master shapes to use for update (0 selected). This message will be updated with the number of the master shapes after the selection is accepted. The Select Masters to update form will be displayed where the user can add a stencil and pick some or all masters from it to be updated in the drawing(s) previously selected.

Click the Add Stencil button and selecting the required stencil click Open button.

Select the shape from the stencil and using the right click context menu or by dragging and dropping add the shape to the Masters to update area. If desired Add all

checkbox can be used.

Masters also can be removed from the Masters to update list using a right click context menu.

Click the OK button and the Update Diagrams Options form should now show the number of the masters to be updated.

It is possible to use the Load log button on the Update Diagrams Options form to open a saved log file using Save Report button on Update Diagrams Status form

The Update Diagrams Status is now displayed and the user can click on the links shown in the related columns to view the informational messages, warnings or errors.

If the user deleted an auto label from a shape, it may not be added after the update as system remembers the deletion. To add the auto label, use Ignore stencil settings checkbox or select the appropriate master

Click OK button on the Update Diagrams Status form, then dismiss the Batch Job form and open the updated diagram.

Clicking Cancel on the Update Diagrams Status form will revert all changes done by Batch Update process

The updated changes should now be reflected by the shapes on the diagram from the selected masters. If the diagram is not refreshed automatically upon opening due to Diagrams Options, manual refresh may be required. The user needs execute a Savework command for the changes to be permanent.

4.10 Edit Master

By using the Edit Master command from the Shapes section of the Admin tab, it is possible to edit the settings for AVEVA Diagrams shapes in a stencil without having to do a new import. The user interface is the same as for Import Shape. However, as the dialogue opens it goes directly to step 3, as steps 1 and 2 are irrelevant for an already existing shape in a stencil.

In step 3, the annotation settings can be changed, in step 4 the attribute presentation can be changed and in step 5 the Default catalogue search filter can be changed.

The administrator / the user can select Edit Shape command from the Shape context sensitive tab for the same purpose on shapes already in the drawing

4.11 Compare/Update

4.11.1 Integration UDA

The integration UDA should be defined using Lexicon module by the administrator in an accessible dictionary database from the current MDB. Once available, if AVEVA Instrumentation or Electrical data have previously been imported into the target database the UDA will provide the comparison using AVEVA Instrumentation or Electrical source database references. If the UDA is not available the comparison will be done according to the default matching criteria.

It is recommended for the administrator to use the definition of the UDA elements as follows. It is possible to extend the element types list for any additional UDET items provided that they are based on the given element types below.

The UDA may be created in any UGROUP in a current dictionary database. If used in conjunction with the specific module, it is suggested to include this UDA in the same group

4.11.2 Options

The Compare/Update add-in is standard for all AVEVA Plant and AVEVA Marine applications. Therefore the settings for its functionalities are included in the Options form. The Options form could be used to configure and maintain the attribute and element type mappings, links between database elements and AVEVA Schematic 3D Integrator rules.

UDA Name UDA Type UDA Length Element Types

pmg-sch-ai text 50 SCINSTRUMENT



pmg-sch-ae text 50 SCEQUI

For AVEVA Diagrams, the administrator will only use the Manage Configuration and Manage Links


The Use advanced configuration checkbox and the Configuration Explorer will give access to the AVEVA Schematic 3D Integrator rules.

The Manage Links button, the Use advanced configuration checkbox and the Configuration Explorer button will become enabled when a Dabacon source is selected in Compare/Update add-in and a configuration is available

For more information on configuration of the integration rules database please see the AVEVA Plant – AVEVA Schematic 3D Integrator (Administration) (TM-3563) Training Guide

If configuration is required to access the source database, the Configure Design Database button will be activated with an appropriate name. Currently this is used only for AVEVA P&ID source data in Tags.

For more information on configuration of the source database please see the AVEVA Plant – AVEVA Engineering - Tags (Advanced) (TM-3551) Training Guide

To display the Options form click on the Options command from the Compare/Update context sensitive tab.

The Manage Configuration button allows the administrator to create a new configuration for element and attribute mappings between the databases or to modify an existing configuration. To create and edit configurations the administrator must be a free user or a member of CUADMIN team. The configuration defines the source and target types of objects that will be compared, and their attributes that will be mapped. Clicking on the Manage Configuration button on the

Options form will display the Compare/Update Configuration Wizard. The wizard will take the administrator through creating a new configuration or choosing an existing configuration to edit, defining the type of source and the target objects, mapping the attributes and finally defining any filters that may be applied to the source data.

In Step 1 of 6, the options to create a new configuration or to edit an existing one will be displayed.

Select Create new configuration or Edit existing configuration radio button. Selecting the option to edit an existing configuration will display a list of existing configurations to select from.

Click Next to continue.

If creating a new configuration; the administrator will be expected to enter the data in the fields in all the steps. However, if editing an existing configuration then the fields will be populated using the information from the selected configuration automatically.

In step 2 of 6, the source data is the data that will be the basis of comparison. The Source dropdown list will be disabled if editing an existing configuration. If creating a new configuration, select the source database from the dropdown list. If the source is AVEVA Electrical, AVEVA Instrumentation or AVEVA P&ID, a Login button will appear. The administrator can log in to the source system if necessary. Key in a name in the Display Name field that will be used for this source list in the Compare/Update dialogue. Either select the Element Type radio button and the type of object in the source database or select the

Group and one of the pre-defined source groups (e.g. pipelines, equipment, instruments, valves or piping specials). Then select the name attribute that will be used for name matching, e.g. NAME and select the unique attribute that will be used for an internal id. For Dabacon sources the unique attribute will be RefNo.

Click Next to continue.

In step 3 of 6, select the type of object in the target database using the Element Type dropdown list. Key in a name in 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 checkbox if this is to be allowed. By default, inserted objects take the same name as their source objects. However, an optional prefix can be specified using the Name Prefix field.

Check Create Reverse Configuration checkbox 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.

If an alternative or a more advanced rule set is required, the administrator could select an external xml file. If the file is read successfully then the administrator could select a rule set from the drop down list and check the Use Advanced Rules

checkbox. If this set of rules are to be tested by the administrator before publishing for the users, then it is possible to check the Restrict the Configuration to Admin Users only checkbox.

In step 5 of 6, the administrator can add filters to limit the population of source data that will be used in the comparison. Note that the end user will have the option to further filter the source data at run time. To add filters use the Add filter button and populate the filters using the Attribute, Operator and Value cells. Selecting AND radio button will require the source data to satisfy all given filters. Selecting OR

radio button will result in filtering the data for each row individually; if one of the filters are satisfied the data will be displayed in Compare/Update grid. To remove the filters use the Delete filter button. Click Next to continue.

In the last step of the wizard, click the Add Mapping

button to add an empty attribute mapping row to the list, and then select the source and target attributes in the dropdown lists as required.

To remove an attribute mapping, select a mapping row and click Delete Mapping button.

Click Finish to complete and save the configuration.

The configuration is saved and the Compare/Update add-in is now ready to be used.

The configuration is saved in the project defaults ModelManagement folder, e.g. %mardflts%\ModelManagement

After creating a configuration or editing an existing one, the administrator should ensure the linking structure is in place. If this is not set, the following error will be displayed to users and it will not be possible to update the schematic database using AVEVA Engineering and AVEVA Design databases.

The Manage Links button will be enabled for free users or users who are a member CUADMIN team where there are one or more reference design databases available in the current MDB. Clicking the Manage Links button on Options form will display the form shown with all options enabled for the free users.

This is an administrative dialogue used to manage Link Worlds. Before using it, it is recommended that the administrator creates a separate Design Reference database in Admin module, and ensures it is available on all MDBs where linking will occur, and all users who need to link can write to it

The list includes all the Design and Design Reference databases available, identifying any that contains links. The following functions are available from the File menu or the right click context menu.

Create Create a new Link World in the selected database if there isn’t one already.

Validate Output a list of links and any errors to the command line for the selected database.

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.

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 the Link Worlds between

databases. The administrator can also drag and drop from one database to another to move or merge a Link World.

4.11.3 Linking

Compare/Update add-in can link matched elements when both the source and target are Dabacon databases. The mechanism used is shared with AVEVA Schematic 3D Integrator so that any links are consistent.

The link information is stored on a CYMLNK object which is situated in a reference database and not

normally visible to the user. This has references to the linked objects. The deslnk, schlnk and englnk pseudo attributes can be used as direct references between linked items to populate data in reports and other deliverables.

In document TM-3534 AVEVA Plant and AVEVA Marine (12.1) Diagrams Administration Rev 1.0 (Page 48-58)