Vous êtes sur la page 1sur 82

AVEVA Integration Service 1.

User Guide
AVEVA Integration Service 1.2 User Guide

Disclaimer
1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or
free from viruses.
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.
February 2010 AVEVA Solutions Ltd, and its subsidiaries 2010 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.
Copyright 2015 to current year.
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
1
AVEVA Integration Service 1.2 User Guide

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.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
2
AVEVA Integration Service 1.2 User Guide

Contents
1 Overview ................................................................................................................................... 5
1.1 About this User Guide ........................................................................................................ 5
2 Overview of AVEVA Integration Service...................................................................................... 5
2.1 Interfaces with other Applications ...................................................................................... 5
3 Service Configuration................................................................................................................. 6
3.1 AVEVA Integration Service Components Installed Location ................................................. 6
3.2 Starting the Services by Giving the Appropriate Login Credentials ...................................... 7
3.3 Adding Data to Services for different Data Source Types .................................................... 9
3.3.1 AVEVA P&ID ............................................................................................................. 10
3.3.2 AVEVA Engineering ................................................................................................... 12
3.3.3 AVEVA Schematics .................................................................................................... 13
3.3.4 AVEVA Diagrams....................................................................................................... 15
3.3.5 AVEVA Instrumentation ............................................................................................ 16
3.3.6 AVEVA Electrical ....................................................................................................... 18
3.3.7 AVEVA Catalogue...................................................................................................... 20
3.3.8 AVEVA Design........................................................................................................... 22
3.3.9 AVEVA OutFitting ..................................................................................................... 23
3.3.10 AVEVA NET Portal ..................................................................................................... 25
3.3.11 MS Excel ................................................................................................................... 27
3.3.12 Logging onto a Dabacon Source Type Project ............................................................ 28
3.3.13 Oracle....................................................................................................................... 29
3.4 Map Network Drives Using Integration Services ............................................................... 32
3.4.1 Enable Mapped Network Drives ............................................................................... 33
3.4.2 Map a new network drive for integration service ...................................................... 34
3.4.3 Configure the existing user network drives in integration services ............................ 39
3.4.4 Show Network Drives Configured With Integration Services ..................................... 43
3.4.5 Remove Network Drives Configured With Integration Services ................................. 44
3.5 Extract Cable Data for AVEVA Design ................................................................................ 46
3.5.1 Configuration of Cable Data ...................................................................................... 46
3.5.2 Fetch Cable Data in Reflection Client ........................................................................ 49
3.6 Notification Service .......................................................................................................... 51
3.6.1 Architecture ............................................................................................................. 51
3.6.2 Working Principle ..................................................................................................... 52

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
3
AVEVA Integration Service 1.2 User Guide

3.6.3 Multiple Client Architecture ..................................................................................... 52


3.6.4 Handling of Notifications When AIS is not Running ................................................... 52
3.6.5 Service Editor ........................................................................................................... 54
3.6.6 Notification Client .................................................................................................... 55
4 Data Verification ...................................................................................................................... 56
5 Appendices: ............................................................................................................................. 61
5.1 Appendix A: Data Authentication ..................................................................................... 61
5.2 Appendix B: Data Filter ..................................................................................................... 62
5.3 Appendix C: Export to XML ............................................................................................... 64
5.4 Appendix D: Data Streaming from AVEVA P&ID ................................................................ 65
6 Integration Settings Editor ....................................................................................................... 68
7 Reported Customer Issues and Resolution ............................................................................... 70
7.1 Microsoft .Net Framework Exception Occurred ................................................................ 70
7.2 NewCore_Interface has stopped working ......................................................................... 74
7.3 Get Schema and Get Data for System Tables in Oracle ..................................................... 77
7.4 Failed to get data from Outfitting in Reflection Client ....................................................... 80

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
4
AVEVA Integration Service 1.2 User Guide

1 Overview

1.1 About this User Guide

This user guide is for AVEVA Integration Service 1.2.


The sections of the guide and its content are as follows:
Overview of AVEVA Integration Service
Service Configuration
Data Verifications
Appendices

2 Overview of AVEVA Integration Service

AVEVA Integration Service provides easy, quick and effective data transfers between different data
sources (AVEVA and non-AVEVA product data) installed in different machines on the network. It
provides a common platform for Plant, Marine and Engineering products for accessing and using
data from other products so that the data management across products can be done effectively.
The integration service should be installed on a server system, and allows administrators to
configure a variety of data sources like AVEVA P&ID, AVEVA Engineering, AVEVA Schematics, MS
Excel, MS SQL SERVER, etc. Data sources configured on the integration server can be consumed by
one or more AVEVA applications that can connect to this service.
A primary consumer of this service infrastructure will be the Compare/Update feature which is
present in various AVEVA products like AVEVA P&ID, AVEVA Engineering. Based on the data
interoperability requirement user will have to create appropriate configuration/s which define the
source of data (Tables, Procedures, Views) and the attributes from source and destination product
data.

2.1 Interfaces with other Applications

A list of data sources supported by the Integration Service is given below:


AVEVA P&ID
AVEVA Engineering
AVEVA Schematics
AVEVA Diagrams
AVEVA Instrumentation
AVEVA Electrical
AVEVA Catalogue
AVEVA Design
AVEVA Outfitting
AVEVA NET Portal
MS Excel 2007, 2010
Copyright 2015 to current year.
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
5
AVEVA Integration Service 1.2 User Guide

3 Service Configuration

Before using the AVEVA Integration Service, it must be configured as described below:
AVEVA Integration Service Components Installed Location
Starting the Services by Giving the Appropriate Login Credentials
Adding Data to Services for different Data Source Types
Data Verification

3.1 AVEVA Integration Service Components Installed Location

Please refer to the installation guide for steps on installing the AVEVA Integration Service. On
successful installation of the AVEVA Integration Service, the folder structure and contents shown
below will be created on the system.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
6
AVEVA Integration Service 1.2 User Guide

3.2 Starting the Services by Giving the Appropriate Login Credentials

The user will need to start the AVEVA Integration Service by giving valid login credentials. This can be
done by opening the 'Windows services' (by running the command services.msc in 'Run' command
window) and selecting the service 'AVEVA Integration Service'. Under properties, the user can make
the changes and give the required credentials.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
7
AVEVA Integration Service 1.2 User Guide

If the service was already running, then on changing the login credentials, the user will be asked to
restart the service as shown below. Services must be stopped and started in order for the new login
name to take effect.

User can restart the service either by Stop-Start or Restart option available in right click menu of
Service.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
8
AVEVA Integration Service 1.2 User Guide

3.3 Adding Data to Services for different Data Source Types

Run the Integration Settings Editor from the All Programmes menu as shown below:

Note: The Configure Integration Service short cut would be appearing in All Programs only if the
component Integration Client is installed in the machine.
Alternatively user can also run the InterOpIntegrationConfig.exe from the installed location
\Program Files\AVEVA\Shared\AVEVA Integration Service by double-clicking on it.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
9
AVEVA Integration Service 1.2 User Guide

This will open a form in which user can add the data after selecting the desired data source type as
described in sub-sections below:

3.3.1 AVEVA P&ID

Select the AVEVA P&ID option from the Select Data Source Type dropdown list of the Integration
Service Editor window and then click on Add Configuration.

Click on Test to check the AVEVA P&ID Reports service has been connected. After clicking on it, user
will get a message as highlighted in above picture. Click on Fill, to list the selected project.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
10
AVEVA Integration Service 1.2 User Guide

The user can select the required rows individually or can select all the rows by clicking the Select all
option. After the selection of rows, click on Add Rows. This will add all the rows to the Source Detail
window.
Now the required data from P&ID project is added to the AVEVA Integration Service Settings form
and it is ready for use by the Compare/Update functionality.

Click on Save and Exit.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
11
AVEVA Integration Service 1.2 User Guide

3.3.2 AVEVA Engineering


In the AVEVA Integration Service Settings form, select AVEVA Engineering from the Select Data
Source Type drop down list and then click on Add Configuration.

The user must then select the appropriate AVEVA PDMS version, enter login credentials and select
the required Project:

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
12
AVEVA Integration Service 1.2 User Guide

Once the required rows are added, click on Save and Exit.

3.3.3 AVEVA Schematics


In the AVEVA Integration Service Settings form, select AVEVA Schematics from the Select Data
Source Type drop down list and then click on Add Configuration.

The user must then select the appropriate AVEVA PDMS version, enter login credentials and select
the required Project:

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
13
AVEVA Integration Service 1.2 User Guide

Once the required rows are added, click on Save and Exit.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
14
AVEVA Integration Service 1.2 User Guide

3.3.4 AVEVA Diagrams


In the AVEVA Integration Service Settings form, select AVEVA Diagrams from the Select Data Source
Type drop down list and then click on Add Configuration.

The user must then select the appropriate AVEVA PDMS version, enter login credentials and select
the required Project:

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
15
AVEVA Integration Service 1.2 User Guide

Once the required rows are added, click on Save and Exit.

3.3.5 AVEVA Instrumentation


Select the AVEVA Instrumentation option from the Select Data Source Type dropdown list of the
Integration Service Editor window and then click on Add Configuration.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
16
AVEVA Integration Service 1.2 User Guide

Click on Test to check the AVEVA Instrumentation Integration service has been connected. After
clicking on it, user will get a message as highlighted in above picture. Click on Fill, to list the selected
project.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
17
AVEVA Integration Service 1.2 User Guide

The user can select the required rows individually or can select all the rows by clicking the Select all
option. After the selection of rows, click on Add Rows. This will add all the rows to the Source Detail
window.
Now the required data from AVEVA Instrumentation is added to the AVEVA Integration Service
Settings form and it is ready for use by the Compare/Update functionality.

Click on Save and Exit.

3.3.6 AVEVA Electrical


Select the AVEVA Electrical option from the Select Data Source Type dropdown list of the
Integration Service Editor window and then click on Add Configuration.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
18
AVEVA Integration Service 1.2 User Guide

Click on Test to check the AVEVA Instrumentation Integration service has been connected. After
clicking on it, user will get a message as highlighted in above picture. Click on Fill, to list the selected
project.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
19
AVEVA Integration Service 1.2 User Guide

The user can select the required rows individually or can select all the rows by clicking the Select all
option. After the selection of rows, click on Add Rows. This will add all the rows to the Source Detail
window.
Now the required data from AVEVA Electrical is added to the AVEVA Integration Service Settings
form and it is ready for use by the Compare/Update functionality.

Click on Save and Exit.

3.3.7 AVEVA Catalogue


In the AVEVA Integration Service Settings form, select AVEVA Catalogue from the Select Data
Source Type drop down list and then click on Add Configuration.

The user must then select the appropriate AVEVA PDMS version, enter login credentials and select
the required Project:
Copyright 2015 to current year.
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
20
AVEVA Integration Service 1.2 User Guide

Once the required rows are added, click on Save and Exit.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
21
AVEVA Integration Service 1.2 User Guide

3.3.8 AVEVA Design


In the AVEVA Integration Service Settings form, select AVEVA E3D from the Select Data Source
Type drop down list and then click on Add Configuration.

The user must then select the appropriate AVEVA E3D version, enter login credentials and select the
required Project:

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
22
AVEVA Integration Service 1.2 User Guide

Once the required rows are added, click on Save and Exit.

Note : For Aveva Design AIS uses stylesheets to query dabacon database and is currently limited to
below element types.

Equipment under the branch World/Site/Zone


Pipe under the branch World/Site/Zone

Views can be used to fetch additional data from 3D Design Database. Please refer E3D Manuals for
information on creating views.

3.3.9 AVEVA OutFitting


In the AVEVA Integration Service Settings form, select AVEVA OutFitting from the Select Data
Source Type drop down list and then click on Add Configuration.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
23
AVEVA Integration Service 1.2 User Guide

The user must then select the appropriate AVEVA Marine version, enter login credentials and select
the required Project:

Once the required rows are added, click on Save and Exit.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
24
AVEVA Integration Service 1.2 User Guide

3.3.10 AVEVA NET Portal


In the AVEVA Integration Service Settings form, select AVEVA NET Portal from the Select Data
Source Type drop down list and then click on Add Configuration.

In the window that is then displayed, enter the appropriate database details and press Connect to
Server:

Select the required AVEVA NET database from the dropdown list:

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
25
AVEVA Integration Service 1.2 User Guide

Click OK.

Once the required rows are added, click on Save and Exit.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
26
AVEVA Integration Service 1.2 User Guide

3.3.11 MS Excel

An Excel file can be selected as the Data Source Type in the AVEVA Integration Service Settings form.
Note: The external excel file format should match the P&ID Reports Excel interface.

Select the Excel option from the Select Data Source Type dropdown list of the Integration Service
Editor window.

Click on Browse File/Browse Folder and select the required Excel file. The required data from Excel
file is added to the AVEVA Integration Service Settings form and it is ready for use by the
Compare/Update functionality.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
27
AVEVA Integration Service 1.2 User Guide

Click on Save and Exit.

3.3.12 Logging onto a Dabacon Source Type Project

If a Dabacon source type is selected as a data source, and the Add configuration button in the
Integration Settings Editor is clicked, the must then log into the required project by entering the
correct credentials in the project login dialog:

Select a product from the Products list:

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
28
AVEVA Integration Service 1.2 User Guide

The list consists of the products associated with the selected data source type. The Path, Bat File
and XSL File fields are then completed automatically with the default details associated with the
selected product. If the product path in the Path field is not available in the Windows Registry, then
the user must select the installed location by browsing via the adjacent ... button.

If a different batch file is to used for running the projects other than the default one displayed in the
Batch File field, select the required batch file by browsing for it via the adjacent ... button. If a
different XSL file is required for fetching the data from the data source type other than the default
one displayed in the XSL File field, select the required file by browsing for it via the adjacent ...
button. In the rest of the fields, enter the appropriate login details for the required project and
database, and select the Login button to complete the login procedure.

3.3.13 Oracle
In the AVEVA Integration Service Settings form, select Oracle from the Select Data Source Type
drop down list and then click on Add Configuration.

Enter the required credentials and click on Test Connection and then click on OK (as shown below).

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
29
AVEVA Integration Service 1.2 User Guide

Once the required rows are added, click on Save and Exit.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
30
AVEVA Integration Service 1.2 User Guide

The TNSNAMES.ORA file configurations which we use during the login to the oracle database

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
31
AVEVA Integration Service 1.2 User Guide

3.4 Map Network Drives Using Integration Services

This module allows the user to map network drives with integration services. It enables service to
access dabacon projects that are mapped in the server machine using a network drive.

User can click on Map Network Drive button in Integration Settings Editor to map the drives.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
32
AVEVA Integration Service 1.2 User Guide

3.4.1 Enable Mapped Network Drives

Integration service can be enabled to access network drives by checking Enable Mapped Network
Drives option .

User will need to start service again for the changes to be in effect.

Note : By default mapped network drive access would be disabled for integration service.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
33
AVEVA Integration Service 1.2 User Guide

3.4.2 Map a new network drive for integration service

User can map a new network drive by using below steps.

1. Select the drive from the drop down .

2. Click on browse button and select the remote folder.

3. Click on Save.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
34
AVEVA Integration Service 1.2 User Guide

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
35
AVEVA Integration Service 1.2 User Guide

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
36
AVEVA Integration Service 1.2 User Guide

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
37
AVEVA Integration Service 1.2 User Guide

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
38
AVEVA Integration Service 1.2 User Guide

3.4.3 Configure the existing user network drives in integration services

By clicking on Show User Network Drives users can view the network drives currently mapped in
server with the logged in windows account.

The user can then select any record displayed in the grid and map it to integration service by clicking
on Map Drives button.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
39
AVEVA Integration Service 1.2 User Guide

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
40
AVEVA Integration Service 1.2 User Guide

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
41
AVEVA Integration Service 1.2 User Guide

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
42
AVEVA Integration Service 1.2 User Guide

3.4.4 Show Network Drives Configured With Integration Services

User can view the drives mapped for integration service by clicking on the button Show Drives
Configured In Service

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
43
AVEVA Integration Service 1.2 User Guide

3.4.5 Remove Network Drives Configured With Integration Services

User can remove the network drives configured in integration service by following below steps.

1. Click on Show Drives Configured In Service

2. Select the drives by clicking on the checkbox.

3. Click on Remove Drives button to remove the drives.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
44
AVEVA Integration Service 1.2 User Guide

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
45
AVEVA Integration Service 1.2 User Guide

3.5 Extract Cable Data for AVEVA Design

We have given the option of fetching the cable data in the reflection client for AVEVA Design. In
order to fetch the cable data we need to configure the cable data in reflection client.

3.5.1 Configuration of Cable Data

Step 1: Go to the Service Installation path \\AVEVA\Shared\IntegrationClient\SampleClient. You can


observe the two configuration files ReflectionClient_x64.exe.config which is for
ReflectionClient_x64.exe and ReflectionClient.exe.config which is for ReflectionClient.exe.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
46
AVEVA Integration Service 1.2 User Guide

Step 2: Open the ReflectionClient_x64.exe.config as below.

Step 3: Please enter the XSL file path for the cable in the value tag as mentioned below. For E.g.
C:\Program Files
(x86)\AVEVA\Instrumentation12.1.3\MDB2InstrumentIndex_OutXML_121_Cable_AE.xsl.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
47
AVEVA Integration Service 1.2 User Guide

Step 4: Please enter the PseudoAttributes in the value tag as mentioned below. For E.g. CBTOLE
CEXES CBSTA CBRNLS SPRE CbFrLength.

Step 5: Please enter the input parameter name for XSL as mentioned below. For E.g. pmg-design-
ae-list.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
48
AVEVA Integration Service 1.2 User Guide

Step 6: Please enter the input parameter value for XSL as mentioned below. For E.g.
ProjectId:3:Key:107.

3.5.2 Fetch Cable Data in Reflection Client

Step 1: Please select the data source type as AVEVA Design as shown below.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
49
AVEVA Integration Service 1.2 User Guide

Step 2: Once you have selected data source type as AVEVA Design you can get a Get Cable Data
option enabled dynamically as shown below. Select the project for which you want to extract cable
data and click on the Get Cable Data.

Step 3: Once you click on the cable data application automatically takes the value from the
configuration file which you have already configured to extract the cable data. It displays the data as
shown below.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
50
AVEVA Integration Service 1.2 User Guide

3.6 Notification Service


Notification is the message that contains data which is sent by a publisher client, this
notification is received by other subscribing clients.

Notification Service is a interface between Integration Service and other Clients for sending,
receiving, deleting and updating notifications.

A notification is sent by a publisher to Integration Service and Integration Service stores


these messages in local machine.

Any subscriber can request for these notifications that are stored at AIS. This request is sent
by the subscriber client to notification service which in turn sends the request to AIS.

All the requests made by client are sent to Notification Services which in turn send to AIS.

All the responses sent by AIS are sent to Notification Service which in turn sends the
response to the Client.

3.6.1 Architecture

Client: It can publish, view, update and delete notifications.

Notification Service: Used to establish communication between client and integration


service.

Integration Service: It will subscribe, store and publish notifications

Notification service Editor: Settings for notification service can be done on this UI.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
51
AVEVA Integration Service 1.2 User Guide

3.6.2 Working Principle

Client publishes the notification in the form of object to Notification Service and Notification
Service in turn publishes it to Integration Service. The notification is serialized and stored as
an encrypted file in the Integration Service server.

When a new notification is available, the clients will be notified and when requested for
notification, Integration Service will send the notifications to the subscriber client via
Notification Service.

When client deletes the notification it will be deleted from Integration Service server.

Whenever a notification is updated by the subscriber client, the update will be notified to
the Notification Service.

3.6.3 Multiple Client Architecture

3.6.4 Handling of Notifications When AIS is not Running


When the AIS is down and if the notifications are being published they are stored in local
machine(serialized and encrypted before storing) where notification service is residing and
notification service will continuously check whether AIS is running or not. When AIS is
started, the notifications are published from the notification service machine to AIS.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
52
AVEVA Integration Service 1.2 User Guide

When the AIS is down and if the notifications are being deleted then the list of notifications to be
deleted is stored in DataConfig file and Notification Service will continuously check whether AIS is
running or not. When AIS is running, the list is sent to AIS for deletion.

When the AIS is down and if the notifications are being Updated then they are stored in local
machine(serialized and encrypted before storing) where notification service is residing and
notification service will continuously check whether AIS is running or not. When AIS is started, the
updated notifications are published from the notification service machine to AIS.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
53
AVEVA Integration Service 1.2 User Guide

3.6.5 Service Editor

Port Number: To set the port number for Notification Service.

Timer Value: The time interval used for checking new/updated notifications.

Timer Interval: The time interval to check if AIS is running.

Integration Service EndPoint: Specifies to which AIS endpoint to connect to.

View Log File: Facility to view Log file.

Clear Log File: Clears the data in Log file.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
54
AVEVA Integration Service 1.2 User Guide

3.6.6 Notification Client

Publish Notifications: On click of this button opens another form where the publisher can fill
the data and click on publish.

Get Notifications: This button is used to get the notifications from the AIS Server, to which it
is subscribed.

Delete Notifications: This is used to delete the notification.

Update Notifications: This is used to update the notification.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
55
AVEVA Integration Service 1.2 User Guide

4 Data Verification
The added data for different Data Source Types can be verified by running the appropriate
'ReflectionClient.exe' from location below.

Click Test Service, which is followed by a confirmation message for a successful Service connection.

Note: Change the Service location to see the data from different service location by clicking on Set
Service location. The window below is then displayed, in which the location can be changed:

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
56
AVEVA Integration Service 1.2 User Guide

After clicking on Get Available Data, the user can verify the data added for different Data Source
Types. The Data Source Type can be selected from the dropdown list on the Reflection Client
window.

Example, for AVEVA Engineering,

Select AVEVA Engineering from the drop down list for Data source Type then type the appropriate
Username and Password (used while adding data into Service) and click on Validate User. Successful
validation would be confirmed by a message.

Select the required table from the list and click 'Get Data' which will display the added data for the
user to verify in a separate window.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
57
AVEVA Integration Service 1.2 User Guide

In the above window Demo Client a new option Convert Units has been added.
Unit conversion feature in Dabacon is supported with Integration services.
Using this feature user can convert the units like Distance, Volume and Pressure etc. to
desired values. The user interface looks like below.

Note: This option works only for AVEVA Engineering 14.1.0 and 14.1.1 versions.

For Data Source Types like AVEVA P&ID, AVEVA Schematics and Excel the same procedure
(mentioned above) can be used to verify the data added to service for each data source.

But for AVEVA Catalogue, the steps are same and there is one more button Get Specification to
get the specifications additional to Get Data

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
58
AVEVA Integration Service 1.2 User Guide

Get Specification displays the list of Specifications added.

Get Data displays the data for one specification.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
59
AVEVA Integration Service 1.2 User Guide

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
60
AVEVA Integration Service 1.2 User Guide

5 Appendices:

5.1 Appendix A: Data Authentication

User can modify the authentication of the data added into the service with a minor change in the
Integration Settings Editor window.
The Authentication attribute of any data source type will have value User by default in the
integration settings editor window. If this value is set to No and saved then the step password
authentication will be skipped while accessing the data.

After making this change if the reflection client is opened and verified for the data source for which
the authentication change is made, the Username and Password options will be disabled and user
can directly go for Get Tables option.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
61
AVEVA Integration Service 1.2 User Guide

5.2 Appendix B: Data Filter

User can also filter the data which is added to Integration service with respect to the attribute value.
For example if set a filter as shown in below picture in Reflection client application for a data source
then only the object rows which satisfy the given attribute value will be displayed on clicking Get
Data option.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
62
AVEVA Integration Service 1.2 User Guide

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
63
AVEVA Integration Service 1.2 User Guide

5.3 Appendix C: Export to XML

User can also save the data from Demo Client Application to a XML file if required. After selecting
the required Table click on the button Get Data. Then click on the button Export to XML from the
Data Viewer window.

The successful export will be confirmed by a message shown below.

The XML file thus exported will be saved to a folder named XMLData at location shown below in
the respective file names.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
64
AVEVA Integration Service 1.2 User Guide

5.4 Appendix D: Data Streaming from AVEVA P&ID

A new feature Stream P&ID Drawing has been introduced in the Reflection Client
application. This allows remote streaming of P&ID object types via integration services.

Pre-requisites:

1. Install Middle Tier Components from AVEVA P&ID latest version.


Note: Middle Tier components from AVEVA P&ID 12.1.SP2 Fix.9 is compatible with
AIS 1.2.
After installing Middle tier components add the P&ID project in the
PIDReportDataWinService Settings editor.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
65
AVEVA Integration Service 1.2 User Guide

2. Add the P&ID project data in to Integration Settings Editor. Run the AVEVA
Integration Service using user credentials.

After setting up the above pre-requisites open the Demo Client by double
clicking on ReflectionClient.exe from Sample Client folder as shown below.

Provide the Service location and click on Get Available Data and then select the P&ID project.
Click on Stream P&ID Drawing a new window would appear like below.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
66
AVEVA Integration Service 1.2 User Guide

Provide the related information or example as shown above and then click on Show Drawing. Then
the particular item will be shown the drawing viewer. The drawing can be zoomed in or out as per
requirement in the viewer.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
67
AVEVA Integration Service 1.2 User Guide

6 Integration Settings Editor

A B D F
P C E F
G
R
J
H
L M
I K

A. New Port# : The user can enter the required port number to start the service.

B. Start Service: This button allows the user to Start the service.

C. Stop Service: This button allows the user to Stop the service.

D. View Service Log: This button hepls the user to view the Log file which has the details of
activites performed between the Start and end of the Service. The log file will be named as
<system name>.log.

E. Clear Log: This button allows the user to Clear the Log file.

F. Exit: This hepls the user to Exit the UI.

G. Save: On saving data-sources, connection details for the data-sources would be stored with
encryption in DataSources.dat file.

H. Select Data Source Name: The combo box consists of various Data Sources. User needs to
select a Data Source inorder to communicate and get the data through service.

I. Select Project: This combo box consists of various projects associated with the data source.
User can select the required data source from it.

J. Data Source Type: The combo box associated with it provides the list of data source types.
User needs to specify the required data source.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
68
AVEVA Integration Service 1.2 User Guide

K. Add Configuration: This is used to configure data sources in the service. User need to
provide the values such as Products, Path, Bat file path, Xsl File path, module, project name,
User name, Password, MDB type to configure the data source.

L. Pending Sessions: Added rows would be displayed in service configuration UI as configured


data-sources for selected product. Pending Sessions button displays the list of current
pending sessions in MSMQ.

M. Delete Configuration: It allows the User to delete the configuration done for the data source.

N. Data Grid: It consists of columns and rows describing the values such as Name, Project,
Product, Server, Environment, Data Format, Database, User and Authentication of the
selected data source.
Copyright 2015 to current year.
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
69
AVEVA Integration Service 1.2 User Guide

O. Saved Data Source: This label shows the status of the action performed.

P. Map Network Drive: This label allows the user to map network drives with integration
services. It enables service to access dabacon projects that are mapped in the server
machine using a network drive.

7 Reported Customer Issues and Resolution

7.1 Microsoft .Net Framework Exception Occurred

Issue Description

System might throw above exception while trying to add new data source in integration settings
editor.

Resolution

User can disable JIT Debugger from visual studio or registry to avoid the popups.

A. Steps to disable the VS JIT Debugger Popup using visual studio

1. On the Tools menu, click Options.


2. In the Options dialog box, select the Debugging folder.
3. In the Debugging folder, select the Just-In-Time page.
4. In the Enable Just-In-Time debugging of these types of code box, select or clear the relevant
program types: Managed, Native, or Script.
5. To disable Just-In-Time debugging, once it has been enabled, you must be running with
Administrator privileges. Enabling Just-In-Time debugging sets a registry key, and
Administrator privileges are required to change that key.
6. Click OK.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
70
AVEVA Integration Service 1.2 User Guide

B. Steps to disable the VS JIT Debugger Popup from registry

1. On the Start menu, search for and run regedit.exe


2. In the Registry Editor window, locate and delete the follow registry keys:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows
NT\CurrentVersion\AeDebug\Debugger

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\DbgManagedDebug
ger

3. If your computer is running a 64-bit operating system, delete the following registry keys also:
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Windows
NT\CurrentVersion\AeDebug\Debugger

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\.NETFramework\Db
gManagedDebugger

4. Take care not to accidentally delete or change any other registry keys.

5. Close the Registy Editor window.

Reported Scenario

User might get the exception while trying to add new data source from integration settings editor as
shown below.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
71
AVEVA Integration Service 1.2 User Guide

Click on Add Configuration will give below popup

Clicking on Login button shows below VS JIT Debugger popup.

On Clicking Yes button, system will open visual studio and when visual studio is closed, application
will continue to function as expected by adding the data source details to the grid as shown below.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
72
AVEVA Integration Service 1.2 User Guide

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
73
AVEVA Integration Service 1.2 User Guide

7.2 NewCore_Interface has stopped working

Issue Description

System might throw App crash error in the machine with Aveva Integration services installed when
user tries to login to Diagrams 14.1.0 through Aveva schematic database node in P&ID Database Grid.

Details of the error from Event Viewer logs

Problem signature:
Problem Event Name: APPCRASH
Application Name: NewCore_Interface.exe
Application Version: 1.0.0.0
Application Timestamp: 54eaf32a
Fault Module Name: core.dll
Fault Module Version: 1.2.1.0
Fault Module Timestamp: 54e2d422
Exception Code: c0000005
Exception Offset: 0040bb62
OS Version: 6.1.7601.2.1.0.256.4
Locale ID: 1033
Additional Information 1: 0a9e
Additional Information 2: 0a9e372d3b4ad19135b953a78882e789
Additional Information 3: 0a9e
Additional Information 4: 0a9e372d3b4ad19135b953a78882e789

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
74
AVEVA Integration Service 1.2 User Guide

Resolution

Disable windows error reporting using Control Panel

1. Go to Control Panel, and then navigate to System and Security -> Action Center -> Problem
Reporting Settings status.
2. Check Never Check for Solutions.
3. Click on OK.

Disable windows error reporting using Registry

1. On the Start menu, search for and run regedit.exe


2. In the Registry Editor window, locate and set the below registry key to 1.

HKEY_CURRENT_USER\Software\Microsoft\Windows\Windows Error
Reporting\DontShowUI

Reported Scenario

User might get the exception while trying to login to Aveva Schematic Database as below .

After right clicking Aveva Schematic Database, login popup is displayed as below

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
75
AVEVA Integration Service 1.2 User Guide

Clicking on login could display the crash popup as below in machine with integration service
installed

On clicking close the program link , Login popup will be displayed as below in P&ID.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
76
AVEVA Integration Service 1.2 User Guide

7.3 Get Schema and Get Data for System Tables in Oracle

Issue Description: Unable to get the schema and data for the system tables Eg:
SYS_IOT_OVER_143842. It is an issue with Oracle itself.
Please find the below link for the reference
http://www.dba-oracle.com/t_ora_25191_cannot_reference_overflow_of_an_iot.htm

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
77
AVEVA Integration Service 1.2 User Guide

For system tables Eg: SYS_IOT_OVER_143842 when we perform Get Schema, we are giving a pop
up message saying that Failed to get schema from service E_No_Data as shown below.
When user observe this pop up for the system table you can see the oracle issue description in the
service logs as below ORA-25191: cannot reference overflow table of an index-organized table.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
78
AVEVA Integration Service 1.2 User Guide

For system tables Eg: SYS_IOT_OVER_143842 when we perform Get Data, we are giving a pop up
message saying that Failed to get data from service E_No_Data as shown below.
When you observed this pop up for the system table you can see the oracle issue description in the
service logs as below ORA-25191: cannot reference overflow table of an index-organized table.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
79
AVEVA Integration Service 1.2 User Guide

7.4 Failed to get data from Outfitting in Reflection Client

Issue Description: Unable to get the data from AVEVA Outfitting when the AVEVA Marine SP2/3/4
versions are re-installed.

Resolution: When AVEVA Marine (SP2/SP3/SP4 version) application is re-installed and to get the
Outfitting data in Reflection client then user must copy and paste the below files from AVEVA
Integration Service installed location.

A. InteropIntegMarine.exe

B. InteropIntegMarine.exe.config

For example: AVEVA Integration Service components are installed at below path

D:\Program Files\AVEVA\Shared\AIS1.1 Components\AVEVA Integration Service

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
80
AVEVA Integration Service 1.2 User Guide

Copy the above mentioned files to the installed location of AVEVA Marine and the AVEVA Marine
product is installed in below path.

D:\AVEVA\Marine\OH12.1.SP4

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
81