GUIA DE TREINAMENTO

AVEVA
(12.0.SP6 / 12.1.SP2 /
12.1.SP3 / 12.1.SP4)

SAP Integration Tool User Guide and

www.aveva.com
 AVEVA (12.0.SP6 / 12.1.SP2 / 12.1.SP3 / 12.1.SP4)
SAP Integration Tool User Guide and Configuration

www.aveva.com
© Copyright 1974 to current year. 2
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA (12.0.SP6 / 12.1.SP2 / 12.1.SP3 / 12.1.SP4)
SAP Integration Tool User Guide and Configuration

Revision Log
Date Revision Description of Revision Author Reviewed Approved
11/04/2014 1.0 Issued TO

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.
Copyright 1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved. AVEVA
shall not be liable for any breach or infringement of a third party's intellectual property rights where such
breach results from a user's modification of the AVEVA software or associated documentation.
AVEVA Solutions Limited, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom

Trademark

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. www.aveva.com
© Copyright 1974 to current year. 3
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 Content

1 Introduction .............................................................................................................................................. 6
1.1 Aim..................................................................................................................................................... 6
1.2 Overview and tool range ................................................................................................................. 6
1.3 Prerequisites .................................................................................................................................... 7
2 Configuring the Integration tool in a new project ................................................................................ 8
2.1 Creating main Integration UDAs (user defined attributes) .......................................................... 8
2.2 Configuring general information for Integration .......................................................................... 9
2.3 Creating the main bat file to be scheduled ................................................................................. 10
2.4 Other configuration........................................................................................................................ 10
3 Configuring reports and files to be exported/imported to/from FTP ................................................ 11
3.1 Understanding the tool folder structure ...................................................................................... 11
3.2 Configuring heading data files ..................................................................................................... 12
3.2.1 Import_Report_Headings_Data ............................................................................................... 12
3.2.2 Report_Headings_Data_Files .................................................................................................. 13
3.3 Special Methods ............................................................................................................................. 14
3.3.1 exportCatalogue ....................................................................................................................... 15

www.aveva.com
4
© Copyright 1974 to current year.
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA (12.0.SP6 / 12.1.SP2 / 12.1.SP3 / 12.1.SP4)
SAP Integration Tool User Guide and Configuration

www.aveva.com
© Copyright 1974 to current year. 5
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CHAPTER 1

1 Introduction

1.1 Aim

To provide a guide explaining how to use and configure the SAP Integration Tool, developed by AVEVA.

1.2 Overview and tool range

This tool will provide a way to export and import data from an existing AVEVA PDMS / AVEVA MARINE
project (12.0.SP6 / 12.1.SP2 / 12.1.SP3 / 12.1.SP4) to a FTP, chosen by the user.
The process to move the data through the given FTP to a SAP database (and vice-versa) is customer’s
responsibility. The process schema is showed below:

The main UDA (user defined attributes) that will be used by the tool, to mark elements that were updated by
the integration, for example, will be created by the user through the tool. However, adding elements to that
UDAs and/or creating new UDAs to fill them with project information is a customer’s responsibility.
After properly configured, the created bat file by the tool must be configured in a Schedule Task, to be
executed in a interested time span.

www.aveva.com
6
© Copyright 1974 to current year.
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA (12.0.SP6 / 12.1.SP2 / 12.1.SP3 / 12.1.SP4)
SAP Integration Tool User Guide and Configuration

1.3 Prerequisites

It is required to have an AVEVA PDMS or AVEVA MARINE project in the versions, last fixes:

12.0.SP6
12.1.SP2
12.1.SP3
12.1.SP4

It’s considered the user have access to the project databases, in order to get and set information and to
create new elements, as well, on the projects. The user must have access to run executables on the
workstation/server that will be used for integration.

It’s also required to have all the software and hardware that are requisites to run AVEVA PDMS and AVEVA
MARINE.

It is required the machine has the following software installed:

Microsoft Office (recommended at least version 2010)

www.aveva.com
© Copyright 1974 to current year. 7
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 CAPÍTULO 15

2 Configuring the Integration tool in a new project

The integration tool needs to be configured before in order to manage the reports to be created / imported.
The firsts steps are carried on LEXICON module, explained at the next items.

2.1 Creating main Integration UDAs (user defined attributes)

The integration tool writes in some UDAs aiming identify which elements were modified or exported by the
tool. These UDAs are listed below:

sentToSAP – It is a logical UDA (accepts as values TRUE or FALSE) that will be written if an element was
sent to a FTP by the integration tool.

modBySAP – It is a logical UDA (accepts as values TRUE or FALSE) that will be written if an element was
modified by the integration tool.

COD_SAP – It is a text UDA (accepts as values strings with 120 spaces in its length at maximum size) that
will be written if an element was modified by the integration tool, during the importation process. The default
UDA length can be edited after created.

To call the tool, the user needs to write, at command window the command: show !!SAPIntegration

The form should appear as illustrated:

To create the explained UDAs, the user must click at the “Create integration UDAs...” button. After that, the
UDAs structure should be listed at LEXICON explorer: www.aveva.com
8
© Copyright 1974 to current year.
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA (12.0.SP6 / 12.1.SP2 / 12.1.SP3 / 12.1.SP4)
SAP Integration Tool User Guide and Configuration

2.2 Configuring general information for Integration

Though the executed command to call the configuration tool, it is also possible to configure some other
important data, which will be used by the integration tool:

To save the data, the user must click at “Save Configuration…” button. Doing that, a message will be
displayed, informing that report was created at the folder “C:\AVEVA”. So, the user must has access to
read/write in this folder:

The created file is a simple text file that contains the information written in the form.

www.aveva.com
© Copyright 1974 to current year. 9
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA (12.0.SP6 / 12.1.SP2 / 12.1.SP3 / 12.1.SP4)
SAP Integration Tool User Guide and Configuration

2.3 Creating the main bat file to be scheduled

To create the main bat file, which will be used to run the entire process through a scheduled task, for
example, the user must have created the configuration file previously, as explained on item 2.2 and
then, click at “Create main BAT file…” button. After that, the following message should be seen, informing
where the bat file was created:

2.4 Other configuration

The tool requires other configuration regarding reports and other documents, for both importation and
exportation process. This configuration will be explained on the next chapter.

www.aveva.com
© Copyright 1974 to current year. 10
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA (12.0.SP6 / 12.1.SP2 / 12.1.SP3 / 12.1.SP4)
SAP Integration Tool User Guide and Configuration

3 Configuring reports and files to be exported/imported to/from FTP

As explained, there are some required configurations to permit the tool to read base information in order to
create the reports containing the desired information from a given part of the project. How to configure base
data is the objective of this chapter.

3.1 Understanding the tool folder structure

The tool folder contains a list of subfolders which each one has a specific role for the integration process:

- dlls: this folder contains the dll responsible for send or receive data in a given FTP. There are
subfolders, separating for each available version. Each dll must be pasted at the respective
installation folder.

- forms: it contains the PML form file to configure the tool, explained at chapter 2.

- macros: it contains the main PML macro to be called by the main BAT file (created through the PML
form, as explained at item 2.3).

- objects: it contains the main PML object that is responsible to run the entire integration process.

- manuals: it contains the User Guide and Configuration manual for the tool.

- files: it is the main folder for configuration of the base files to be used during a report/other files
creation/importation. It has some few subfolders inside it:

o bats: it contains the bats to be executed by the integration tool. Normally it has two bat files
inside it: runIntegrationSAP.bat (bat file to be scheduled) and MAINBAT.bat (bat that will be
created and updated at each integration process). The files will be separated by projects,
permitting to execute the tool to different projects.

o ExecutableMacros: it contains the macro that will, in fact, run all the process previously
mapped by the heading configuration data.

o LogFiles: it contains the log files which will inform what happened to each round of
integration steps.

o OutputFiles: it contains all the reports and files (separated by project) created by a round of
integration, letting the files able to be sent to the chosen FTP.

o ImportFiles: it contains all the imported files existing at the given FTP location for a project.

o ConfigFiles: it contains all the configuration files responsible for export/import data to/from
the given FTP outside/inside AVEVA database. This folder will contain headings data files,
which will be responsible to tell the integration tool how to process information. This item will
be better explained on the next items.

www.aveva.com
© Copyright 1974 to current year. 11
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA (12.0.SP6 / 12.1.SP2 / 12.1.SP3 / 12.1.SP4)
SAP Integration Tool User Guide and Configuration
3.2 Configuring heading data files

Heading data files are the files existing at Configfiles folder. They represent an extremely important role to
the process, considering the tool will read the data inside these files and with that will know what and how
export/import.
The owner folder contains two main folders:

3.2.1 Import_Report_Headings_Data

This folder will contain the configuration files that will be responsible to inform to the integration tool what
import and which attributes set. It also set the common attribute between SAP and AVEVA solution (PDMS
or MARINE), to make the bridge between the two solutions.
Each file is separated by projects and inside a project folder, the files are listed with the exact name the SAP
data file will have into FTP. For example, the following folder for a hypothetical project CPV contains a file
named IMPORTDATACONFIGEXAMPLE.csv:

At the FTP location, must exist a folder structure with the exact name, as follow:

With this folder structure, the integration tool will be able to download the correct files aiming the importation
process.

The configuration file existing in the Import_Report_Headings_Data must respect a given structure:

Note some characteristics of this file:

- The element type line can contain more than one element type. The syntax to be used is:
ElementType1 ElementType2 ElementType3 …
www.aveva.com
© Copyright 1974 to current year. 12
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA (12.0.SP6 / 12.1.SP2 / 12.1.SP3 / 12.1.SP4)
SAP Integration Tool User Guide and Configuration
- The filter lines must end with two points: “..”. This will identify all the required filter lines the customer
will need.
- The OwnerElement line, as the element type line can contain more than one owner element. The
syntax to be used is: OwnerElement1 OwnerElement2 OwnerElement3 …
- The attribute lines must respect the same order the data file, inside the FTP, has.
- The text “!!” will be used to make the link between the two data sources (PDMS and SAP). The
attribute marked with this symbol, will be used to match the element in the AVEVA database.
Considering that, the previous example, the name attribute will be used to find the elements inside
AVEVA database.
- At last, considering the example displayed previously, an example that should exist at the FTP
location is showed below:

3.2.2 Report_Headings_Data_Files

This folder will contain the configuration files responsible for inform to the integration tool what to export. The
folders structures are similar to the Import_Report_Headings_Data. The file structure is also similar to the
adopted at the import process.
In addition to, more special characters are available to modify the original attribute value in a new value,
aiming the desired value. The special characters are added at the end of the name of the attribute of each
line. The list of the special characters is exposed below:

Special Char 1: ##Original value/New value

This case presents a situation which the user wants to modify the original value existing in the project to a
new one

Special Char 2: <Required Header>

This character presents to the user the possibility to change the header title, using the text inside the <>
instead of the complete description of the attribute.

Special Char 3: ++

This character offers to the user the concatenation feature, permitting the user to gather more than one
attributes value in a single line.

Special Char 4: !!

This character is used when it is interested to extract a material list from the project. This character will
identify the quantifier attribute, user to group the elements that have the same attribute value of the
quantifier attribute.

Special Char 5: !##Original value/New value

This case is similar to the special char 1. The main difference is this case the original value can be a part of
the attribute value. This can be used, for example, to remove some part of the text existing in the attribute
value:
Original value: =456145/4785421
Syntax: ref!##=/
Result: 456145/4785421 www.aveva.com
© Copyright 1974 to current year. 13
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA (12.0.SP6 / 12.1.SP2 / 12.1.SP3 / 12.1.SP4)
SAP Integration Tool User Guide and Configuration
Below it is displayed an example of a configuration file:

3.3 Special Methods

Beyond the current syntax used to create general reports, there are special methods to create other kind of
files and reports. Each special method has different parameters required to run the method. However,
syntax is common when calling a special method:

MODULE
!this.methodName(parameter 1, parameter 2, parameter n, …)

For example:

MARINEDRAFTING
!this.createPdfFromDRWGHull(|/100_NESTING_DWGs|,|true|)

This item will explain what the available methods are and how to use them.

www.aveva.com
© Copyright 1974 to current year. 14
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
 AVEVA (12.0.SP6 / 12.1.SP2 / 12.1.SP3 / 12.1.SP4)
SAP Integration Tool User Guide and Configuration

3.3.1 exportCatalogue

This method is responsible to export catalogue data. It is prepared to export the given disciplines:

PIPING / EQUIPMENT / OUTFITTINGSTRUC / CABLES / HVAC / HULLSTRUCPLATES

This method is a mixed one, because it needs both method calling and parameter list, so, the configuration
file must respect the following example:

For example:

There are two exceptions related to the Piping and Hull structural plates elements. Considering the piping
elements, the file structure is the same as exposed, however, the integration tool will create a report line
considering some new data, like nominal bore, for example, concatenating it to the report line.
The Hull structural plates elements case requires only the lines until /OwnerElement. After that, the code is
configured to export data considering some catalogue attributes:

- Length
- Width
- Height
- Matref
- Density

www.aveva.com
© Copyright 1974 to current year. 15
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.