Aveva Erm Integration User Guide
Aveva Erm Integration User Guide
1.2 AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar losses; loss of
anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of data or information; any special,
indirect, consequential or pure economic loss, costs, damages, charges or expenses which may be suffered by the
user, including any loss suffered by the user resulting from the inaccuracy or invalidity of any data created by the
AVEVA software, irrespective of whether such losses are suffered directly or indirectly, or arise in contract, tort
(including negligence) or otherwise.
1.3 AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with the
performance of the AVEVA software shall be limited to 100% of the licence fees paid in the year in which the user's
claim is brought.
1.4 Clauses 1.1 to 1.3 shall apply to the fullest extent permissible at law.
1.5 In the event of any conflict between the above clauses and the analogous clauses in the software licence under
which the AVEVA software was purchased, the clauses in the software licence shall take precedence.
Copyright
Copyright and all other intellectual property rights in this manual and the associated software, and every part of it
(including source code, object code, any data contained in it, the manual and any other documentation supplied
with it) belongs to, or is validly licensed by, AVEVA Solutions Limited or its subsidiaries.
All rights are reserved to AVEVA Solutions Limited and its subsidiaries. The information contained in this document is
commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or transmitted without the
prior written permission of AVEVA Solutions Limited. Where such permission is granted, it expressly requires that
this copyright notice, and the above disclaimer, is prominently displayed at the beginning of every copy that is made.
The manual and associated documentation may not be adapted, reproduced, or copied, in any material or electronic
form, without the prior written permission of AVEVA Solutions Limited. The user may not reverse engineer,
decompile, copy, or adapt the software. Neither the whole, nor part of the software described in this publication
may be incorporated into any third-party software, product, machine, or system without the prior written
permission of AVEVA Solutions Limited, save as permitted by law. Any such unauthorised action is strictly prohibited,
and may give rise to civil liabilities and criminal prosecution.
The AVEVA software described in this guide is to be installed and operated strictly in accordance with the terms and
conditions of the respective software licences, and in accordance with the relevant User Documentation.
Unauthorised or unlicensed use of the software is strictly prohibited.
Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved. AVEVA shall not be
liable for any breach or infringement of a third party's intellectual property rights where such breach results from a
user's modification of the AVEVA software or associated documentation.
AVEVA Solutions Limited, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom.
Trademarks
AVEVA and Tribon are registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised use of the
AVEVA or Tribon trademarks is strictly forbidden.
AVEVA product/software names are trademarks or registered trademarks of AVEVA Solutions Limited or its
subsidiaries, registered in the UK, Europe and other countries (worldwide).
The copyright, trademark rights, or other intellectual property rights in any other product or software, its name or
logo belongs to its respective owner.
Page 2
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration
User Guide for AVEVA Everything3D™
Contents Page
1 Preface..................................................................................................................... 8
1.1 About..............................................................................................................................
This Document 8
1.2 .............................................................................................................................. 8
Audience
1.3 ..............................................................................................................................
Summary of Chapters 9
1.4 Product
..............................................................................................................................
Training Information 10
1.5 ..............................................................................................................................
Technical Support 10
2 Introduction
..................................................................................................................... 11
2.1 ..............................................................................................................................
Overview of AVEVA ERM-Design Integration 11
2.2 Integration
..............................................................................................................................
Supported 12
2.3 ..............................................................................................................................
Notification Workflow Overview 12
2.4 ..............................................................................................................................
Notification Details 14
2.4.1 Design ...........................................................................................................
Project Id 14
2.4.2 Sent To Application
........................................................................................................... 15
3 AVEVA.....................................................................................................................
ERM-Design Integration Capabilities 16
3.1 ..............................................................................................................................
Handling Multiple Projects 16
3.2 .............................................................................................................................. 17
Prevalidation
3.3 Partial
..............................................................................................................................
Import in AVEVA ERM 17
3.4 ..............................................................................................................................
Update/Rework Information on Part Lists 18
4 Software
.....................................................................................................................
Requirements 19
5 About.....................................................................................................................
Settings Dialog Box 20
6 Configuring
.....................................................................................................................
Design Application and AVEVA ERM for Integration 25
6.1 ..............................................................................................................................
Configuring Design Application for AVEVA ERM-Design Integration 25
6.1.1 Set Up Project for AVEVA ERM-Design Integration
........................................................................................................... 26
6.1.2 Set Up ...........................................................................................................
Admin Module 26
6.1.3 Set Up Lexicon Module
........................................................................................................... 29
6.1.4 Install...........................................................................................................
and Set Up AVEVA Integration Service 30
6.1.5 Configure ...........................................................................................................
Design Application for AVEVA Integration Service 31
6.2 ..............................................................................................................................
Configuring AVEVA ERM for AVEVA ERM-Design Integration 31
6.2.1 Configure Integration
........................................................................................................... 31
6.2.2 Configure Material Definition
........................................................................................................... 34
6.2.3 Configure ...........................................................................................................
Material Control 35
6.2.4 Set Up ...........................................................................................................
External Source Applications 36
6.2.5 Set Up AVEVA Integration Service
........................................................................................................... 37
Page 3
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
6.2.6 Set Up Projects
........................................................................................................... 39
6.2.7 Set Up Material Type Defaults
........................................................................................................... 40
6.2.8 Set Up
...........................................................................................................
Fabricate Types 41
7 List of.....................................................................................................................
Source Tables Used 42
8 About.....................................................................................................................
Material Mapping 43
8.1 ..............................................................................................................................
Material Category Mapping 43
8.2 ..............................................................................................................................
Supporting PML Functions 45
8.3 Create
..............................................................................................................................
a New Mapping 46
8.4 ..............................................................................................................................
Material Mapping Settings 47
8.5 ..............................................................................................................................
Exporting Material Category Mappings to Excel 48
9 Performing
.....................................................................................................................
Basic Tasks Using AVEVA ERM-Design Integration 49
9.1 Processing
..............................................................................................................................
Messages in AVEVA ERM 49
9.2 ..............................................................................................................................
Importing Data in AVEVA ERM Manually 50
9.3 ..............................................................................................................................
Filtering Notifications 51
9.4 ..............................................................................................................................
Sharing ExternalReferenceId 51
10 Standard
.....................................................................................................................
Material Integration 53
..............................................................................................................................
10.1 Concept Description 53
..............................................................................................................................
10.2 Overview of Transfer Process 54
..............................................................................................................................
10.3 Information Transferred 55
10.4 Integration
..............................................................................................................................
Workflow – Data Transfer to AVEVA ERM 56
10.4.1 Configure a filter for standard materials
........................................................................................................... 56
10.4.2 Update the status of the standard materials
........................................................................................................... 57
10.4.3 Publish ...........................................................................................................
the standard materials 57
10.4.4 Import the standard materials into AVEVA ERM
........................................................................................................... 57
10.4.5 Verify...........................................................................................................
the imported data in AVEVA ERM 58
10.4.6 Provide ...........................................................................................................
feedback on data processing in AVEVA ERM 58
10.4.7 Process ...........................................................................................................
the feedback 58
10.5 Integration
..............................................................................................................................
Workflow – Data Transfer from AVEVA ERM 59
10.5.1 Publish the standard materials in AVEVA ERM
........................................................................................................... 59
10.5.2 Import ...........................................................................................................
the standard materials 60
10.5.3 Verify...........................................................................................................
the imported data 61
10.5.4 Provide feedback on data processing
........................................................................................................... 61
10.5.5 Process the feedback in AVEVA ERM
........................................................................................................... 61
..............................................................................................................................
10.6 Importing Bolt Data from AVEVA ERM 62
11 System
.....................................................................................................................
Hierarchy Integration 66
11.1 Concept
..............................................................................................................................
Description 66
..............................................................................................................................
11.2 Overview of Transfer Process 67
..............................................................................................................................
11.3 Information Transferred 67
..............................................................................................................................
11.4 Integration Workflow – Data Transfer from AVEVA ERM 68
Page 4
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
11.4.1 Publish system hierarchy from AVEVA ERM
........................................................................................................... 68
11.4.2 Import system hierarchy
........................................................................................................... 69
11.4.3 Provide
...........................................................................................................
feedback on data processing 69
11.4.4 Process feedback in AVEVA ERM
........................................................................................................... 70
12 Project.....................................................................................................................
Component Integration 71
..............................................................................................................................
12.1 Concept Description 71
..............................................................................................................................
12.2 Overview of Transfer Process 71
12.3 Information
..............................................................................................................................
Transferred 72
..............................................................................................................................
12.4 Integration Workflow – Design Application to AVEVA ERM 73
12.4.1 Set up material type on EQUIPMENT
........................................................................................................... 73
12.4.2 Set up ...........................................................................................................
systems on EQUIPMENT 73
12.4.3 Configure a filter for project components
........................................................................................................... 74
12.4.4 Update the status of the project components
........................................................................................................... 75
12.4.5 Publish ...........................................................................................................
the project components 75
12.4.6 Import ...........................................................................................................
the project components in AVEVA ERM 75
12.4.7 Verify...........................................................................................................
the imported data in AVEVA ERM 76
12.4.8 Provide feedback on data processing in AVEVA ERM
........................................................................................................... 76
12.4.9 Process the feedback
........................................................................................................... 76
..............................................................................................................................
12.5 Integration Workflow – AVEVA Engineering to AVEVA ERM 77
12.5.1 Set up ERMCategory for tags in AVEVA Engineering
........................................................................................................... 77
12.5.2 Set up systems in AVEVA Engineering
........................................................................................................... 77
12.5.3 Update status of Equipment in AVEVA Engineering
........................................................................................................... 78
12.5.4 Set up ...........................................................................................................
AVEVA ERM to import data from AVEVA Engineering 78
12.5.5 Import data into AVEVA ERM
........................................................................................................... 78
12.5.6 Verify...........................................................................................................
the imported data in AVEVA ERM 78
..............................................................................................................................
12.6 Integration Workflow – AVEVA ERM to AVEVA Engineering 79
12.6.1 Publish ...........................................................................................................
the project components in AVEVA ERM 79
12.6.2 Import the project components in AVEVA Engineering
........................................................................................................... 79
13 Transfer
.....................................................................................................................
of Advance Bill of Material from AVEVA Diagrams to AVEVA 80
ERM
..............................................................................................................................
13.1 Concept Description 80
..............................................................................................................................
13.2 Overview of Transfer Process 80
13.3 Information
..............................................................................................................................
Transferred 81
..............................................................................................................................
13.4 Integration Workflow - Data Transfer to AVEVA ERM 81
13.4.1 Update the status of ABoM
........................................................................................................... 82
13.4.2 Import ...........................................................................................................
ABoM data in AVEVA ERM 82
13.4.3 Verify...........................................................................................................
the imported data in AVEVA ERM 83
14 Part List
.....................................................................................................................
Integration 84
..............................................................................................................................
14.1 Concept Description 84
..............................................................................................................................
14.2 Overview of Transfer Process 84
14.3 Pipe ..............................................................................................................................
and HVAC Spool 85
14.3.1 Information Transferred
........................................................................................................... 85
Page 5
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
14.3.2 Integration Workflow - Data Transfer to AVEVA ERM
........................................................................................................... 86
.............................................................................................................................. 90
14.4 Fabricates
14.4.1 Information ...........................................................................................................
Transferred 90
14.4.2 Integration Workflow – Data Transfer to AVEVA ERM
........................................................................................................... 91
..............................................................................................................................
14.5 Publishing Bolt Data to AVEVA ERM 94
15 Deletion
..................................................................................................................... 96
..............................................................................................................................
15.1 Concept Description 96
15.2 Delete
..............................................................................................................................
Workflow (Initiated in Design Application) 97
15.2.1 Design application sends CanDeleteRequest
........................................................................................................... 98
15.2.2 AVEVA ERM processes CanDeleteRequest
........................................................................................................... 99
16 View.....................................................................................................................
AVEVA ERM Data in Design 104
.............................................................................................................................. 104
16.1 Overview
..............................................................................................................................
16.2 Only ERM configured 104
16.3 Both
..............................................................................................................................
AVEVA NET and ERM configured 105
..............................................................................................................................
16.4 View Live Data as Pseudo Attributes 106
Page 6
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
Page 7
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 1 - Preface
1 Preface
This chapter provides an introduction to this guide, specifies the intended audience,
provides the summary of chapters and lists the related documents for the guide. The
chapter also provides information about product training and how to contact technical
support.
1.2 Audience
This guide is intended for users who are responsible for configuring and using AVEVA
ERM-Design Integration. The guide assumes that you have the functional and technical
knowledge in using AVEVA E3D, AVEVA ERM, AVEVA Engineering™, AVEVA Diagrams and
AVEVA Integration Service™.
Page 8
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 1 - Preface
Chapter Summary
Introduction Contains an introduction to AVEVA ERM-Design Integration,
the list of concepts for which the integration is supported
and an overview of the notification workflow.
AVEVA ERM-Design Describes the various capabilities of AVEVA ERM-Design
Integration Capabilities Integration.
Software Requirements Contains the software requirements and prerequisites for
installing and using AVEVA ERM-Design Integration.
About Settings Dialog Box Provides information about the Settings dialog box in AVEVA
E3D through which most configurations are made.
Configuring AVEVA Contains procedures for enabling AVEVA E3D and AVEVA
Everything3D and AVEVA ERM for integration.
ERM for Integration
List of Source Tables Contains the list of source tables used for integration.
Used
About Material Mapping Explains the Material Category concept and contains
procedures for setting up material category mapping in
AVEVA E3D.
Performing Basic Tasks Contains procedures for performing some of the basic tasks
Using AVEVA ERM-Design for using AVEVA ERM-Design Integration.
Integration
Standard Material Describes the concept and provides the workflow for
Integration integrating standard materials.
System Hierarchy Describes the concept and provides the workflow for
Integration integrating system hierarchies.
Project Component Describes the concept and provides the workflow for
Integration integrating project components.
Transfer of Advance Bill Describes the concept and provides the workflow for
of Material from AVEVA transferring Advance Bill of Material data from AVEVA
Diagrams to AVEVA ERM Diagrams to AVEVA ERM.
Part List Integration Describes the concept and provides workflows for integrating
pipe spools and fabricates part lists.
Deletion Describes the concept and provides the worklow for delete
operations.
View AVEVA ERM Data in Contains procedures for viewing AVEVA ERM data in Design.
Design
Page 9
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 1 - Preface
After you register a support incident, we will know your identity (from your customer ID)
and the details of the incident. We will endeavour to fix the software issue or consider
the software improvement suggestion as soon as possible, and notify you about the
status of the incident.
If you are an accredited user of the AVEVA products, you are entitled to use AVEVA
Helpdesk for which you should have valid login credentials. For any other queries, contact
the nearest AVEVA Regional Support Centre (http://support.aveva.com/support).
Page 10
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 2 - Introduction
2 Introduction
This section contains an introduction to AVEVA ERM-Design Integration.
You can access AVEVA ERM-Design Integration as shown in the following images.
Page 11
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 2 - Introduction
Using the notification mechanism, an ‘Update’ notification is sent to the receiver system
whenever changes are published from the sending system. The receiver system can
process this notification by fetching the corresponding data and importing it. If data is
successfully imported, an ‘Acknowledgement’ notification is sent back to the sending
system. In the case of an error during the import, an ‘Error’ notification is sent. Both
‘Acknowledgement’ and ‘Error’ notifications contain information about the data so that
the sending system can also update the published status of the data. In this way, data
already transferred will not be sent again until it is changed and re-published.
Page 12
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 2 - Introduction
Page 13
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 2 - Introduction
Concepts like standard material are not project specific in AVEVA ERM. For this reason,
when any of these concepts are published from AVEVA ERM, the ‘Update’ notification
generated will not contain any value for Design Project. All the other integration concepts
published from AVEVA ERM to AVEVA E3D, are project specific. When the data is
published for these concepts, the Update notification is generated with Design Project Id
(APS).
Page 14
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 2 - Introduction
When a record in s14001 Integration Service screen for the service infrastructure id and
design project cannot be identified, the notification is sent to the application defined as
default in the s00033 External Source Applications screen.
Page 15
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 3 - AVEVA ERM-Design Integration Capabilities
Design Project Id information is transferred between AVEVA E3D and AVEVA ERM
together with all the concepts and this information is included in the notification
summary, and in the details.
Page 16
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 3 - AVEVA ERM-Design Integration Capabilities
3.2 Prevalidation
During the transfer of data, AVEVA ERM rejects the import of data if any mandatory fields
are not set. To avoid publishing of invalid data, and to ensure successful publishing of
data to AVEVA ERM, a prevalidation is performed in AVEVA E3D before publishing the
data to AVEVA ERM.
Prevalidation looks for errors and warnings in a similar way as AVEVA ERM would if such
data were to be transferred, and displays the errors in red and warnings in amber. The
error and warning messages are displayed as tooltips if you point to them. The following
points must be noted about error and warnings during the prevalidation:
· Data with errors cannot be published; the errors must be corrected before
publishing the data to AVEVA ERM.
· Data with warnings can be published to AVEVA ERM but the warnings must also
be fixed. Data sent with warning is rejected by AVEVA ERM import.
Page 17
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 3 - AVEVA ERM-Design Integration Capabilities
Page 18
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 4 - Software Requirements
4 Software Requirements
This section contains the software requirements for installing and using AVEVA ERM-
Design Integration.
Page 19
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 5 - About Settings Dialog Box
The navigation for the Settings dialog box in different modules is as follows:
· Catalogue: TOOLS > AVEVA ERM > Settings
· Design: ADMIN > AVEVA ERM > Settings
The following image provides the user interface of the Settings dialog box.
Page 20
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 5 - About Settings Dialog Box
Filter Configuration
The Filter Configuration tab contains the settings to configure the components for
integration. You can provide any number of settings. The following fields are required for
each entry in the Filter Configuration tab:
UI Element Description
List Based On User defined name to differentiate between different settings.
Select Element The element based on which the component information is published.
Type(s)
Status Definition The status definition used (always "/PublishingStatus").
Filtering Status The status when the elements can be published to the preview screen.
Publishing The maturity level of the component information. Only the possible
Status maturity levels available based on the filtering Status.
Select Transfer The data published depends on the PML function selected.
List
Page 21
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 5 - About Settings Dialog Box
Through the Import & Material Mapping Settings tab, you have an option to specify if
you do not want certain fields to be updated by AVEVA ERM. You can do this by selecting
the required check boxes. The attributes that you select in the Select fields to be
protected from ERM area are protected from any updates from AVEVA ERM sent to
AVEVA Everything3D (AVEVA E3D).
In the Fully Validated Status box, if you select any value other than “[Not in Use]”, the
components with that status cannot be updated by AVEVA ERM. If you select [Not in
Use], AVEVA ERM can update the components.
For information about Material Mapping Settings, see Material Mapping Settings.
Page 22
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 5 - About Settings Dialog Box
The Integration Service tab of the Settings dialog box is used for configuring AVEVA
Integration Service.
Page 23
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 5 - About Settings Dialog Box
UI Element Description
Service Installed Machine name of the computer on which AVEVA Integration Service is
On installed.
Port Port number to which the Service must connect to.
Service URL The link to the Service used for integration.
Test Validates the Service URL by connecting to the Service and displays a
message.
DataSource Must be set to AVEVA ERM.
Type
DataSource Name of the data source in AVEVA Integration Service.
Table
Load data If selected, automatically loads data in the Notifications screen if the
automatically if count is less than the number specified.
elements are
less than
UI Element Description
Service Installed
Machine name of the computer on which AVEVA Notification Service
On
is installed.
Page 24
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 6 - Configuring Design Application and AVEVA ERM for Integration
Page 25
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 6 - Configuring Design Application and AVEVA ERM for Integration
In the Admin module, you need to perform the following tasks to start using AVEVA ERM-
Design Integration:
· Set the access of Properties database to Read/Write to allow for the creation of
CMPW and CMPT objects.
· Create a separate Dictionary database for the user defined attributes (UDAs) and
status definitions for the Catalogue integration.
Page 26
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 6 - Configuring Design Application and AVEVA ERM for Integration
3. From the Modules area of the Module Definition dialog box, select PARAGON
from the list of available modules.
4. From the Settings area of the Module Definition dialog box, click Advanced
Settings. The Advanced Module Settings dialog box is displayed.
After the database properties have been configured for read/write access, you must
create a separate Dictionary database for the user defined attributes (UDAs) and status
definitions for the Catalogue integration.
Page 27
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 6 - Configuring Design Application and AVEVA ERM for Integration
Page 28
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 6 - Configuring Design Application and AVEVA ERM for Integration
6. On the Modify Multiple Database: ALL window, make sure the database
created is included in the correct MDBs.
7. Click Apply to apply the changes.
Note: The Command window allows the administrator to maintain the Dictionary
database through the use of a command line interface.
Page 29
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 6 - Configuring Design Application and AVEVA ERM for Integration
4. For data transfers from AVEVA Engineering and AVEVA Diagrams, run the
following macros.
o IntegrationSetup_Engineering.dat
o IntegrationSetup_DiagramSetUp.dat
The Dictionary Explorer is displayed as follows:
Page 30
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 6 - Configuring Design Application and AVEVA ERM for Integration
Make sure that the elements on the tab are set appropriately. For more information, see
Integration Settings.
Page 31
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 6 - Configuring Design Application and AVEVA ERM for Integration
4. For the Integration Service URL box, enter the URL of AVEVA Integration
Service used for integration with AVEVA E3D.
5. For the Notification Service URL box, enter the URL of AVEVA Notification
Service used for integration with AVEVA E3D.
Important: Whenever the URL for AVEVA Integration Service or Notification
Service is modified, you must restart the multi-consumer service running on
the AVEVA ERM server.
7. For the Integrated Engineering & Design Import Path box, enter the location
from where the configuration files related to AVEVA ERM-Design Integration
can be imported.
Page 32
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 6 - Configuring Design Application and AVEVA ERM for Integration
UI Element Description
Integration · The link to AVEVA Integration Service used for integration with
Service URL AVEVA E3D.
· Updatable
Notification · The link to Notification Service used for integration with AVEVA
Service URL E3D.
· Updatable.
Enable · Check box used to enable AVEVA ERM-Design Integration. If the
Integrated check box is cleared, the functionalities related to AVEVA ERM-
Engineering & Design Integration are stopped. However, the Integrated
Design Engineering & Design custom properties and staging areas are not
removed. This must be done manually by clicking Uninstall.
· Updatable.
· Cleared by default value.
Integrated · The location where the configuration files needed for imports
Engineering & related to AVEVA ERM-Design Integration are available.
Design Import · Updatable
Path · You must click Apply to save the Integrated Engineering & Design
Import Path.
Install Installs AVEVA ERM-Design Integration by performing the following:
· Creates an import staging area with the name “IS” where
configuration files are generated.
· Creates the custom properties related to AVEVA ERM-Design
Integration, such as Design Status, Component Name, Technical
Responsible and so on.
· Creates integration service records that are according to the
integration agreed design and displayed in the s14001 Integration
Service screen. The records created by the installation are marked
as system created, and only few attributes can be updated.
· Creates views and data extraction information needed to export
data from AVEVA ERM to AVEVA E3D.
Uninstall Uninstalls AVEVA ERM-Design Integration by performing the
following:
· Removes configuration files from the staging area that are used for
AVEVA ERM-Design Integration.
· Uninstalls the custom properties used for AVEVA ERM-Design
Integration.
· Removes the integration service records marked as created by the
system.
· Removes the views and data extraction details needed to export
data from AVEVA ERM to AVEVA E3D .
Page 33
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 6 - Configuring Design Application and AVEVA ERM for Integration
UI Element Description
Material Type · At the time of setting up AVEVA ERM, you must specify if the
Required Material Type attribute must be mandatory or optional in the
material definition catalogues in s20010 Project Components
and s20011 Standard Materials.
· Updatable.
· Cleared by default.
Default Unit of · Mentions the default unit of measure for fabricates
Measure for · List of Values. Contains valid units defined in the s00010 screen.
Fabricates · Updatable.
· Default value is "PCS"
Buyer Group · If the check box is selected, the buyer group is a required field
Required when creating or updating standard materials (s20011), project
components (s20010) and hull materials (s30017).
· For AVEVA ERM-Design Integration to successfully transfer
standard materials and project components from AVEVA E3D,
the check box must be cleared before importing standard
materials and project components into AVEVA ERM.
· Updatable.
· Cleared by default.
Page 34
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 6 - Configuring Design Application and AVEVA ERM for Integration
Important: If the value of the Default ABOM Header Number Setup Method list is set to
Auto, the ABoM header id is generated automatically. If the value is User, ABoM header
id must be entered by the user. For the ABoM integration to work as expected, this
setting must be set to Auto.
Page 35
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 6 - Configuring Design Application and AVEVA ERM for Integration
In the context of integration, the data displayed in this screen indicates the default
application used for integration: either AVEVAMARINE or AVEVADESIGN based on which
application has a value defined for the I.S Data Source Type column. When both
applications have a data source type, then AVEVAMARINE is considered as the default
application.
Note:
· For the installation performed in the d0073 ERM System Settings screen to be
successful, at least one of the two applications (AVEVADESIGN or AVEVAMARINE)
must have a value in the I.S. Data Source Type column.
· To create the expected concept transfer record for ABOM, AVEVADIAGRAM must
have a value in the I.S. Data Source Type column.
Column Description
Source App. The code used in AVEVA ERM to identify each source application
and also used as the data source identifier in AVEVA ERM data
import functions.
Status Check box to indicate if the application is an active data source or
not. If selected, the application id can be used elsewhere in
AVEVA ERM. If cleared, the application id cannot be assigned to
new records that are being imported into AVEVA ERM.
EDR (External Check box to indicate if the application requires deletion
Deletion confirmation. When selected, delete notifications
Confirmation (CanDeleteRequest, CanDeleteAcknowledgement,
Required) CanDeleteError, Delete) are sent to the external applications and
AVEVA ERM for those components that are ready to be deleted
after they were transferred to the external application.
I.S. Data Source Type The data source supported by AVEVA Integration Service.
Page 36
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 6 - Configuring Design Application and AVEVA ERM for Integration
The s22050 Data Import and s14002 Integration Messages screens use these definitions
to import data.
The concepts defined in this screen are also used as concept information in the messages
transferred.
Column Description
Id · The identifier of the Service Infrastructure concept.
· Required.
· Searchable.
· Updatable.
· The list of valid identifiers to be used when using AVEVA E3D and
AVEVA ERM is as follows:
§ ABOM
§ ActualSteelMaterialUsage
§ ExternalRefSync
§ Fabricate
§ HvacSpool
§ Pipespool
§ ProjectComponent
§ StandardMaterial
§ SteelStructure
§ SystemHierarchy
Project · The design project pertaining to the integration transfer record.
· Updatable.
· Searchable.
· The combination of Integration Service Id and Project is unique.
Page 37
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 6 - Configuring Design Application and AVEVA ERM for Integration
Column Description
· Is a list of values. Contains the projects that are set up for
integration and defined in the s10001 screen.
Description · Description for the Service Infrastructure identifier.
· Required.
· Updatable.
Direction · The direction of the concept transfers from AVEVA ERM point of
view.
· Can have the values "In", "Out" or "Both".
· Updatable for records not created by the system.
Automatically · Check box indicating if the ‘Update’ notifications for the specific
Picked data transfer should be picked up automatically or not. If selected,
data is transferred without user interaction. If cleared, the ‘Update’
notifications need to be processed manually using the s14002
Integration Messages screen.
· Updatable when the direction is "In" or "Both".
Application · Name of the external source application to which or from where
AVEVA ERM transfers data.
· Required.
· Searchable.
· Is a list of values. Contains all external applications defined in the
s00033 External Source Application screen.
User Name User name to be used for logging on to the external application.
Password Password to be used for logging on to the external application.
Source Table Source table name defined in AVEVA E3D to be used while querying
for data. For the list of source tables used, see List of Source Tables
Used.
Data Type · Data type of the concept to be imported in AVEVA ERM.
· Few examples used in the current integration are:
o ProjComp: To import project components from AVEVA
Engineering – Tags module.
o Fabricate: To import steel parts, pipe spool and fabricate design
data from AVEVA E3D.
o SteelTapeHdr: To import profile and plate nesting information
from AVEVA E3D.
Import Staging Name of the import staging area. The list of values is obtained from
area the s22015 Import Staging Areas screen and contains the list of
different import staging areas used by the import service. This value
must always be "IS" for AVEVA ERM-Design Integration transfer
concepts.
Page 38
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 6 - Configuring Design Application and AVEVA ERM for Integration
Column Description
Project ID This is the project id used across AVEVA products. The AVEVA E3D
project that needs to be integrated with AVEVA ERM must be
registered in this screen before using AVEVA ERM-Design Integration.
Include System · Check box indicating if system breakdown number must be part of
Number in the project component identification.
Project · If selected, the system id is used as part of the project component
Component Id identification and thus becomes mandatory when defining a new
project component in the s20010 Project Components screen.
· If cleared, the project component identification must be entered by
the user.
· The check box must be cleared for importing project components
from AVEVA E3D. The user is then expected to add the system
manually in the project component catalogue from AVEVA ERM.
Integration · The name of the project in the AVEVA Design application. This value
Design Project Id is expected in the integration data transferred from AVEVA Design
application. Integration Design Project id value can be added to the
records defined in the s14001 Integration Service screen, where the
service infrastructure id and the integration design project id
uniquely define a service infrastructure record.
· No default value.
· Updatable.
· Unique. The same integration design project id cannot be added to
more than one project.
· If the integration design project id is used in a record definition for
integration service on the s14001 Integration Service screen, it
cannot be deleted.
Page 39
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 6 - Configuring Design Application and AVEVA ERM for Integration
For details on how to create a material type in AVEVA ERM, please refer to the screen
user guide.
Important:
· Material Type in AVEVA ERM and Material Category Mapping in AVEVA E3D must
be synchronised before importing and publishing standard materials to and from
AVEVA ERM.
· Material Type in AVEVA ERM and Material type for Project Components in
AVEVA E3D must be synchronised before importing project components into
AVEVA ERM.
Page 40
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 6 - Configuring Design Application and AVEVA ERM for Integration
For AVEVA ERM-Design Integration, the following fabricate types are to be added
manually in AVEVA ERM:
· FAB: Plain Fabricate
· PSPOOL: Pipe Spool
· HSPOOL: HVAC Spool
Page 41
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 7 - List of Source Tables Used
Page 42
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 8 - About Material Mapping
You must map a standard material in AVEVA ERM to the standard components in AVEVA
E3D. The key to this mapping is the ERM Material Type which is transferred as part of the
fields transferred.
Page 43
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 8 - About Material Mapping
The image shows how a mapping is defined. For every ERM Material Type, a
corresponding Section and a Category is assigned in the AVEVA E3D catalogue. This
information is useful when importing the standard materials from AVEVA ERM.
The generic type description GTYPE is valid for all components stored in the same
category.
ERM Material Type defines the location where the standard material information is
stored when importing it from AVEVA ERM into AVEVA E3D.
The Auto Generate Mapping button generates the material category mapping for each of
the part elements in the current MDB (Multiple Database).
Page 44
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 8 - About Material Mapping
When a new standard material is transferred from AVEVA ERM, the category for the
standard material found by looking up the transferred field Material Type in the mapping
table. When searching for new or modified standard materials to be transferred to AVEVA
ERM, all categories defined in the mapping table are looked up.
You can store the data (for example, weight) through an associated General Part (GPART)
in Component Data (CMPD) instead of directly storing it in the component. However, in
order to be able to create GPARTs and CMPD definitions, you must first define Part World
(PRTWLD), Part Element (PRTELE), Component World (CMPW) and Component Type
(CMPT).
Most of the shared attributes may be stored as User Defined Attributes (UDAs) together
with the component. You can define PML-scripts for reading and writing all shared
attributes.
Page 45
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 8 - About Material Mapping
Alternatively, you can auto-generate the mapping by clicking Auto Generate Mapping.
This will create mapping for the available GPARTs, SCOMs and SPRFs.
Note: The ERM Material Type in AVEVA ERM must be synchronised before importing and
publishing standard materials to or from AVEVA ERM.
Page 46
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 8 - About Material Mapping
UI Element Description
Material Type Restricts the character length of AVEVA ERM Material Type to the
Max Length specified number while creating mappings.
Material Type Enables you to read the data ERM Material Type from a PML Script
Auto Generate when generating material type automatically.
PML Note: If no data is provided, the PML function
ermgetmaterialtype.pmlfnc is used by default.
Page 47
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 8 - About Material Mapping
2. On the Save As dialog box, select the required file location and click Save.
3. After you receive a message that the material type defaults are exported
successfully, click OK.
Page 48
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 9 - Performing Basic Tasks Using AVEVA ERM-Design Integration
To process a message:
1. On the s14002 Integration Messages screen, click Process Messages. The
d0211 Available Messages to Process dialog box that displays the list of
messages to be processed is displayed.
2. Select the required message for Object Name (concept transferred) and design
project and then click Process.
The Count column on the d0211 Available Messages to Process area indicates the
number of ‘Update’ notifications available for the same transfer concept (Object Name)
and design project.
Note: Messages with a topic other than ‘Update’ (for example, ‘Acknowledgement’,
‘Error’, ‘CanDeleteRequest’, ‘CanDeleteAcknowledgement’, ‘CanDeleteError’, ‘Delete’)
are processed automatically in AVEVA Enterprise Resource Management (AVEVA ERM).
Page 49
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 9 - Performing Basic Tasks Using AVEVA ERM-Design Integration
Page 50
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 9 - Performing Basic Tasks Using AVEVA ERM-Design Integration
The following image illustrates how the notifications are filtered based on the Application
Name.
The following concepts support this feature: Standard material, project component,
drawing and fabricate.
Example 1: Standard Material created and published from AVEVA ERM and imported in
AVEVA E3D.
Step 1: Create and publish a new standard material in AVEVA ERM. An ‘Update’
notification is generated from AVEVA ERM to AVEVA E3D with the number of
components available.
Step 2: AVEVA E3D processes the ‘Update’ notification, queries the data from AVEVA
ERM and imports data into AVEVA E3D.
Page 51
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 9 - Performing Basic Tasks Using AVEVA ERM-Design Integration
For all the concepts supporting this feature, the External Reference information can be
verified in AVEVA ERM in the Integration tab in the External Reference field.
Example 2: Standard material created and published from AVEVA E3D. When standard
materials are published from AVEVA E3D, External Reference is part of the information
exported, and mapped into the import run in AVEVA ERM and this way, the elements are
created with External Reference information.
Page 52
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 10 - Standard Material Integration
Some features of standard materials are needed both in the design process of AVEVA E3D
and in the resource management process of AVEVA ERM. The catalogue integration
shares the standard material information between AVEVA ERM and AVEVA E3D.
Page 53
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 10 - Standard Material Integration
For more information about the notification mechanism, see Notification Workflow
Overview.
AVEVA ERM can also retrieve standard materials from AVEVA E3D without receiving an
'Update' notification by connecting to AVEVA Integration Service. To do this, AVEVA ERM
must send a request to AVEVA Integration Service and the service, in turn, retrieves data
from AVEVA E3D. Similarly, AVEVA E3D can also retrieve the standard material
information from AVEVA ERM without receiving an 'Update' notification by connecting to
AVEVA Integration Service. To do this, you must use the Manual Import menu in the
Notifications window of AVEVA E3D.
Page 54
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 10 - Standard Material Integration
From AVEVA ERM point of view, the data published and made available for AVEVA E3D to
fetch and import is available in the following data extraction query:
The following screenshot provides an example for the view with data available in AVEVA
ERM.
Page 55
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 10 - Standard Material Integration
The workflow for transferring standard material information from AVEVA E3D to AVEVA
ERM is as follows:
1. Configure a filter for the standard materials in AVEVA E3D.
2. Update the status of the standard materials in AVEVA E3D.
3. Publish the standard materials in AVEVA E3D.
4. Import the standard materials into AVEVA ERM.
5. Verify the imported data in AVEVA ERM.
6. Provide feedback on data processing in AVEVA ERM.
7. Process the feedback in AVEVA E3D.
A new filter must be configured in AVEVA E3D before transferring data. For more
information about the Filter Configuration tab, see Filter Configuration.
The Select for Publish check box column allows the users to view the selected
information in the Components Preview. Select the check box for the required rows and
save the settings by clicking Save.
Page 56
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 10 - Standard Material Integration
Select the required component and click Publish to expose data to AVEVA ERM. Status of
the GPART is also moved to ‘Published’ and an ‘Update’ notification is sent to AVEVA
ERM.
Page 57
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 10 - Standard Material Integration
To import the standard materials in AVEVA ERM, see Processing Messages in AVEVA ERM.
The import of standard material from AVEVA E3D can also be done without an ‘Update’
notification, using the s22050 Data Import screen. For more information, see Importing
Data in AVEVA ERM Manually.
The information about errors, if any, is displayed in the Audit Summary and Audit Detail
grids.
Standard material import can be done partially as well. This means that the components
that can be imported successfully in AVEVA ERM will be processed, and
‘Acknowledgement’ notification will be generated for these, while for those that could
not be imported successfully in AVEVA ERM are communicated back to AVEVA E3D with
an ‘Error’ notification.
This ensures that after a data transfer is successfully completed, the data is removed
from the source table.
Page 58
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 10 - Standard Material Integration
The workflow for transferring standard material information from AVEVA ERM to AVEVA
E3D is as follows:
1. Publish the standard materials in AVEVA ERM.
2. Import the standard materials in AVEVA E3D.
3. Verify the imported data in AVEVA E3D.
4. Provide feedback on data processing in AVEVA E3D.
5. Process the feedback in AVEVA ERM.
Page 59
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 10 - Standard Material Integration
The Publish action displays a message that mentions how many items of the selected
ones were published. The reasons why some materials cannot be published are as
follows:
· Material type information for the selected standard material is not available.
· Material type information for the selected material is available, but the material
type is not marked as ‘Available in External System’ in the s20004 Material Type
Defaults screen.
When the standard materials are published in AVEVA ERM, an ‘Update’ notification is
sent to AVEVA E3D:
Standard materials are not a project-based concept in AVEVA ERM. For this reason, when
the transfer is initiated in AVEVA ERM, the design project value is empty in the Update
notification. The application to send the notification to (‘Sent to Appl.’) is decided based
on the application that is set in the s14001 Integration Service screen for the record
defined for ‘StandardMaterial’ and with no design project.
AVEVA E3D fetches the data from AVEVA Integration Service and displays the components
which have been published on AVEVA ERM side.
Page 60
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 10 - Standard Material Integration
When processing an ‘Acknowledgement’ that has values for External_Ref fields in the
message details, the material is assigned the External_Ref that will be used for further
identification in the integration process.
Page 61
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 10 - Standard Material Integration
The q200 Bolt Extract screen in AVEVA ERM contains the catalogue for bolts.
Page 62
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 10 - Standard Material Integration
Note: AVEVA ERM-Design Integration does not use any notifications to import and
publish bolt information. Therefore, you must manually import the data into AVEVA
Catalogue.
5. Click Apply.
6. Now, click Notifications.
Page 63
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 10 - Standard Material Integration
7. On the Notifications dialog box, click Manual Import > Bolt. The bolt data to
be imported is displayed.
Page 64
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 10 - Standard Material Integration
Page 65
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 11 - System Hierarchy Integration
Systems are related to a system breakdown structure. The system breakdown structure
can be created with multiple levels (hierarchy) or it can be created with no levels (flat
structure). This can be done in the s10004 Set-Up Project Structure and Systems screen.
When using systems for a given project in AVEVA ERM (that is, when relating systems to
material requirements in the s21000 Part List screen) only systems that are related to the
project are valid.
Page 66
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 11 - System Hierarchy Integration
For more information about the notification mechanism, see Notification Workflow
Overview.
The data published from AVEVA ERM and made available to AVEVA E3D to fetch and
import is available in the following data extraction query.
Page 67
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 11 - System Hierarchy Integration
The publish of system structure is done on the project level. The information message
that mentions that ‘1 of 1 records are published’ refers to the project key and it will be
the same irrespective of the number of systems in the structure.
Page 68
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 11 - System Hierarchy Integration
AVEVA E3D retrieves the data from AVEVA Integration Service and displays the system
hierarchy information which have been published from AVEVA ERM. Select the systems
and click Update Database to import the system hierarchies from AVEVA ERM into AVEVA
E3D.
Page 69
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 11 - System Hierarchy Integration
This ensures that after a data transfer is completed, the same data is not sent until it is
changed and published again.
Page 70
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 12 - Project Component Integration
When AVEVA E3D publishes project components, an ‘Update’ notification is sent to the
notification service and further to AVEVA Integration Service that in turn sends this
notification further to AVEVA ERM. When AVEVA ERM receives the notification, it can
request for the available project component data published in AVEVA E3D and import it
in AVEVA ERM.
For more information about the notification mechanism, see Notification Workflow
Overview.
AVEVA ERM-Design Integration defines PML functions to fetch project component data
from the AVEVA E3D (Dabacon) database. The following PML function is used to support
project component integration:
· ProjectComponent PML function collects equipment data from AVEVA E3D
Page 71
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 12 - Project Component Integration
AVEVA ERM can fetch project components from AVEVA Engineering by connecting to the
Integration Service. To fetch the data AVEVA ERM sends a request to the Integration
Service and the service fetches the data from AVEVA Engineering. The following DBviews
are defined to support project component integration:
· Equipment_View DBview collects equipment data from AVEVA Engineering
· Released_For_Procurement DBview collects equipment data from AVEVA
Engineering with status “Released_For_Procurement”
To transfer data from AVEVA ERM to AVEVA Engineering through AVEVA Integration
Service, project components are imported into AVEVA Engineering using the Compare/
Update feature of AVEVA Engineering.
Page 72
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 12 - Project Component Integration
When transferring project components, material type is one of the parts of the
information transferred. For this reason, a UDAT (User Defined Attribute)
“ProjectComponentType” is defined in AVEVA E3D. The list of ProjectComponentType is
created in AVEVA E3D and is synchronised with AVEVA ERM so that each
ProjectComponentType has a corresponding material type that can be verified in the
s20004 screen.
Page 73
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 12 - Project Component Integration
It is possible to import the project components into AVEVA ERM with or without system
information. If the project components are imported without system information, the
system needs to be set manually for the project component. Then part list items with the
project components can be imported into AVEVA ERM.
A new setting must be created in AVEVA E3D before transferring data. The Select for
Publish check box column allows the users to view the selected information in the
Publish window. Select the check box for the required rows and save the settings by
clicking Save.
Page 74
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 12 - Project Component Integration
Components that satisfy the criteria are displayed in the data grid. Select the required
component and click Publish to expose data to AVEVA ERM. Status of the project
components is moved to ‘Published’ and an ‘Update’ notification is sent to AVEVA ERM.
To import the project components in AVEVA ERM, see Processing Messages in AVEVA
ERM. The import of project components from AVEVA E3D can also be done without an
‘Update’ notification, using the s22050 Data Import screen. For more information, see
Importing Data in AVEVA ERM Manually.
Page 75
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 12 - Project Component Integration
This ensures that after a data transfer is successfully completed, the data is removed
from the PML function.
Page 76
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 12 - Project Component Integration
When transferring Project Components, material type is one of the parts of the
information transferred. For this reason, an UDET (User Defined Element Type)
“ERMCategory” is defined in AVEVA Engineering. The list of ERMCategory is created in
AVEVA Engineering and is synchronised with AVEVA ERM so that each ERMCategory has a
corresponding material type that can be verified in the s20004 screen.
It is possible to import project components into AVEVA ERM with or without system
information. If the project components are imported without system information, the
system needs to be set manually for the project component. Then part list items with the
project components can be imported into AVEVA ERM.
Page 77
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 12 - Project Component Integration
Page 78
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 12 - Project Component Integration
The Publish action will display a message that mentions how many items were published
out of the selected ones. Project components cannot not be published for the following
reasons:
· Material type information for the selected project component is not available.
· Material type information for the selected project component is available, but
the material type is not marked as ‘Available in External System’ in the s20004
Material Type Defaults screen.
In AVEVA Engineering, you must create a Compare Update configuration to import data
from AVEVA ERM and update the database of Engineering. For more information, refer to
“Compare and Update” guide of AVEVA Engineering.
Page 79
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 13 - Transfer of Advance Bill of Material from AVEVA Diagrams to AVEVA ERM
The data is published into the ABOM PML function, which is made available through
Integration Service. AVEVA Enterprise Resource Management (AVEVA ERM) connects to
AVEVA Integration Service and transfers the available data into screen s21002.
Data is available to AVEVA ERM only when the publishing status in AVEVA Everything3D
(AVEVA E3D) reaches the status “Published”. When an ABOM is in status ‘Retired’, no
updates are allowed.
After the data is consumed in AVEVA ERM, the publishing status in AVEVA E3D is changed
to “Consumed”. This ensures that the data is not imported again into AVEVA ERM until it
is changed and published again.
On the ABOM transfer from AVEVA E3D, an appropriate configuration is created so that
the information needed to create/update both items and header records are available.
· ABOM header records corresponding to the information sent are also created.
· Design Ref – Dabacon ID information is mapped to External Reference (on ABoM
Item).
· Diagram Id is mapped to External Group Reference (on ABoM Item).
· TAG Id is mapped to External TAG Id (on ABoM Item).
Page 80
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 13 - Transfer of Advance Bill of Material from AVEVA Diagrams to AVEVA ERM
Page 81
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 13 - Transfer of Advance Bill of Material from AVEVA Diagrams to AVEVA ERM
Page 82
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 13 - Transfer of Advance Bill of Material from AVEVA Diagrams to AVEVA ERM
Page 83
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 14 - Part List Integration
Note: Currently, AVEVA ERM-Design Integration does not support the transfer of UDETs
of base type ZONE and owner type ZONE to AVEVA Enterprise Resource Management
(AVEVA ERM).
When the publishing status of the part lists in AVEVA E3D reaches the status “Published”,
the data is available for transfer to AVEVA ERM. After the information is consumed in
AVEVA ERM, the publishing status in AVEVA E3D is changed to “Consumed”. This ensures
that the same data is not transferred again to AVEVA ERM until it is changed and
published again.
For more information about the notification mechanism, see Notification Workflow
Overview.
Page 84
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 14 - Part List Integration
The following columns are transferred from AVEVA E3D to AVEVA ERM:
· DesignProjectID
· Fabricate ID
· Type (always 'Fabricate')
· Fabricate Type (pipe spool)
· Description
· Weight
· Material Category (S, P, F)
· MaterialId (standard material ID or project component id)
· DesignUniqueID (Name, or Dabacon id)
· DrawingQuantity (Quantity w/o excess)
· ApprovedQuantity (Quantity w/excess)
· TechnicalStatus (Currently set to Published)
· Revision
· Unit
· External_Ref
Page 85
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 14 - Part List Integration
The integration workflow for pipe spool from AVEVA E3D to AVEVA ERM is as follows:
1. Configure a filter for pipe spools in AVEVA E3D.
2. Update the status of pipe spools in AVEVA E3D.
3. Publish the pipe spools in AVEVA E3D.
4. Import the pipe spools in AVEVA ERM.
5. Verify the imported data in AVEVA ERM.
6. Provide feedback on data processing in AVEVA ERM.
7. Process the feedback in AVEVA E3D.
A new setting must be created in AVEVA E3D before transferring data. The Select for
Publish check box column allows the users to view the selected information in the
PartList Preview. Select the check box for the required rows and save the settings by
clicking Save.
Page 86
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 14 - Part List Integration
Select the required pipe spool and click Publish to expose data to AVEVA ERM. Status of
the pipe spool is moved to ‘Published’ and an ‘Update’ notification is sent to AVEVA ERM.
Page 87
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 14 - Part List Integration
To import the pipe spools in AVEVA ERM, see Processing Messages in AVEVA ERM. The
import of pipe spool from AVEVA E3D can also be done without an ‘Update’ notification,
using the s22050 Data Import screen. For more information, see Manual Import of Data
in AVEVA ERM.
The information about errors, if any, is displayed in the Audit Summary and Audit Detail
grids. When import is completed in AVEVA ERM, the system generates an
‘Acknowledgement’ or ‘Error’ notification according to the result of the import.
Page 88
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 14 - Part List Integration
The standard materials or project components added as part list items under the header
PSPOOL elements can be seen in AVEVA ERM through the s21015 Fabricate Part Lists
screen.
This ensures that after a data transfer is successfully completed, the data is removed
from the PML function.
Page 89
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 14 - Part List Integration
14.4 Fabricates
This section describes the concepts and procedure for fabricates integration.
When the publishing status of the fabricates in AVEVA E3D reaches the status
“Published”, the data is published to the Structure PML function. This data in the PML
function is made available through AVEVA Integration Service, and is consumed in AVEVA
ERM. AVEVA ERM connects to AVEVA Integration Service and transfers the available data
into the corresponding concepts (fabricate, fabricate Part List and fabricate part list
items).
The following columns are transferred from AVEVA E3D to AVEVA ERM:
· DesignProjectID
· Fabricate ID
· Type (always 'Fabricate')
· Fabricate Type (FAB)
· Description
· Weight
· Material Category (S, P, F)
· MaterialId (standard material ID or project component id)
· DesignUniqueID (Name, or Dabacon id)
· DrawingQuantity (Quantity w/o excess)
· ApprovedQuantity (Quantity w/excess)
· TechnicalStatus (Currently set to Published)
· Revision
· Unit
· OwnedBy
· External_Ref
Page 90
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 14 - Part List Integration
A new part list setting must be created in AVEVA E3D before transferring data. The Select
for Publish check box column allows the users to view the selected information in the
PartList Preview. Select the check box for the required rows and save the settings by
clicking Save.
Page 91
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 14 - Part List Integration
Select the required STRUCTURE and click Publish to expose data to AVEVA ERM. Status of
the STRUCTURE is moved to ‘Published’ and an ‘Update’ notification is sent to AVEVA
ERM.
To import the fabricates in AVEVA ERM, see Processing Messages in AVEVA ERM. The
import of fabricates from AVEVA E3D can also be done without an ‘Update’ notification,
using the s22050 Data Import screen. For more information, see Manual Import of Data
in AVEVA ERM.
Page 92
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 14 - Part List Integration
The information about errors, if any, is displayed in the Audit Summary and Audit Detail
grids. When import is completed in AVEVA ERM, the system generates an
‘Acknowledgement’ or ‘Error’ notification according to the result of the import.
The standard materials, project components or fabricates added as part list items under
the header Structure elements can be seen in AVEVA ERM through the s21015 Fabricate
Part Lists screen.
This ensures that after a data transfer is successfully completed, the data is removed
from the PML function.
Page 93
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 14 - Part List Integration
Page 94
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 14 - Part List Integration
The s2100 Part Lists screen in AVEVA ERM displays the bolts data imported from AVEVA
Catalogue.
Page 95
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 15 - Deletion
15 Deletion
This section describes the integration process for delete operations for standard materials
and project components.
The following points must be noted while performing the integration of delete
operations:
· To ensure synchronisation between two applications, deletion performed in one
application requires an “approval” from the other if the information has already
been transferred.
· If the information has not been transferred, the application owning the data can
delete the data without any approval workflow.
· An application that does not own the data cannot delete the data. For example,
if AVEVA Everything3D (AVEVA E3D) transfers standard materials to AVEVA
Enterprise Resource Management (AVEVA ERM), AVEVA ERM cannot delete the
standard materials, unless the user has admin rights.
Page 96
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 15 - Deletion
The following diagram explains the delete workflow that is applicable when a component
created in System 1 was transferred to System 2, and later, System 1 tries to delete the
component.
Page 97
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 15 - Deletion
AVEVA E3D sends the CanDeleteRequest only under the following circumstances:
· If the element is already published
· If the element is not used in design
Page 98
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 15 - Deletion
When the notification contains the ExternalReferenceId information, the same is used to
identify the data (instead of the Id).
Page 99
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 15 - Deletion
Page 100
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 15 - Deletion
Page 101
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 15 - Deletion
Page 102
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 15 - Deletion
Page 103
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 16 - View AVEVA ERM Data in Design
Note: You can also view the data for objects that have been created in AVEVA
Engineering, and then published to AVEVA ERM and also imported to AVEVA E3D using
the Compare/Update feature. For such objects, Design in Context uses the object's
reference id, as known in AVEVA Engineering, to synchronise and display the data in
AVEVA E3D.
16.1 Overview
To view the live data from AVEVA ERM in Design, you must configure ERM settings by
clicking TOOLS > Context and then select the Configure option. Refer to Dashboard
Server in Design in Context help guide for further information.
Page 104
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 16 - View AVEVA ERM Data in Design
To view the live data from AVEVA ERM, click the information view icon on the Associated
Information window. The data from AVEVA ERM categorised into Material Information
and Planning Information is displayed.
The data shown here is fetched live from AVEVA ERM. If the connection is down for some
reason, then nothing is displayed.
The data displayed on the Associated Information window, such as Material Information,
Planning Information, can be configured through the DataImportConfiguration file, that is
available at the installation location of the product. A sample location is C:\Program
Files (x86)\AVEVA\Everything3D2.10\ERMIntegration
\DataImportConfiguration\DataImportMappings.xml
Page 105
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 16 - View AVEVA ERM Data in Design
A set of pseudo attributes that will connect through AVEVA Integration Service to display
the mentioned information when displaying attribute data on selected/displayed objects.
The connection to AVEVA ERM will be done once for each object and retrieve all relevant
attribute information at the same time,
Page 106
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA ERM-Design Integration User Guide for AVEVA Everything3D™
CHAPTER 16 - View AVEVA ERM Data in Design
DB views are created in AVEVA ERM, through the existing Data extraction functionality.
These views can then be accessed through AVEVA Integration Service, using the
integration service to facilitate direct lookup of data between Design/Catalogue and
ERM.
Data to be shared from AVEVA ERM varies depending on the elements queried:
· Material information
o Requisition id
o Requisition status
o Purchase order id
o Purchase order status
o Received status
o Delivery deadline
o Supplier
· Planning information
o Work package id
o Scheduled start
o Scheduled Finish
o Actual Start
o Actual Finish
o Resource Work hours (budget)
o Work package status
o Installation Status
o Installation Date
Page 107
© Copyright 2003 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
Print Template A - v2.0