area based adp administrator guide

Area Based ADP

Administrator Guide

DisclaimerInformation of a technical nature, and particulars of the product and its use, is given by AVEVASolutions Ltd and its subsidiaries without warranty. AVEVA Solutions Ltd and its subsidiaries disclaimany 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 orentity 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.

CopyrightCopyright and all other intellectual property rights in this manual and the associated software, and everypart of it (including source code, object code, any data contained in it, the manual and any otherdocumentation 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 inthis document is commercially sensitive, and shall not be copied, reproduced, stored in a retrievalsystem, or transmitted without the prior written permission of AVEVA Solutions Ltd. Where suchpermission is granted, it expressly requires that this Disclaimer and Copyright notice is prominentlydisplayed at the beginning of every copy that is made.

The manual and associated documentation may not be adapted, reproduced, or copied, in any materialor electronic form, without the prior written permission of AVEVA Solutions Ltd. The user may also notreverse engineer, decompile, copy, or adapt the associated software. Neither the whole, nor part of theproduct 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 bylaw. Any such unauthorised action is strictly prohibited, and may give rise to civil liabilities and criminalprosecution.

The AVEVA products described in this guide are to be installed and operated strictly in accordance withthe terms and conditions of the respective license agreements, and in accordance with the relevantUser 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

TrademarksAVEVA and Tribon are registered trademarks of AVEVA Solutions Ltd or its subsidiaries. Unauthoriseduse of the AVEVA or Tribon trademarks is strictly forbidden.

AVEVA product names are trademarks or registered trademarks of AVEVA Solutions Ltd or itssubsidiaries, 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 orlogo belongs to its respective owner.

AVEVA Solutions Ltd

Area Based ADP Administrator Guide

Contents Page


Administrator GuideIntroduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1Role of the ABA Drafting Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1Setting Up Administrative Access Rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:2

Area Based ADP Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1

ABA Administrative Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1Discipline Drawing Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1ABA Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2ABA Defaults File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2ABA Defaults Form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2

Creating Area Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:5Creating and Modifying Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:6To Create a Geographical Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:6To Modify/Replace an Existing Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:8To Remove an Existing Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:8Areas Window Sort Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:8

Creating and Modifying Classifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:9Creating and Modifying Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:10Creating New Task Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:12Discipline Based Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:12Description of the Supplied ABA Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:12Process Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:13

12.0i


Drawing Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:14View Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:16Naming Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:18

Creating and Modifying Labelling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:19Creating and Modifying Template Drawings . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:22Introduction to Variant Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:22Creating Template Drawings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:22Modifying Template Drawings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:25Modifying Template Sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:26

Creating and Modifying Template View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:26Creating a Template View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:26Modifying Template Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:32

Creating/Modifying Keyplan Layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:32View Based Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:32Overlay Sheet Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:34

Creating/Modifying Auto Number Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:36Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:39

Browsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:39Browse Existing Drawings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:39Stored Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:41

Creating ABA Drawings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1

User Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:1SAMGRIDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:1SAMKEYPLAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:2SAMGRIDDIMN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:3SAMEQUICLDIMN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A:3

Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B:1Name Lengths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B:1Rule Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B:1Tasks and Symbol Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B:1

12.0ii

Area Based ADP Administrator GuideIntroduction

1 Introduction

Area Based ADP (Automatic Drawing Production) can be used with either AVEVA Plant orAVEVA 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 theHull Drafting Module of AVEVA Marine.

The purpose of this document is to provide the ABA administrator with guidance on how toorganise 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 isreflected in the terminology used in this guide. All terms are fully described in theAdministrator 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 drawingto be produced.

As ABA Drafting administrator, you are responsible for setting up the libraries for thesetemplates. Setup involves the definition of labelling rules, the classification of disciplinebased drawing contents, and the construction of drawing tasks. The latter is defined as anyactivity applied to a drawing, such as the creation of a North arrow, or the plotting of adrawing.

You can create new libraries, or edit the content of existing libraries, so that the standarddata available to individual users complies with a company's requirements for draftingfunctions. This includes the definition of areas, the configuration of the drawing number, thebuilding of key plans, and the maintenance of drawing symbols.

1.1 Role of the ABA Drafting AdministratorAs ABA Drafting administrator you can configure the ABA environment to satisfy companyor project requirements by manipulating elements held in libraries. This includes:

Default Setting

The ABA Defaults system allows you to define the following aspects of applicationfunctionality:

• Library pointers• Drawing Scales• Symbol template pointers• Log file output locations

Libraries

You will be responsible for controlling the following types of library:

12.01:1

Area Based ADP Administrator GuideIntroduction

• Drawing Templates• Area definitions• Classifications• Key plans• Symbols• Labelling• Tasks

Scales

There are a series of pre-determined drawing scales used during drawing production. Youmay 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 maymodify these to refer to any other suitable symbols.

Log File Output

The location of output files produced during drawing production.

1.2 Setting Up Administrative Access RightsIn order to gain access to the administrator options on the ABA Final Designer menus youmust be a member of a special administration team with read/write access to the databasethat holds the libraries.

To become a Drafting administrator you do not need to change your user status i.e. bothfree and general users can be setup to carry out the administrative role. However, you mustbe identified as a member of an authorised administration team called DRAFTADMIN. Youalso need read/write access to a PADD DB in which you create new library elements. It isnormally better to create all symbols, labels, templates etc. in a database that only allowsread access to normal Drafting users.

Note: When entering a Drafting module as an administrator, only load binary files createdby an administrator. If you use a binary created by a user you will not get access tothe administration options on the application menus. If this happens exit the Draftingmodule and re-enter using the macro selection on the form.

In many companies, access as the Drafting administrator is limited to one or two specialuser logins. By using this method you can avoid any problems caused by using incorrectbinary files on entry.

12.01:2

Area Based ADP Administrator GuideArea Based ADP Hierarchy

2 Area Based ADP Hierarchy

12.02:1

Area Based ADP Administrator GuideArea Based ADP Hierarchy

12.02:2

Area Based ADP Administrator GuideABA Administrative Tools

3 ABA Administrative Tools

To access the ABA administration elements:

1. Select Draft > Administration.2. Then select Draft > Area based ADP.

3.1 Discipline Drawing FilterWhen there is a large number of areas and templates, it is possible to split the data intoseparate hierarchies. For example there may be different area definitions for differentdisciplines, or particular departments may want to separate their templates. To enable this tohappen, set the function attribute on each drawing, and at area library level.

When ABA collects all the templates it uses a filter to collect the appropriate templates andareas. By default all areas, and all templates, are selected.

The filter is located on the main system form.

12.03:1


3.2 ABA DefaultsThe administrator can customise many aspects of ABA, including library location, permitteddrawing scales, and output location. Configure these within the defaults file and defaultsform.

3.2.1 ABA Defaults FileThe defaults file, DRA-ABA-DEFAULTS, contains the library locations, permitted viewscales, symbol templates used, and paper sizes. It is stored in %PDMSDFLTS% and is splitinto the following sections:

3.2.2 ABA Defaults FormThis form has three functions:

• To define the location of all libraries and output files• To set the attributes for batch users• To allow easy loading of macro files

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 eachdiscipline. A user could then access a specific defaults file and hence reference the librariesdefined 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

Section 1 Labelled ‘General Defaults For Area Based ADP Use’. This definesthe information covered in the ABA defaults form (see ABA DefaultsForm).

Section 2 Labelled ‘Permitted View Scales’. This defines all scales available tousers. Scales can be removed from the list using any text editor torestrict those available to the user.

Section 3 Labelled ‘Symbol Templates’. This defines the names of the symbolsused by the supplied tasks.

Section 5 Labelled ‘Imperial Paper Sizes’ specify the paper sizes available tothe user.

Section 6 Labelled ‘Metric Paper Sizes’ specify the paper sizes available to theuser.

12.03:2


to set the defaults form on each and every entry. If you organise a multi-discipline projectand you want this to function, consider a PDMSUSER environment for each user.

To have different defaults across different projects, determine a location for separatedefaults files, and modify the location path for each project. Each project default file canthen, 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, orfrom, the defaults file.

To define the location of the libraries, type the location in the relevant field, or navigate to itin the members list and click CE.

The hierarchy is checked every time the defaults form is loaded to ensure that all librariesare correctly located. If this is not the case the 'face' button does not smile, and thehierarchy must be checked to find the problem.

Note: The use of this form in the installation of ABA is covered in the ABA InstallationGuide.

The fields in the defaults form are as follows:

Defaults file Specifies the location directory and name of the defaults file usedto store the ABA default settings.

Library The top-level LIBY element which holds all the required ABAadministrative elements.

12.03:3


Template A LIBY or DRTMLB is used to hold all the ABA drawing templates.If a LIBY is used, all relevant DRTMLBs are scanned fortemplates.

Area This can be a LIBY or DLLB to hold all the IDLI (ID List) elementsthat store the physical limit co-ordinates for each of the ABAgeographical areas. Using a LIBY enables multiple DLLBs to beused to split areas by discipline.

Classification A LIBY or DLLB used to contain all the IDLI elements for eachABA classification.

Keyplans A SHLB is a sheet library used to hold all the OVER (overlay)elements for the keyplans.

Symbols A SYLB is a symbol library that contains all ABA symbols e.g.north arrows.

Labelling A TRLB is a tag-rule library that contains all the ABA tag rules.

Tasks A TASKLB is a task library, which holds all the ABA tasks.

Create Hierarchy This option is used to automatically create the administrativehierarchy specified in the defaults form.

To use this functionality:

Modify the names to the desired settings.

If the required structure exists, the Create Hierarchy button will

show .

However, if it does not exist, the button will show .

Note: This only detects the existence of the LIBY, but not theelements 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 thatappears.

The previously mentioned process will also create some initial

SYMBol elements. The button icon will then turn to , whichindicates that the structure is OK.

12.03:4


To alter the default settings for the batch user click the Batch User button. The BatchUsername and Password form is displayed.

On this form:

To load and review macros click the Input File button.

3.3 Creating Area LibrariesAll libraries are DLLB elements which may be used for specific discipline types. Forexample, the set of areas for a piping discipline are likely to be different 3D volumes to thoseused by mechanical or structural disciplines. Area libraries are use to split the total areasinto smaller groups to suit discipline based requirements.

To create area libraries:

1. Select Create > Area ADP Library > Area Library from the main menu to display theABA Area Library Definition form.

Logfile Location Gives the directory path for process logfiles.

Batchfile Location Gives the directory path for process batchfiles.

User Name Specifies the name of the user that will enter AVEVA the baseproduct.

Password Specifies the password of the user.

12.03:5


2. Enter a name for the new library in the Name field.3. Select the appropriate function for the library from the Function drop-down box.4. Click Add to add the new library to the Area Library list. You can use the Replace and

Remove buttons to modify and remove area libraries respectively.5. Close the form.

3.4 Creating and Modifying AreasAn area is a physical box volume within the plant which is used in conjunction with atemplate to create a drawing.

3.4.1 To Create a Geographical Area1. Select Create > Area ADP Library>Area on the main menu to display the ABA Area

Definition form.

12.03:6


2. Enter a suitable name for the area in the Name field3. Enter a suitable description for the area in the Description field 4. Select a Library from the list of all available area libraries in which the new areas can

be built.5. Enter the 3D position of the start point for the area in the From fields using the base

product convention of North, East and Up (these directions can be changed to South,West and Down using the pull down button).

6. Enter the 3D position of the end point for the area in the To fields using the baseproduct convention of North, East and Up (these directions can be changed to South,West and Down using the pull down button).

Note: It is usual to enter the co-ordinates of the two corners of the limits box from theminimum to the maximum.

7. To set the limits of the area to contain specific items from the design model click on theSet by Model Items button. The Set Area by Selecting Model Items form isdisplayed.

12.03:7


The form works in the same manner as the member’s list. Items may be added to thearea 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 changeaccordingly (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 beenadded in the Selected Elements list, click on the entry and press the Goto Selectedbutton.

8. Once you have selected all the items required for the area click on the OK button toreturn to the Area Definition form.

9. Once the area has been defined following the steps detailed above, create it in thedatabase. To do this, click on the Add button to add the new area to the Areas list.

3.4.2 To Modify/Replace an Existing AreaSelect the required area from the Area Definition form and make the necessary changes.Click the Replace button to confirm the changes.

3.4.3 To Remove an Existing AreaSelect the required area from the Areas window then click on the Remove button.

3.4.4 Areas Window Sort OrderBy default areas are sorted by name.

12.03:8


Use the right mouse button to:

3.5 Creating and Modifying ClassificationsTo aid in the creation of templates, the drawlist has been modified to use classifications. Aclassification is a collection of objects gathered according to a defined criterion.

To create a classification:

1. Select Create > Area ADP Library > Classification to display the ABAClassification Definition form.

2. Enter a suitable name for the classification in the Name field3. Enter a suitable description for the classification in the Description field4. Enter the required criteria in the Criteria field. To modify/replace or remove a criteria

select the desired criteria from the list. The criteria may be of two different types.

Sort by name sorts the areas in the Areas window by name and alphanumerically (A-Z, 0-9)

Sort by description sorts the areas in the Areas window by discipline and alphanumerically.

12.03:9


5. Select Criteria Type. This determines the check on input criteria but depends on thetype:Rule - to add (or remove) a certain type of element with an attribute of a specified value(if required). Examples:ALL PIPEALL PIPE WITH PSPEC EQ A1A

Note: Always use a qualifying element with the All statement. Otherwise the time taken toevaluate 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 isnormally used, but you can use the reference number). The item may be addedmanually or by going to the relevant item in the member’s list and clicking on the CEbutton 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 relevantpane, right clicking, and selecting Remove from the pop-up menu.

3.6 Creating and Modifying TasksABA tasks are used to help process drawings. Tasks can be applied to views, sheets, and tothe processing of drawings.

To create ABA tasks:

1. Select Create > Area ADP Library > Task from the main menu to display the ABATask Definition form.

12.03:10


The File menu item has these options:• Close - closes the form• 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 arestored in %PMLLIB%. The Viewing Tasks section of the form allows the user to select a task from one ofthe four Task Type areas i.e. View, Drawing, Process and Naming. By clicking onthe appropriate Task Type, all of the available tasks of that type will appear in theTasks list below.

2. Select a task to display:• 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 taskhas been supplied by Aveva.

• Description - This is a brief description of the Task.• Function - This associates the PML file used to define the task.

12.03:11


3. Task Parameter definition section of the form.Description - Describes the function of the ParameterValue - Sets the value of the parameterObject Type - Sets the value type as Real, String, Distance or Boolean

4. Select the Add option to create a new parameter. To modify or remove an existingparameter first select it from the Parameter list, change the description and Value asrequired and select either the Replace or Remove option.The Right Mouse Button also has the same options as above;Add - This will add the newly defined parameter into the current task.Replace - This will replace the selected parameter with the modified one.Remove - This will remove the selected parameter.If, on exit from the form, changes have been made but not saved you will be presentedwith a Question form.

3.7 Creating New Task FunctionsIn the example in ABA Task Definition form, the PML function ABAARRANGE refers to afile abaarrange.pmlfnc, found in the PMLLIB path.

For any newly created task, create the corresponding PML function file and locate itsomewhere in the PMLLIB path.

3.8 Discipline Based TasksIf you want to organise tasks on a discipline basis, create different defaults files for eachdiscipline, which in turn specify different libraries. You can define different tasks in each ofthese libraries by using the ABA application, by the standard COPY command, or by loadingthem from macros created using the OUTPUT command.

Users access the specific defaults file that applies to their discipline when they first enterDraft. Use Display Save files to reduce the need to constantly set the defaults form.

3.9 Description of the Supplied ABA TasksThe tasks are:

• Process• Drawing• View based

Each one is selected at different levels within the application, and each relates to specificlevels in the hierarchy. Some tasks are Aveva defined and others user defined. Aveva tasks

12.03:12


are identified by an asterisk prefix and are described here. For details on user defined taskssee User Tasks.

3.9.1 Process TasksThese tasks operate on all of the drawings produced during a process run. SelectCreate>Area ADP Drawings…>Process Drawing Control>Process Tasks… to accessthese tasks.

Plot_Drawings

Plots all produced drawings in a ‘process run’, in a particular format, and to a directory, asspecified in the options.

Report_Labels

Produces a report for all drawings produced in a process run. The report files are created inthe 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 bodyformat. The current example reports on the labels and produces an output suitable for Excelinput and is listed below:

-- Code - this section sets data into PML variables!title = desc of site of ddnm!dateTime = object dateTime()!date = !dateTime.date() & '.' & !dateTime.month() & '.' & !dateTime.year()!area = func of drwg!tag = !!ce.exBtex-- Header - this section is the report header textTitle;Date;Area;Sequence;Tags-- Data - this section uses the pml variables to produce the report body!title & ';' & !date & ';' & !area & ';1;' & !tag

When the task is activated, a report file is created with the relevant header text and thevariable data is extracted to produce an entry in the report for each label on the drawing, forexample:

In this example, an entry has been created for each piece of equipment with fields that givethe site description, the current date, the area which is held as the function of the DRWG,the digit 1, and the displayed text from the SLAB label using an intelligent text string, forexample #EQUI(C2:).

Example:

Title;Date;Area;Sequence;Tags

Mechanical Equipment;11.8.1999;Z;1;23CS500

12.03:13


Hyper_Plant

This task produces a series of files which can be used to interface to the AVEVA HyperPlantproduct.

The task produces four files, which are linked by a common field - an index number thatrepresents a drawing:

• Plotfile, e.g. -dra1.pltThis is a base product format plot file, one for each drawing produced during an ABAprocess run.

• Hit file, e.g. -dra1.hitThis text file contains data about each label that appears on the drawing, specifying thelabel location on the page (0,0 is bottom left), the relevant design element referenceand name. One file is produced for each drawing produced during an ABA process run.

• Sheets file, e.g. -pdms_dsheet.outThis file provides the link between each drawing and its related plot file and hit file.A single file is produced for the ABA process run.

• Items file, e.g. -pdms_item_to_dsheet.outThis file provides the link between a design element and the sheet on which it appears.

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 determinethe 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 towhich sheet.

Finally, the plotfile could be converted to a tiff file format for inclusion on a web page, and thehitfile could be used to provide the location of each design element for the placement ofrelevant hyperlinks to other documents.

3.9.2 Drawing TasksThese tasks operate on a specific drawing. Select Create>Area ADP Library>TemplateDrawing or Modify>Area ADP Library>Template Sheet from the main menu to accessthem.

Keyplan_View

This is the Overlay Sheet method for keyplan production. It produces an OLAY basedkeyplan at SHEE level. To function correctly, the OVER name specified in the options mustexist in the library. This OVER must be constructed with SpPURP ABAT, and it should own aVIEW 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 areasbuilt in the ‘area definition library’.

When the drawing is processed, an OLAY element will be created under the SHEE elementthat references the specified OVER and shows the correct ‘hatched layer’ for the relevant

12.03:14


area. This is achieved by the setting of the OLAY attribute OSLV to include the design andthe 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 singlereport for the relevant drawing.

Schedule

This produces a table which creates a list of given elements according to a specifieddiscipline drawlist. This discipline is probably the same IDLI as the one you created for theView 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, tableentry, 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 onthe backing sheet and have the function attribute set to ‘Table Data’. The LVIS should be setFalse 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 befilled. That is, the main reserved area rectangle will be set FPEN 1 with subsequent set to 2onwards. The origin of the rectangle is important since it will determine the position of thefirst symbol within it. For example, the first reserved area rectangle for a vertical fill wouldhave the origin at the Top Left if the relevant symbols also had their origin at the Top Left.

12.03:15


3.9.3 View TasksThese 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.

12.03:16


Arrange_Labels

Scans the view for existing labels and arranges them around the border of the view to thespecified options as shown below.

Draw_MeasureLines

A series of lines are produced at the View limits to indicate a rule scale set to dimensionsspecified 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 ofthat view. The location of the north arrow can be set by creating a ‘reserved area’ on thetemplate drawing.

Create a VNOTE below the template view with LVIS FALSE and under it create aRECTangle with its origin at the centre and part-named with the string ‘n_arrow’. The taskwill look for this rectangle and use its position for the north arrow symbol. If the rectangledoes not exist, then the symbol is placed at a default position defined as the top-left cornerof the view.

The north arrow is orientated to conform to the actual north direction of the view. It alsofunctions correctly with any of the Isometric views, Iso 1 to 4 inclusive. Any other viewdirection such as elevation view is not given a north arrow.

12.03:17


The user can reposition the created SYMB element if required using the Draft standardapplication tools.

The north arrow SYMB will be created in a unique LAYE element which is named as per theVIEW plus a suffix /NorthArrow

3.9.4 Naming TasksWhen a Template/Area combination is selected during the drawing creation process, thedefault drawing name is the concatenation of the element names. For example, a drawingwhich used the template /DRTM-PIPING-A0 and area /A101 would be called /DRTM-PIPING-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 drawingprocess form. It is slightly different to other tasks because the template and area names areinserted into the passed parameters as parameter 1 and 2, and the actual task parametersare appended.

Another difference is that the task function is expected to return a string to ABA. If the returnstring 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 bychecking the database for a particular name, but it is possible that the name is also used inthe 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 calledfrom user defined tasks:

!!abanewdrwgs.checkname(!namestring) where !namestring is the required name.

This routine returns one of three values. 0, 1, and 2, where:

A sample of code to check this might be as follows:

!num = !!abanewdrwgs.checkname(!namestring)

0 means the drawing name is available

1 means the drawing name has been used in PDMS

2 means the drawing name has been used in the list of drawings about to be created by

ABA.

12.03:18


This use of naming tasks is described in more detail in the ABA User Guide.

3.10 Creating and Modifying Labelling1. To create a labelling convention use the ABA Tag Rule Definition form, displayed by

selecting Create > Area ADP Library > Labelling from the main menu.

2. To create a new tag rule set click on the Create Tag Rule Set button which displays theCreate Tag Rule Set form.

if !num eq 0 then

return !namestring $* its ok so use it

else

!!alert.error(‘Name already used’)

return ‘ ‘ $* return a blank name

endif

12.03:19


3. Enter a suitable name in the Name field and a suitable description in the Descriptionfield. When the new name and description have been entered click on the Apply buttonto confirm the settings.

4. To modify/replace a tag rule set use the pull down menu to pick the correct set youwant to modify, then click the Modify Tag Rule Set button, which displays the ModifyTag Rule Set form.

5. Edit the values in the Name or Description fields to those required and click the Applybutton.

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

12.03:20


10. Label Libraries. Select the library you want to use a label from using the pull downmenu at the top for the form. Once the library is selected pick the label by eitherselecting a label from the list under the library selection menu or click on the label youwant in the graphical view. This is simply a Draft representation of the labels so theusual zoom functionality is available. Once you have selected the label, click on theApply 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 Addbutton 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 theTag Rules list.

To modify/replace an existing tag rule:

Select the required tag rule from the Tag Rule Definition form and make the necessarychanges. Once the modifications have been made to the tag rule definition, click on theReplace button.

To remove an existing tag rule:

12.03:21


Make sure the correct rule is selected from the Tag Rule Definition form then click on theRemove button.

Note: Currently, the supplied functionality within the task *Arrange_Labels will operatecorrectly with a label template type of TXTM. If an SYTM is utilised, the labels maynot be positioned and orientated as you might expect. This limitation is due to thefact that an SYTM can have an origin at any point within its configuration and henceis indeterminable, unlike a TXTM origin.

3.11 Creating and Modifying Template Drawings

3.11.1 Introduction to Variant TemplatesABA has been designed to deal with sets of drawings produced from a template, which thenneed a few minor variations from the original template. For example, a template forproducing piping general arrangement may be satisfactory for 95% of drawings, but needsan additional isometric view to clarify some details on the remaining 5%. This is treated as avariant of the original rather than a new template.

The original template is known as the ‘master’ and the template with minor changes isknown as the ‘variant’. There can be only one master but several variants.

The master/variant process works as follows:• New drawings always use the master template.• 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.• It is not possible to make a variant revert to a master in the application.

3.11.2 Creating Template DrawingsTo create a template drawing :

1. Select Create > Area ADP Library > Template Drawing from the main menu. Thisdisplays the ABA Template Drawing form.

2. Enter a suitable name for the template in the Name field.3. Enter a suitable description for the template in the Description field.4. The value for the Date is automatically set to the current date.

12.03:22


5. The Drawn By field is automatically populated with the login name of the user (this istaken from the operating system, not the base product).

6. If necessary click on Attributes button to make any changes. This displays theDrawing Template Attributes form.

Note: The Drawing Template Attributes form uses a common layout available in thestandard ADP application. For a detailed explanation, refer to the DrawingProduction User Guide.

The form is divided into tabs allowing for example the assignment of line styles andcolours to the five line types (note line, leader line, etc.).

In the Intelligent Text system there are code words that are used to request theposition of certain elements. These expand to a string providing the location expressedin either the ENU (East North Up) coordinate system, as an absolute position (XYZ), inthe 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 DRAFTdatabase (including DEPT, REGI, DRWG, SHEE, VIEW, LAYE). The setting of theseattributes determines the output format used by the positional code words, and aredetermined by the selection made in the Intelligent Text tab. The same output formatis 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-definedsettings from the colour, line-pattern and thickness drop-down lists. Clicking on Pickallows a colour to be selected from colour palette. To select a user-defined style, tickthe checkbox; the User-defined line styles form is displayed. Select a Style Table andmake a selection from the list of styles.For the Hatch Pattern, you can assign a colour and either a standard fillstyle or auser-defined fill style. These are selected in a similar way to line colour and style.

12.03:23


If any changes have been made, click Apply, then Dismiss.7. To set the Function, click on the pull-down menu and select the appropriate function.

This sets the function of the drawing, which is used by the drawing selectionmechanism to separate different template types during drawing creation. It is also usedby the auto-numbering functionality.

8. Click OK when you are satisfied with the data in the Template Drawing form. The ABATemplate Sheet form is displayed.

9. If required click the Copy as Variant button to create a variant of the master. Thischanges the current element to the variant. This is only available during a modifyphase.

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.

12.03:24


12. Select the orientation of the paper (Landscape or Portrait). The paper size may alsobe 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 pathof a .plt file in the field).

14. Add tasks you want performed by using the left arrow to copy them from the TasksAvailable 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 Selectedwindow. Do this by clicking the Modify Task button.

By default, a simple modify form is shown which allows you to modify the taskparameters, but these are all treated as text. If a task function has a matching form it isshown in place of the default, allowing modify forms to be created with more controland flexibility.

15. Once the sheet is configured correctly, click OK and the Template View form appears.

3.11.3 Modifying Template DrawingsTo modify a template drawing:

1. Select Modify > Area ADP Library > Template Drawing from the main menu todisplay the ABA Template Drawing List form.

12.03:25


2. Select the template drawing you want to modify by clicking on it and the TemplateDrawing form appears. Follow the steps outlined in Creating Template Drawings tomodify the template drawing.

3.11.4 Modifying Template SheetsTo modify a template sheet:

1. Select Modify > Area ADP Library > Template Sheet from the main menu to displaythe ABA Template Sheet List form.

2. Select the template sheet you want to modify by clicking on it and the Template Sheetform appears. Follow the steps outlined in Creating Template Drawings, step 8onwards, to modify the template sheet as desired..

Note: That if you are positioned at a DRTMPL or SHTMPL then the relevant modify formwill be shown, bypassing those described above.

3.12 Creating and Modifying Template View

3.12.1 Creating a Template ViewTo create a template view:

1. Select Create > Area ADP Library > Template View from the main menu to show theTemplate Sheet List.

2. Double-click on the template for which you want to create a view. The ABA TemplateView form is then displayed.

12.03:26


3. From the Frame menu select any of the following:• On/Off - makes the View frame visible or invisible.• 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.

12.03:27


• Position > Cursor > Top Right - positions the top right of the view at the cursorposition.

• Position > Cursor > Bottom Left - positions the bottom left of the view at thecursor position.

• Position > Cursor > Bottom Right - positions the bottom right of the view at thecursor 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.4. Click on one of the buttons in the top right of the form:

• Create New - creates a new view under the SHTMPL e.g. TMPL3/S1/V1.• Remove - deletes the current view.• Copy - copies the current view to a new view.

5. Enter a suitable title for the view in the View field6. Select the type of drawing you want to create using the pull down menu. The options

are: • Wireline• Universal Hidden Line• Global Hidden Line• Local Hidden Line• Modelled Wireline

7. In the Section Mode field choose between Standard or Omit Fractional PipeComponents, which removes from the view any piping components that will only bepartly 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 whilststill fitting in the view frame.

• Nearest - choose Metric, Architectural, or Engineering.• 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 LimitInformation form is displayed, which shows the maximum 3D distances for thechosen scale.

12.03:28


11. Configure the View Settings:4. If required change the view attributes by clicking on the Attributes button which

displays the User-Defined View Attributes form.The Note Line colour and style are set in the same way as for the DrawingTemplates Attributes form (see Creating Template Drawings, step 6.).

5. Click OK to return to the Template View form.6. With the attributes of the view configured define the draw list of the view. Click on

the Draw List button to display the Add Drawing Item Lists form.

12.03:29


The Add Drawing Item Lists form contains a list of all the available classificationsin the Classifications window. The classifications may be added to the view byselecting them from the list and clicking on the Add button. They may also beremoved from the Classifications List (Current View) window by clicking theRemove button. You may add or remove a single classification or multipleclassifications.You can sort the classifications list by name using Sort by Name or by descriptionwith Sort by Desc. Do this by right-clicking in the list to display the sub-menushown below:

Within both lists, you can Select All of the available entries or clear the selectedentries 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.

12.03:30


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 Removebutton 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:

• Area - the default for producing a graphical representation of the area.• Keyplan - identifies this view as a Keyplan View. • User - allows you to create view tailored to your own requirements.

13. Add tasks you want performed by using the left arrow to copy them from the TasksAvailable window to the Tasks Selected window.All tasks are processed in the order in which they appear in the Tasks Selected list. Ifyou wish to modify the order then click the right mouse button whilst over the list andchoose 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 Selectedwindow. Do this by clicking the Modify Task button.

12.03:31


By default, a simple modify form is displayed which allows you to modify the taskparameters, but these are all treated as text. If a task function has a matching form it isshown in place of the default, allowing modify forms to be created with more controland flexibility

14. Click Apply when you have completed sections of the form.

3.12.2 Modifying Template ViewsTo modify a template view:

1. Select Modify > Area ADP Library > Template View from the main menu. The ABATemplate View form is displayed.

2. Make the changes required using the procedures detailed in the previous section.3. Click the Apply button to confirm.

3.13 Creating/Modifying Keyplan LayersThere are two methods of creating a keyplan within ABA. The first is the 'view basedmethod' and the second is the 'overlay sheet method'.

3.13.1 View Based MethodThis method relies on a template view being identified as a keyplan for every templatesheet, and then a view task being applied to that template view.

When a drawing is processed, all view limits are set through the selected area to be drawn.However, a keyplan requires different drawing limits as it covers a larger area, for examplethe whole plant.

To apply the view based method:

1. Select the Keyplan radio button from View Function section of the ABA TemplateView form.

2. Click the Keyplan Area button to display the Select Keyplan Area form. This lists allarea projects that have been setup using the Area Definition form.

12.03:32


3. There are two further options available on this form:• 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.

12.03:33


7. Click OK to confirm the changes.

This completes the processes for applying a view-based keyplan to the drawing. Whendrawings are processed, the task will apply the hatching to the appropriate area of thekeyplan view.

3.13.2 Overlay Sheet MethodAn overlay contains a view of the complete model containing grid lines and important designitems to give the correct impression of the overall plant layout. You need to size it to fit in thedesignated area on the template sheet so that it can be overlaid onto the completed drawingwhen the keyplan task is run.

Once the view is in place, the Add Hatched Areas to an Overlay form can be used to createa representation of each of the areas in the model. This form allows the user toautomatically create a set of boxes with shading to represent each area.

Note: You must be at or below the keyplan overlay sheet (OVER) before proceeding. If youare not then a warning appears notifying you that you are at the wrong place in thehierarchy. The utility creates one layer for each of the areas existing in the arealibrary.

This method uses an overlay sheet with area based hatching layers to represent thekeyplan.

To apply the overlay sheet method:

1. Select the Keyplan_View form.

2. Select the Keyplan from the drop-down list.3. Enter X and Y values to position the overlay on the drawing template designated area.

This sets the position of the bottom left corner of the overlay sheet.4. Enter an Angle and Scale of the overlay sheet.5. Click Apply to finish.6. Select Create > Area ADP Library > Keyplan Layers from the main menu to display

the Add Hatched Areas to an Overlay form.

12.03:34


7. Make sure Name has been set to the correct overlay (if not then click on the CE buttonand navigate to the desired overlay).

8. Set the Frame colour/style and Hatch Pattern colour/style for the hatching layers. Eachlayer 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 layerwill be that area for which the drawing is using.

9. Click Apply and ABA populates the keyplan hatch layers, one for each defined areawithin 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 includethe *Keyplan_View task.

12.03:35


3.14 Creating/Modifying Auto Number RulesAuto numbering allows the user to assign predefined numbering conventions to particulartypes of drawings. By identifying a particular type or group of elements ABA can assign adefined numbering convention.

To access auto number rules:

1. Select Create > Area ADP Library > Auto-Number Rules from the main menu todisplay the Number Settings form.

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 Auto-

Numbering Rules form.

12.03:36


Use this form to define how ABA creates the drawing number for a particular elementrule.

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.• Element Rules… button - covered later in this section.• Description - gives the description of the numbering 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 touse in the construction of the number.

• Indices - assigns the maximum number of significant figures to the drawing rule.5. Complete the cut, copy, replace… section of the form:

• Cut - removes the numbering rule from the list.• Copy - makes a copy of the rule and inserts it into the above fields.• Replace - replaces the current rule with the modified version.• 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 andAfter. The auto-numbering process uses each rule in turn, numbering all drawingsapplicable to that rule, then moves onto the next rule. Therefore the order of the rulelist determines the preference for how the drawings are numbered.

12.03:37


6. Complete the Data Display section of the form:• Key field - displays the current auto naming rules.• Data field - displays all the attributes for the selected rule. This includes the

Element Rules for the numbering rule.7. Complete the Data Display section of the form:

• Test - tests the numbering rule on the current element. If successful it will return aconstructed number, if the rule is not valid to the element then a warning informingof this will appear.

• Use Rule - as above, but the Rule attribute in the Element Rule is tested on thecurrent element.

8. Click the Element Rules button to display the Define Rules form. This allows you todefine which elements are to be selected for a particular rule. Auto-numbering works bygoing through each element rule to collect the relevant drawings, and then applies theassociated numbering rule to those drawings.

The File menu options are: • Save - saves the current element rules to the file dra-element-rules.pmldat, which is

stored in %PDMSUSER% by default.• Load - loads the element rules file into this form.• Location - defines where the element rules file is stored. The sub-menu options

are: User, Project, and PDMS.9. Complete the Definition section of the form:

• Name - the name of the corresponding number rule. The name here MUST beidentical to the numbering name.

12.03:38


• Types - identifies what type of element(s) to search for i.e. DRWG selectsdrawings.

• Rule - sets another selection rule for the elements to be acted upon.• Description - describes the element rule.• Include - includes the new element definition.• Replace - replaces the current rule with the modified rule.• Remove - removes the current rule.

10. The Defined section of the form lists all available element rules. To view or modify arule 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 SummaryThe auto-numbering function is controlled by a combination of files and uses the standardPML function autonam. This function makes use of two files:

• dra-elements.pmldat - determines which element is recognised as a matching element.For ABA this is a DRWG with its function attribute equal to ‘ABAT’.

• dra-nam.pmldat - controls the format of the DRWG name.

The format of the number created is made up from a combination of text and returnedvalues 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 isbased 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. Thesystem 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 ofthe supplied TASKLB).

3.15 Browsers

3.15.1 Browse Existing DrawingsTo browse through any existing drawings within the current MDB:

Select Browse > Existing Drawings from the main menu to display the ABA BrowseSheets form.

12.03:39


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:• File > Reload - refreshes the list of available ABA drawings.• File > Close - closes the form.• 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 functionattribute. For example, if you want to look through just the piping drawings, select the Pipingoption.

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.

12.03:40


3.15.2 Stored Log FilesTo view any stored log file from previous Process Drawing runs:

1. Select Browse > Stored LogFiles from the main menu to display the File Browserform.

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, thenwhen you select a file from the list and press the Apply button, the drawings processedduring that run are loaded into the Process Drawings Control form. This enables you torerun 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 optionwill not be available.

If you select the Edit option button and then click on a file, the file contents will be opened inWindows Note Pad.

To delete a file from the operating system press the Delete button.

12.03:41


12.03:42

Area Based ADP Administrator GuideCreating ABA Drawings

4 Creating ABA Drawings

During the administration of ABA it is possible to produce ABA drawings and test createdelements (for example, templates, areas, and tasks) prior to final refinement.

To create a drawing select Create > Area ADP Drawings from the main menu. Thisdisplays the Process Drawings Control form.

Please refer to the Area Based ADP User Guide for full details on how to use this form.

12.04:1

Area Based ADP Administrator GuideCreating ABA Drawings

12.04:2

Area Based ADP Administrator GuideUser Tasks

A 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 besuitable for all other users, such as those specific to a project - in this particular case thestandard supplied project SAM.

The user tasks are held along with all other tasks in the task library /Aba/task_library andcall functions stored in the PMLLIB path but are held in a separate directory, for examplebase product install path\AB_ADP\Pmllib\UserTasks

A.1 SAMGRIDSThis view task is supplied as TASK /Aba/view_task2 with a matching PML functionsamgrids.pmlfnc

The task is designed to create labels by reading design SCTN elements modelled torepresent each gridline with the description attribute holding the gridline reference.

The SCTN in the example above;

When the task is activated, the design SCTN elements used to represent the gridlines aredetermined and located by reading the keyplan discipline drawlist i.e. /keyplan_discipline.

Description ‘T-900’

Posstart E 320000mm N 429500mm U 518000mm

Posend E 320000mm N 470500mm U 518000mm

12.0A:1


This IDLI has the attribute function set to the word 'keyplan' and uses a rule to point to theset of SCTN elements.

If you want to reference a different set of SCTN elements, change this rule by selectingModify > Area ADP Library…>Classification from the main menu and selecting keyplanfrom 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 intersectionsdetermine the need for a gridline label. This label references an SYTM which extracts thedescription and the position.

For an example see SYTM /Aba/grids/NS which holds two intelligent text elements using thehash codes #DESC and #POSSE.

The labels are created in a unique LAYE element which is named as per the viewplus a suffix /Grids.

A.2 SAMKEYPLANThis keyplan view task is supplied as TASK /Aba/view_task5 with a matching PML functionsamkeyplan.pmlfnc.

The task is designed to create a hatched 2D element under the keyplan view whichrepresents the area limits of that view.

A keyplan view is defined as a VIEW element with attribute sppurp set to ABAK which is setusing the View Function keyplan option on the ABA Template View form. For details on howto 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 verticesat 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.

Example:

ALL ZONE WITH ( MAT ( ATTRIB NAME , '/UTIL-GRID' ) GT 0 )

12.0A:2


A.3 SAMGRIDDIMNThis view task is supplied as TASK /Aba/view_task6 with a matching PML functionsamgriddimn.pmlfnc.

The task is designed to create dimensions outside of the view limits between the gridlinereferences, if they have been created using the task as discussed above.

A.4 SAMEQUICLDIMNThis view task is supplied as TASK /Aba/view_task7 with a matching PML functionsam.pmlfnc.

The task is designed to create dimensions outside of the view limits between the origins ofany equipment elements that exist within the view limits.

12.0A:3


12.0A:4

Area Based ADP Administrator GuideLimitations

B Limitations

All of the normal base product limitations apply when using the ABA application. Thefollowing need special attention:

B.1 Name LengthsThere is a limitation of 120 characters for the element name attribute. This would notordinarily cause you any problems, but in the ABA application, the limitation needs to beconsidered when determining the drawing number.

By default the application names the Draft elements using the following format:

These combined names must be less than 120 characters in length.

B.2 Rule ExpressionsIn setting classification and tag rules, you will be using expressions to extract design modelelements.

It is perfectly legitimate to use the syntax:

ALL WITH (PURP EQ ‘ABC’)

However, although it produces the required result, it is time consuming since all thedatabases in the whole MDB are scanned if opened in read mode.

It is better to include a qualifier in the command:

ALL EQUI WITH (PURP EQ ‘ABC’)

B.3 Tasks and Symbol TemplatesIf an SYTM were to be used, the labels may not be positioned and orientated as you mightexpect and the report may not output the required data. The reasons for this are two fold; AnSYTM can have an origin at any point within its configuration. The display text of an SYTMcannot be expanded.

DRWG template_name + area_name

SHEE template_name + area_name + /S1

VIEW template_name + area_name + /S1/V1

LAYE template_name + area_name + /S1/V1/NorthArrow

12.0B:1

Area Based ADP Administrator GuideLimitations

The supplied tasks *Arrange_Labels and *Report_Labels are designed to operate withlabels 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 displaytext would have to be written to match that specific SYTM.

12.0B:2

Index


AABA

Administrative Tools . . . . . . . . . . . . . 3:1Defaults . . . . . . . . . . . . . . . . . . . . . . 3:2

ABA Defaults File . . . . . . . . . . . . . . . . . . 3:2ABA Drafting Administrator

role . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1ABA Drawings

create . . . . . . . . . . . . . . . . . . . . . . . . 4:1ABA Tasks

creating . . . . . . . . . . . . . . . . . . . . . . 3:10modifying . . . . . . . . . . . . . . . . . . . . 3:10supplied description . . . . . . . . . . . . 3:12

Administrative Access Rightssetting up . . . . . . . . . . . . . . . . . . . . . 1:2

Area Based ADPhierarchy . . . . . . . . . . . . . . . . . . . . . . 2:1

Area Librariescreating . . . . . . . . . . . . . . . . . . . . . . . 3:5

Areascreating . . . . . . . . . . . . . . . . . . . . . . . 3:6modifying . . . . . . . . . . . . . . . . . . . . . 3:6

Areas Window Sort Order . . . . . . . . . . . . 3:8Auto Number Rules

create . . . . . . . . . . . . . . . . . . . . . . . 3:36modifying . . . . . . . . . . . . . . . . . . . . 3:36

BBrowsers . . . . . . . . . . . . . . . . . . . . . . . . 3:39

CClassifications

creating . . . . . . . . . . . . . . . . . . . . . . 3:9modifying . . . . . . . . . . . . . . . . . . . . . 3:9

DDiscipline

based tasks . . . . . . . . . . . . . . . . . . 3:12drawing filter . . . . . . . . . . . . . . . . . . 3:1

Drawing Tasks . . . . . . . . . . . . . . . . . . . 3:14

EExisting Area

remove an existing . . . . . . . . . . . . . . 3:8replacing . . . . . . . . . . . . . . . . . . . . . 3:8

Existing Drawingsbrowse . . . . . . . . . . . . . . . . . . . . . . 3:39

FForm

ABA Defaults . . . . . . . . . . . . . . . . . . 3:2Add Drawing Item Lists . . . . . . . . . 3:29Add Hatched Areas to an Overlay . 3:34Add Tag Rules Lists . . . . . . . . . . . . 3:30Area Definition . . . . . . . . . . . . . . . . . 3:6Area Library Definition . . . . . . . . . . . 3:5Auto-Numbering Rules . . . . . . . . . 3:36Batch Username and Password . . . 3:5Browse Sheets . . . . . . . . . . . . . . . . 3:39Classification Definition . . . . . . . . . . 3:9Create Tag Rule Set . . . . . . . . . . . 3:19Defaults . . . . . . . . . . . . . . . . . . . . . . 3:3Define Rules . . . . . . . . . . . . . . . . . 3:38Drawing Template Attributes . . . . . 3:23

12.0Index page 1


File Browser . . . . . . . . . . . . . . . . . . 3:41Keyplan_View . . . . . . . . . . . . . . . . . 3:34Limit Information . . . . . . . . . . . . . . . 3:28Modify Tag Rule Set . . . . . . . . . . . . 3:20Number Setting . . . . . . . . . . . . . . . 3:36Question . . . . . . . . . . . . . . . . . . . . . 3:12Select Keyplan Area . . . . . . . . . . . . 3:32Select Label Template . . . . . . . . . . 3:20Set Area by Selecting Model Items . 3:7Tag Rule Definition . . . . . . . . . . . . . 3:19Task Definition . . . . . . . . . . . . . . . . 3:10Template Drawing . . . . . . . . . . . . . 3:22Template Drawing List . . . . . . . . . . 3:25Template Sheet . . . . . . . . . . . . . . . 3:24Template Sheet List . . . . . . . . . . . . 3:26Template View . . . . . . . . . . . . . . . . 3:26User-Defined View Attributes . . . . . 3:29

GGeographical Area

creating . . . . . . . . . . . . . . . . . . . . . . . 3:6

IIntroduction . . . . . . . . . . . . . . . . . . . . . . . 1:1

KKeyplan Layers

create using overlay sheet method 3:34creating using view based method . 3:32modify . . . . . . . . . . . . . . . . . . . . . . . 3:32

LLabelling

create . . . . . . . . . . . . . . . . . . . . . . . 3:19modify . . . . . . . . . . . . . . . . . . . . . . . 3:19

Limitations . . . . . . . . . . . . . . . . . . . . . . . . B:1Log Files Stored

browse . . . . . . . . . . . . . . . . . . . . . . 3:41

NName Checking . . . . . . . . . . . . . . . . . . 3:18Name Lengths

limitations . . . . . . . . . . . . . . . . . . . . . B:1Naming Tasks . . . . . . . . . . . . . . . . . . . . 3:18New Task Functions

creating . . . . . . . . . . . . . . . . . . . . . . 3:12

RRule Expressions

limitations . . . . . . . . . . . . . . . . . . . . . B:1

SSAMEQUICLDIMN . . . . . . . . . . . . . . . . . A:3SAMGRIDDIMN . . . . . . . . . . . . . . . . . . . A:3SAMGRIDS . . . . . . . . . . . . . . . . . . . . . . A:1SAMKEYPLAN . . . . . . . . . . . . . . . . . . . . A:2Symbol Templates

limitations . . . . . . . . . . . . . . . . . . . . . B:1

TTasks

drawing . . . . . . . . . . . . . . . . . . . . . 3:14keyplan view . . . . . . . . . . . . . . . . . . A:2limitations . . . . . . . . . . . . . . . . . . . . . B:1name . . . . . . . . . . . . . . . . . . . . . . . 3:18name checking . . . . . . . . . . . . . . . . 3:18process . . . . . . . . . . . . . . . . . . . . . 3:13user . . . . . . . . . . . . . . . . . . . . . . . . . A:1view . . . . . . . . . . . . . . . . . 3:16, A:1, A:3

Template Drawingscreate . . . . . . . . . . . . . . . . . . . . . . . 3:22modify . . . . . . . . . . . . . . . . . . . . . . 3:25

Template Sheetsmodify . . . . . . . . . . . . . . . . . . . . . . 3:26

Template Viewcreate . . . . . . . . . . . . . . . . . . . . . . . 3:26modify . . . . . . . . . . . . . . . . . . . . . . 3:26

VVariant Templates

introduction . . . . . . . . . . . . . . . . . . 3:22View Tasks . . . . . . . . . . . . . . . . . . . . . . 3:16

12.0Index page 2

area based adp administrator guide

Documents