Professional Documents
Culture Documents
Administrator Guide
Disclaimer
1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free from
viruses.
1.2 AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar losses; loss of
anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of data or information; any
special, indirect, consequential or pure economic loss, costs, damages, charges or expenses which may be
suffered by the user, including any loss suffered by the user resulting from the inaccuracy or invalidity of any data
created by the AVEVA software, irrespective of whether such losses are suffered directly or indirectly, or arise in
contract, tort (including negligence) or otherwise.
1.3 AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with the
performance of the AVEVA software shall be limited to 100% of the licence fees paid in the year in which the user's
claim is brought.
1.4 Clauses 1.1 to 1.3 shall apply to the fullest extent permissible at law.
1.5 In the event of any conflict between the above clauses and the analogous clauses in the software licence under
which the AVEVA software was purchased, the clauses in the software licence shall take precedence.
Copyright
Copyright and all other intellectual property rights in this manual and the associated software, and every part of it
(including source code, object code, any data contained in it, the manual and any other documentation supplied
with it) belongs to, or is validly licensed by, AVEVA Solutions Limited or its subsidiaries.
All rights are reserved to AVEVA Solutions Limited and its subsidiaries. The information contained in this document
is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or transmitted without
the prior written permission of AVEVA Solutions Limited. Where such permission is granted, it expressly requires
that this copyright notice, and the above disclaimer, is prominently displayed at the beginning of every copy that is
made.
The manual and associated documentation may not be adapted, reproduced, or copied, in any material or
electronic form, without the prior written permission of AVEVA Solutions Limited. The user may not reverse
engineer, decompile, copy, or adapt the software. Neither the whole, nor part of the software described in this
publication may be incorporated into any third-party software, product, machine, or system without the prior written
permission of AVEVA Solutions Limited, save as permitted by law. Any such unauthorised action is strictly
prohibited, and may give rise to civil liabilities and criminal prosecution.
The AVEVA software described in this guide is to be installed and operated strictly in accordance with the terms
and conditions of the respective software licences, and in accordance with the relevant User Documentation.
Unauthorised or unlicensed use of the software is strictly prohibited.
© 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
Contents Page
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.
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.
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.
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
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.
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.
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"?>
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.
endobject
-- End of object definition for VNETUserClass<Project Code>()
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')
!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
-- 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
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>
endobject
-- End of object definition for .VNETUserClass<Project Code>()
!this.return '$!result'
endmethod
-- End of method definition for .VNETUserClass<Project Code>()
-- 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
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.
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&-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.
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
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.
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.
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
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.
Name Description
DRA-VNET-EXCLUDE VNET Outfitting Draft hitfile list of item types for exclusion
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.
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.
-- 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
-- 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
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
-- 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
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
!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>
<ID>3"-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"-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.
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.
Control >
Setup >
Character Encoding displays the current settings. Refer to Character Sets to Code Page
Mapping (All) for further information.
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.
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.
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.
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.
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.
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
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.
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
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.
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.
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).
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.
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.
A progress bar at the bottom of the main window displays the progress of each stage of the
task.
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.
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.
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
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.
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.
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).
second is an object that can be added to a batch script file, to also generate a hitfile for a
plotfile.
<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')
/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')
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).
If the user has selected to modify a previously defined options file, select the file to be
modified.
The section where the Hyperplant file options can be found is under the Administrative
functional area.
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>
</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>
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.
For items of class SpoolDrawing use associations is an assembly including and also is
associated with.
The window should look like this:
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:
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.
For items of class Assembly use associations is a collection including and is an assembly
including.
The window should look like this:
Then save the settings and then when the user goes back to the Portal the Asset
breakdown node will expand as:
¦ 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
<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
Index
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