AVEVA Integration Service Installation

AVEVA Integration Service 1.
Installation Guide
AVEVA Integration Service Installation Guide
Disclaimer
Information of a technical nature, and particulars of the product and its use, is given by AVEVA Solutions Ltd
and its subsidiaries without warranty. AVEVA Solutions Ltd and its subsidiaries disclaim any and all
warranties and conditions, expressed or implied, to the fullest extent permitted by law.
Neither the author nor AVEVA Solutions Ltd, or any of its subsidiaries, shall be liable to any person or entity
for any actions, claims, loss or damage arising from the use or possession of any information, particulars, or
errors in this publication, or any incorrect use of the product, whatsoever.
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 AVEVA Solutions Ltd or its subsidiaries.
All other rights are reserved to AVEVA Solutions Ltd 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 Ltd Where such permission is granted,
it expressly requires that this Disclaimer and Copyright notice 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 Ltd. The User may also not reverse
engineer, decompile, copy, or adapt the associated software. Neither the whole, nor part of the product
described in this publication may be incorporated into any third-party software, product, machine, or system
without the prior written permission of AVEVA Solutions Ltd, save as permitted by law. Any such
unauthorised action is strictly prohibited, and may give rise to civil liabilities and criminal prosecution.
The AVEVA products described in this guide are to be installed and operated strictly in accordance with the
terms and conditions of the respective licence agreements, and in accordance with the relevant User
Documentation. Unauthorised or unlicensed use of the product is strictly prohibited.
First published 2015.
Copyright 2015 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom.
Trademarks
AVEVA is registered trademark of AVEVA Solutions Ltd or its subsidiaries. Unauthorised use of the AVEVA
trademark is strictly forbidden.
AVEVA product names are trademarks or registered trademarks of AVEVA Solutions Ltd or its subsidiaries,
registered in the UK, Europe and other countries (worldwide).
The copyright, trade mark rights, or other intellectual property rights in any other product, its name or logo
Copyright 2015 to current year.

AVEVA Solutions Limited and its subsidiaries.
All Rights Reserved.
1
ISSUE HISTORY
Date Issue No Remarks
10/03/2015 1.0 Initial Version, Release Number 1.0
11/06/2015 1.1 Fix Version, Release Number 1.1
08/09/2018 1.2 Fix. Version, Release Number 1.2
SUMMARY OF CHANGES
Paragraph Details
NA NA

2
Contents
1. Introduction ........................................................................................................................................... 5
2. License Activation ................................................................................................................................. 5
3. Hardware and Software Requirements ................................................................................................... 5
3.1 Hardware Requirements ................................................................................................................. 5
3.2 Software Requirements................................................................................................................... 6
4. Prerequisites for AVEVA Integration Service............................................................................................ 6
5. Prerequisites to use different Data sources ........................................................................................... 15
5.1 Dabacon Based Products ............................................................................................................... 15
5.2 AVEVA P&ID .................................................................................................................................. 15
5.3 AVEVA Instrumentation/Electrical................................................................................................. 18
5.4 Excel ............................................................................................................................................. 20
6. Procedure to retain Data Sources added in previous version. ................................................................ 21
7. Installation Procedure:.......................................................................................................................... 23
7.1 Schematic Integration Components............................................................................................... 27

3
This page has been deliberately left blank

4
1. Introduction
This guide is intended for IT Managers and support Users who are planning to implement AVEVA Integration
Service 1.2. The Hardware & Software requirements sections present detailed requirements of the
hardware, operating system, software packages and version numbers required for the installation of the
product.
Please follow all the instructions and read the information described at Sections 6 to install AVEVA
Integration Service 1.2, they contain all the required information for new Users and existing Users.
2. License Activation
The licensing of the AVEVA Integration Service product is managed by AVEVAs ALS security system. To
operate, AVEVA software must be able to access the correct ALS license file, which should be installed on
either the Server, on the workstation, or on a networked workstation. ALS is a network license service which
hands out floating licenses to clients, meaning that licenses are not tied to a certain workstation but can be
used from any workstation where the software is installed, as long as the total number of licenses in use
does not exceed the number of licenses purchased. The ALS guide is available on the AVEVA support site.
Note: Although the disk contains several AVEVA products, the user will only be able to use the items that are
licensed to them. The user will get an on-screen notification to warn them when the license is due for
renewal. License Activation
3. Hardware and Software Requirements
This section gives detailed requirements of the hardware, operating system, software packages and version
numbers required to implement AVEVA Integration Service 1.2. Where the text identifies operating systems
or 3rd party packages (e.g. Microsoft Excel), currently only English versions has been certified for use with
AVEVA Integration Service 1.2.
3.1 Hardware Requirements
Intel(R) Core(TM) i5 2.8 GHz, RAM 4GB

15 to 17 monitor running in XVGA (1280 *1024) mode or greater.

5
3.2 Software Requirements
Operating System as Microsoft Windows 7 SP1

Microsoft Data Access Components (MDAC) 2.6 or later
Microsoft .NET Framework 4
Microsoft Message Queue (MSMQ) Server
AVEVA Licensing System
Note: The user should have full Admin rights on the computer for accessing the Integration Service.
4. Prerequisites for AVEVA Integration Service

Before installing AVEVA Integration Service 1.2 there are some steps to be done as prerequisites, they are:
Turn on the MSMQ Server Core
Go to Control Panel > Programs and Features and select the Turn Windows features on or off option:
Check all the checkboxes under Microsoft Message Queue (MSMQ) Server and then click OK.

6
The user must also verify that the Message Queuing and Message Queuing Triggers services are running
(by running the command services.msc in 'Run' command window). If not, they must be started.
Do the Computer Management Setting as follows:-
Run the command compmgmt.msc in the MS command window.

Expand the node Services and Applications in the left pane of Computer Management window.
Open Message Queuing
Open Private Queues

7
Right-click the on integration_tasks message queue and select Properties
Select the Security tab of integration_tasks Properties window and click on Advanced button.
Select the Owner tab Advanced Security Settings

8
Change the current owner to Administrators by selecting Administrators group in the section Change
owner to and click Apply button.
Click the Permissions tab

9
Click on Add and add the name of the user who is going to configure the service, giving the full control.

10
Click OK to close all the windows.
Existing P&ID Users

For P&ID users the Middle tier service will be running already as below.
The user needs to uninstall the middle tier integration service by following steps:
1. Go to Control Panel. In Programs click on Uninstall a Program

11
2. The lists of installed programs appear as below.
3. Right click on Aveva Schematic Middle Tier 1.0 and click on Change
4. The following window appears, click on Next.
5. Click on Change in the following window.

12
6. In the following window click Schematic Integration and select Entire feature will be unavailable. And
click on next.
7. Click on Change.

13
8. The following screen will appear which shows the progress of re-installation.
9. Click on Finish.

14
5. Prerequisites to use different Data sources

There are some prerequisites to be set for using AVEVA Integration Service with different data source types.
5.1 Dabacon Based Products

AVEVA Products listed below should be installed on the same machine where the Integration Service is
installed, so that they can be supported as data source by the service:
AVEVA Engineering
AVEVA PDMS or E3D
AVEVA OutFitting
5.2 AVEVA P&ID

To use AVEVA P&ID as Data Source Type, the user first needs to add those P&ID projects to AVEVA P&ID
Report Service. This can be done using following process:
Run the ServiceEditor.exe by selecting AVEVA > Engineer > Manage > P&ID Data Service Editor from the All
Programs menu or from the installed location by double-clicking on it:
Add the pid.prj file of required P&ID project by clicking the Add button and browsing for the file.

15
Click on the Save All button.
Note: The user needs to click on the Stop Service button and then Start Service button for the selection to
take effect.
Finally, click on Exit.
The data from the added project can be confirmed by running ClientApplication.exe from the location below:

16
Set the Service Location by giving the correct machine name and port as shown below.
Test the service using the Test Service button to make sure it is OK.
Click on get 'Get Projects' and select the Project from the dropdown list.
Select table from the list of ALL TABLES and click on Retrieve Data to check that data is available.

17
5.3 AVEVA Instrumentation/Electrical
To use AVEVA Instrumentation/Electrical as Data Source Type, the user first needs to add those
Instrumentation/Electrical projects to AVEVA Instrumentation Integration Service. This can be done using
following process:
Run the Instrumentation Integration Service by selecting AVEVA Plant > Engineer >
Instrumentation>Instrumentation Integration Service from the All Programs menu or from the installed
location by double-clicking on it:

18
2. Add AvevaInstProjects.mdb file by clicking the Add Project button and browsing for the mdb file.

19
Click on the Save button.
Note: The user needs to click on the Stop Service button and then Start Service button for the selection to
take effect.
Finally, click on Close.
5.4 Excel
For using MS Excel as data source type, MS Office 2007 or later versions must be installed.

20
6. Procedure to retain Data Sources added in previous version.
User need to follow below procedure to retain the old data source details configured in the AVEVA
Integration Settings Editor before installing latest version of AVEVA Integration Service.
Steps to follow,
1. Cut/Copy the DataSources.dat file from AVEVA Integration Service installed location.
For example the AIS installed in below path,
D:\Program Files\AVEVA\Shared\AIS1.1 Components\AVEVA Integration Service
2. Paste this file in a folder where normal user has access to that folder.
For example the file is copied to below location,
C:\Users\Public\Documents\AVEVA\Aveva Integration Service
3. Copy the folder path where the DataSources.dat file is copied and open the
InterOpIntegrationWinService.config file in notepad from the AVEVA Integration Service
installed location.

21
4. Provide the folder location where DataSources.dat file is copied to in the XML file.
5. Save the Configuration file and install the new version of AVEVA Integration Service.
6. After installation of new version of AVEVA Integration Service repeat the steps 3 & 4.

22
7. Installation Procedure:
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
Figure2. End User License Agreement Screen

23
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

24
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.

25
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.
Figure7. Progress Installation screen

26
This is the Installation completed screen.
Figure8. Installation completed screen

Click Finish to complete installation and exit. Please refer to the AVEVA Integration Service User Guide for
details about how to configure and use the Integration Service.
Notes:
AIS 1.2 doesnt require AIS 1.0 or AIS 1.1 to be installed in the machine.
If AIS 1.2 is installed on top of AIS 1.0 or AIS 1.1 then it automatically upgrades to AIS 1.2 version.
When AIS 1.2 is uninstalled then all AIS components are completely uninstalled from the machine.
7.1 Schematic Integration Components
Data Integration
Integration Service: It is required for importing the data into AVEVA P&ID. Currently this service can
import data from sources like AVEVA P&ID, Excel & SQL Server.
Integration Client: This sample application can be used for verifying that the data source is properly
setup on the Integration Service and able to fetch data from the source product.
Notification
Notification Service: It is required for importing the notification into AVEVA Integration service.
Notification Client: This sample application can be used for verifying that the notification is properly
setup on the Integration Service and able to see notification from the AVEVA integration service.

27

AVEVA Integration Service Installation

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

AVEVA Integration Service Installation

Uploaded by

Copyright:

Available Formats

AVEVA Integration Service 1.

Copyright 2015 to current year.

Date Issue No Remarks

10/03/2015 1.0 Initial Version, Release Number 1.0

11/06/2015 1.1 Fix Version, Release Number 1.1

08/09/2018 1.2 Fix. Version, Release Number 1.2

Copyright 2015 to current year.

Copyright 2015 to current year.

This page has been deliberately left blank

Copyright 2015 to current year.

3. Hardware and Software Requirements

3.1 Hardware Requirements

Intel(R) Core(TM) i5 2.8 GHz, RAM 4GB

Copyright 2015 to current year.

3.2 Software Requirements

Operating System as Microsoft Windows 7 SP1

4. Prerequisites for AVEVA Integration Service

Copyright 2015 to current year.

Do the Computer Management Setting as follows:-

Run the command compmgmt.msc in the MS command window.

Copyright 2015 to current year.

Right-click the on integration_tasks message queue and select Properties

Select the Owner tab Advanced Security Settings

Copyright 2015 to current year.

Click the Permissions tab

Copyright 2015 to current year.

Copyright 2015 to current year.

Click OK to close all the windows.

Existing P&ID Users

Copyright 2015 to current year.

2. The lists of installed programs appear as below.

4. The following window appears, click on Next.

5. Click on Change in the following window.

Copyright 2015 to current year.

Copyright 2015 to current year.

Copyright 2015 to current year.

5. Prerequisites to use different Data sources

5.1 Dabacon Based Products

5.2 AVEVA P&ID

Copyright 2015 to current year.

Click on the Save All button.

Finally, click on Exit.

Copyright 2015 to current year.

Copyright 2015 to current year.

5.3 AVEVA Instrumentation/Electrical

Copyright 2015 to current year.

Copyright 2015 to current year.

Click on the Save button.

Finally, click on Close.

Copyright 2015 to current year.

6. Procedure to retain Data Sources added in previous version.

Copyright 2015 to current year.

Copyright 2015 to current year.

Figure1. Welcome Screen

Figure2. End User License Agreement Screen

Figure3. Custom Screen

Figure4. Custom Setup screen

Copyright 2015 to current year.

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

Copyright 2015 to current year.

Figure6. Ready to Install AVEVA Integration Service screen

Figure7. Progress Installation screen

Copyright 2015 to current year.

This is the Installation completed screen.