Set up Lexicon Module

The Lexicon module allows the administrator to take complete control of the administration of the Dictionary (DICT) database of a project. The Dictionary databases contain the definitions of User Defined Attributes (UDAs), User Default Element Types (UDETs), User System Defined Attributes (USDAs) and Database View Element (DBVW) as set up in Lexicon. The Command window allows the administrator to maintain the Dictionary database through the use of a command line interface.

Important: If you have upgraded AVEVA Marine, you must rerun the latest Lexicon scripts to continue to use AVEVA ERM-Design Integration.

Notes About DB views and PML functions

To facilitate advanced selection criteria and data output, DB views have been replaced with PML functions for integrating data. The following points must be noted about the usage of DB views and PML functions.

• New User: If you are a new user of AVEVA ERM-Design Integration, the PML functions are used for integration by default. To avoid complexities, DB views must not be used for new installations. For this purpose, you must not run the IntegrationSetup_DbViews.dat macro even though it is available in the same location as the other macros. If you run this macro, then DB views are created and the same will be used for integration.

  Nevertheless, you can switch back to PML functions if you delete the DB views from your project location.

• Existing User: If you are an existing user, DB views are used for integration by default. To switch to PML functions, you must delete the DB views from your project location.

When both PML functions and DB views are available for a concept, AVEVA ERM-Design Integration uses DB views to store and retrieve data. When using PML functions, you must make sure that AVEVA ERM is configured to work in the PML Safe mode. If using DB views, then configure AVEVA ERM to work in the Non PML Safe mode. For more information, see the screen help for s14001 Integration Service in AVEVA ERM.

Note: To use the latest features, we recommend that you use PML functions for transferring data. If you decide to use the DB views, some features may not be available.

To set up Lexicon for AVEVA ERM-Design Integration:

1. Start AVEVA Administration, and launch the Lexicon module as a SYSTEM user or equivalent.

2. Click Display then Command Window to display the Command window.

3. Run the following Lexicon macros by dragging them to the Command window. By default, these macros are placed in the C:\AVEVA\Marine\OH12.1.SP5\ERMIntegration\LexiconMacros location during installation.

   Important: If you have upgraded AVEVA Marine, you must rerun the latest Lexicon scripts to continue to use AVEVA ERM-Design Integration.

4. When using PML functions to store and retrieve data, run the macro IntegrationSetup_UDAs.dat and restart Lexicon.

   When using DB views to store and retrieve data, run the macro IntegrationSetup_LexiconMacros.dat. This macro will in turn execute the IntegrationSetup_UDAs.dat and IntegrationSetup_DbViews.dat macros.

   This will create the UDAs, UDETs, Status definitions required for the integration. The Dictionary Explorer is displayed as follows:

   

   Important: If you are using AVEVA Plate & Bar Nesting together with AVEVA Marine, you must first run the macros for AVEVA Plate & Bar Nesting and then the macros for AVEVA Marine.

For data transfers from AVEVA Engineering and AVEVA Diagrams, run the following macros.

• IntegrationSetup_Engineering.dat

• IntegrationSetup_DiagramSetUp.dat

The Dictionary Explorer is displayed as follows: