You are on page 1of 58

AVEVA Integration Service 1.

Deployment Architecture
AVEVA Integration Service Deployment Architecture

Table of Contents

Deployment Architecture .......................................................................................................................... 2

1. Client, DataSource and Service configured in one machine: ........................................................... 2

2. Service and DataSource in one machine and Client in different machine. ..................................... 19

3. Client, DataSource and Service in different machines................................................................... 34

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
1
AVEVA Integration Service Deployment Architecture

Deployment Architecture

1. Client, DataSource and Service configured in one machine:


Machine A

Client Service Data Source


Fetches the Data
Requests for Data Aveva Ex: Aveva Electrical,
Ex: Aveva
Integration Instrumentation, E3D
P&ID, ERM,
Service
Marine
Returns the
Sends the Requested Data
Requested
Data

In this scenario, DataSource and the Service and client are installed in same machine. In order to fetch the
data the Client sends a request to Service and the Service fetches the data in Data source. Here, the client
should point to the machine on which service is installed and the service should point to the machine on
which DataSource is present.

Example:
If the Service, Client and DataSource are Aveva Integration Service, Aveva P&ID and Aveva Engineering
the following steps need to be followed for setup.

Step1: In order to install Aveva Integration Service the followings steps need to be followed:

i. Installation Procedure for Integration Service:

Please run the AVEVA_Integration_Service 1.2.msi from set up folder location and the
Welcome Screen would appear as shown below. Click Next to go to the next page.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
2
AVEVA Integration Service Deployment Architecture

Figure1. Welcome Screen

Figure2. End User License Agreement Screen

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
3
AVEVA Integration Service Deployment Architecture

Figure3. Custom Screen

This is the Custom Setup screen. User can set the installation folder by clicking Browse button if
required. Click Next to go to the next page.

Figure4. Custom Setup screen

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
4
AVEVA Integration Service Deployment Architecture

Note: If Aveva Integration Service is running the following pop-up appears, the client needs to stop the
service in order to avoid the pop-up.

Figure5: Service already running, need to stop before installation screen.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
5
AVEVA Integration Service Deployment Architecture

This is the Ready to Install AVEVA Integration Service screen. Click Install to start installing.

Figure6. Ready to Install AVEVA Integration Service screen

This is the Progress Installation screen. This shows that installation is taking place.

Figure6. Progress Installation screen


Copyright 2015 to current year.
AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
6
AVEVA Integration Service Deployment Architecture

This is the Installation completed screen.

Figure7. Installation completed screen

Click Finish to complete installation and exit.

Step2: Installation of P&ID (Client) should be done by the user. For the installation of P&ID refer P&ID
installation document.

Step3: Installation of Aveva Instrumentation (DataSource) should be done by the user. For the installation
of Aveva Instrumentation refer Aveva Instrumentation installation document.

Step4: Integration Service needs to configure with Aveva Engineering, which is done as follows:

Open Integration Service i.e., run the Integration Settings Editor from the All Programmes menu
as shown below:

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
7
AVEVA Integration Service Deployment Architecture

Alternatively user can also run the InterOpIntegrationConfig.exe from the installed location \Program
Files\AVEVA\Shared\AVEVA Integration Service by double-clicking on it.

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.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
8
AVEVA Integration Service Deployment Architecture

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

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

Step5: Now, the P&ID should point to Integration Service in order to fetch data from Aveva Engineering.

Open the AVEVA P&ID application with proper login credentials. Login window appears before
opening the P&ID application as shown below.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
9
AVEVA Integration Service Deployment Architecture

After opening the P&ID application, open any of the existing drawings.

Now, click on P&ID Reports Launch from P&ID Reports group in Manage tab.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
10
AVEVA Integration Service Deployment Architecture

The following window appears..

Now, click on Prefrences, from the drop down select Prefrences.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
11
AVEVA Integration Service Deployment Architecture

The following window appears; now click on Compare/Update tab.

The following window appears here, in Actions pannel click on the dropdown as shown below and select
service.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
12
AVEVA Integration Service Deployment Architecture

Then the following window appears, click on Yes.

Now,from the Select Source drop down select Aveva Engineering and click on Login.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
13
AVEVA Integration Service Deployment Architecture

After clicking on Login the following window appears, enter the values for User and Password and click on
Connect.

Now, select Create new configuration and click on next.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
14
AVEVA Integration Service Deployment Architecture

The following window will apear. Here, user needs to fill the Configuration Name, select the appropriate
values from the list for Object Type Mapping, Name Attribute, Unique Attribute. And click on Next.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
15
AVEVA Integration Service Deployment Architecture

In the following window user needs to select the Object Type and select the check box Allow Insertion
and click on Next.

The following screen appears, then click on Next.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
16
AVEVA Integration Service Deployment Architecture

As the following screen will appear, user needs to Add Mappings and select the check box Select All
Mappings and then click on Finish.

After clicking on Finish the following window appears then click on OK.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
17
AVEVA Integration Service Deployment Architecture

In Home tab select CompareUpdateLink.

The compare/update tab opens and user needs to select the in the configuration name from dropdown.
Then we can view the data of Aveva Engineering in P&ID.

Hence setup is completed; the user can view the data of Aveva Engineering from Aveva P&ID.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
18
AVEVA Integration Service Deployment Architecture

2. Service and DataSource in one machine and Client in different machine.

Machine A Machine B
Ex: Aveva P&ID, AE\AI. Service Data Source
Requests for Data Aveva
Fetches the Data Ex:
Integration Dabacon
Service (Marine),
E3D,
Returns the Requested
Diagrams
Data
Client

In this scenario, DataSource and the Service are installed in same machine and client is at different
machine. In order to fetch the data the Client sends a request to Service and the Service fetches the data
in Data source. Here, the client should point to the machine on which service is installed and the service
should point to the machine on which DataSource is present.

Example: If the Client (Ex: Aveva Electrical) is located at Machine number:INHYZDPC25 whereas the
service and DataSource (Ex: Aveva Diagrams) are installed at Machine number:INHYZDPC24. Then the
following steps need to be followed to setup in order to get data of marine from Aveva Electrical.

Step1: In order to install Aveva Integration Service the followings steps need to be followed:

i. Installation Procedure for Integration Service:

Please run the AVEVA_Integration_Service 1.2.msi from set up folder location and the
Welcome Screen would appear as shown below. Click Next to go to the next page.

Figure1. Welcome Screen


Copyright 2015 to current year.
AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
19
AVEVA Integration Service Deployment Architecture

Figure2. End User License Agreement Screen

Figure3. Custom Screen

This is the Custom Setup screen. User can set the installation folder by clicking Browse button if
required. Click Next to go to the next page.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
20
AVEVA Integration Service Deployment Architecture

Figure4. Custom Setup screen

Note: If Aveva Integration Service is running the following pop-up appears, the client needs to stop the
service in order to avoid the pop-up.

Figure5: Service already running, need to stop before installation screen.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
21
AVEVA Integration Service Deployment Architecture

This is the Ready to Install AVEVA Integration Service screen. Click Install to start installing.

Figure6. Ready to Install AVEVA Integration Service screen

This is the Progress Installation screen. This shows that installation is taking place.

Figure6. Progress Installation screen

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
22
AVEVA Integration Service Deployment Architecture

This is the Installation completed screen.

Figure7. Installation completed screen

Click Finish to complete installation and exit.

Step2: Installation of Aveva Electrical (Client) should be done by the user. For the installation of Aveva
Electrical refer Electrical installation document.

Step3: Installation of Aveva Diagrams (DataSource) should be done by the user. For the installation of
Aveva Diagrams refer Diagrams installation document.

Step4: Integration Service needs to configure with Diagrams, which is done as follows:

Open Integration Service i.e., run the Integration Settings Editor from the All Programmes menu
as shown below:

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
23
AVEVA Integration Service Deployment Architecture

Alternatively user can also run the InterOpIntegrationConfig.exe from the installed location \Program
Files\AVEVA\Shared\AVEVA Integration Service by double-clicking on it.

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.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
24
AVEVA Integration Service Deployment Architecture

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

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

Step5: Now, the Electrical should point to Integration Service in order to fetch data from Aveva Diagrams.

Open Electrical Engineer, from the All Programmes menu as shown below:

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
25
AVEVA Integration Service Deployment Architecture

The following window appears; select the appropriate AVEVA Electrical Project from the list. And click on
Select.

The User needs to click on Project tab and select Setup from the drop down and then select Aveva
Integration Services and then select Import Configuration.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
26
AVEVA Integration Service Deployment Architecture

After selecting Import configuration the following window appears. Then select service from the drop
down.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
27
AVEVA Integration Service Deployment Architecture

The value of Service Installed On should be set to the machine name on which service is installed.

After chaning the machine number click on save and then click on Test Service. If Service Ok appears
then click on Exit.

Select the source from the drop down and click on LogIn.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
28
AVEVA Integration Service Deployment Architecture

The following window will appear then user needs to select the project and give the values for User and
Password and click on Connect.

Select Create new Configuration and click on Next.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
29
AVEVA Integration Service Deployment Architecture

Then give a Configuration Name and Group name, select the element from the drop down of Object Type
Mapping. Select the name and unique attribute from the drop down. Click on Next.

Select the check box Allow Insertion and then click on Next.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
30
AVEVA Integration Service Deployment Architecture

Click on next.

User needs to add the attribute mappings in order to get data. Select the check box Select All Mappings
and then click on Finish.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
31
AVEVA Integration Service Deployment Architecture

The following message appears, click on OK.

Click on Connect.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
32
AVEVA Integration Service Deployment Architecture

Select the project and enter the password. Click Connect.

Select the Group from the Groups drop down and click on import data.

Now, we can see the diagrams data in Electrical.

User can fetch the data of diagrams or any other data source from different machine by connecting to
service.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
33
AVEVA Integration Service Deployment Architecture

3. Client, DataSource and Service in different machines.

Machine A Machine B Machine C


Ex: Instrumentation Fetches the Data Ex: SQL, WCF, AVEVA NET
1. Requests for Data Aveva PORTAL. , P&ID
2. Integration
3. Service
4.
Sends the Requested Data Returns the
Requested Data

Client
Data Source
In this scenario, DataSource and the Service and client are installed in different. In order to fetch the data
the Client sends a request to Service and the Service fetches the data in Data source. Here, the client
should point to the machine on which service is installed and the service should point to the machine on
which DataSource is present.

Example:
If the client (Ex: Instrumentation) is located at machine INHYZDPC08, service is installed at machine
INHYZDPC24 and DataSource (Ex: Aveva P&ID) is located at machine INPUND151. The following steps
need to be followed for setup in order to get data of Instrumentation in P&ID

Step1: In order to install Aveva Integration Service the followings steps need to be followed:

i. Installation Procedure for Integration Service:

Please run the AVEVA_Integration_Service 1.2.msi from set up folder location and the
Welcome Screen would appear as shown below. Click Next to go to the next page.

Figure1. Welcome Screen


Copyright 2015 to current year.
AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
34
AVEVA Integration Service Deployment Architecture

Figure2. End User License Agreement Screen

Figure3. Custom Screen

This is the Custom Setup screen. User can set the installation folder by clicking Browse button if
required. Click Next to go to the next page.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
35
AVEVA Integration Service Deployment Architecture

Figure4. Custom Setup screen

Note: If Aveva Integration Service is running the following pop-up appears, the client needs to stop the
service in order to avoid the pop-up.

Figure5: Service already running, need to stop before installation screen.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
36
AVEVA Integration Service Deployment Architecture

This is the Ready to Install AVEVA Integration Service screen. Click Install to start installing.

Figure6. Ready to Install AVEVA Integration Service screen

This is the Progress Installation screen. This shows that installation is taking place.

Figure6. Progress Installation screen


Copyright 2015 to current year.
AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
37
AVEVA Integration Service Deployment Architecture

This is the Installation completed screen.

Figure7. Installation completed screen

Click Finish to complete installation and exit.

Step2: Installation of Aveva Instrumentation (Client) should be done by the user. For the installation of
Aveva Instrumentation refer Instrumentation installation document.

Step3: Installation of Aveva P&ID (DataSource) should be done by the user. For the installation of Aveva
P&ID refer P&ID installation document.

Step4: Integration Service needs to configure with P&ID, which is done as follows:

Open Integration Service i.e., run the Integration Settings Editor from the All Programmes menu
as shown below:

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
38
AVEVA Integration Service Deployment Architecture

Alternatively user can also run the InterOpIntegrationConfig.exe from the installed location \Program
Files\AVEVA\Shared\AVEVA Integration Service by double-clicking on it.

Prerequisites for adding P&ID Data to Integration Service:

Open P&ID service editor from the path: AVEVA\Shared\Aveva P&ID Reports Service\ServiceEditor.exe.

The following editor will open. Click on ADD.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
39
AVEVA Integration Service Deployment Architecture

The following window opens from location AVEVA\P&ID 12.1 SP2\Project. User needs to select a
project Example: Test.

In project folder user needs to select PID.PRJ file. Example, in test project folder user has to select
PID.PRJ file and click on Open.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
40
AVEVA Integration Service Deployment Architecture

Now, the data is added to the datagrid. Click on Save All. Then click on Stop Service and then click on
Start Service.

The message box appears. Click on OK.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
41
AVEVA Integration Service Deployment Architecture

Adding P&ID Data to Integration Service

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.

Then the following Service Editor appears.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
42
AVEVA Integration Service Deployment Architecture

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.
43
AVEVA Integration Service Deployment Architecture

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.

Step5: Now, the Instrumentation should point to Integration Service in order to fetch data from P&ID
data.

Open Instrumentation Engineer from the All Programmes menu as shown below:

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
44
AVEVA Integration Service Deployment Architecture

Select the project and click on Select button.

In Project tab select Setup and then select Aveva Integration Services and then select Import
Configuration.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
45
AVEVA Integration Service Deployment Architecture

Click yes.

Click on Service in the following window.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
46
AVEVA Integration Service Deployment Architecture

The value of Service Installed Onshould be set to the machine on which service is installed that is
INHYZDPC24.

After chaning the machine number click on save and then click on Test Service. If Service Ok appears
then click on Exit.

Select the source from the drop down and click on LogIn.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
47
AVEVA Integration Service Deployment Architecture

Select the project and enter the credentials. Click on Connect.

Select Create new Configuration and click on Next.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
48
AVEVA Integration Service Deployment Architecture

Give an appropriate Group name and select the Object Type Mapping example Instrument. Click on Next.

In Object Type drop down select the element that was assigned in Object Type Mapping in previous
screen example Instrument and select Allow Insertion. Click Next.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
49
AVEVA Integration Service Deployment Architecture

Click on Next.

Add the mappings attributes and select Select All Mappings and click on Finish.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
50
AVEVA Integration Service Deployment Architecture

Click on OK.

In Manage tab select the product from which we need data that is Aveva P&ID and then click on Connect.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
51
AVEVA Integration Service Deployment Architecture

Here we can select from which P&ID project we want the data and then click on Connect.

From the Groups select the Group name that is created and click on Import Data.

The P&ID data can be seen in Aveva Instrumentation as shown below.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
52
AVEVA Integration Service Deployment Architecture

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
53
AVEVA Integration Service Deployment Architecture

Prerequisites for adding AE/AI Data to Integration Service:

Open Electrical Integration service editor from the Start Menu.

The following editor will open. Click on ADD Project.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
54
AVEVA Integration Service Deployment Architecture

The following window opens from location AE_AI Project. User needs to select the Project, Example-
AvevaInstProjects file and click on Open.

Now, the data is added to the datagrid. Click on Save. Then click on Stop Service and then click on
Start Service.

The following message box appears. Click on OK.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
55
AVEVA Integration Service Deployment Architecture

Adding AE/AI Data to Integration Service:

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.

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.
56
AVEVA Integration Service Deployment Architecture

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.

Copyright 2015 to current year.


AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
57

You might also like