Professional Documents
Culture Documents
Area Based ADP
Area Based ADP
Administrator Guide
Disclaimer
Information of a technical nature, and particulars of the product and its use, is given by AVEVA
Solutions Ltd and its subsidiaries without warranty. AVEVA Solutions Ltd and its subsidiaries disclaim
any and all warranties and conditions, expressed or implied, to the fullest extent permitted by law.
Neither the author nor AVEVA Solutions Ltd, or any of its subsidiaries, shall be liable to any person or
entity for any actions, claims, loss or damage arising from the use or possession of any information,
particulars, or errors in this publication, or any incorrect use of the product, whatsoever.
Copyright
Copyright and all other intellectual property rights in this manual and the associated software, and every
part of it (including source code, object code, any data contained in it, the manual and any other
documentation supplied with it) belongs to AVEVA Solutions Ltd or its subsidiaries.
All other rights are reserved to AVEVA Solutions Ltd and its subsidiaries. The information contained in
this document is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval
system, or transmitted without the prior written permission of AVEVA Solutions Ltd. Where such
permission is granted, it expressly requires that this Disclaimer and Copyright notice is prominently
displayed at the beginning of every copy that is made.
The manual and associated documentation may not be adapted, reproduced, or copied, in any material
or electronic form, without the prior written permission of AVEVA Solutions Ltd. The user may also not
reverse engineer, decompile, copy, or adapt the associated software. Neither the whole, nor part of the
product described in this publication may be incorporated into any third-party software, product,
machine, or system without the prior written permission of AVEVA Solutions Ltd, save as permitted by
law. Any such unauthorised action is strictly prohibited, and may give rise to civil liabilities and criminal
prosecution.
The AVEVA products described in this guide are to be installed and operated strictly in accordance with
the terms and conditions of the respective license agreements, and in accordance with the relevant
User Documentation. Unauthorised or unlicensed use of the product is strictly prohibited.
First published September 2007
AVEVA Solutions Ltd, and its subsidiaries
AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom
Trademarks
AVEVA and Tribon are registered trademarks of AVEVA Solutions Ltd or its subsidiaries. Unauthorised
use of the AVEVA or Tribon trademarks is strictly forbidden.
AVEVA product names are trademarks or registered trademarks of AVEVA Solutions Ltd or its
subsidiaries, registered in the UK, Europe and other countries (worldwide).
The copyright, trade mark rights, or other intellectual property rights in any other product, its name or
logo belongs to its respective owner.
Contents
Page
Administrator Guide
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Role of the ABA Drafting Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Setting Up Administrative Access Rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2
3:6
3:8
3:8
3:8
12.0
3:22
3:22
3:25
3:26
Browsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:39
Browse Existing Drawings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:39
Stored Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:41
Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B:1
Name Lengths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B:1
Rule Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B:1
Tasks and Symbol Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B:1
ii
12.0
Introduction
Area Based ADP (Automatic Drawing Production) can be used with either AVEVA Plant or
AVEVA Marine (henceforth known as the base product in this document).
Area Based ADP (henceforth known as the ABA in this document) does not work with the
Hull Drafting Module of AVEVA Marine.
The purpose of this document is to provide the ABA administrator with guidance on how to
organise the application to enable the user to easily produce drawings from the 3D model.
It is assumed that the administrator is an experienced user of the DRAFT module and this is
reflected in the terminology used in this guide. All terms are fully described in the
Administrator Application User Guide and the User Guide for this module.
ABA allows a user to produce drawings by selecting predefined physical box volumes
(known as areas) and matching them to a template that describes the format of the drawing
to be produced.
As ABA Drafting administrator, you are responsible for setting up the libraries for these
templates. Setup involves the definition of labelling rules, the classification of discipline
based drawing contents, and the construction of drawing tasks. The latter is defined as any
activity applied to a drawing, such as the creation of a North arrow, or the plotting of a
drawing.
You can create new libraries, or edit the content of existing libraries, so that the standard
data available to individual users complies with a company's requirements for drafting
functions. This includes the definition of areas, the configuration of the drawing number, the
building of key plans, and the maintenance of drawing symbols.
1.1
Library pointers
Drawing Scales
Libraries
You will be responsible for controlling the following types of library:
1:1
12.0
Drawing Templates
Area definitions
Classifications
Key plans
Symbols
Labelling
Tasks
Scales
There are a series of pre-determined drawing scales used during drawing production. You
may remove any of the scales that do not adhere to your company standards.
Symbol Templates
There are pointers to the supplied symbols used during the drawing production. You may
modify these to refer to any other suitable symbols.
Log File Output
The location of output files produced during drawing production.
1.2
1:2
12.0
2:1
12.0
2:2
12.0
3.1
3:1
12.0
3.2
ABA Defaults
The administrator can customise many aspects of ABA, including library location, permitted
drawing scales, and output location. Configure these within the defaults file and defaults
form.
3.2.1
3.2.2
Section 1
Labelled General Defaults For Area Based ADP Use. This defines
the information covered in the ABA defaults form (see ABA Defaults
Form).
Section 2
Section 3
Section 5
Section 6
Labelled Metric Paper Sizes specify the paper sizes available to the
user.
The default setup assumes a single defaults file and a single set of ABA libraries. However,
it is possible to create several defaults files and accompanying libraries; one for each
discipline. A user could then access a specific defaults file and hence reference the libraries
defined for a specific discipline.
When a user accesses a new defaults file, a record of it is saved in the %PDMSUSER%/
aba_defaults file. This file is loaded on entry to the ABA application and removes the need
3:2
12.0
to set the defaults form on each and every entry. If you organise a multi-discipline project
and you want this to function, consider a PDMSUSER environment for each user.
To have different defaults across different projects, determine a location for separate
defaults files, and modify the location path for each project. Each project default file can
then, in turn, reference differently named libraries if so required.
Select Settings > Area Based ADP Defaults to display the ABA Defaults form.
Use the menu options File > Save or File > Load to save or load the default settings to, or
from, the defaults file.
To define the location of the libraries, type the location in the relevant field, or navigate to it
in the members list and click CE.
The hierarchy is checked every time the defaults form is loaded to ensure that all libraries
are correctly located. If this is not the case the 'face' button does not smile, and the
hierarchy must be checked to find the problem.
Note: The use of this form in the installation of ABA is covered in the ABA Installation
Guide.
The fields in the defaults form are as follows:
Defaults file
Specifies the location directory and name of the defaults file used
to store the ABA default settings.
Library
The top-level LIBY element which holds all the required ABA
administrative elements.
3:3
12.0
Template
Area
This can be a LIBY or DLLB to hold all the IDLI (ID List) elements
that store the physical limit co-ordinates for each of the ABA
geographical areas. Using a LIBY enables multiple DLLBs to be
used to split areas by discipline.
Classification
A LIBY or DLLB used to contain all the IDLI elements for each
ABA classification.
Keyplans
Symbols
Labelling
A TRLB is a tag-rule library that contains all the ABA tag rules.
Tasks
Create Hierarchy
Note: This only detects the existence of the LIBY, but not the
elements contained within it
To create the hierarchy specified in the defaults form, click the
button and select a db from the Create Aba Hierarchy form that
appears.
The previously mentioned process will also create some initial
SYMBol elements. The button icon will then turn to
indicates that the structure is OK.
3:4
, which
12.0
Logfile Location
Batchfile Location
To alter the default settings for the batch user click the Batch User button. The Batch
Username and Password form is displayed.
On this form:
User Name
Specifies the name of the user that will enter AVEVA the base
product.
Password
3.3
3:5
12.0
3.4
3.4.1
3:6
12.0
3:7
12.0
The form works in the same manner as the members list. Items may be added to the
area using the button or removed from the area using the button.
As items are added or removed from the area, notice that the co-ordinates change
accordingly (unless the item does not affect the extremities of the area).
If you wish to access, in the Design Members list, an element that has already been
added in the Selected Elements list, click on the entry and press the Goto Selected
button.
8. Once you have selected all the items required for the area click on the OK button to
return to the Area Definition form.
9. Once the area has been defined following the steps detailed above, create it in the
database. To do this, click on the Add button to add the new area to the Areas list.
3.4.2
3.4.3
3.4.4
3:8
12.0
3.5
Sort by name
Sort by description
3:9
12.0
5. Select Criteria Type. This determines the check on input criteria but depends on the
type:
Rule - to add (or remove) a certain type of element with an attribute of a specified value
(if required). Examples:
ALL PIPE
ALL PIPE WITH PSPEC EQ A1A
Note: Always use a qualifying element with the All statement. Otherwise the time taken to
evaluate the expression is excessive. An expression such as ALL WITH (PURP EQ
ANY) is not recommended.
Element - to add (or remove) an element from the DESIGN database (the name is
normally used, but you can use the reference number). The item may be added
manually or by going to the relevant item in the members list and clicking on the CE
button to the right of the Criteria field.
6. Select the type of rule from the pull down menu (either Add or Remove).
7. Select the action required from the second pull-down menu:
1. to add an extra criterion to the Criteria List select Add Criteria.
2. to modify/replace an existing criterion make sure the correct one is selected and
select Replace Criteria.
3. to remove a criterion from the list make sure the correct one is selected and select
Remove Criteria.
8. Finally, click the relevant button:
1. to create a new Classification click Add.
2. to modify/replace an existing Classification make sure the correct one is selected in
the lower pane and click Replace.
3. to remove an existing Classification make sure the correct one is selected in the
lower pane and click Remove.
Note: Criteria and Classifications may also be deleted by selecting them in the relevant
pane, right clicking, and selecting Remove from the pop-up menu.
3.6
3:10
12.0
Load Tasks - This loads all tasks from the default task library location. This is used
to update the list to include all tasks that have been created externally.
Save Tasks - Saves all current tasks to the task library. Tasks are stored in the ABA
Defaults > Tasks Library, and the PML Functions associated with the each task are
stored in %PMLLIB%.
The Viewing Tasks section of the form allows the user to select a task from one of
the four Task Type areas i.e. View, Drawing, Process and Naming. By clicking on
the appropriate Task Type, all of the available tasks of that type will appear in the
Tasks list below.
Name - This defines the name that will act as the reference for that task. NB This
name cannot contain any spaces. Also the * before a name indicates that the task
has been supplied by Aveva.
Function - This associates the PML file used to define the task.
3:11
12.0
3.7
3.8
3.9
Process
Drawing
View based
Each one is selected at different levels within the application, and each relates to specific
levels in the hierarchy. Some tasks are Aveva defined and others user defined. Aveva tasks
3:12
12.0
are identified by an asterisk prefix and are described here. For details on user defined tasks
see User Tasks.
3.9.1
Process Tasks
These tasks operate on all of the drawings produced during a process run. Select
Create>Area ADP Drawings>Process Drawing Control>Process Tasks to access
these tasks.
Plot_Drawings
Plots all produced drawings in a process run, in a particular format, and to a directory, as
specified in the options.
Report_Labels
Produces a report for all drawings produced in a process run. The report files are created in
the specified directory. The content of the report is controlled by the external defaults file.
This file has three sections; the data extraction pml code, the header format, and the body
format. The current example reports on the labels and produces an output suitable for Excel
input and is listed below:
3:13
12.0
Hyper_Plant
This task produces a series of files which can be used to interface to the AVEVA HyperPlant
product.
The task produces four files, which are linked by a common field - an index number that
represents a drawing:
To illustrate how these files are used, we could ask the following question:
On which drawings does the equipment /PUMP1 appear?
The four files produced could be:
dra1.plt; dra1.hit; pdms_dsheet.out; pdms_item_to_dsheet.out
To answer the question, we can scan the items file pdms_item_to_dsheet.out to determine
the index of the sheets on which /PUMP1 appears.
The sheets file pdms_dsheet.out can then be read to find which plotfile and hitfile relates to
which sheet.
Finally, the plotfile could be converted to a tiff file format for inclusion on a web page, and the
hitfile could be used to provide the location of each design element for the placement of
relevant hyperlinks to other documents.
3.9.2
Drawing Tasks
These tasks operate on a specific drawing. Select Create>Area ADP Library>Template
Drawing or Modify>Area ADP Library>Template Sheet from the main menu to access
them.
Keyplan_View
This is the Overlay Sheet method for keyplan production. It produces an OLAY based
keyplan at SHEE level. To function correctly, the OVER name specified in the options must
exist in the library. This OVER must be constructed with SpPURP ABAT, and it should own a
VIEW of SpPURP ABAK.
Once the view exists process it using the Create>Area ADP Library>Keyplan Layers
menu item. This creates all the necessary layers corresponding to each of the existing areas
built in the area definition library.
When the drawing is processed, an OLAY element will be created under the SHEE element
that references the specified OVER and shows the correct hatched layer for the relevant
3:14
12.0
area. This is achieved by the setting of the OLAY attribute OSLV to include the design and
the layer number that corresponds to the relevant area.
The OLAY is named per the SHEE name plus a suffix /Keyplan
Report_Labels
This produces a report as specified in Process Tasks, but in this case produces a single
report for the relevant drawing.
Schedule
This produces a table which creates a list of given elements according to a specified
discipline drawlist. This discipline is probably the same IDLI as the one you created for the
View contents. The table can be created vertically down or horizontally from left to right.
In order to facilitate the table, create the relevant symbol templates for the header, table
entry, and last entry (if different), that extracts the relevant data using Draft hashcodes.
To position the table on the page and permit overflow areas, create a series of one or more
reserved areas on the relevant backing sheet. The reserved area will exist in a NOTE on
the backing sheet and have the function attribute set to Table Data. The LVIS should be set
False so that the rectangles do not appear on the final drawing.
Each rectangle should have FPEN attribute set to indicate the order in which they are to be
filled. That is, the main reserved area rectangle will be set FPEN 1 with subsequent set to 2
onwards. The origin of the rectangle is important since it will determine the position of the
first symbol within it. For example, the first reserved area rectangle for a vertical fill would
have the origin at the Top Left if the relevant symbols also had their origin at the Top Left.
3:15
12.0
3.9.3
View Tasks
These tasks operate on a specific drawing view.
Selected Create > Area ADP Library > Template Drawing or Modify > Area ADP Library
> Template View from the main menu to access them.
3:16
12.0
Arrange_Labels
Scans the view for existing labels and arranges them around the border of the view to the
specified options as shown below.
Draw_MeasureLines
A series of lines are produced at the View limits to indicate a rule scale set to dimensions
specified in the options.
The lines are produced in a unique LAYE element named as per the VIEW plus a suffix /
Measure.
North_Arrow
A north arrow is added to the View and is orientated to indicate the true North direction of
that view. The location of the north arrow can be set by creating a reserved area on the
template drawing.
Create a VNOTE below the template view with LVIS FALSE and under it create a
RECTangle with its origin at the centre and part-named with the string n_arrow. The task
will look for this rectangle and use its position for the north arrow symbol. If the rectangle
does not exist, then the symbol is placed at a default position defined as the top-left corner
of the view.
The north arrow is orientated to conform to the actual north direction of the view. It also
functions correctly with any of the Isometric views, Iso 1 to 4 inclusive. Any other view
direction such as elevation view is not given a north arrow.
3:17
12.0
The user can reposition the created SYMB element if required using the Draft standard
application tools.
The north arrow SYMB will be created in a unique LAYE element which is named as per the
VIEW plus a suffix /NorthArrow
3.9.4
Naming Tasks
When a Template/Area combination is selected during the drawing creation process, the
default drawing name is the concatenation of the element names. For example, a drawing
which used the template /DRTM-PIPING-A0 and area /A101 would be called /DRTMPIPING-A0-A101.
An alternative naming method is provided by the inclusion of a user defined naming task.
This is a pml function which is run at the time the drawings are added to the drawing
process form. It is slightly different to other tasks because the template and area names are
inserted into the passed parameters as parameter 1 and 2, and the actual task parameters
are appended.
Another difference is that the task function is expected to return a string to ABA. If the return
string is empty, the default name is inserted instead.
Name Checking in Naming tasks
Naming tasks need to check if a drawing name is already in use. This is easily done by
checking the database for a particular name, but it is possible that the name is also used in
the list of drawings about to be created by ABA itself.
To check if a base product name has been used elsewhere, use the following method called
from user defined tasks:
!!abanewdrwgs.checkname(!namestring) where !namestring is the required name.
This routine returns one of three values. 0, 1, and 2, where:
0
means the drawing name has been used in the list of drawings about to be created by
ABA.
!num = !!abanewdrwgs.checkname(!namestring)
3:18
12.0
if !num eq 0 then
return !namestring
$* its ok so use it
else
!!alert.error(Name already used)
return
endif
This use of naming tasks is described in more detail in the ABA User Guide.
3.10
2. To create a new tag rule set click on the Create Tag Rule Set button which displays the
Create Tag Rule Set form.
3:19
12.0
3. Enter a suitable name in the Name field and a suitable description in the Description
field. When the new name and description have been entered click on the Apply button
to confirm the settings.
4. To modify/replace a tag rule set use the pull down menu to pick the correct set you
want to modify, then click the Modify Tag Rule Set button, which displays the Modify
Tag Rule Set form.
5. Edit the values in the Name or Description fields to those required and click the Apply
button.
6. Enter a suitable name for the tag rule in the Name field.
7. Enter the tag rule definition in the Rule field, this may be as specific or general as
required e.g. ALL PIPE or ALL PIPE WITH PSPEC EQ /SCTG (if you enter syntax in
this format the application will convert it to ALL PIPE WITH (ATTRIB PSPE EQ ID /
SCTG) automatically).
8. Enter a suitable description for the tag rule in the field Label Template.
9. To select the label template for the tag rule to use, click on the Select Label Template
button which displays the Select Label Template form.
3:20
12.0
10. Label Libraries. Select the library you want to use a label from using the pull down
menu at the top for the form. Once the library is selected pick the label by either
selecting a label from the list under the library selection menu or click on the label you
want in the graphical view. This is simply a Draft representation of the labels so the
usual zoom functionality is available. Once you have selected the label, click on the
Apply button to return to the Tag Rule Definition form.
11. Create a new tag rule. Once the new tag rule has been fully defined, click on the Add
button to add the new tag rule to the Tag rule list for the current tag rule set.
12. If you want to modify, replace or remove a tag rule click on the required rule from the
Tag Rules list.
To modify/replace an existing tag rule:
Select the required tag rule from the Tag Rule Definition form and make the necessary
changes. Once the modifications have been made to the tag rule definition, click on the
Replace button.
To remove an existing tag rule:
3:21
12.0
Make sure the correct rule is selected from the Tag Rule Definition form then click on the
Remove button.
Note: Currently, the supplied functionality within the task *Arrange_Labels will operate
correctly with a label template type of TXTM. If an SYTM is utilised, the labels may
not be positioned and orientated as you might expect. This limitation is due to the
fact that an SYTM can have an origin at any point within its configuration and hence
is indeterminable, unlike a TXTM origin.
3.11
3.11.1
3.11.2
Variants can only be selected from the existing drawing list on the Process Drawings
form.
The M or V1, V2 annotations indicate whether a drawing uses the master or variant
template, in the list of selected drawings.
3:22
12.0
5. The Drawn By field is automatically populated with the login name of the user (this is
taken from the operating system, not the base product).
6. If necessary click on Attributes button to make any changes. This displays the
Drawing Template Attributes form.
Note: The Drawing Template Attributes form uses a common layout available in the
standard ADP application. For a detailed explanation, refer to the Drawing
Production User Guide.
The form is divided into tabs allowing for example the assignment of line styles and
colours to the five line types (note line, leader line, etc.).
In the Intelligent Text system there are code words that are used to request the
position of certain elements. These expand to a string providing the location expressed
in either the ENU (East North Up) coordinate system, as an absolute position (XYZ), in
the Ship Reference System, or as a purely numerical output (Numbers only).
To accomplish this, two attributes are provided for a number of elements in the DRAFT
database (including DEPT, REGI, DRWG, SHEE, VIEW, LAYE). The setting of these
attributes determines the output format used by the positional code words, and are
determined by the selection made in the Intelligent Text tab. The same output format
is used throughout a given layer.
For AVEVA Plant, the Ship Reference System is irrelevant and is therefore unavailable.
Standard options of line colour and style are set explicitly by selecting system-defined
settings from the colour, line-pattern and thickness drop-down lists. Clicking on Pick
allows a colour to be selected from colour palette. To select a user-defined style, tick
the checkbox; the User-defined line styles form is displayed. Select a Style Table and
make a selection from the list of styles.
For the Hatch Pattern, you can assign a colour and either a standard fillstyle or a
user-defined fill style. These are selected in a similar way to line colour and style.
3:23
12.0
9. If required click the Copy as Variant button to create a variant of the master. This
changes the current element to the variant. This is only available during a modify
phase.
10. Enter a suitable title for the sheet in the Sheet Title field.
11. Select the paper size for the sheet using the Paper pull-down menu.
3:24
12.0
12. Select the orientation of the paper (Landscape or Portrait). The paper size may also
be entered manually (Width and Height).
13. Choose the Backing Sheet for the sheet, either Unset (no backing sheet), Reference
(a BACK element in the project) using the pull down menu, or Filename (enter the path
of a .plt file in the field).
14. Add tasks you want performed by using the left arrow to copy them from the Tasks
Available window to the Tasks Selected window.
If you want to modify the task, you may do so but only when it is in the Tasks Selected
window. Do this by clicking the Modify Task button.
By default, a simple modify form is shown which allows you to modify the task
parameters, but these are all treated as text. If a task function has a matching form it is
shown in place of the default, allowing modify forms to be created with more control
and flexibility.
15. Once the sheet is configured correctly, click OK and the Template View form appears.
3.11.3
3:25
12.0
2. Select the template drawing you want to modify by clicking on it and the Template
Drawing form appears. Follow the steps outlined in Creating Template Drawings to
modify the template drawing.
3.11.4
2. Select the template sheet you want to modify by clicking on it and the Template Sheet
form appears. Follow the steps outlined in Creating Template Drawings, step 8
onwards, to modify the template sheet as desired..
Note: That if you are positioned at a DRTMPL or SHTMPL then the relevant modify form
will be shown, bypassing those described above.
3.12
3.12.1
3:26
12.0
Size > Cursor - defines the size of the view with a cursor hit for each corner.
Size > Explicit - the user enters the size into a form.
Copy Size > Width - copies the width of another view (must be selected in the
graphical view).
Copy Size > Height - copies the height of another view (must be selected in the
graphical view).
Copy Size > Width & Height - copies the width and height of another view (must
be selected in the graphical view).
Position > Cursor > By - alters the position of the view by base point and
displacement (using the mouse).
Position > Cursor > Centre - positions the centre of the view at the cursor position.
Position > Cursor > Top Left - positions the top left of the view at the cursor
position.
3:27
12.0
Position > Cursor > Top Right - positions the top right of the view at the cursor
position.
Position > Cursor > Bottom Left - positions the bottom left of the view at the
cursor position.
Position > Cursor > Bottom Right - positions the bottom right of the view at the
cursor position.
Position > Explicit - allows the user to position the view using co-ordinates.
Align > Centre Vert - aligns the centre of the current view with vertically the centre
of a selected view i.e. the two views have the same Y co-ordinate.
Align > Centre Horiz - aligns the centre of the current view horizontally with the
centre of a selected view i.e. the two views have the same X co-ordinate.
Align > Top - aligns the top edge of the current view with the top edge of a selected
view.
Align > Bottom - aligns the bottom edge of the current view with the bottom edge
of a selected view.
Align > Left - aligns the left hand edge of the current view with the left hand edge of
a selected view.
Align > Right - aligns the right hand edge of the current view with the right hand
edge of a selected view.
Create New - creates a new view under the SHTMPL e.g. TMPL3/S1/V1.
Wireline
Modelled Wireline
7. In the Section Mode field choose between Standard or Omit Fractional Pipe
Components, which removes from the view any piping components that will only be
partly displayed.
8. In the Style field select a representation style set for the view from the pull down menu.
9. Select a commonly used direction from the Direction pull-down menu or enter your
own direction in the text field.
10. Select the scale using the Scale Selection drop-down list:
Maximum - where the contents of the view will be made as large as possible whilst
still fitting in the view frame.
Specific - you can choose the type of scaling and the scale itself, e.g. Metric - 1/1,
Architectural - 1=1-0, or Engineering - 1=10-0.
Click the question mark button for assistance in determining a scale. The Limit
Information form is displayed, which shows the maximum 3D distances for the
chosen scale.
3:28
12.0
3:29
12.0
The Add Drawing Item Lists form contains a list of all the available classifications
in the Classifications window. The classifications may be added to the view by
selecting them from the list and clicking on the Add button. They may also be
removed from the Classifications List (Current View) window by clicking the
Remove button. You may add or remove a single classification or multiple
classifications.
You can sort the classifications list by name using Sort by Name or by description
with Sort by Desc. Do this by right-clicking in the list to display the sub-menu
shown below:
Within both lists, you can Select All of the available entries or clear the selected
entries with the option Clear Selection.
7. Click OK to return to the Template View form.
8. Click on the Tagging button to display the Add Tag Rule Lists form.
3:30
12.0
If required right-click and choose Select All or Clear Selection within both tag lists.
9. Select the Tag Rule Set you want to use from the pull-down menu.
10. Select the tag rules you want in the Tag rules window, and then click the Add
button to add the rules to the Tag Rule List (Current View). Use the Remove
button to get rid of unwanted rules.
11. Click the OK button to return to the Template View form.
12. Define the View Function, using one of these options:
13. Add tasks you want performed by using the left arrow to copy them from the Tasks
Available window to the Tasks Selected window.
All tasks are processed in the order in which they appear in the Tasks Selected list. If
you wish to modify the order then click the right mouse button whilst over the list and
choose either Move Up or Move Down.
If you want to modify the task, you may do so but only when it is in the Tasks Selected
window. Do this by clicking the Modify Task button.
3:31
12.0
By default, a simple modify form is displayed which allows you to modify the task
parameters, but these are all treated as text. If a task function has a matching form it is
shown in place of the default, allowing modify forms to be created with more control
and flexibility
14. Click Apply when you have completed sections of the form.
3.12.2
3.13
3.13.1
3:32
12.0
Use Area Limits - this uses the selected area for the keyplan, which will set the
view scale so that the limits box for that area fits into the view frame for the keyplan.
Auto Limits - this will calculate a view scale such that the contents of the drawlist
for the keyplan view fit into the view frame.
4. Click Apply to confirm the changes and return to the Template View form.
5. Add the user task 'hatch_keyplan' to the Tasks Selected window.
6. Use the Modify Task button to set the Hatching styles/colours and Frame styles/
colours.
3:33
12.0
3.13.2
3:34
12.0
7. Make sure Name has been set to the correct overlay (if not then click on the CE button
and navigate to the desired overlay).
8. Set the Frame colour/style and Hatch Pattern colour/style for the hatching layers. Each
layer represents a particular area of the plant as defined in the Area Definition form.
When the drawing is processed with this keyplan applied, the only visible keyplan layer
will be that area for which the drawing is using.
9. Click Apply and ABA populates the keyplan hatch layers, one for each defined area
within the library, and locates them under the keyplan view in the overlay sheet.
To apply the overlay sheet to a template modify the ABA Template Sheet form to include
the *Keyplan_View task.
3:35
12.0
3.14
2. Select any one of these options from the File menu as needed:
Save - saves the current numbering rules to the file dra-nam.pmldat, which is
stored in %PDMSUSER% by default. N.B. this does not save the element rules.
Load - loads the numbering rules file into the Auto-Numbering Rules form.
Auto Naming On/Off - toggles the auto numbering on and off. Not applicable to
ABA as this is dealt with in other areas of ABA.
Define Naming Rules - takes the user to the Auto-Numbering Rules definition
form.
3. To create/modify the rules, click the Define Naming Rules button to display the AutoNumbering Rules form.
3:36
12.0
Use this form to define how ABA creates the drawing number for a particular element
rule.
4. Complete the Data Input section of the form:
Scan Level - determines the top level in the hierarchy for the element rule should
start from e.g. world, dept, regi.
Rule Name - the name of the rule which is used as a reference to its respective
Element Rule.
Format - defines the format for the number. This section can use a PML expression
to call a function or method, which can then ascertain attributes from the drawing to
use in the construction of the number.
Indices - assigns the maximum number of significant figures to the drawing rule.
Copy - makes a copy of the rule and inserts it into the above fields.
Insert - places the new rule into the current list. The pull-down menu allows you to
specify where the rule is placed within the list. The options available are Before and
After. The auto-numbering process uses each rule in turn, numbering all drawings
applicable to that rule, then moves onto the next rule. Therefore the order of the rule
list determines the preference for how the drawings are numbered.
3:37
12.0
Data field - displays all the attributes for the selected rule. This includes the
Element Rules for the numbering rule.
Test - tests the numbering rule on the current element. If successful it will return a
constructed number, if the rule is not valid to the element then a warning informing
of this will appear.
Use Rule - as above, but the Rule attribute in the Element Rule is tested on the
current element.
8. Click the Element Rules button to display the Define Rules form. This allows you to
define which elements are to be selected for a particular rule. Auto-numbering works by
going through each element rule to collect the relevant drawings, and then applies the
associated numbering rule to those drawings.
Save - saves the current element rules to the file dra-element-rules.pmldat, which is
stored in %PDMSUSER% by default.
Location - defines where the element rules file is stored. The sub-menu options
are: User, Project, and PDMS.
Name - the name of the corresponding number rule. The name here MUST be
identical to the numbering name.
3:38
12.0
Types - identifies what type of element(s) to search for i.e. DRWG selects
drawings.
Rule - sets another selection rule for the elements to be acted upon.
10. The Defined section of the form lists all available element rules. To view or modify a
rule click on the one required.
11. Click OK to return to the Auto-Numbering Rules form.
12. Click OK to return to the Number Settings form.
13. Click OK to finish.
3.14.1
Summary
The auto-numbering function is controlled by a combination of files and uses the standard
PML function autonam. This function makes use of two files:
The format of the number created is made up from a combination of text and returned
values from functions supplied with the ABA UI. The function !!abaAutoNumber(discipline)
returns the necessary part of the number/name to the auto-naming activity, this reply is
based on the Function attribute set by the option field in the ABA Template Drawing form.
The values returned are set in the Task Library as defined in the ABA Defaults file. The
system administrator manages the creation of this library.
Each choice of the DRWG function has a TKPARA attribute that matches the requirement,
for example Administration will return the result A (see the /ABA/AutoNumber member of
the supplied TASKLB).
3.15
Browsers
3.15.1
3:39
12.0
To view a drawing in the Main Display form (shown using the menu option Display > Main)
select it from the list or use the up and down keyboard arrows to cycle through the list.
The menu options are:
Browse > Stored LogFiles - displays a form to read any stored log file (see the next
section for details).
Use the ABA Discipline option to select the drawing types based on the drawing function
attribute. For example, if you want to look through just the piping drawings, select the Piping
option.
The following right-mouse click options are available in the Existing Sheets window:
Modify Template View(s) - displays the Template View form and accesses the views
available under the Sheet Template from which the picked drawing was derived.
Modify Template Sheet - displays the Template Sheet form and accesses the Sheet
Template from which the picked drawing was derived.
Modify Template Drawing - displays the Template Drawing form and accesses the
Drawing Template from which the picked drawing was derived.
3:40
12.0
3.15.2
Home Directory - accesses the directory from which you entered the base product.
2. Click on a directory in the Sub Directories list to access the contents of a particular
sub directory.
3. The Files list shows the log files that exist in the chosen directory. Click on a log file of
interest.
If the Browse Sheet form has been called from the Process Drawings Control form, then
when you select a file from the list and press the Apply button, the drawings processed
during that run are loaded into the Process Drawings Control form. This enables you to
rerun a previously processed group of drawings without having to reselect them.
If the Browse Sheet form has been called from the Administration menu, the Load option
will not be available.
If you select the Edit option button and then click on a file, the file contents will be opened in
Windows Note Pad.
To delete a file from the operating system press the Delete button.
3:41
12.0
3:42
12.0
4:1
12.0
4:2
12.0
User Tasks
This section describes the user tasks supplied with the ABA application.
A user task is defined as a task that specifies a particular method of working that may not be
suitable for all other users, such as those specific to a project - in this particular case the
standard supplied project SAM.
The user tasks are held along with all other tasks in the task library /Aba/task_library and
call functions stored in the PMLLIB path but are held in a separate directory, for example
base product install path\AB_ADP\Pmllib\UserTasks
A.1
SAMGRIDS
This view task is supplied as TASK /Aba/view_task2 with a matching PML function
samgrids.pmlfnc
The task is designed to create labels by reading design SCTN elements modelled to
represent each gridline with the description attribute holding the gridline reference.
T-900
Posstart
Posend
When the task is activated, the design SCTN elements used to represent the gridlines are
determined and located by reading the keyplan discipline drawlist i.e. /keyplan_discipline.
A:1
12.0
This IDLI has the attribute function set to the word 'keyplan' and uses a rule to point to the
set of SCTN elements.
Example:
ALL ZONE WITH ( MAT ( ATTRIB NAME , '/UTIL-GRID' ) GT 0 )
If you want to reference a different set of SCTN elements, change this rule by selecting
Modify > Area ADP Library>Classification from the main menu and selecting keyplan
from the classification list. See Creating Area Libraries for details on how to use this form.
The SCTN elements found are tested against the relevant area limits and any intersections
determine the need for a gridline label. This label references an SYTM which extracts the
description and the position.
For an example see SYTM /Aba/grids/NS which holds two intelligent text elements using the
hash codes #DESC and #POSSE.
A.2
SAMKEYPLAN
This keyplan view task is supplied as TASK /Aba/view_task5 with a matching PML function
samkeyplan.pmlfnc.
The task is designed to create a hatched 2D element under the keyplan view which
represents the area limits of that view.
A keyplan view is defined as a VIEW element with attribute sppurp set to ABAK which is set
using the View Function keyplan option on the ABA Template View form. For details on how
to use this option see Creating and Modifying Labelling.
The drawlist contents of this view are set to the keyplan discipline.
The hatched area is simply an OUTL element created under a VNOT element with vertices
at each corner of the area limits.
The VNOT is created in a unique LAYE element which is named per the view plus a suffix /
KeyplanHatch.
A:2
12.0
A.3
SAMGRIDDIMN
This view task is supplied as TASK /Aba/view_task6 with a matching PML function
samgriddimn.pmlfnc.
The task is designed to create dimensions outside of the view limits between the gridline
references, if they have been created using the task as discussed above.
A.4
SAMEQUICLDIMN
This view task is supplied as TASK /Aba/view_task7 with a matching PML function
sam.pmlfnc.
The task is designed to create dimensions outside of the view limits between the origins of
any equipment elements that exist within the view limits.
A:3
12.0
A:4
12.0
Limitations
All of the normal base product limitations apply when using the ABA application. The
following need special attention:
B.1
Name Lengths
There is a limitation of 120 characters for the element name attribute. This would not
ordinarily cause you any problems, but in the ABA application, the limitation needs to be
considered when determining the drawing number.
By default the application names the Draft elements using the following format:
DRWG
template_name + area_name
SHEE
VIEW
LAYE
B.2
Rule Expressions
In setting classification and tag rules, you will be using expressions to extract design model
elements.
It is perfectly legitimate to use the syntax:
B.3
B:1
12.0
The supplied tasks *Arrange_Labels and *Report_Labels are designed to operate with
labels produced using a text template (TXTM ) as the template reference.
In order to use an SYTM, tasks for arranging the labels and producing reports of the display
text would have to be written to match that specific SYTM.
B:2
12.0
Index
A
ABA
Administrative Tools . . . . . . . . . . . . . 3:1
Defaults . . . . . . . . . . . . . . . . . . . . . . 3:2
ABA Defaults File . . . . . . . . . . . . . . . . . . 3:2
ABA Drafting Administrator
role . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
ABA Drawings
create . . . . . . . . . . . . . . . . . . . . . . . . 4:1
ABA Tasks
creating . . . . . . . . . . . . . . . . . . . . . . 3:10
modifying . . . . . . . . . . . . . . . . . . . . 3:10
supplied description . . . . . . . . . . . . 3:12
Administrative Access Rights
setting up . . . . . . . . . . . . . . . . . . . . . 1:2
Area Based ADP
hierarchy . . . . . . . . . . . . . . . . . . . . . . 2:1
Area Libraries
creating . . . . . . . . . . . . . . . . . . . . . . . 3:5
Areas
creating . . . . . . . . . . . . . . . . . . . . . . . 3:6
modifying . . . . . . . . . . . . . . . . . . . . . 3:6
Areas Window Sort Order . . . . . . . . . . . . 3:8
Auto Number Rules
create . . . . . . . . . . . . . . . . . . . . . . . 3:36
modifying . . . . . . . . . . . . . . . . . . . . 3:36
B
Browsers . . . . . . . . . . . . . . . . . . . . . . . . 3:39
C
Classifications
creating . . . . . . . . . . . . . . . . . . . . . . 3:9
modifying . . . . . . . . . . . . . . . . . . . . . 3:9
D
Discipline
based tasks . . . . . . . . . . . . . . . . . . 3:12
drawing filter . . . . . . . . . . . . . . . . . . 3:1
Drawing Tasks . . . . . . . . . . . . . . . . . . . 3:14
E
Existing Area
remove an existing . . . . . . . . . . . . . . 3:8
replacing . . . . . . . . . . . . . . . . . . . . . 3:8
Existing Drawings
browse . . . . . . . . . . . . . . . . . . . . . . 3:39
F
Form
ABA Defaults . . . . . . . . . . . . . . . . . . 3:2
Add Drawing Item Lists . . . . . . . . . 3:29
Add Hatched Areas to an Overlay . 3:34
Add Tag Rules Lists . . . . . . . . . . . . 3:30
Area Definition . . . . . . . . . . . . . . . . . 3:6
Area Library Definition . . . . . . . . . . . 3:5
Auto-Numbering Rules . . . . . . . . . 3:36
Batch Username and Password . . . 3:5
Browse Sheets . . . . . . . . . . . . . . . . 3:39
Classification Definition . . . . . . . . . . 3:9
Create Tag Rule Set . . . . . . . . . . . 3:19
Defaults . . . . . . . . . . . . . . . . . . . . . . 3:3
Define Rules . . . . . . . . . . . . . . . . . 3:38
Drawing Template Attributes . . . . . 3:23
Index page 1
12.0
R
Rule Expressions
limitations . . . . . . . . . . . . . . . . . . . . . B:1
S
SAMEQUICLDIMN . . . . . . . . . . . . . . . . .
SAMGRIDDIMN . . . . . . . . . . . . . . . . . . .
SAMGRIDS . . . . . . . . . . . . . . . . . . . . . .
SAMKEYPLAN . . . . . . . . . . . . . . . . . . . .
Symbol Templates
limitations . . . . . . . . . . . . . . . . . . . . .
A:3
A:3
A:1
A:2
B:1
Keyplan Layers
create using overlay sheet method 3:34
creating using view based method . 3:32
modify . . . . . . . . . . . . . . . . . . . . . . . 3:32
Tasks
drawing . . . . . . . . . . . . . . . . . . . . . 3:14
keyplan view . . . . . . . . . . . . . . . . . . A:2
limitations . . . . . . . . . . . . . . . . . . . . . B:1
name . . . . . . . . . . . . . . . . . . . . . . . 3:18
name checking . . . . . . . . . . . . . . . . 3:18
process . . . . . . . . . . . . . . . . . . . . . 3:13
user . . . . . . . . . . . . . . . . . . . . . . . . . A:1
view . . . . . . . . . . . . . . . . . 3:16, A:1, A:3
Template Drawings
create . . . . . . . . . . . . . . . . . . . . . . . 3:22
modify . . . . . . . . . . . . . . . . . . . . . . 3:25
Template Sheets
modify . . . . . . . . . . . . . . . . . . . . . . 3:26
Template View
create . . . . . . . . . . . . . . . . . . . . . . . 3:26
modify . . . . . . . . . . . . . . . . . . . . . . 3:26
Labelling
create . . . . . . . . . . . . . . . . . . . . . . . 3:19
modify . . . . . . . . . . . . . . . . . . . . . . . 3:19
Limitations . . . . . . . . . . . . . . . . . . . . . . . . B:1
Log Files Stored
browse . . . . . . . . . . . . . . . . . . . . . . 3:41
Variant Templates
introduction . . . . . . . . . . . . . . . . . . 3:22
View Tasks . . . . . . . . . . . . . . . . . . . . . . 3:16
G
Geographical Area
creating . . . . . . . . . . . . . . . . . . . . . . . 3:6
I
Introduction . . . . . . . . . . . . . . . . . . . . . . . 1:1
N
Name Checking . . . . . . . . . . . . . . . . . . 3:18
Name Lengths
limitations . . . . . . . . . . . . . . . . . . . . . B:1
Naming Tasks . . . . . . . . . . . . . . . . . . . . 3:18
New Task Functions
creating . . . . . . . . . . . . . . . . . . . . . . 3:12
Index page 2
12.0