You are on page 1of 72

AVEVA NET Marine Gateway

Administrator Guide

NOTE: Marine includes both of the following products:

1) AVEVA NET Vantage Marine Gateway

2) AVEVA NET AVEVA Marine Gateway


AVEVA Solutions Limited

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.
AVEVA NET Gateway Administrator Guide

Revision Sheet

Date Version Comments / Remarks


AVEVA NET Gateway Administrator Guide
AVEVA NET Gateway Administrator Guide

AVEVA NET Gateway Administrator Guide

Contents Page

AVEVA NET Marine Gateway


Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Assumptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Guide Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1

Configure AVEVA NET Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1


Character Sets to Code Page Mapping (All) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Default Character Set Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
Classification Mapping (Outfitting Design, Hull Design and SPOOLER) . . . . . 2:3
Default System Classification of Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
User Defined Classification of Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4
User-Defined Identifiers for Outfitting Objects (Outfitting Design, Hull Design
and ISODRAFT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:7
VNETxmlOrigName Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:7
VNETxmlOrigName Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:8
Select Items to Export (Outfitting Design, Outfitting, Hull Design and SPOOLER)
2:9
Default Outfitting Design Items Selection Configuration File . . . . . . . . . . . . . . . . . . . . . . . 2:10
Default SPOOLER Items Selection Configuration File. . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:10
Configure Attributes to Export (Outfitting Design, Hull Design and SPOOLER) . .
2:11
Default Attribute Inclusion Configuration File (Outfitting Design and Hull Design). . . . . . . 2:11
Default Attribute Inclusion Configuration File (SPOOLER) . . . . . . . . . . . . . . . . . . . . . . . . 2:12
Attributes by Item Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:12
Redefine the Displayed Attribute Name in AVEVA NET . . . . . . . . . . . . . . . . . . . . . . . . . . 2:13

© Copyright 1974 to current year. i 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide

Define a Default Value if Attribute is Unset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:13


Hitfile Exclusions Configuration File (Outfitting Draft). . . . . . . . . . . . . . . . . . . 2:13
Default Outfitting Draft Exclude Configuration File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:14
Create Additional AVEVA NET Associations (OtherNames) (Outfitting Design
and Hull Design) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:14
VNETxmlOtherName Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:15
VNETxmlOtherName Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:16
Review Files for Assemblies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:19

Export Design Items and Properties . . . . . . . . . . . . . . . . . . . . . . . . . 3:1


AVEVA NET Export - Main Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:6
Select Assemblies to Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:8
Select Manufacturing Data to Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:9

Export SPOOLER Items and Properties . . . . . . . . . . . . . . . . . . . . . . 4:1


SPOOLER Export Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1
Select ISODEP to Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1

Save and Load Export Configurations . . . . . . . . . . . . . . . . . . . . . . . 5:1


Export Review Model Files for AVEVA NET . . . . . . . . . . . . . . . . . . . 6:1
Settings to Enable AVEVA NET SPOOL Highlighting . . . . . . . . . . . . . . . . . . . . 6:1

Export DRAFT Drawings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1


Plotting DRAFT Drawings for VNET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1
Batch Plotting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1

Export Isometrics and Spool Isometrics. . . . . . . . . . . . . . . . . . . . . . 8:1


Configure Outfitting ISODRAFT for AVEVA NET . . . . . . . . . . . . . . . . . . . . . . . . 8:1
Example AVEVA NET .xml Output File for an Isometric. . . . . . . . . . . . . . . . . . . 8:2
Example AVEVA NET .xml File Output for a Spool Isometric . . . . . . . . . . . . . . 8:3

AVEVA NET SPOOLER Breakdown Nodes. . . . . . . . . . . . . . . . . . . . 9:1


AVEVA NET Assembly Breakdown Nodes . . . . . . . . . . . . . . . . . . . 10:1
AVEVA NET Gateway Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:1
AVEVA NET Gateway Files 11.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:1

© Copyright 1974 to current year. ii 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide

AVEVA NET Gateway Files Outfitting11.6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:3


AVEVA NET Gateway Files Outfitting12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:3

© Copyright 1974 to current year. iii 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide

© Copyright 1974 to current year. iv 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Introduction

1 Introduction

The AVEVA NET Gateway Administrator Guide is intended for AVEVA NET Portal Data
Administrators responsible for loading and managing data within AVEVA NET Portal.

1.1 Assumptions
It is assumed that the user is already familiar with the AVEVA NET Portal architecture,
schema and basic operating principles, as indicated in the AVEVA NET Portal Overview
Administrator Guide.

1.2 Guide Structure


The AVEVA NET Gateway Administrator Guide is divided into the following chapters:

Configure AVEVA NET lists the configuration files used by the various Marine
Gateway modules and explains how to configure the Gateway for
those modules.

Export Design Items and describes exporting items and properties, covering export
Properties configuration, and the selection of Marine sites and
Assemblies for export.

Export SPOOLER Items and describes exporting items and properties, covering export
Properties configuration and selecting Marine ISODEP to export.

Save and Load Export explains how to save and load a configuration settings file
Configurations for AVEVA NET Export Configurations that can be re-used.

Export Review Model Files for explains how to export Review files and shows the settings
AVEVA NET to enable AVEVA NET Spool highlighting.

Export DRAFT Drawings explains how to export Outfitting Draft drawings, covering
plotting drawings and batch plotting.

Export Isometrics and Spool explains how to export isometrics and spool isometrics,
Isometrics including configuring Marine ISODRAFT for AVEVA NET.

AVEVA NET SPOOLER gives the extra Breakdown Node configurations that need
Breakdown Nodes to be added to the AVEVA NET Portal in order to view
SPOOLER information.

© Copyright 1974 to current year. 1:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Introduction

AVEVA NET Assembly gives the extra Breakdown Node configurations that need
Breakdown Nodes to be added to the AVEVA NET Portal in order to view
Assemblies information.

AVEVA NET Gateway Files shows the Gateway Files installed by the installation
program into the current installation’s Marine directory
structure.

© Copyright 1974 to current year. 1:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

2 Configure AVEVA NET Gateway

For the gateway to work, for an AVEVA NET installation, the user needs to do some
configuration to the AVEVA NET Outfitting Gateway. The configuration comes in the form of
txt files and PML object/method files. Some of the configuration files are used by a number
of the outputting methods described in this document to get Marine data in the form of Items
and associated attributes and Drawings into AVEVA NET.
The configuration files used by the various modules of Outfitting are listed below

Outfitting Module Section Configuration File

Common 3.1 %OutfittingDFLTS%\VNET-CHAR-ENCODE


3.2 %PMLLIB%\vnet\settings\AVEVA-Classify.pmlmac
%PMLLIB%\vnet\settings\VNETUserClass(Proj).pmlobj
3.3 %PMLLIB%\vnet\settings\VNETxmlOrigName(Proj).pmlobj
3.7 %PMLLIB%\vnet\settings\VNETxmlOtherName(Proj).pmlobj

Outfitting Design 3.4 %OutfittingDFLTS%\DES-VNET-ITEMS


Outfitting 3.5 %OutfittingDFLTS%\DES-VNET-INCLUDE
Hull Design

Outfitting - 3.8 %OutfittingDFLTS%\DES-VNET-RVMTEMPLATE.xr


AssemblyPlanning
Hull Design

SPOOLER 3.4 %OutfittingDFLTS%\SPL-VNET-ITEMS


3.5 %OutfittingDFLTS%\SPL-VNET-INCLUDE
%OutfittingDFLTS%\SPL-VNET-TOLERANCE

Outfitting Draft 3.6 %OutfittingDFLTS%\DRA-VNET-EXCLUDE

ISODRAFT 3.3 %PMLLIB%\vnet\settings\VNETxmlOrigName(Proj).pmlobj

2.1 Character Sets to Code Page Mapping (All)


The user can configure the XML encoding of the generated output files, to be based on the
PROJ CHARSET/PROJ MBCHARSET that the Outfitting project is set to. This will make the
XML text recognisable in the localised VNET installation. i.e.
<?xml version="1.0" encoding="UTF-8"?>
To change the encoding there is a configuration file where the encoding that the user wants
is mapped to the required code page name. A file is supplied as default which has a number

© Copyright 1974 to current year. 2:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

of the most common mappings which users would probably require with Outfitting and
VNET.
The Outfitting Character Set is mapped to the required XML Codepage by the defaults file
VNET-CHAR-ENCODE. The file contains a list of Outfitting Character Sets and the mapped
Pagecode and a description of the Language. The standard file supplied with the VNET
Outfitting Gateway installation is located in the OutfittingDFLTS directory,
%OutfittingUI%\DFLTS.

Name Description
VNET-CHAR-ENCODE VNET Character CodePage Mapping

In order to keep standard (AVEVA) and user configurations separate, there can be separate
VNET-CHAR-ENCODE files placed in the standard Outfitting defaults areas. By default any
user inclusion files found in default directories will override the supplied/standard inclusions
file.
User inclusion files should have the same file name, and be placed into the following places,
depending on the company standards for defaults. (This is standard to all other Marine
defaults file configurations).
• The Marine DFLTS directory holds company exclusions, which are available to all
projects.
• The ABCDFLTS directory (where ABC is the project name) holds exclusions specific to
one project.
• The Marine USER directory holds exclusions specific to a single user.

2.1.1 Default Character Set Mapping


The default Character Set Code is automatically loaded as the Character Encoding map file
(see Settings). It contains something like:
...
--Begin
885901 ISO-8859-1 Latin1 (West European)
885902 ISO-8859-2 Latin2 (East European)
885903 ISO-8859-3 Latin3 (South European)
885904 ISO-8859-4 Latin4 (North European)
885905 ISO-8859-5 Cyrillic
885906 ISO-8859-6 Arabic
885907 ISO-8859-7 Greek
885908 ISO-8859-8 Hebrew
885909 ISO-8859-9 Latin5 (Turkish)
885910 ISO-8859-10 Latin6 (Nordic)
885911 ISO-8859-11 Thai
KOREAN EUC-KR Korean
JAPANESE Shift-JIS Japanese
CHINESE EUC-CN Chinese Simplified
TCHINESE EUC-TW Chinese Traditional
UTF-8 UTF-8 UNICODE
DEFAULT UTF-8 UNICODE

The result of the mapping is that CHARSET/MBCHARSET code 885908 are XML encoded
as ISO-8859-8 (Hebrew). The DEFAULT statement means that if the character set is not
listed the XML will be encoded as UTF-8.

© Copyright 1974 to current year. 2:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

Note: If no DEFAULT statement is listed, the XML will default to UTF-8.

A simple example is shown below on how to edit the file, to map CHARSET/ MBCHARSET
code 885905 to WINDOWS-1251 encoding:
...
--Begin
885901 ISO-8859-1 Latin1 (West European)

885904 ISO-8859-4 Latin4 (North European)
885905 WINDOWS-1251 Cyrillic
885906 ISO-8859-6 Arabic

DEFAULT UTF-8 UNICODE

This will make the first line of all XML generated by the Gateway change as shown below,
as long as the Character set in Outfitting is 885905:
<?xml version="1.0" encoding="UTF-8"?> To
<?xml version="1.0" encoding="WINDOWS-1251"?>

2.2 Classification Mapping (Outfitting Design, Hull


Design and SPOOLER)
When exporting data from Outfitting to AVEVA NET the user can set the classification of
items. There are two ways of doing this. By default there is a setting file AVEVA-
Classify.pmlmac, which allows classification by item type only, but the user can also classify
items using standard PML functionality, in the for of an object file which is named
VNETUserClass<Project Code>.pmlobj, so a setting file for the Default Project MAR would
be named VNETUserClassSAM.pmlobj.
These are explained in more detail below.

2.2.1 Default System Classification of Items


The default classification is controlled by the PML Function AVEVA-Classify.pmlmac, this is
automatically loaded as the Class map file (see Settings).
It contains something like:
...
--Begin
SITE+System
ZONE+Area
EQUI+Equipment
NOZZ+Nozzle
PIPE+PipeLine
BRAN+PipingSegment
VALV+Valve
INST+Instrument
SCTN+StructuralBeam
PANE+StructuralPanel
HVAC+HVAC
ISOREG+WorkPack
SPLDRG+SpoolDrawing

© Copyright 1974 to current year. 2:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

SPOOL+Spool
FIELD+Weld
ASWL+Assembly
ASMBLY+Assembly
BLOCK+Block
Otherwise+Component
The result of the mapping is that objects of type SITE in Outfitting are instantiated as objects
of class System in AVEVA NET. The Otherwise statement means that all objects that are
not matched else where in the list are instantiated of class Component. It is important that all
the classes on the right hand side, the AVEVA NET Classes, exist in the Class library. The
contents of the class library can be inspected by using the Admin Tool.

2.2.2 User Defined Classification of Items


It is possible to override the default system classification by modifying the code in the PML
object file VNETUserClass<Project Code>.pmlobj (see Settings).
This object takes Outfitting type and Outfitting name as arguments, together with the default
system assigned AVEVA NET Class, and returns the user-defined Class of the object.
Typically this function is used to set the class by looking at the name of the object possibly in
combination with other attributes of the Outfitting Object.
To enable faster processing of the objects files, the user can add naming and classification
pairs to a user storage area, which is an pml ARRAY object, stored on the main
VNETExport window, which once set up in the classification object file, can be called any
number of times. There are 10 of these storage arrays, which are loaded using the standard
syntax.
The example below is part of the standard installation for MAR project.
First it checks that the array is empty, it loads a temporary array with the classification data
in the form of a Equipment Letter+Classification. The storage array is then cleared out as a
precaution, and then the temporary array is loaded in to the storage array by splitting it on
the + this then allows the Equipment Letter to be found easily during the main processing.
The next part of the object would be to use the data in the storage array to check a EQUIP
items tagname against the Equipment letters in the storage area, and if it finds a match, it
classifies that equipment as that type for AVEVA NET.
define object VNETUserClass<Project Code>
-- Used as a temporary store for the original name
member .result is string

endobject
-- End of object definition for VNETUserClass<Project Code>()

define method .VNETUserClassSAM(!type is STRING, !name is STRING, !Class is


STRING)
-- Set up the result to be the default class for the item
!this.result = !Class

if !!VNETExport.UserClassStore1.empty() then
!equitagdata = array()
!equitagdata.append('C+Columns and Towers')
!equitagdata.append('E+Heat Transfer')
!equitagdata.append('D+Drum')
!equitagdata.append('P+Pump')
!equitagdata.append('VENTILATION+HVAC')

© Copyright 1974 to current year. 2:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

-- Some instruments are build as EQUIs

!equitagdata.append('LG+LEVEL GAUGE')
!equitagdata.append('LT+LEVEL TRANSMITTER')
!equitagdata.append('LS+LEVEL SWITCH')
!equitagdata.append('LV+HAND VALVE')
!equitagdata.append('LZ+HAND VALVE')

!!VNETExport.UserClassStore1.clear()
!!VNETExport.UserClassStore1[1] = array()
!!VNETExport.UserClassStore1[2] = array()

-- Separate out the tags from the array descriptions and load into one
of the user storage areas

do !indx indices !equitagdata


!!VNETExport.UserClassStore1[1].append(!equitagdata[!indx].part
(1,'+').trim())
!!VNETExport.UserClassStore1[2].append(!equitagdata[!indx].part
(2,'+').trim())
enddo
endif

if (!type eq 'EQUI') then


-- Split the items name at any dashes and remove the prefixing VPD
slash
!splitname = !name.after('/').split('-')

-- Find the tag in the list of tags and get its position
-- Searches through the split parts of the name for the tag letters
-- If it finds any then it breaks out
!pos = real()
do !indx indices !splitname
!pos = !!VNETExport.UserClassStore1[1].findfirst (!splitname
[!indx])
if not !pos.unset() then
break
endif
enddo

-- Check to see if anything was found


-- Try to be more clever
-- Convert all REALS to hashes then split them on hashes an try the
search again
if !pos.unset() then
if (!splitname.size() eq 1) then
!length = !splitname[1].length()
do !loop from 1 to !length
!test = !splitname[1].substring(!loop,1).real()
handle any
elsehandle none
!splitname[1] = !splitname[1].replace
(!splitname[1].substring(!loop,1),'#',1,1)
endhandle
enddo
!newname = !splitname[1].split('#')
do !indx indices !newname
!pos = !!VNETExport.UserClassStore1[1].findfirst
(!newname[!indx])

© Copyright 1974 to current year. 2:5 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

if not !pos.unset() then


break
endif
enddo
endif
endif
-- Check to see if anything was found
-- If yes then output just the description form the array of tags and
descriptions
if !pos.unset().not() then
!this.result = !!VNETExport.UserClassStore1[2][!pos]
endif
elseif (!type eq 'INST') then
...
...
endif

endmethod
-- End of method definition for .VNETUserClass<Project Code>()

A simple example is shown below, which will classify EQUI items by their first letter in the
Outfitting name:
define object VNETUserClass<Project Code>

-- Used as a temporary store for the original name


member .result is string

endobject
-- End of object definition for .VNETUserClass<Project Code>()

define method .VNETUserClass<Project Code>(!type is STRING, !name is


STRING, !Class is STRING)
-- Variables defined are....
-- !type = Outfitting Type of the current element e.g. SITE or GASK
-- !name = Outfitting name including "/".
-- !Class = AVEVA default class result
!this.result = !Class
!FirstChar = !name.substring(2,1)
if (!type eq 'EQUI') then
if (!FirstChar eq 'E') then
!this.result = 'Heat Transfer'
elseif (!FirstChar eq 'V') then
!this.result = 'Vessel'
elseif (!FirstChar eq 'P') then
!this.result = 'Pump'
elseif (!FirstChar eq 'D') then
!this.result = 'Drums'
elseif (!FirstChar eq 'C') then
!this.result = 'Columns and Towers'
else
-- If here then it could not match an EQUI character, so set
back to AVEVA result
!this.result = !Class
endif
else
-- If it's here then it is not an EQUI, therefore leave as
AVEVA result
!this.result = !Class
endif

© Copyright 1974 to current year. 2:6 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

!this.return '$!result'
endmethod
-- End of method definition for .VNETUserClass<Project Code>()

2.3 User-Defined Identifiers for Outfitting Objects


(Outfitting Design, Hull Design and ISODRAFT)
It is possible to override the default naming by modifying the code in the PML object file
VNETxmlOrigName<Project Code>.pmlobj (see Settings).
It is possible that the identifier of an object in Outfitting does not match the identifier of the
same object in another system, or the identifier which is being used project wide. For
example, the identifier of a pipeline on a P&ID might be of the form 6”-AI-502100-AB3-PP-
30IS while the pipe in Outfitting is called 6”-AI-502100-AB3, but on the project the Pipe is
known as AI-502100. In this situation, the name exported from Outfitting can be changed to
produce the project wide identifier.
The export process assigns two identifiers to each Outfitting object. The main identifier is
the Outfitting name without the leading slash e.g. 6&amp;-AI-502100-AB3. It is given a
context of PROJECTCONTEXT which is replaced by the name of the ‘Top Object during
processing by the VNET Import Controller.
The second identifier is the original Outfitting name e.g. /6&amp;-AI-502100-AB3. This is
given the context VPD in the context of PROJECTCONTEXT. This is needed by AVEVA
NET for picking to work with Outfitting documents. All documents referring to the original
Outfitting name, with a slash, also have the extra Outfitting context.
It is the main identifier that can be modified, by including a file in the
%PMLLIB%\vnet\setting directory called VNETxmlOrigName<Project Code>.pmlobj, if
this file does not exist then the original name will be used.

2.3.1 VNETxmlOrigName Example 1


The XML produced by the Export appware using no User-Defined Identifiers would look
something like this, for a pipe named /6”AI-502100-AB3
<Object>
<ID>6&amp;-AI-502100-AB3</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
</Context>
<ClassID>PipingSegment</ClassID>
<Association type="is identified by">
<Object>
<ID>/6&amp;-AI-502100-AB3</ID>
<Context><ID>VPD</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
</Context>
</Context>
</Object>
</Association>
</Object>

© Copyright 1974 to current year. 2:7 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

2.3.2 VNETxmlOrigName Example 2


If the user wants to name their pipes using only its Fluid Service and Number which are
defined as part of its name, using the above pipe /6”-AI-502100-AB3, then the user wants
to create a name of AI-502100. To create this the user would need the following PML
syntax, in a file called VNETxmlOrigName<Project Code>.pmlobj
define object VNETxmlOrigName<Project Code>
-- Used as a temporary store for the original name
member .result is string
endobject

-- End of object definition for VNETxmlOrigName<Project Code>

define method .VNETxmlOrigName<Project Code>( !object is dbref, !name is


string )

-- The !object and !name are always passed to this file, and must be
declared. You will need
-- these to do some of the naming that you require

if (!object.type EQ 'PIPE') then


if (!name.match('-') gt 0) then
!splitname = !name.split('-')
if ((!splitname.size() eq 3) or (!splitname.size() eq 4))
then
!this.result = !splitname[2] & '-' & !splitname[3]
else
!this.result = !name
endif
elseif (!name.match('/') gt 0) then
!splitname = !name.split('/')
if (!splitname.size() eq 4) then
!this.result = !splitname[1] & '-' & !splitname[2] & '/'
& !split name[3]
else
!this.result = !name
endif
else
!this.result = !name
endif
elseif (!object.type EQ ‘EQUI’) then
...
elseif (!object.type EQ ‘INST’) then
...
else
!this.result = !name
endif

endmethod

The result would be that for Outfitting objects of type PIPE, if the name can be split on ‘-‘
dashes and it breaks down into 3 or 4 items then make the name up from the 2nd (AI) and
3rd (502100) components, which means that the size (6”) and spec (AB3) of the pipe (1st
and 4th components respectively) would not be used in the name. Also if the name does not
contain ‘-‘ dashes then split the name on ‘/’ backslashes. If there are 4 components then
make the name up from the 1st, 2nd and 3rd components. If the name does not fall into any
of these breakdowns then return the original name.

© Copyright 1974 to current year. 2:8 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

Note: The supplied name has already had the preceding slash removed before this method
is called.

The XML produced by the Export appware with the above configuration object, the User-
Defined Identifiers would look something like this:
For a pipe named /6”-AI-502100-AB3
<Object>
<ID>AI-502100</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
</Context>
<ClassID>PipingSegment</ClassID>
<Association type="is identified by">
<Object>
<ID>/6&amp;-AI-502100-AB3</ID>
<Context><ID>VPD</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
</Context>
</Context>
</Object>
</Association>
</Object>

This routine is also called whenever an object needs to be identified, including objects that
are the target of associations, such as connected items.

2.4 Select Items to Export (Outfitting Design, Outfitting,


Hull Design and SPOOLER)
The user can configure the export to export only the Outfitting Item Types that they require
in their AVEVA NET Portal.
To change which item types are exported there is a configuration file where the item types
that the user wants included in the export must be defined. A file is supplied as default which
has a number of the most common Outfitting item types and their Owned Item types listed in
it which users would probably require within AVEVA NET.
The configuration of the included item types is configured by the defaults file DES-VNET-
ITEMS. The file contains a list of Outfitting collections, which collect the most relevant items
that the user would probably want to export. The standard file supplied with the AVEVA NET
Marine Gateway installation is located in the MarineDFLTS directory, %MarineUI%\DFLTS.

Marine Module Name Description


Outfitting Design DES-VNET-ITEMS AVEVA NET Outfitting Design Item Types
for inclusion
SPOOLER SPL-VNET-ITEMS AVEVA NET SPOOLER Item Types for
inclusion

In order to keep standard (AVEVA) and user configurations separate, there can be separate
DES-VNET-ITEMS and SPL-VNET-ITEMS files placed in the standard Outfitting defaults

© Copyright 1974 to current year. 2:9 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

areas. By default any user inclusion files found in default directories will override the
supplied/standard inclusions file.
User inclusion files should have the same file name, and be placed into the following places,
depending on the company standards for defaults. (This is standard to all other Outfitting
defaults file configurations).
• The OutfittingDFLTS directory holds company exclusions, which are available to all
projects.
• The ABCDFLTS directory (where ABC is the project name) holds exclusions specific to
one project.
• The OutfittingUSER directory holds exclusions specific to a single user.

2.4.1 Default Outfitting Design Items Selection Configuration File


The default exclusion is controlled by the defaults file DES-VNET-ITEMS. It contains
something like:
...
--Begin
ZONE
PIPE
BRAN with (TYPE of OWNER neq 'HVAC')
BRAN MEMBERS with (TYPE of OWNER of BRAN neq 'HVAC' and TYPE neq 'TUBI'
and TYPE neq 'FTUB' and TYPE neq 'GASK' and TYPE neq 'FLAN' and TYPE
neq 'TEE' and TYPE neq 'WELD')
EQUI
NOZZLE
SCTN with (TYPE of OWNER neq 'TMPL')
PANEL with (TYPE of OWNER neq 'TMPL')
HVAC
HVAC MEMBERS
BRAN MEMBERS with (TYPE of OWNER of BRAN eq 'HVAC' and TYPE neq 'TUBI'
and TYPE neq 'FTUB' and TYPE neq 'STIF' and TYPE neq 'TEE')
To add Item Types\Collections that are to be exported to AVEVA NET, add the Item Type
Collection syntax to the list. Each collection must be on a new line, the file syntax can be
case-sensitive.
The order of the collections in the configuration file has no significance on the exported
data.

2.4.2 Default SPOOLER Items Selection Configuration File


The default exclusion is controlled by the defaults file SPL-VNET-ITEMS. It contains
something like:
...
--Begin
SPLDRG
To add Item Types Collections that are to be exported to AVEVA NET, add the Item Type
Collection syntax to the list. Each collection must be on a new line, the file is case-sensitive,
and they can only be collections of SPLDRG’s.
The order of the collections in the configuration file has no significance on the exported
data.

© Copyright 1974 to current year. 2:10 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

2.5 Configure Attributes to Export (Outfitting Design,


Hull Design and SPOOLER)
A number of attributes that items can have in Outfitting are only relevant to the users of
Outfitting, and have no context to the engineering of the Project as a whole. To export these
attributes can confuse users of AVEVA NET who do not understand Outfitting.
To define which attributes are exported there is a configuration file where the attributes that
the user wants included in the export must be defined. A file is supplied as default which has
a number of the most common Outfitting attributes listed in it which users would probably
require within AVEVA NET.

Note: Within the AVEVA NET export files, the Attributes are grouped within a Characteristic
element as Name \ Value pairs.

The configuration of the included attributes is configured by the defaults file DES-VNET-
INCLUDE. The file contains a list of Outfitting attributes in shortname format, which are to
be exported against the relevant Outfitting items. The standard file supplied with the VNET
Outfitting Gateway installation is located in the OutfittingDFLTS
directory,%OutfittingUI%\DFLTS.

Name Description
DES-VNET-INCLUDE AVEVA NET Design attributes for inclusion

In order to keep standard (AVEVA) and user configurations separate, there can be separate
DES-VNET-INCLUDE and SPL-VNET-INCLUDE files placed in the standard Outfitting
defaults areas. By default any user inclusion files found in default directories will override
the supplied/standard inclusions file.
User inclusion files should have the same file name, and be placed into the following places,
depending on the company standards for defaults. (This is standard to all other Outfitting
defaults file configurations).
• The OutfittingDFLTS directory holds company exclusions, which are available to all
projects.
• The ABCDFLTS directory (where ABC is the project name) holds exclusions specific to
one project.
• The OutfittingUSER directory holds exclusions specific to a single user.

2.5.1 Default Attribute Inclusion Configuration File (Outfitting Design and


Hull Design)
The default exclusion is controlled by the defaults file DES-VNET-INCLUDE. It contains
something like:
...
--Begin
name
type
lock
owner
description
...

© Copyright 1974 to current year. 2:11 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

href
tref
hbore
tbore
...
cref
oriflag
posflag
Laxes
Catref
P:poss
P:pose
P:fire
P:grade
P:tctl
P:loha
P:psize
...
PIPE\pspec
PIPE\ispec
PIPE\tspec
PIPE\href
PIPE\tref

HVAC\PSPEC
HVAC\ISPEC
To add attributes whose values are to be seen within AVEVA NET, add the attribute name to
the list. Each attribute must be on a new line, the file is case-insensitive
e.g. PSPEC is the same as pSpec which is the same as Pspec.
User defined attributes (UDA’s) whose values are to be seen within AVEVA NET, add the
attribute name to the list. Each attribute must be on a new line, the file is case insensitive,
see example below, and above.
:Status
Pseudo attributes that are assigned to items are not exported unless they are listed, and
because of the different way of listing them inside Outfitting, the user must prefix the
attribute name with the following P: that is P : Attribute, an example is shown below.
P:LOHE

2.5.2 Default Attribute Inclusion Configuration File (SPOOLER)


The default exclusion is controlled by the defaults file DES-VNET-INCLUDE. It contains
something like:
...
--Begin
SPLDRG\Issued#NoStatus

2.5.3 Attributes by Item Type


To only have certain attributes exported to certain Outfitting Item Types, the user must
define the attribute in the inclusion file, prefixed by the Outfitting Item Type, and a ‘\’ slash,

© Copyright 1974 to current year. 2:12 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

that is Outfitting Item Type \ Attribute, an example is shown below, and above.
PIPE\Name

Note: If this was the only line in the include file, the user would only get a name attribute
exported against their pipes, and no other attribute.

2.5.4 Redefine the Displayed Attribute Name in AVEVA NET


The attribute description that has been defined in the Outfitting dictionary of an attribute may
not necessarily be the name that the user wants to be displayed within the AVEVA NET
portal. For example the Built attribute in Outfitting has a description in the Outfitting
dictionary of Built/Unbuilt flag, in AVEVA NET the user may want to have this displayed as
Build Status.
To redefine the description that is output for the attribute, the user needs to append the new
description after the attribute, preceded by >, that is Attribute > New Description, an
example is shown below.
Built>Build Status
This can also be applied to attributes that have been configured for specific item types, that
is Outfitting Item Type \ Attribute > New Description, an example is shown below.
PIPE>Name>Tag Number

2.5.5 Define a Default Value if Attribute is Unset


In order to output an attribute that must always have a value, if attribute exists on an item,
the user has the facility to add a default value.
To define the default value that is to be output for an unset attribute, the user needs to
append the default value to the attribute definition, prefixed by #, that is Attribute > New
Description#Default Value, examples are shown below.
Built>Build Status#Unknown
PIPE>HREF>Connected To#NotSet
The order of the attributes in the configuration file has no significance on the exported data.
To export all of the attributes for every item, the user must enter them all into the relevant
INCLUDE files,
To export NO attributes at all, rename or delete (making a backup copy first) the
configuration file in all of the Default directories that are being used by the Outfitting
installation.

2.6 Hitfile Exclusions Configuration File (Outfitting Draft)


The configuration of the hitfiles’ contents is configured by the defaults file DRA-VNET-
EXCLUDE. The file contains a list of Outfitting items types to be excluded from the
generated files. The standard file supplied with the AVEVA NET Outfitting Gateway
installation is located in the OutfittingDFLTS directory, %OutfittingUI%\DFLTS.

Name Description
DRA-VNET-EXCLUDE VNET Outfitting Draft hitfile list of item types for exclusion

© Copyright 1974 to current year. 2:13 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

In order to keep standard (AVEVA) and user configurations separate, there can be separate
DRA-VNET-EXCLUDE files placed in the standard Outfitting defaults area’s. By default any
user exclusions files found in default directories will override the supplied/standard
exclusions file.
User exclusion files should have the same file name, and be placed into the following
places, depending on the company standards for defaults. (This is standard to all other
Outfitting defaults file configurations).
• The OutfittingDFLTS directory holds company exclusions, which are available to all
projects.
• The ABCDFLTS directory (where ABC is the project name) holds exclusions specific to
one project.
• The OutfittingUSER directory holds exclusions specific to a single user.

2.6.1 Default Outfitting Draft Exclude Configuration File


The default exclusion is controlled by the defaults file, DRA-VNET-EXCLUDE.
It contains something like:
...
--Begin
TUBI
FTUBE
...
SBFR
FRMW
U:EQUI
U:PIPE
U:BRAN
U:VALV
To add items that are not to be pick-able within AVEVA NET, add the shorthand Type
description to the list. Each type must be on a new line.
To exclude items types that are unnamed, the user can prefix U: to the Type, i.e. U: Item
Type, an example is shown above.

2.7 Create Additional AVEVA NET Associations


(OtherNames) (Outfitting Design and Hull Design)
It is possible to create additional AVEVA NET associations on the items being exported from
Outfitting by creating a PML object file called VNETxmlOtherName<Project Code>.pmlobj
and placing it in the settings folder of vnet under the Marine installations PMLLIB folder, see
Settings.
It is possible that the user needs to associate an object in Marine to another item within the
AVEVA NET project, and rather than manually create the required XML, the user can add
the associations to items as they are exported from Marine. The association must be a valid
association known to the AVEVA NET project.
An example would be that the user needs to associate an In-line Instrument FT-506 with the
Pipe 3”-15D-O-66006-BBU3.1 that it is in, as well as being labelled with just its Tag. The
identifier (Tag) on a P&ID might be of the form O-66006/FT-506 but in the Marine model and

© Copyright 1974 to current year. 2:14 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

in the AVEVA NET project the identifier of the instrument is FT-506. In Marine it is easy to
know the owning pipe so the user can set up the required syntax to add the association
when the instrument item is exported from Marine. The associated identifier is in the context
of PROJECTCONTEXT, because the identifier generated from the P&ID is in the context of
the Project, so all the user needs to do is convert the Pipe name to be the same as the
identifier on the P&ID and to concatenate the Instrument tag to it.
In the file the user can create as many associations as is needed, the result passed back to
the main appware is an array which is part of the VNETxmlOtherName<Project
Code>.pmlobj object, and it is defined in the top part of the file, see VNETxmlOtherName
Example 2.

2.7.1 VNETxmlOtherName Example 1


The XML produced by the Export appware using no OtherName Identifiers would look
something like this, for an Instrument named /FT-506
<Object>
<ID>FT-506</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
</Context>
<ClassID>FLOW TRANSMITTER</ClassID>
<Association type="is identified by">
<Object>
<ID>/FT-506</ID>
<Context>
<ID>VPD</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
<Context>
</Context>
</Object>
</Association>
<Association type="is a part of">
<Object>
<ID>3&quot;-15D-O-66006-BBU3.1/B1</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
</Context>
</Object>
</Association>
<Association type="is logically connected to">
<Object>
<ID>TEE 1 of BRANCH /3&quot;-15D-O-66006-BBU3.1/B1</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
</Context>
</Object>
</Association>
<Characteristic>
<Name>Name of the element</Name>
<Value>/FT-506</Value>
</Characteristic>
</Object>

© Copyright 1974 to current year. 2:15 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

2.7.2 VNETxmlOtherName Example 2


If the user wants to create the association to the identifier on the P&ID as described above,
the user will need to create the following PML syntax, in a file called
VNETxmlOtherName<Project Code>.pmlobj
In this example the name of the pipe is 3”-15D-O-66006-BBU3.1 and the Instrument is FT-
506:
define object VNETxmlOtherName<Project Code>
-- Used as a temporary store for the original name
member .result is string
endobject

-- End of object definition for VNETxmlOtherName<Project Code>

define method .VNETxmlOtherName<Project Code>( !object is dbref, !name is


string )

-- The !object and !name are always passed to this file, and must be
declared. You will need
-- these to do some of the naming that you require

-- Set up the result array and a temporary store


!result = array()
!tempresult = ''

-- Set up an array of Contexts you need


!context = array()
!context[1] = 'PROJECTCONTEXT'
!context[2] = 'PROJECTCONTEXT|VPD'

-- Set up an array of associations that you need


!assoctype = array()
!assoctype[1] = 'is identified by'

-- Check to see if the current item is of type INST


if ( !object.type EQ 'INST') then
-- Get the items owning pipe, if there is an error jump to the
blocks endhandle other wise
-- Do the commands in the handle none block
!ownpipe = pipe
handle none

-- Check the owning pipes name has a ‘–‘ in it and is not unset
if (!ownpipe.name.match('-') gt 0) and
(!ownpipe.name.match('unset') eq 0) then

-- Split the name on the ‘-‘


!splitname = !ownpipe.name.split('-')

-- If the size of the array created by the split is eq 5 parts then


the pipes name is
-- to be part 3 and part 4 separated by a ‘-‘ otherwise use the
original pipe name
if (!splitname.size() eq 5) then
!pipename = !splitname[3] & '-' & !splitname[4]

© Copyright 1974 to current year. 2:16 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

else
!pipename = !ownpipe.name
Endif

-- Checking the owning pipes name for a ‘–‘ failed so now check for
a ‘/’
elseif (!ownpipe.name.match('/') gt 0) then

-- Split the name on the ‘/‘


!splitname = !ownpipe.name.split('/')

-- If the size of the array created by the split is eq 4 parts then


the pipes name is
-- to be part 1 and part 2 separated by a ‘-‘ otherwise use the
original pipe name
if (!splitname.size() eq 4) then
!pipename = !splitname[1] & '-' & !splitname[2]
else
!pipename = !ownpipe.name
endif
-- Checking the owning pipes name for a ‘–‘ failed and checking for
a ‘/’ failed
-- so just use the original pipe name
else
!pipename = !ownpipe.name
endif

-- Check that name is valid


!splitname = !pipename.split('-')
!checkreal = !splitname[1].real()
handle any
elsehandle none

-- If the characters before the ‘-‘ are not strings characters then
the name is invalid
-- for a pipe so use the original pipe name
!pipename = !ownpipe.name

endhandle
endhandle

-- Create the name to be used in the association by concatenating


!pipename which
-- is the name created in this file and the !name is the Instruments
name passed to
-- this object from main Export process
!tempresult = !pipename+!name

endif

-- Check that you have a valid name and add it to the results array
of the object
if (!tempresult eq '/') or (!tempresult eq '') or (!tempresult
eq !name) then
else

© Copyright 1974 to current year. 2:17 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

!this.result[1] = !tempresult & ' ~ ' & !context[1] & ' ~ ' &
!assoc
type[1]
endif

endmethod
The result would be that for Marine objects of type INST, if the owning pipes name can be
split on ‘-‘ dashes and it breaks down into 5 items then make the name up from the 3rd (O)
and 4th (66006) components, which means that the size (3”), the area (15D) and spec
(BU3.1) of the pipe (1st, 2nd and 5th components respectively) would not be used in the
name.
If the name does not contain ‘-‘ dashes then split the name on ‘/’ backslashes. If there are 4
components then make the name up from the 1st and 2nd components. If the name does not
fall into any of these breakdowns then return the original name. (Note: that the supplied
name has already had the preceding slash removed before this method is called).
The INST items name is then concatenated on to the end of the pipename that has been
created so the user gets O-66006/FT-506. The result stored in the VNETxmlOtherName file
results array !this.result[1] would be string that looks like this:
O-66006/FT-506~PROJECTCONTEXT~is identified by
The XML produced by the Export appware with the above configuration object, the
OtherNames Identifiers would look something like this:
For a instrument named /FT-506
<Object>
<ID>FT-506</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
</Context>
<ClassID>FLOW TRANSMITTER</ClassID>
<Association type="is identified by">
<Object>
<ID>/FT-506</ID>
<Context>
<ID>VPD</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
</Context>
</Context>
</Object>
</Association>
<Association type="is identified by">
<Object>
<ID>O-66006/FT-506</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
</Context>
</Object>
</Association>
<Association type="is a part of">
<Object>

© Copyright 1974 to current year. 2:18 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

<ID>3&quot;-15D-O-66006-BBU3.1/B1</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
</Context>
</Object>
</Association>
<Association type="is logically connected to">
<Object>
<ID>TEE 1 of BRANCH /3&quot;-15D-O-66006-BBU3.1/B1</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
</Context>
</Object>
</Association>
<Characteristic>
<Name>Name of the element</Name>
<Value>/FT-506</Value>
</Characteristic>
</Object>
The difference between the original Example and this one is shown in italics.

2.8 Review Files for Assemblies


For the Review files for Assemblies the user needs to edit the Configuration File DES-
VNET-RVMTEMPLATE.xr.

© Copyright 1974 to current year. 2:19 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Configure AVEVA NET Gateway

© Copyright 1974 to current year. 2:20 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export Design Items and Properties

3 Export Design Items and Properties

To export the design items and their properties, the user needs to export them into a XML
format. To do this the user needs to run AVEVA NET Gateway from within Outfitting Design
and Hull Design.

3.1 AVEVA NET Export - Main Window


The AVEVA NET Export - Main window allows the user to select the databases from which
the items are to be exported, as well as the format of the exported data.
To display the AVEVA NET Export - Main window in Outfitting, select Utilities > AVEVA
NET Export from the main menu.
To display the AVEVA NET Export - Main window in Hull Design, select XML > Export >
AVEVA NET Export from the main menu.

© Copyright 1974 to current year. 3:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export Design Items and Properties

Control >

Save Settings Allows the user to save an Export Configuration. Refer to


Save Settings for further information.

Load Settings Allows the user to load an existing Export Configuration.


Refer to Load Settings for further information.

Close Closes the AVEVA NET Export - Main window.

Setup >

Settings Displays the AVEVA NET Export - Settings window


allowing the user to change the settings for the export.
Refer to Settings for further information.

About Displays the current version of the Gateway.

Character Encoding displays the current settings. Refer to Character Sets to Code Page
Mapping (All) for further information.

© Copyright 1974 to current year. 3:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export Design Items and Properties

Select Hierarchy To Export


If the MDB has a number of Sites, Assemblies or Manufacturing Data Sites and the user
only wants to export specific ones the user can select one of the radio buttons and then click
Change Selection to display the Item Selection window.

Select MDB and Items


The user can only select to export a MDB, which means that all the MDBs Sites are
exported unless the user selects specific Sites of the selected MDB.
To export Sites and other Outfitting Design items in Marine, the user selects Design Items
option on the AVEVA NET Export - Main window.
By default when the AVEVA NET Export - Main window is displayed the current MDB is
selected as the item to be exported. To warn the user that the whole of the MDB is selected,
the text Unset (Output all MDB) is displayed next to Change Selection.

The user can change the MDB to be exported by selecting any of the other available MDB’s
from the MDB drop-down list.

To specific which Sites are to be exported from the MDB click Change Selection to display
the AVEVA NET Export - Item Selection window.

© Copyright 1974 to current year. 3:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export Design Items and Properties

The AVEVA NET Export - Item Selection window lists all of the current MDB’s main items
in the left hand list, and the currently selected Items to Export in the right hand list.

Note: If the left hand list is empty, it denotes that the whole MDB is selected.

To add a site to be specifically exported, select the site in the left hand list, and select the `
button to move the site to the right hand list.
Or use the context sensitive right mouse pop-up menu in the Items in MDB list.

Repeat this procedure selecting all of the items to be exported.


To add all of the items, select the `` button, or use the right mouse button menu.
To remove items from the selection use the _ or the __ buttons, or use the context sensitive
right mouse button menu in the Items to Export list.

© Copyright 1974 to current year. 3:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export Design Items and Properties

After clicking OK, the AVEVA NET Export - Main window will display the text Selected xx
Item(s) (xx is the number of items selected) next to Change Selection.

To generate the output files, click Apply. The Progress frame will show which main Item is
being exported and how many items it found within that main Item to export.

A progress bar displays the progress of the task on the window and in the Main window, as
a percentage complete.

The output files will be of the form Site_<SiteName>_VPD.xml, where <SiteName> is the
name of the Outfitting Site, or Block_<BlockName>_VPD.xml, where <BlockName> is the
name of the Outfitting Block.

Note: Some characters that can be used in a Outfitting name cannot be used as characters
in a file name so these are removed or replaced with other characters in the resulting
xml file names.

Once the output files have been generated they need to be incorporated into a AVEVA NET
Staging Area, so that they can be processed by the AVEVA NET Import Controller.
Clicking Settings displays the AVEVA NET Export - Settings window. Refer to Settings for
further information.
Clicking Dismiss closes the AVEVA NET Export - Main window.

© Copyright 1974 to current year. 3:5 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export Design Items and Properties

3.2 Settings
To change the setup setting for the export, select Setup > Settings from main menu to
display the AVEVA NET Export - Settings window.

In the Pathnames for Setup Files the user sets the directory for the output files, by default
this is “%OutfittingUSER%”.
The user can also set the Mapping files that the user wants to use to output the data for
AVEVA NET, this includes Classifying Items, Renaming Items, adding an alias to an item.
By default the current Projects 3 CODE letters are used to load any mapping files that match
in a settings file.
To change the selected mapping file, the user must enter the files path and name in the
relevant text box, or the user can select the ... button, which displays a file selection dialog
box, which the user can use to navigate and select the required file. Clicking Default selects
the default file by its PROJ letters.

© Copyright 1974 to current year. 3:6 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export Design Items and Properties

Also on the Settings window, the user sets the other settings that determine the detail of the
output xml.

Include UnNamed Items in selection Selecting the check box allows the user to
select unnamed Items to be included in the
Export.

Export referenced items will for SPOOLER exports export all of the associated Outfitting
Sites that are owners of items included within the SPLDRG(s) SPOOL(s) and FIELD(s).
The following settings will remove attributes that have un-useful values to users other than
Outfitting. This is only valid if the user has included attributes in their output settings.

Include Unset values Selecting the check box removes attributes that
have values Unset.

Include Nulref (=0/0) values Selecting the check box removes attributes that
have an unreferenced DBRef.

Evaluate all Positions in WRT to /* Selecting the check box evaluates all positions
with respect to the world.

Include (E0 N0 U0) positions Selecting the check box removes attributes that
have a position of E0 N0 U0.

Include (0) values Selecting the check box removes attributes that
have a value of 0.

The user can also set the level of logging required, and whether or not the user is notified of
any attribute errors, or connection errors.
The default logging will generate a log file that reports the selection criteria that the user has
selected, and also the settings that the user has defined on this window, and also the
number of items found in each site.
Full Export Logging includes all of the information of the default log, but it also includes the
number of items found by Outfitting type, and lists all the items that are in the export files
along with information about re-classification and renaming.
To change the logfiles location, so that it is not in the same folder as the users export files,
select the ... button, which displays a folder selection dialog box, which the user can use to
navigate to and select the required folder.

© Copyright 1974 to current year. 3:7 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export Design Items and Properties

3.3 Select Assemblies to Export


To change the settings for exporting Assemblies, select Setup > Settings from main menu
to display the AVEVA NET Export - Settings window, then select the Assembly Setup file
tab to set the relevant settings.

By default the Create Assemblies Review (RVM) files and Export referenced Design
Items check boxes are selected. Create Assemblies Review (RVM) files allows graphics
files to be exported with the selected Assembly, while Export referenced Design Items
allows the export of Outfitting Design items associated with an Assembly.
Selecting the Create Assembly Review txt (RVT) files check box generates text files to be
exported with an Assembly.
By default when the AVEVA NET Export - Main window is displayed, the current MDB is
selected as the item to be exported, this means all of the Assemblies in the MDB will be

© Copyright 1974 to current year. 3:8 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export Design Items and Properties

exported. The user can either select to export an MDB, which means that all of its
Assemblies are exported, or select to export specific Assemblies of the selected MDB.
Click Assemblies on the AVEVA NET Export - Main window.

If the selected MDB has a number of Assemblies, and the user only wants to export specific
ones, the user can change the selection by clicking Change Selection to display the
AVEVA NET Export - Item Selection window. The selection process is the same as that
detailed in Select Assemblies to Export.

When the user clicks OK, the AVEVA NET Export - Main window will display a line of text
next to Change Selection indicating the number of items selected.
Clicking Apply generates the output files.
Once the output files have been generated they need to be incorporated into a AVEVA NET
Staging Area, so that they can be processed by the AVEVA NET Import Controller.

3.4 Select Manufacturing Data to Export


To change the settings for exporting Manufacturing Data, select Setup > Settings from
main menu to display the AVEVA NET Export - Settings window, then select the Design
Setup file tab to set the relevant settings.

By default when the AVEVA NET Export - Main window is displayed, the current MDB is
selected as the item to be exported, this means all of the Manufacturing Data in the MDB

© Copyright 1974 to current year. 3:9 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export Design Items and Properties

will be exported. The user can either select to export an MDB, which means that all of its
Manufacturing Data sites are exported, or select to export specific Manufacturing Data sites
of the selected MDB.
Click Manufacturing on the AVEVA NET Export - Main window.

If the selected MDB has a number of Manufacturing Data sites, and the user only wants to
export specific ones, the user can change the selection by clicking Change Selection to
display the AVEVA NET Export - Item Selection window. The selection process is the
same as that detailed in Select Assemblies to Export.

Valid Marine Manufacturing Top Items are: MBLOCK, MANPKG (defined in


!!VNETExport.ManuTypes member).
When the user clicks OK, the AVEVA NET Export - Main window will display a line of text
next to Change Selection indicating the number of items selected.
Clicking Apply generates the output files.
Once the output files have been generated they need to be incorporated into a AVEVA NET
Staging Area, so that they can be processed by the AVEVA NET Import Controller.

© Copyright 1974 to current year. 3:10 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export SPOOLER Items and Properties

4 Export SPOOLER Items and Properties

To export the SPOOLER items and their properties, the user needs to export them into a
XML format. To do this the user needs to run the AVEVA NET Gateway from within
SPOOLER.

4.1 SPOOLER Export Configuration


To change the setting for exporting SPOOLER items, select Setup > Setting from the
AVEVA NET Export - Main window to display the AVEVA NET Export - Settings window,
then select the Spooler Setup Files tab to set the relevant setting. Refer to Settings for
further information on how to change the settings.

Selecting the Include UnNamed Items in selection check box on the AVEVA NET -
Settings window allows the user to be able to select unnamed Items to be included in the
Export. When the check box is selected the item ISODEPT 1 of WORLD /* is listed.
Export referenced Design items will for SPOOLER exports, export all of the associated
Sites that are owners of items included within the SPLDRG(s) SPOOL(s) and FIELD(s).

4.2 Select ISODEP to Export


The user can only select to export a MDB, which means that all of its ISODEP’s are
exported, or the user can select specific Sites of the selected MDB.
By default when the AVEVA NET Export - Main window is displayed, the current MDB is
selected as the item to be exported, this means that all of the sites in the MDB would be
exported.

© Copyright 1974 to current year. 4:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export SPOOLER Items and Properties

To warn the user that the whole of the MDB is selected, the text “Unset (Output all MDB)” is
displayed next to Change Selection.

If the MDB is not the one to be exported, the user can change it by selecting any of the other
available MDB’s under the MDB list.
If the selected MDB has a number of Sites, and the user only wants to export specific ones,
the user can change the selection by clicking Change Selection, this will display the VNET
Export - Item Selection window.

© Copyright 1974 to current year. 4:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export SPOOLER Items and Properties

The VNET Export - Item Selection window lists all of the current MDB’s items in the left
hand list, and the currently selected Items to Export in the right hand list.

Note: If the left hand list is empty, it denotes that the whole MDB is selected.

To add and remove items to export, use the buttons `, ``, _, __ button’s or use the right
mouse button menus.
When the user clicks OK, the VNET Export - Main window will display the text “Selected XX
item(s)” (XX is the number of items selected) next to Change Selection.

To generate the output files, click Apply. The progress of each stage of the export is
displayed in the Progress frame of the VNET Export - Main window.

© Copyright 1974 to current year. 4:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export SPOOLER Items and Properties

A progress bar at the bottom of the main window displays the progress of each stage of the
task.

The output files will be of the form SPLDRG_<SPLDRGName>_VPDSPL.xml, where <


SPLDRGName > is the name of the Outfitting SPLDRG.

Note: Some characters that can be used in a Outfitting name can not be used as
characters in a file name so these are removed or replaced with other characters in
the resulting xml file names.

Once the output files have been generated they need to be incorporated into a VNET
Staging Area, so that they can be processed by the VNET Import Controller.
If the user has set the Export referenced items setting, then the referenced Design items
main items will also be exported automatically using the principles explained in Export
Design Items and Properties.

© Copyright 1974 to current year. 4:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Save and Load Export Configurations

5 Save and Load Export Configurations

From Outfitting Design and SPOOLER, the user can save and load a configuration settings
file for their AVEVA NET Export configurations that can be re-used.
The windows are accessed from the AVEVA NET Export – Main window’s Control drop-
down menu. There are two options available, Save Settings and Load Settings.

Save Settings
To save an export configuration, select Control > Save Settings from the menu bar to
display the Save Export Definition window.

© Copyright 1974 to current year. 5:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Save and Load Export Configurations

Navigate to the folder where the configuration file is to be saved, enter a filename or select
an existing file name to overwrite, by default the folder is “%OutfittingUSER%”, then click
Save.

Load Settings
To load an existing export configuration, select Control > Load Settings from the menu bar
to display the Load Export Definition window

© Copyright 1974 to current year. 5:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Save and Load Export Configurations

Navigate to the folder where configuration file has been saved, select the file, then click
Open.

Note: The user can only load a configuration file that was saved from the same module.

© Copyright 1974 to current year. 5:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Save and Load Export Configurations

© Copyright 1974 to current year. 5:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export Review Model Files for AVEVA NET

6 Export Review Model Files for AVEVA NET

Use the Outfitting Design Export command to output a Review file. This file should be
placed in an AVEVA NET Staging Area so that it can be processed by the AVEVA NET
Import Controller. The Review file can be successfully imported into AVEVA NET without a
Review Status file. Alternatively, it can be accompanied by a standard Status File, supplied
with the AVEVA NET release, or a custom Status file created for the project.

6.1 Settings to Enable AVEVA NET SPOOL Highlighting


When exporting Review Models that are to be used in conjunction with the AVEVA NET
Spool highlighting functionality, the exported Review models must have some settings that
are not normally used.
The Implied Tubing must be set to Separate. Select Utilities > Export > Create to display
the Export window.

Click Representation to display the Export Representations window.

© Copyright 1974 to current year. 6:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export Review Model Files for AVEVA NET

Select Separate from the Implied Tube drop-down list.


The reason that this is required is because SPLDRG’s are a secondary hierarchy within
Marine and the Review model file does not actually contain this hierarchy. Because the
SPOOL’s and FIELD’s of a SPLDRG can break in to the middle of a pipe’s Implied Tubing
the user needs to export each Separate piece of tubing as a separate Review graphical
object, and by default Marine Export will export the Implied Tube between components as
one graphical item. To enable AVEVA NET to highlight the individual components of the
SPLDRG, the Implied Tubing must be exported as separate parts. If this option is not set, no
Spools will be visible within the AVEVA NET application.

© Copyright 1974 to current year. 6:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export DRAFT Drawings

7 Export DRAFT Drawings

In AVEVA NET, DRAFT drawings can be made pickable in the same way as Marine
Isometrics currently are, if they are generated with hitfiles.
Configuring the output is explained in Hitfile Exclusions Configuration File (Outfitting Draft).

7.1 Plotting DRAFT Drawings for VNET


The standard DRAFT Plot Sheet window has been modified with the inclusion of an extra
option to allow the user to select whether or not hitfiles are generated when a plot file is
generated. The option is AVEVA NET files, and when this is selected, this means that if the
selected output target is either File or File & Plotter, then a hitfile will also be generated, if
there are valid items on the Sheet or View.

7.2 Batch Plotting


If there is a requirement to batch plot a number of Draft drawing sheets, there are a couple
of useful utilities supplied. The first will plot all of the drawing sheets in the current MDB. The

© Copyright 1974 to current year. 7:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export DRAFT Drawings

second is an object that can be added to a batch script file, to also generate a hitfile for a
plotfile.

Batch Plotting Function


The first utility is a function that will navigate to the world ( /* ) and plot off all the sheets
under it along with the relevant hitfiles, using which ever defaults file is appropriately set up
to be used.
To call the function the user must firstly be in a Outfitting Draft database, then open a Marine
command window, and in it type the following command.
!!VNETExportAllSheets()
This will then invoke the function VNETExportAllSheets.pmlfnc, and all of the sheets will
be plotted. To change the size of drawings, or any other of the plotting default setting modify
the file.

Batch Plotting using a Script file


If the user batch plots Outfitting Draft drawings using a script file, the user can add a call that
will generate the hitfile for the sheet or view. The object will only plot if the current object that
it is called from is either a Outfitting Draft Sheet of View.
To call the hitfile generating object from a script file add the following line to the file, after a
plot file has been plotted.
!a = object VNETNETWriteHit('<Directory>', '<Filename>','BATCH')
Where:

<Directory> is the directory where the plot files are being placed.
<Filename> is the plot file name without a file extension

For example a batch file that plotted a number of sheets may look like this:
/STAB00001/S1
PLOT SHEE FILE /%PDMSUSER%/STAB00001.S1.PLT OVER
/STAB00002/S1
PLOT SHEE FILE /%PDMSUSER%/STAB00002.S1.PLT OVER
/STAB00003/S1
PLOT SHEE FILE /%PDMSUSER%/STAB00003.S1.PLT OVER
/STAB00004/S1
PLOT SHEE FILE /%PDMSUSER%/STAB00004.S1.PLT OVER
This would generate four plot files in the directory pointed to by the environment variable
PDMSUSER.
If the user wants to create a hitfile as well for each of the plotfiles the user would need to
modify the file with a call to the object, as shown below, the new lines are shown in italic:
/STAB00001/S1
PLOT SHEE FILE /%PDMSUSER%/STAB00001.S1.PLT OVER
!a = object VNETWriteHit('%PDMSUSER%', 'STAB00001.S1','BATCH')
/STAB00002/S1
PLOT SHEE FILE /%PDMSUSER%/STAB00002.S1.PLT OVER
!a = object VNETWriteHit('%PDMSUSER%', 'STAB00002.S1','BATCH')

© Copyright 1974 to current year. 7:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export DRAFT Drawings

/STAB00003/S1
PLOT SHEE FILE /%PDMSUSER%/STAB00003.S1.PLT OVER
!a = object VNETWriteHit('%PDMSUSER%', 'STAB00003.S1','BATCH')
/STAB00003/S1
PLOT SHEE FILE /%PDMSUSER%/STAB00004.S1.PLT OVER
!a = object VNETWriteHit('%PDMSUSER%', 'STAB00004.S1','BATCH')

© Copyright 1974 to current year. 7:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export DRAFT Drawings

© Copyright 1974 to current year. 7:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export Isometrics and Spool Isometrics

8 Export Isometrics and Spool Isometrics

All the pre-generated isometrics must have been generated by Outfitting Design ISODRAFT
with the HYPERPLANT ISOMETRIC FILES option set. This will ensure that when Isometric
plotfiles are generated, the corresponding hitfiles with suffix ‘.hit’, and the AVEVA NET
registry files with suffix ‘.xml’ are generated, in the same output directory. The AVEVA NET
software relies on the fact that these suffixes are present.
A hitfile indicates the position and name of specific Outfitting Design items which appear on
the corresponding plotfile.
The hitfile is processed by the AVEVA NET Import Controller so that Plant items on the
Isometric are pickable and also so that AVEVA NET can set-up associations between the
Isometric and the Plant item objects within the AVEVA NET Database.
The AVEVA NET file associates the pipe in the isometric with the plotfile. The name of the
pipe is generated using the AVEVA NET Gateways notion of an identifier, which may be
different from the actual Outfitting Design items name. Configuring the naming of Marine
Items (including Pipes) is explained in User-Defined Identifiers for Outfitting Objects
(Outfitting Design, Hull Design and ISODRAFT).

8.1 Configure Outfitting ISODRAFT for AVEVA NET


It is assumed that the user has loaded Outfitting Design, and have entered the ISODRAFT
module.
From the main menu, select the Options drop-down menu, and either select Create to
create a new options file, or select Modify.

If the user has selected to modify a previously defined options file, select the file to be
modified.

© Copyright 1974 to current year. 8:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export Isometrics and Spool Isometrics

The section where the Hyperplant file options can be found is under the Administrative
functional area.

Click Administrative to display the Administrative Options window. Select the


Hyperplant files check box to export the hitfiles for the Isometrics that are to be produced.

8.2 Example AVEVA NET .xml Output File for an


Isometric
The following is an example of a AVEVA NET .xml file that would be produced, if the user
were using the user-Defined Identifier configuration object as explained in
VNETxmlOrigName Example 2, and the user has the ISODRAFT setting “Plotfiles renamed
based on the drawing name” set (: ), then the resulting .vnet file for pipe /6”-AI-502100-AB3

© Copyright 1974 to current year. 8:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export Isometrics and Spool Isometrics

would be.
<vl:VNETList xmlns:vl="http://www.aveva.com/VNET/List" xmlns="http:
//www.aveva.com/VNET/eiwm">
<Template>
<ID>VPD ISO Association 6"-AI-502100-AB3</ID>
<Object>
<ID>AI-502100</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
</Context>
<Association type="is referenced in">
<Object>
<ID>6-AI-502100-AB3_Sht_1</ID>
<Context>
<ID>VPD</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
</Context>
</Context>
</Object>
</Association>
</Object>
</Template>
</vl:VNETList>

8.3 Example AVEVA NET .xml File Output for a Spool


Isometric
The difference between a Isometric AVEVA NET xml file and a Spool Isometric AVEVA NET
xml file is that the Spool Isometric has an extra association on it that references it back to
the associated SPLDRGs.
The following is an example of a AVEVA NET .xml file that would be produced, if the user
was using the user-Defined Identifier configuration object as explained in
VNETxmlOrigName Example 2, and the user has the ISODRAFT setting “Plotfiles renamed
based on the drawing name” set (: ), then the resulting .vnet file for pipe /502100 would be:
<vl:VNETList xmlns:vl="http://www.aveva.com/VNET/List"
xmlns="http://www.aveva.com/VNET/eiwm">
<Template>
<ID>VPD ISOSPL Association for 502100</ID>
<Object>
<ID>502100</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
</Context>
<Association type="is referenced in">
<Object>
<ID>502100_Sht_1</ID>
<Context>
<ID>VPD</ID>
<Context>
<ID>PROJECTCONTEXT</ID>

© Copyright 1974 to current year. 8:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
Export Isometrics and Spool Isometrics

</Context>
</Context>
</Object>
</Association>
</Object>
<Object>
<ID>AI-502100</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
</Context>
<Association type="is referenced in">
<Object>
<ID>502100_Sht_1</ID>
<Context>
<ID>VPD</ID>
<Context>
<ID>PROJECTCONTEXT</ID>
</Context>
</Context>
</Object>
</Association>
</Object>
</Template>
</vl:VNETList>

© Copyright 1974 to current year. 8:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
AVEVA NET SPOOLER Breakdown Nodes

9 AVEVA NET SPOOLER Breakdown Nodes

To view SPOOLER information in AVEVA NET the user needs to add some extra
Breakdown Node configurations to the AVEVA NET Portal. The example shown will extend
the Default Asset Breakdown node, but the same principle can be used on any user defined
Breakdown Node’s.
If the user has used the default AVEVA classifications as shown in Default System
Classification of Items the user will have the Outfitting Design items classified thus:
PIPE+Pipeline

ISOREG+WorkPack
SPLDRG+SpoolDrawing
SPOOL+Spool
FIELD+Weld
The user will probably want to have a breakdown that will allow the user to expand the
Workpack’s, to see what SpoolDrawing’s are associated with the Workpack. Then the
user will then want to expand the SpoolDrawing’s to see the associated Pipeline’s,
Spool’s and Weld’s, as shown here.
Project
+---Assets
¦ +---SpoolDrawings
¦ ¦ +---Pipelines
¦ ¦ +---Spools
¦ ¦ +---Welds
¦ ¦
¦ +---Workpacks
¦ +---SpoolDrawings
¦ +---Pipelines
¦ +---Spools
¦ +---Welds
To do this the user must have the role of Administrator within the AVEVA NET Portal. Then
the user will need to customise the Enterprise Explorer Web Part, details on how to do this
can be found in the AVEVA NET Administration Guide. Under the Administrator functions,
the user will need to select the Configure Breakdown nodes...
Select the DefaultAssetBreakdown node which is the one that we are going to modify, and
then in the section of the window Breakdown node expansion from instances add the
following information
For items of class Workpack use associations is a collection including.

© Copyright 1974 to current year. 9:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
AVEVA NET SPOOLER Breakdown Nodes

For items of class SpoolDrawing use associations is an assembly including and also is
associated with.
The window should look like this:

Figure 9:1. Configure Breakdown Nodes

Save the node properties, and then save the settings and then when the user goes back to
the Portal the Asset breakdown node will expand as:

© Copyright 1974 to current year. 9:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
AVEVA NET SPOOLER Breakdown Nodes

Figure 9:2. VNET Portal Expansion

© Copyright 1974 to current year. 9:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
AVEVA NET SPOOLER Breakdown Nodes

© Copyright 1974 to current year. 9:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
AVEVA NET Assembly Breakdown Nodes

10 AVEVA NET Assembly Breakdown Nodes

To view Assemblies information in AVEVA NET the user needs to add some extra
Breakdown Node configurations to the AVEVA NET Portal. The example shown will extend
the Default Asset Breakdown node, but the same principle can be used on any user defined
Breakdown Node’s.
If the user has used the default AVEVA classifications as shown in Default System
Classification of Items, the user will have the items classified thus:
PIPE+Pipeline

ASWL+Assembly
ASMBLY+Assembly
BLOCK+Block
HSTIFF+Hstiff
HPANBO+Hpanbo
HPANEL+Hpanel
HPLATE+Hplate

Otherwise+Component
The user will probably want to have a breakdown that will allow the user to expand the
Assemblies, to see how the Assemblies come together to create the completed Assembly
Project
+---Assemblies
¦ +---Assemblies
¦ ¦ +---Assemblies
¦ ¦ +---Assemblies
¦ ¦ +---Assemblies
¦ ¦
To do this the user must have the role of Administrator within the VNET Portal. Then the
user will need to customise the Enterprise Explorer Web Part, details on how to do this can
be found in the AVEVA NET Administration Guide. Under the Administrator functions, the
user will need to select the Configure Breakdown nodes... .
Create a new node called AssemblyBreakdown, and in the section Breakdown node
properties add the following information, Displayed label Assembly, and a Displayed
tooltip Assemblies. Set the Expansion type to By Entry No Class.
Show items of class Assembly using associations from root is an assembly including.
In the section of the window Breakdown node expansion from instances add the
following information.
Set the By default use associations to expand to is a collection including.

© Copyright 1974 to current year. 10:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
AVEVA NET Assembly Breakdown Nodes

For items of class Assembly use associations is a collection including and is an assembly
including.
The window should look like this:

Figure 10:1. Configure Breakdown Nodes

Save the node properties, and close the window.


Under the section Breakdown nodes select the new AssemblyBreakdown node using the
Ctrl key to add it to the selection of nodes that will be displayed, as shown below.

Figure 10:2. Selecting the Assembly Breakdown node for display

Then save the settings and then when the user goes back to the Portal the Asset
breakdown node will expand as:

© Copyright 1974 to current year. 10:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
AVEVA NET Assembly Breakdown Nodes

Figure 10:3. VNET Portal Expansion

© Copyright 1974 to current year. 10:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
AVEVA NET Assembly Breakdown Nodes

© Copyright 1974 to current year. 10:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
AVEVA NET Gateway Files

11 AVEVA NET Gateway Files

11.1 AVEVA NET Gateway Files 11.5


The following files are installed by the installation program, into the current installations
Marine directory structure.
Directory structures that will already exist in the Marine directories are shown in bold
italics, and files that are overwritten or modified are shown in bold. All other files are
specific to the AVEVA NET Gateway.
<Outfitting Directory>
+---OutfittingUI
¦ +---DFLTS
¦ ¦ DES-VNET-INCLUDE
¦ ¦ DES-VNET-ITEMS
¦ ¦ DRA-VNET-EXCLUDE
¦ ¦ SPL-VNET-INCLUDE
¦ ¦ SPL-VNET-ITEMS
¦ ¦ SPL-VNET-TOLERANCE
¦ ¦ VNET-CHAR-ENCODE
¦ +---DRA
¦ ¦ +---GEN
¦ ¦ FPLOTIT
¦ ¦ MPLOTIT
¦ +---ISO
¦ +---GEN
¦ RMESS
+---PMLLIB
+---vnet
+---forms
¦ VNETdirbrowser.pmlfrm
¦ VNETExport.pmlfrm
¦ VNETxlist.pmlfrm
¦ VNETxsettings.pmlfrm
¦
+---functions
¦ VNETCharEncode.pmlfnc
¦ VNETCharactAttrs.pmlfnc
¦ VNETdirbrowser.pmlfnc
¦ VNETdirbrowserdir.pmlfnc
¦ VNETDefaultsExist.pmlfnc
¦ VNETExportAllSheets.pmlfnc

© Copyright 1974 to current year. 11:1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
AVEVA NET Gateway Files

¦ VNETfilebrowser.pmlfnc
¦ VNETFileName.pmlfnc
¦ VNETLoadAttrib.pmlfnc
¦ VNETLoadItems.pmlfnc
¦ VNETLoadXMLEncode.pmlfnc
¦ VNETLogTime.pmlfnc
¦ VNETsetupfile.pmlfnc
¦ VNETStripName.pmlfnc
¦ VNETStripXML.pmlfnc
¦
+---objects
¦ VNETDMEExportISO.pmlobj
¦ VNETEncodingStore.pmlobj
¦ VNETErrorStore.pmlobj
¦ VNETGetAttributes.pmlobj
¦ VNETISOBatchExport.pmlobj
¦ VNETISOBatchxsettings.pmlobj
¦ VNETlog.pmlobj
¦ VNETOriginalID.pmlobj
¦ VNETSpool.pmlobj
¦ VNETWriteHit.pmlobj
¦ VNETWriteISOXML.pmlobj
¦ VNETWriteSPLXML.pmlobj
¦ VNETWriteXML.pmlobj
¦
+---settings
AVEVA-Classify.pmlmac
Def-Classify.pmlmac
VNETUserClass.pmlobj
VNETUserClassIMP.pmlobj
VNETUserClassSAM.pmlobj
VNETxmlOrigNameIMP.pmlobj
VNETxmlOrigNameSAM.pmlobj

© Copyright 1974 to current year. 11:2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
AVEVA NET Gateway Files

11.2 AVEVA NET Gateway Files Outfitting11.6


All of the files in AVEVA NET Gateway Files 11.5 are installed along with these additional
files.
Directory structures that will already exist in the Marine directories are shown in bold italics,
and files that are overwritten or modified are shown in bold. All other files are specific to this
version of Marine.
<Outfitting Directory>
+---OutfittingUI
¦ +---DES
¦ ¦ +---ADDINS
¦ ¦ VNET
¦ +---DRA
¦ ¦ +---GEN
¦ ¦ FPLOTIT
¦ ¦ MPLOTIT
¦ +---SPL
¦ +---ADDINS
¦ VNET
+---PMLLIB
+---vnet
+---forms
¦ VNETExport.pmlfrm
¦ VNETxsettings.pmlfrm
¦
+---objects
appVNET.pmlobj
appVNETSPL.pmlobj

11.3 AVEVA NET Gateway Files Outfitting12


All of the files in AVEVA NET Gateway Files 11.5 are installed along with these additional
files.
Directory structures that will already exist in the Marine directories are shown in bold
italics, and files that are overwritten or modified are shown in bold. All other files are
specific to this version Marine.

© Copyright 1974 to current year. 11:3 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide
AVEVA NET Gateway Files

<Outfitting Directory>
+---AVEVA.Marine.UI.HullVNET.uic
¦
+---OutfittingUI
¦ +---DES
¦ ¦ +---ADDINS
¦ ¦ VNET
¦ +---DFLTS
¦ ¦ DES-VNET-INCLUDE
¦ ¦ DES-VNET-ITEMS
¦ ¦ DES-VNET-RVMTEMPLATE.xr
¦ +---DRA
¦ ¦ +---GEN
¦ ¦ FPLOTIT
¦ ¦ MPLOTIT
¦ +---SPL
¦ +---ADDINS
¦ VNET
+---PMLLIB
+---vnet
+---forms
¦ VNETExport.pmlfrm
¦ VNETxlist.pmlfrm
¦ VNETxsettings.pmlfrm
¦
+---functions
¦ VNETassemrvm.pmlfnc
¦ VNETDefaultsExist.pmlfnc
¦ VNETLinkDocs.pmlfnc
¦ VNETsetupfile.pmlfnc
¦
+---objects
¦ appVNET.pmlobj
¦ appVNETSPL.pmlobj
¦ VNETAssembly.pmlobj
¦ VNETAssemblyStore.pmlobj
¦ VNETWriteASMXML.pmlobj
¦ VNETWriteSPLXML.pmlobj
¦ VNETWriteXML.pmlobj
¦
+---settings
AVEVA-Classify.pmlmac
Def-Classify.pmlmac

© Copyright 1974 to current year. 11:4 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide

Index

A Default SPOOLER Items Selection Configura-


tion File . . . . . . . . . . . . . . . . . . 2:10
Additional AVEVA NET Associations Default System Classification of Items . . 2:3
creating . . . . . . . . . . . . . . . . . . . . . . 2:14 Default Value
Assemblies defining if Attribute is Unset . . . . . . 2:13
selecting to export . . . . . . . . . . . . . . 3:8 Displayed Attribute Name
Attributes redefining in AVEVA NET . . . . . . . 2:13
by Item Type . . . . . . . . . . . . . . . . . . 2:12
configuring to export . . . . . . . . . . . . 2:11
AVEVA NET PDMS/Marine Gateway
H
configuring . . . . . . . . . . . . . . . . . . . . 2:1 Hitfile Exclusions Configuration File . . . 2:13
AVEVA NET Spool Highlighting Hull Design
settings to enable . . . . . . . . . . . . . . . 6:1 classification mapping . . . . . . . . . . . 2:3
configuring attributes to export . . . 2:11
B creating additional AVEVA NET associa-
tions . . . . . . . . . . . . . . . . . 2:14
Batch Plotting . . . . . . . . . . . . . . . . . . . . . 7:1 Default Attribute Inclusion Configuration File
Function . . . . . . . . . . . . . . . . . . . . . . 7:2 2:11
using a Script file . . . . . . . . . . . . . . . 7:2 selecting items to export . . . . . . . . . 2:9
user-defined identifiers for PDMS objects
C 2:7

Character Sets to Code Page Mapping . 2:1


Classification Mapping . . . . . . . . . . . . . . 2:3 I
ISODRAFT
D user-defined identifiers for PDMS objects
2:7
Default Attribute Inclusion Configuration File Isometrics
2:11, 2:12 exporting . . . . . . . . . . . . . . . . . . . . . 8:1
Default Character Set Mapping . . . . . . . . 2:2
Default Design Items Selection Configuration
File . . . . . . . . . . . . . . . . . . . . . . 2:10 O
Default DRAFT Exclude Configuration File 2:14 Outfitting
Default Outfitting Items Selection Configuration
File . . . . . . . . . . . . . . . . . . . . . . 2:10 user-defined identifiers for PDMS ob-

© Copyright 1974 to current year. Index page 1 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA NET Gateway Administrator Guide

jects . . . . . . . . . . . . . . . . 2:7
classification mapping . . . . . . . . . . . 2:3
configuring attributes to export . . . . 2:11
creating additional AVEVA NET associa-
tions . . . . . . . . . . . . . . . . . . 2:14
Default Attribute Inclusion Configuration File
2:11
selecting items to export . . . . . . . . . . 2:9
OutfittingDRAFT
Hitfile Exclusions Configuration File 2:13
OutfittingDRAFT Drawings
exporting . . . . . . . . . . . . . . . . . . . . . . 7:1
plotting for VNET . . . . . . . . . . . . . . . 7:1

P
PDMS ISODEP
selecting to export . . . . . . . . . . . . . . 4:1
PDMS ISODRAFT
configuring for VNET . . . . . . . . . . . . 8:1

R
Review Files for Assemblies . . . . . . . . . 2:19
Review Model Files for AVEVA NET
exporting . . . . . . . . . . . . . . . . . . . . . . 6:1

S
Selecting Items to Export . . . . . . . . . . . . 2:9
Spool Isometrics
exporting . . . . . . . . . . . . . . . . . . . . . . 8:1
SPOOLER
classification mapping . . . . . . . . . . . 2:3
configuring attributes to export . . . . 2:11
Default Attribute Inclusion Configuration File
2:12
exporting items and properties . . . . . 4:1
selecting items to export . . . . . . . . . . 2:9

U
User Defined Classification of Items . . . . 2:4

V
VNET Assembly Breakdown Nodes . . . 10:1
VNET Export - Main Form . . . . . . . . . . . . 3:1
VNET PDMS Gateway Files PDMS11.5 11:1
VNET PDMS Gateway Files PDMS11.6 11:3
VNET PDMS Gateway Files PDMS12 . 11:3
VNET SPOOLER Breakdown Nodes . . . 9:1

© Copyright 1974 to current year. Index page 2 12 Series


AVEVA Solutions Limited and its subsidiaries.
All rights reserved.

You might also like