AT_PIPERG_V_02_00

��

� � � � � � � � � � � � � � � � ��

REBIS

1600 RIVIERA AVENUE., SUITE 300

WALNUT CREEK, CALIFORNIA 94596 USA

PHONE (925) 933-2525FAX (925) 933-1920WEB WWW.REBIS.COM

��

�?@IB978D�9>6?B=1D9?>

��

Rebis documentation is copyrighted material. Reproduction of this material in any manner, in whole or inpart, is strictly forbidden by Rebis. ALL rights reserved.

�� Rebis reserves the right to update, revise, and make changes to this product at the discretion of Rebis withoutany obligation on the part of Rebis. This information herein is subject to change without notice.

�� Although Rebis’ programs have been tested and appear to produce satisfactory results, no warranty isexpressed or implied, by the authors or by Rebis, as to the accuracy or functioning of the program, and noresponsibility is assumed in connection therewith. All information presented is for review, interpretation,approval, and application by authorized personnel.

�� AutoPLANT® is registered trademarks of Rebis Inc.

AutoCAD® is a registered trademark in the U.S. Patent and Trademark Office by AutoDESK, Inc.

Crystal Reports® is a registered trademark of Seagate Software Inc.

ISOGEN® is a registered trademark of Alias Limited.

Adobe® Acrobat® Reader are registered trademarks of Adobe Systems Incorporated.

Windows®, MS-DOS®, Access® and all other names and trademarks are the property of their respectiveowners.

QA - AP020010

��

CHAPTER 1: INTRODUCTION

ABOUT THIS MANUAL ..............................................................................................................................1-2

NEW FEATURES IN V2.0 ...........................................................................................................................1-3

VERSION 2.0 NEW FEATURES .................................................................................................................1-32D PIPING APPLICATION..............................................................................................................1-3GENERAL.......................................................................................................................................1-3DRAFTING TOOLS MENU (* NEW *).............................................................................................1-4MISCELLANEOUS ATTACHMENTS..............................................................................................1-4PIPING TOOLS MENU ...................................................................................................................1-4COMPONENTS ..............................................................................................................................1-4

HELP AND DOCUMENTATION..................................................................................................................1-7ADDING YOUR HELP.....................................................................................................................1-8

HOW DOES IT WORK?............................................................................................................1-8PIPING CUSTOMER HELP......................................................................................................1-9

TIPS ON USING REBIS HELP .......................................................................................................1-9

SYSTEM REQUIREMENTS ......................................................................................................................1-10GRAPHICS ENVIRONMENT........................................................................................................1-10SYSTEM .......................................................................................................................................1-10AUTOPLANT APPLICATIONS......................................................................................................1-10STRUCTURAL APPLICATIONS...................................................................................................1-10SUPPLEMENTAL/OTHER APPLICATIONS.................................................................................1-10INSTALLATION.............................................................................................................................1-10ASSUMPTIONS ............................................................................................................................1-10KNOWLEDGE OF AUTOCAD ......................................................................................................1-11KNOWLEDGE OF DRAFTING AND DESIGN TECHNIQUES......................................................1-11

AUTHORIZATION.....................................................................................................................................1-11NEW SECURITY...........................................................................................................................1-11EXISTING HARDWARE LOCKS ..................................................................................................1-11

DOCUMENTATION CONVENTIONS........................................................................................................1-12

TECHNICAL SUPPORT AND TRAINING.................................................................................................1-13TYPES OF TECHNICAL SUPPORT.............................................................................................1-13

�12<5�?6�?>D5>DC

ii AutoPLANT PIPING

CHAPTER 2: GETTING STARTED

PROJECT CONFIGURATION.....................................................................................................................2-2PROJECT CUSTOMIZATION TOOLS............................................................................................2-2

AUTOPLANT CONFIGURATION EDITOR...............................................................................2-2AUTOPLANT CLASS EDITOR .................................................................................................2-3

SOFTWARE CONFIGURATION.................................................................................................................2-3SOFTWARE CONFIGURATION FILES..........................................................................................2-3

NETWORK VS LOCAL WORKSTATION INSTALLATIONS.....................................................2-3AT.INI KEYWORDS ........................................................................................................................2-4TEMPORARY FILES ......................................................................................................................2-4WINDOWS REGISTRY ENTRIES ..................................................................................................2-4SOFTWARE CONFIGURATION - HOW TO TOPICS ....................................................................2-5

SETUP MULTIPLE CONFIGURATIONS..................................................................................2-5SET THE NETWORK PATH.....................................................................................................2-5SET THE LOCAL WORKSTATION PATH................................................................................2-6SET/MODIFY AN APPLICATION CONFIGURATION ..............................................................2-6SET THE TEMPORARY FILES DIRECTORY..........................................................................2-6

INTERFACE ................................................................................................................................................2-7MENUS ...........................................................................................................................................2-7TOOLBARS.....................................................................................................................................2-8DRAWING AREA ..........................................................................................................................2-11COMMAND PROMPTS ................................................................................................................2-13DIALOGS ......................................................................................................................................2-15

CONNECTION TECHNIQUES ..................................................................................................................2-16GENERAL COMPONENT PLACEMENT......................................................................................2-17PLACE A COMPONENT IN SPACE .............................................................................................2-17PLACE A PIECE OF PIPE IN SPACE...........................................................................................2-18PLACE AN ELBOW IN SPACE.....................................................................................................2-21ATTACH TO AN EXISTING COMPONENT..................................................................................2-24PLACE A KNOWN DISTANCE FROM AN EXISTING COMPONENT..........................................2-26ALIGN TO EXISTING COMPONENTS.........................................................................................2-29AUTOMATICALLY PLACE CONNECTING PIPE (AUTO PIPE) ...................................................2-34CHANGE THE REFERENCE POINT............................................................................................2-36AUTOMATICALLY ROUTE COMPONENTS ................................................................................2-37PLACE ON A SMART POLYLINE.................................................................................................2-39

DRAWING PRODUCTION OVERVIEW....................................................................................................2-41

SPECIFICATION OVERVIEW...................................................................................................................2-43SPEC DATABASE TABLE FORMAT............................................................................................2-43PROVIDED SPECS AND CATALOGS .........................................................................................2-43

�12<5�?6�?>D5>DC

Reference Manual iii

CHAPTER 3: SETUP MENU

OVERVIEW .................................................................................................................................................3-2

DRAWING PREFERENCES .....................................................................................................................4-3

2D HIDDEN LINE OPTIONS .......................................................................................................................4-6

MODULE SETUP ......................................................................................................................................4-8AVAILABLE MODULES ..................................................................................................................4-8LOAD ALL.......................................................................................................................................4-9LOAD MODULE..............................................................................................................................4-9UNLOAD MODULE.........................................................................................................................4-9UNLOAD ALL MODULES ...............................................................................................................4-9VIEW MODULE DETAILS...............................................................................................................4-9APPLY.............................................................................................................................................4-9CABLE TRAY MODULE (PIPING MODULE ONLY) .....................................................................4-10

LOAD......................................................................................................................................4-10SPECS/CATALOGS ...............................................................................................................4-10COMPONENTS ......................................................................................................................4-10DRAWING PREFERENCES...................................................................................................4-10

CONDUIT MODULE (PIPING MODULE ONLY)...........................................................................4-10LOAD......................................................................................................................................4-10SPECS/CATALOGS ...............................................................................................................4-11COMPONENTS ......................................................................................................................4-11

DUCTILE IRON MODULE ............................................................................................................4-11LOAD......................................................................................................................................4-11SPECS/CATALOGS ...............................................................................................................4-11COMPONENTS ......................................................................................................................4-11

HIGH PURITY MODULE...............................................................................................................4-12LOAD......................................................................................................................................4-12SPECS/CATALOGS ...............................................................................................................4-12COMPONENTS ......................................................................................................................4-12

HVAC MODULE (PIPING MODULE ONLY) .................................................................................4-12LOAD......................................................................................................................................4-12SPECS/CATALOGS ...............................................................................................................4-12COMPONENTS ......................................................................................................................4-13

LINED PIPE MODULE ..................................................................................................................4-13LOAD......................................................................................................................................4-13SPECS/CATALOGS ...............................................................................................................4-13COMPONENTS ......................................................................................................................4-13

TUBING MODULE ........................................................................................................................4-13LOAD......................................................................................................................................4-13SPECS/CATALOGS ...............................................................................................................4-14COMPONENTS ......................................................................................................................4-14

VICTAULIC MODULE ...................................................................................................................4-14LOAD......................................................................................................................................4-14SPECS/CATALOGS ...............................................................................................................4-14COMPONENTS ......................................................................................................................4-14

MODULE CUSTOMIZATION ........................................................................................................4-15MODULE SETUP CUSTOMIZATION - HOW TO TOPICS...........................................................4-15

DEFINE A NEW MODULE GROUP CONFIGURATION ........................................................4-15DEFINE A NEW MODULE DIRECTORY STRUCTURE.........................................................4-16MODIFY THE MODULE SETUP DIALOG..............................................................................4-16

COMPONENT PREFERENCES................................................................................................................4-17SPECIFICATION...........................................................................................................................4-17NOMINAL SIZE.............................................................................................................................4-17LINE NUMBER..............................................................................................................................4-17

�12<5�?6�?>D5>DC

iv AutoPLANT PIPING

DATA MODE.................................................................................................................................4-17

COMPONENT COPY PREFERENCES ...................................................................................................4-18POST-COPY UPDATE AUTOMATION.........................................................................................4-18

PROMPT FOR NEW COMPONENT VALUE..........................................................................4-18SYSTEM DEFAULT UPDATING ............................................................................................4-19AUTOMATIC SCRIPT-BASED UPDATING............................................................................4-19

COMPONENT FIELDS .................................................................................................................4-19COMPONENT COPY PREFERENCES DIALOG ...................................................................4-19

PREFIX AND SUFFIX...................................................................................................................4-20BASIC SCRIPT UPDATE METHOD .............................................................................................4-21ESTABLISH POST-COPY COMPONENT UPDATE PREFERENCES.........................................4-21SET THE PREFIX AND/OR SUFFIX WHEN UPDATING COPIED COMPONENTS....................4-21COPY A COMPONENT ................................................................................................................4-22

COMPONENT UPDATE PREFERENCES ..............................................................................................4-23AVAILABLE FIELDS .....................................................................................................................4-23ADD > ...........................................................................................................................................4-24REMOVE.......................................................................................................................................4-24FIELDS TO INCLUDE...................................................................................................................4-24

CHAPTER 4: COMPONENT MENUS

PIPE COMPONENTS..................................................................................................................................4-2

BENDS AND RETURNS .............................................................................................................................4-4

BRANCHING COMPONENTS ....................................................................................................................4-5

TAP PORT...................................................................................................................................................4-6

VALVES ......................................................................................................................................................4-8TOPWORKS .................................................................................................................................4-8

AUTOMATIC INSERTION ........................................................................................................4-8MANUAL INSERTION ..............................................................................................................4-8TOPWORKS PLACEMENT CUSTOMIZATION .......................................................................4-9DIALOG SELECTION...............................................................................................................4-9SPEC SELECTION.................................................................................................................4-10CLASS SELECTION...............................................................................................................4-10TURN OFF TOPWORKS PLACEMENT.................................................................................4-10

USER VALVES ...........................................................................................................................4-11ADDING A CUSTOM COMPONENT............................................................................................4-11

FLANGES..................................................................................................................................................4-12

REDUCERS AND SWAGES .....................................................................................................................4-12

MISCELLANEOUS FITTINGS ..................................................................................................................4-13USER FITTINGS .........................................................................................................................4-15

ADDING A CUSTOM COMPONENT......................................................................................4-15

SUPPORTS ...............................................................................................................................................4-16ADDING A CUSTOM COMPONENT............................................................................................4-16PLACE A SUPPORT.....................................................................................................................4-17

MISCELLANEOUS ATTACHMENTS .....................................................................................................4-18PIPING..........................................................................................................................................4-18ISOMETRICS................................................................................................................................4-18ADDING A CUSTOM COMPONENT............................................................................................4-19REFERENCE DIMENSION ATTACHMENT .................................................................................4-19

CUSTOMIZATION CONSIDERATIONS.................................................................................4-21

COMPONENT PLACEMENT - HOW TO TOPICS....................................................................................4-21ADD OPERATORS TO VALVES (TOPWORKS) ..........................................................................4-21ALIGN TO EXISTING COMPONENTS.........................................................................................4-22

�12<5�?6�?>D5>DC

Reference Manual v

ATTACH TO AN EXISTING COMPONENT..................................................................................4-23AUTOMATICALLY ROUTE COMPONENTS ................................................................................4-23AUTOMATICALLY PLACE CONNECTING PIPE (AUTOPIPE)....................................................4-23CHANGE THE REFERENCE POINT............................................................................................4-24DEFINE A TAP PORT FOR OLET PLACEMENT.........................................................................4-24PLACE A COMPONENT IN SPACE .............................................................................................4-25PLACE A KNOWN DISTANCE FROM AN EXISTING COMPONENT..........................................4-25PLACE ON A SMART POLYLINE.................................................................................................4-26

COMPONENT MANIPULATION - HOW TO TOPICS...............................................................................4-27EDIT COMPONENT INFORMATION............................................................................................4-27UPDATE COMPONENT INFORMATION .....................................................................................4-27COPY A COMPONENT ................................................................................................................4-28ESTABLISH POST-COPY COMPONENT UPDATE PREFERENCES.........................................4-29MOVE A COMPONENT................................................................................................................4-29SET THE PREFIX AND/OR SUFFIX WHEN UPDATING COPIED COMPONENTS....................4-30

CHAPTER 5: PIPING TOOLS MENU

OVERVIEW .................................................................................................................................................5-2

CENTERLINE ROUTERS MENU................................................................................................................5-2EDIT COMPONENT PREFERENCES............................................................................................5-2FROM DIALOG .............................................................................................................................5-3

OPTIONS..................................................................................................................................5-3INFO MODE DIALOG ...................................................................................................................5-11FROM POLYLINE .......................................................................................................................5-12FROM FILE .................................................................................................................................5-13

FILE STRUCTURE .................................................................................................................5-13PRO-PIPE ROUTER ...................................................................................................................5-13DESIGNER ROUTER .................................................................................................................5-14FROM POINTS ...........................................................................................................................5-15

BACK ......................................................................................................................................5-15REDRAW................................................................................................................................5-15REF.........................................................................................................................................5-15ABS.........................................................................................................................................5-16NORTH...................................................................................................................................5-16SOUTH ...................................................................................................................................5-16WEST .....................................................................................................................................5-16EAST ......................................................................................................................................5-16UP...........................................................................................................................................5-16DOWN ....................................................................................................................................5-16PICK NEXT POINT.................................................................................................................5-16

CENTERLINE ROUTER - HOW TO TOPICS ...............................................................................5-17ROUTE A CENTERLINE FROM DIALOG ..............................................................................5-17ROUTE A CENTERLINE FROM POINTS ..............................................................................5-17ROUTE A CENTERLINE FROM POLYLINE ..........................................................................5-18ROUTE A CENTERLINE - DESIGNER ROUTER ..................................................................5-18ROUTE A CENTERLINE - PROPIPE ROUTER .....................................................................5-19ROUTE A CENTERLINE FROM FILE ....................................................................................5-19EDIT CENTERLINE PREFERENCES ....................................................................................5-19

REPRESENTATIONS ...............................................................................................................................5-20OPERATION BUTTONS...............................................................................................................5-20AUTOCAD ENTITIES....................................................................................................................5-21

ACIS .......................................................................................................................................5-212D VIEW .................................................................................................................................5-21MESH .....................................................................................................................................5-21

�12<5�?6�?>D5>DC

vi AutoPLANT PIPING

3D DISPLAY MODES................................................................................................................................5-22WIREFRAME ..............................................................................................................................5-22CENTERLINE .............................................................................................................................5-22WIREFRAME W/CENTERLINE ..................................................................................................5-23MESH ..........................................................................................................................................5-23SET VIEWPORT DRAW MODE ...................................................................................................5-24RESET ALL VIEWPORT DRAW MODES.....................................................................................5-24SHADE ALL VIEWPORTS............................................................................................................5-24HIDE ALL VIEWPORTS................................................................................................................5-24CONTROL 3D DISPLAY MODES.................................................................................................5-24

3D DISPLAY UTILITIES MENU ................................................................................................................5-25SET OBJECT RIMS ON................................................................................................................5-25SET OBJECT RIMS OFF..............................................................................................................5-25SET CENTERLINE COLOR..........................................................................................................5-25SET CENTERLINE TYPE .............................................................................................................5-26SET CENTERLINE VISIBILITY.....................................................................................................5-26SET TORUS CENTERLINE TYPE................................................................................................5-27SET CLIPPED GRAPHICS TYPE.................................................................................................5-27

CONNECTIVITY CHECKER .....................................................................................................................5-27CHECKER ...................................................................................................................................5-27CHECK RUN ...............................................................................................................................5-29RESUME CHECKER ..................................................................................................................5-29CONNECTIVITY - HOW TO TOPICS ...........................................................................................5-29

CHECK SELECTED COMPONENTS FOR CONNECTIVITY.................................................5-29CHECK ENTIRE RUN ............................................................................................................5-29RESUME CHECKER ..............................................................................................................5-30

DIMENSION NODES.................................................................................................................................5-30

JOIN COMPONENTS................................................................................................................................5-31

STOP SIGNS ...........................................................................................................................................5-32PLACE STOP SIGNS FOR ISO....................................................................................................5-32

CHAPTER 6: DATABASE TOOLS MENU

OVERVIEW .................................................................................................................................................6-2

EDIT COMPONENT ..................................................................................................................................6-2EDIT COMPONENT - PAGE 2 ......................................................................................................6-4

UPDATE COMPONENT ............................................................................................................................6-5

CLEAN DATABASE ..................................................................................................................................6-6

VIEW DATABASE .....................................................................................................................................6-8

DATABASE INFORMATION .....................................................................................................................6-8CLEAR CONNECTIONS.................................................................................................................6-9VIEW TRANSACTIONS..................................................................................................................6-9

UPDATE FROM SPEC................................................................................................................................6-9

DATABASE - HOW TO TOPICS...............................................................................................................6-11EDIT COMPONENT INFORMATION............................................................................................6-11UPDATE COMPONENT INFORMATION .....................................................................................6-11CLEAN THE DRAWING DATABASE TO REMOVE INVALID LINKS ...........................................6-12VIEW THE DRAWING DATABASE...............................................................................................6-12

DRAWING DATABASE CUSTOMIZATION .............................................................................................6-13DRAWING DATABASE FORMAT.................................................................................................6-13DRAWING DATABASE TABLES ..................................................................................................6-14

HOW IT WORKS ....................................................................................................................6-15DRAWING DATABASE TABLE SCHEMAS..................................................................................6-16

�12<5�?6�?>D5>DC

Reference Manual vii

SCHEMA DEFINITION ...........................................................................................................6-16PIPING/ISOMETRICS COMPONENT DATA................................................................................6-17EQUIPMENT COMPONENT DATA..............................................................................................6-18DRAWING DATABASE CUSTOMIZATION - HOW TO TOPICS..................................................6-18

SET THE DRAWING DATABASE FORMAT AS MS ACCESS OR DBASE ...........................6-18SET THE EXTENSIONS FOR DBASE DRAWING DATABASE TABLES ..............................6-19ADD A TABLE TO THE DRAWING DATABASE ....................................................................6-19ADD/MODIFY THE DRAWING DATABASE TABLE STRUCTURE (FIELDS)........................6-20DEFINE THE DATA PUT INTO THE DRAWING DATABASE................................................6-20ADD A DRAWING DATABASE FIELD TO THE DRAWING PREFERENCES DIALOG.........6-21ADD/MODIFY THE FIELDS IN THE EDIT COMPONENT DIALOGS.....................................6-23

CHAPTER 7: 2D PIPING AND THE DRAFTING TOOLS MENU

2D PIPING APPLICATION OVERVIEW......................................................................................................7-2PACKAGING THE 2D PIPING PRODUCT .....................................................................................7-2HIDDEN LINE REMOVAL OUTPUT FOR CUSTOM ENTITIES.....................................................7-2AUTOCAD R14 VS. AUTOCAD 2000 .............................................................................................7-2MODIFICATIONS TO DRAWING PREFERENCES DIALOG .........................................................7-22D HIDDEN LINE OPTIONS...........................................................................................................7-3SYMBOL MANAGER ......................................................................................................................7-4RESTRICTIONS FROM THE STANDARD 3D PIPING PRODUCT................................................7-4

PIPING TOOLS ........................................................................................................................7-4DRAW SCRIPTS.............................................................................................................................7-52D HLR OPTIONS ..........................................................................................................................7-5

DRAFTING TOOLS MENU .........................................................................................................................7-6

SYMBOL MANAGER..................................................................................................................................7-6AUTOCAD 2000 USAGE ................................................................................................................7-6AUTOCAD R14 USAGE..................................................................................................................7-7PROCEDURES...............................................................................................................................7-7SYMBOL LIBRARY DETAILS.........................................................................................................7-9

TITLE BLOCK.............................................................................................................................................7-9

2D SYMBOLS ...........................................................................................................................................7-10CUSTOMIZATION ........................................................................................................................7-10

INSULATE PIPE........................................................................................................................................7-11

PIPE END SYMBOL..................................................................................................................................7-11

2D EDITING MENU ...................................................................................................................................7-11BROKEN PIPE..............................................................................................................................7-12BREAK..........................................................................................................................................7-12MEND............................................................................................................................................7-13MEND ALL ....................................................................................................................................7-13

CHAPTER 8: ANNOTATION

OVERVIEW .................................................................................................................................................8-2

ANNOTATION PREFERENCES ...............................................................................................................8-2ANNOTATION STYLE ....................................................................................................................8-2PLACEMENT ..................................................................................................................................8-3NORMAL MODE.............................................................................................................................8-3TEXT MODE ...................................................................................................................................8-3TEXT OPTIONS..............................................................................................................................8-4BLOCK OPTIONS...........................................................................................................................8-4CONTAINER OPTIONS..................................................................................................................8-4LEADER OPTIONS.........................................................................................................................8-4

�12<5�?6�?>D5>DC

viii AutoPLANT PIPING

EDIT ANNOTATION....................................................................................................................................8-5FORMAT.........................................................................................................................................8-5EDIT VERTEX.................................................................................................................................8-5ROTATE..........................................................................................................................................8-5MOVE..............................................................................................................................................8-5ANNOTATION.................................................................................................................................8-5EXIT ................................................................................................................................................8-6

DATABASE FIELD ANNOTATION.............................................................................................................8-6

LINE NUMBER ANNOTATION...................................................................................................................8-6

NOTES ANNOTATION ...............................................................................................................................8-7

ELEVATION ANNOTATION .......................................................................................................................8-7

COORDINATE ANNOTATION....................................................................................................................8-7

TAGS...........................................................................................................................................................8-7

INSTRUMENT BALLOONS ......................................................................................................................8-8

ANNOTATION - HOW TO TOPICS.............................................................................................................8-9EDIT ANNOTATION .......................................................................................................................8-9PLACE A MATERIAL TAG..............................................................................................................8-9PLACE AN INSTRUMENT BALLOON ..........................................................................................8-10DATABASE FIELD ANNOTATION - HOW TO TOPICS ...............................................................8-11

PLACE "MAIN SIZE" ANNOTATION ......................................................................................8-11PLACE "DESCRIPTION" ANNOTATION................................................................................8-11PLACE "LONG DESCRIPTION" ANNOTATION ....................................................................8-12PLACE "SPECIFICATION" ANNOTATION.............................................................................8-12PLACE "PIPE CUT LENGTH" ANNOTATION ........................................................................8-13PLACE "INSULATION" ANNOTATION...................................................................................8-13

LINE NUMBER ANNOTATION - HOW TO TOPICS.....................................................................8-14PLACE SHORT LINE NUMBER ANNOTATION.....................................................................8-14PLACE LONG LINE NUMBER ANNOTATION.......................................................................8-14PLACE SHORT LINE NUMBER ANNOTATION WITH CENTERLINE SYMBOL...................8-15PLACE LONG LINE NUMBER ANNOTATION WITH CENTERLINE SYMBOL .....................8-16

NOTE ANNOTATION - HOW TO TOPICS ...................................................................................8-16INSERT A GENERAL NOTE ..................................................................................................8-16

INSERT ELEVATION INFORMATION..........................................................................................8-17COORDINATE ANNOTATION - HOW TO TOPICS .....................................................................8-18

PLACE NE/ NS/ EW COORDINATE ANNOTATION ..............................................................8-18PLACE GENERAL COORDINATE ANNOTATION.................................................................8-18

CHAPTER 9: REPORTS MENU

OVERVIEW .................................................................................................................................................9-2

BILL OF MATERIALS ...............................................................................................................................9-2GENERAL PROCEDURE ...............................................................................................................9-3REPORT NAME..............................................................................................................................9-3REPORT FILE.................................................................................................................................9-4UNITS/PRECISION.........................................................................................................................9-4MISC. OPTIONS.............................................................................................................................9-4MATERIAL TAG OPTIONS.............................................................................................................9-5BILL OF MATERIALS CONFIGURATION ......................................................................................9-6

GENERAL TAB (BOM CONFIG) ..............................................................................................9-7TITLE TAB (BOM CONFIG) .....................................................................................................9-9HEADER TAB (BOM CONFIG) ..............................................................................................9-10ROW TAB (BOM CONFIG).....................................................................................................9-11COLUMN TAB (BOM CONFIG)..............................................................................................9-12

�12<5�?6�?>D5>DC

Reference Manual ix

BILL OF MATERIALS - HOW TO TOPICS ...................................................................................9-13GENERATE A BILL OF MATERIALS .....................................................................................9-13SELECT THE BOM FORMAT CONFIGURATION .................................................................9-14ADD/MODIFY A BOM FORMAT CONFIGURATION..............................................................9-14SET THE BOM PLACEMENT METHOD ................................................................................9-15SET THE BOM BORDER PROPERTIES ...............................................................................9-15SET THE BOM HEADER PROPERTIES................................................................................9-16SET THE BOM TITLE PROPERTIES.....................................................................................9-16SET THE BOM ROW PROPERTIES......................................................................................9-17SET THE BOM COLUMN PROPERTIES...............................................................................9-17

BILL OF MATERIALS CUSTOMIZATION.....................................................................................9-18HOW DOES IT WORK?..........................................................................................................9-18REPORT FILES......................................................................................................................9-18

GENERATE REPORTS ...........................................................................................................................9-19REPORT TYPE.............................................................................................................................9-20REPORT NAME............................................................................................................................9-20REPORT FILE...............................................................................................................................9-22OPTIONS......................................................................................................................................9-22UNITS/PRECISION.......................................................................................................................9-23OUTPUT .......................................................................................................................................9-23OK.................................................................................................................................................9-23REPORTS - HOW TO TOPICS.....................................................................................................9-24

GENERATE REPORTS..........................................................................................................9-24REPORT GENERATOR CUSTOMIZATION...........................................................................9-24HOW DOES IT WORK?..........................................................................................................9-24REPORT FILES......................................................................................................................9-25REPORT TYPES ....................................................................................................................9-25REPORT DEFINITION............................................................................................................9-25

REPORTS CUSTOMIZATION - HOW TO TOPICS......................................................................9-26ADD/MODIFY A REPORT TYPE............................................................................................9-26CREATE A NEW REPORT FILE ............................................................................................9-26ADD A NEW REPORT DEFINITION ......................................................................................9-26ADD A MENU COMMAND TO GENERATE A SPECIFIC EXTERNAL REPORT ..................9-27

CHAPTER 10: DRAWING PRODUCTION MENU

OVERVIEW ...............................................................................................................................................10-2

DRAWING SETUP ..................................................................................................................................10-2

WORK AREA SETUP .............................................................................................................................10-3WORK AREA ................................................................................................................................10-4REFERENCE DRAWINGS ...........................................................................................................10-4INSERTION POINT.......................................................................................................................10-5PICK..............................................................................................................................................10-5ROTATION....................................................................................................................................10-5MEMBERSHIP STATUS...............................................................................................................10-5XREF ATTACHMENT TYPE.........................................................................................................10-5NEW..............................................................................................................................................10-6OPEN............................................................................................................................................10-6SAVE.............................................................................................................................................10-6SAVE AS.......................................................................................................................................10-6CLOSE..........................................................................................................................................10-6CANCEL........................................................................................................................................10-6

WORK AREA VIEWS ..............................................................................................................................10-7CURRENT WORKING AREA .......................................................................................................10-7ADD...............................................................................................................................................10-7REMOVE.......................................................................................................................................10-7

�12<5�?6�?>D5>DC

x AutoPLANT PIPING

WINDOW ......................................................................................................................................10-7EDIT..............................................................................................................................................10-7COPY............................................................................................................................................10-8INSERT/APPLY IN MODEL ..........................................................................................................10-8PREVIEW......................................................................................................................................10-8AUTO ZOOM ................................................................................................................................10-8VIEW PROPERTIES.....................................................................................................................10-9

VIEW TITLE............................................................................................................................10-9VIEW.......................................................................................................................................10-9SCALE ....................................................................................................................................10-9PROJECTION TILE ..............................................................................................................10-10VIEW OPTIONS....................................................................................................................10-10MATCH LINE OPTIONS.......................................................................................................10-103D VIEW ENVELOPE...........................................................................................................10-10OK.........................................................................................................................................10-11CANCEL ...............................................................................................................................10-11EDIT SCALES.......................................................................................................................10-11COORDINATE SYSTEM ......................................................................................................10-12

UPDATE WORK AREA .........................................................................................................................10-12

CHAPTER 11: 2D TO 3D MENU

OVERVIEW ...............................................................................................................................................11-2

PROCESS OVERVIEW .............................................................................................................................11-2THE MAPPING PROCESS...........................................................................................................11-2MAPPING FILES...........................................................................................................................11-3

CLASSMAP.INI.......................................................................................................................11-3PIDFLD.INI .............................................................................................................................11-32D3D.INI .................................................................................................................................11-4PIDPREF.INI...........................................................................................................................11-5

SET PROJECT..........................................................................................................................................11-5

BROWSE/INSERT COMPONENTS..........................................................................................................11-6

PREFERENCES........................................................................................................................................11-7

CHAPTER 12: OTHER COMMANDS AND FUNCTIONS

SCRIPTING TOOLS MENU ......................................................................................................................12-2LOAD ............................................................................................................................................12-2UNLOAD .......................................................................................................................................12-2EXECUTE .....................................................................................................................................12-2DEBUG .........................................................................................................................................12-2

SPECIFICATION SELECTION DIALOG...................................................................................................12-2

DRAWING NODES AND DRAWING BORDER CUSTOMIZATION.........................................................12-3

SPECIFICATION SELECTION ERROR....................................................................................................12-3

SPECIFICATION VALIDATION ................................................................................................................12-4VALIDATION.................................................................................................................................12-4SPEC REPAIR ..............................................................................................................................12-4CATALOG REPAIR.......................................................................................................................12-4NOTES/WARNINGS .....................................................................................................................12-5DRAWING REPAIR.......................................................................................................................12-5

DRAWING SELECTION OPTIONS...........................................................................................................12-6ALL................................................................................................................................................12-6MANUAL .......................................................................................................................................12-6ADVANCED - CURRENT DRAWING ...........................................................................................12-6

�12<5�?6�?>D5>DC

Reference Manual xi

DOMAIN .................................................................................................................................12-7SELECT/ENTER.....................................................................................................................12-7TYPE ......................................................................................................................................12-7ATTRIBUTE FIELD.................................................................................................................12-7CONSTRAINT ........................................................................................................................12-8ATTRIBUTE VALUE ...............................................................................................................12-8OPERATOR............................................................................................................................12-9ACTIVE QUERIES..................................................................................................................12-9WINDOW SELECTION...........................................................................................................12-9INCLUDE XREFS ...................................................................................................................12-9SAVE ......................................................................................................................................12-9NEW .....................................................................................................................................12-10DELETE................................................................................................................................12-10

ADVANCED - MULTIPLE DRAWING .........................................................................................12-11DOMAIN ...............................................................................................................................12-11SELECT/ENTER...................................................................................................................12-11ADD DRAWINGS..................................................................................................................12-12TYPE ....................................................................................................................................12-12ATTRIBUTE FIELD...............................................................................................................12-12CONSTRAINT ......................................................................................................................12-12ATTRIBUTE VALUE .............................................................................................................12-12OPERATOR..........................................................................................................................12-13ACTIVE QUERIES................................................................................................................12-14SAVE ....................................................................................................................................12-14NEW .....................................................................................................................................12-14DELETE................................................................................................................................12-14

DEFINING A SELECTION SET ..................................................................................................12-15SELECT ALL THE COMPONENTS IN THE CURRENT DRAWING. ...................................12-15MANUALLY SELECT COMPONENTS IN THE CURRENT DRAWING ...............................12-15DEFINE MULTIPLE DRAWING QUERIES...........................................................................12-15DEFINE A CURRENT DRAWING QUERY...........................................................................12-16CREATE AND SAVE A QUERY ...........................................................................................12-16MODIFY AN EXISTING QUERY ..........................................................................................12-17DEFINE A COMPLEX QUERY (MULTIPLE CONSTRAINTS)..............................................12-17DELETE A QUERY...............................................................................................................12-18

��

This Reference Guide was generated in response to user’s requests to have the application on-line help formatted in a manner that could be referenced away from a setting in which the actualsoftware was installed and running in front of them. It is provided in Adobe® Acrobat® Readerformat to enable you to print as many copies of this information as desired.

ABOUT THIS MANUAL 1-2

NEW FEATURES IN V1.5 1-3

HELP AND DOCUMENTATION 1-7

SYSTEM REQUIREMENTS 1-10

AUTHORIZATION 1-11

DOCUMENTATION CONVENTIONS 1-12

TECHNICAL SUPPORT AND TRAINING 1-13

� � � � �

�

�>DB?4E3D9?>�2?ED�D89C��1>E1<

1-2 AutoPLANT PIPING

�

��

This Reference Guide was generated in response to user’s requests to have the application on-line helpformatted in a manner that could be referenced away from a setting in which the actual software was installedand running in front of them. Remember, this manual was generated from the on-line help, and therefore mayhave references to help topic links, which are not available as links in this format. The manual is provided inAdobe® Acrobat® Reader format to enable you to print as many copies of this information as desired. Anoption to install the Acrobat Reader is available on your installation CD.

This section provides a brief description of the content in each chapter of this Reference Manual. Thechapters are primarily organized by the layout of the main PIPING application menu, i.e., all of thecommands that reside in a particular PIPING submenu are covered in one chapter.

+ Chapter 1: Introduction: This contains an overview of the reference manual.

+ Chapter 2: Getting Started: This chapter introduces software authorization and project setup, thenprovides several step-by-step exercises to get you acquainted with the PIPING interface.

+ Chapter 3: Setup Menu: This chapter covers the commands in the Piping/Setup menu.

+ Chapter 4: Component Menus: This chapter covers the various Piping component menus.

+ Chapter 5: Piping Tools Menu: This chapter covers the commands in the Piping/Piping Tools menu.

+ Chapter 6: Database Tools Menu: This chapter covers the commands in the Piping/Database Tools menu.

� Chapter 7: Drafting Tools Menu: This chapter covers the commands in the Drafting Tools menu. It alsoprovides an overview of the new 2D PIPING application functionality.

+ Chapter 8: Annotation Menu: This chapter covers the commands in the Piping/Annotation menu.

+ Chapter 9: Reports Menu: This chapter covers the commands in the Piping/Reports menu.

+ Chapter 10: Drawing Production Menu: This chapter covers the commands in the Piping/Drawing Productionmenu.

+ Chapter 11: 2D to 3D Menu: This chapter covers the commands in the Piping/2D to 3D menu.

+ Chapter 12: Other Commands/Functions: This chapter covers other Piping commands, functions, andutilities that are in general not executed explicitly from the Piping menu.

�>DB?4E3D9?>�5G��51DEB5C�9>��

Reference Manual 1-3

�� This area of the PIPING help system provides version-by-version links to new features added to theapplication. The following identifies the New Features and Modifications in Version 2.0 of the PIPINGapplication.

�� The following provides a brief description of the new features and modifications in Version 2.0 of thePIPING application.

��

A 2D version of the AutoPLANT PIPING application may now be purchased separately. Users that purchasean authorization for the full 3D AutoPLANT PIPING application will get the 2D functionality free of charge.

The 2D PIPING product will be installed in the same manner as the 3D PIPING product. The functionalitywill be controlled by the Rebis Security system. The security system will control whether a user has access tothe 2D or 3D PIPING environment and the associated commands and functions. When an Authorizationrequest is made, the request will be specifically for the use of 2D or 3D PIPING. This will be controlled bythe creation of either a 2D or 3D piping model, export to PCF etc. The primary control of the componentdrawing mode will be handled through the Drawing Preferences dialog.

��

� The AutoPLANT report writer has been upgraded to version 7.0 of Crystal Reports. Due to an anomaly inCrystal Reports, you should request the free correction release of version 7.0 from Seagate (version7.0.100.15 or higher). This will enable version 5.0 reports to be saved without crashing under version 7.0(this is only if you are using version 7.0 of Seagate). If you are currently customising reports, you maycontinue to do so with version 5.0. However, obviously the new report templates delivered can only bemodified with version 7.0 or higher.

�� Although version 8.0 has not been tested we expect this bug has been corrected in the standardversion 8.0 release allowing version 5.0 reports to be saved in version 8.0. Under this version thereport should be saved as a version 7.0 report unless you want to upgrade his own runtime to version8.0.

� Architectural Desktop support: This version will be supported when run with the version of AutoCADthat is delivered with Architectural Desktop. There is no interaction with any of the Desktop objects orany other added functionality associated with the Desktop product.

� DIN specs now have the nominal diameter prefixed with DN, such as DN100 for 100mm pipe. Variousother changes were made to support the DN prefix. These include a correction to pulled pipe.

� Using international settings in Windows for decimal delimiter now works correctly for welds and withISOMETRICS dimensioning.

� Toolbars now load correctly on computers using dual-byte character sets (Asian characters)

� New HDPE Catalog and spec. The catalog is called Driscopipe and the spec HDPE.

�>DB?4E3D9?>�5BC9?>��5G��51DEB5C


�

��

� The Drafting Tools menu has been added to the main Piping menu. It contains commands specificallydesigned for the placement and manipulation of 2D AutoCAD entities. A new Symbol Managerapplication is included, which provides a dockable interface (AutoCAD 2000 ONLY) that lists symbolsin a tree view. A separate floating dialog interface is provided for AutoCAD R14 users. These symbolsmay be inserted from the Symbol Manager directly into your drawing, or new symbols added.

� The Broken Pipe commands, which were previously located in the Annotation menu have been moved tothe Drafting Tools menu. The 2D symbol placement options that were also in the Annotation menu havealso been moved to this menu.

��!"��

� Reference Dimension attachment: The Reference Dimension attachment is now available for placementby executing the Miscellaneous Attachments option from the Piping/Iso menu, then selecting ReferenceDimension. This attachment is provided to enable you to dimension from a point on a component to adisconnected item in an ISOGEN isometric drawing generated from a PIPING model or ISOMETRICSdrawing using AutoPLANT Import/Export. This capability was added to enable you to identify thecomponent and the item to which it references.

��

� 3D Display Utilities/Set Clipped Graphics Type: Enables you to toggle the display of clipped cylinder(pipe) graphics to either Baseballs or Quadrant display. You may also enter SETCLIPPEDGRAPHICS atthe command line to manually toggle this clipped graphics display of individual cylinders.

� Representations: The numerous individual menu commands that were provided to generate graphicrepresentations of your components have been centralized in a single dialog control.

#�" ��

� Nozzles: A need has been established to create a nozzle component that will simply represent the nozzleas a symbolic representation and will typically be used when the user has already modeled the nozzle butneeds a connection to an existing pipe line. This would allow complete Isos to be generated as well as acomplete Bill Of Materials output and other requirements. To satisfy this requirement the existing nozzlecomponent has been modified.

� High Purity elbow draw scripts have been improved to be more realistic. They now include a straightsection of tube before the bend.

� Insulation is now drawn on all components, not just pipe and elbows.

� Pulled pipe is now available in the Tubing module (renamed from Swagelok)

� Tap ports can now be placed on diaphragm valves.

� Single and double line representations have been enhanced. Both single and double line modes will nowdraw elevation views correctly. The check valve representations have also been corrected.

� Pulled pipe now can be tapped on the straight sections. You can also add pipe supports to the straightsections.

� The cut pipe symbol can now be optionally changed to the Japanese standard.

�>DB?4E3D9?>�5BC9?>��5G��51DEB5C


� Rectangular and Round HVAC components in imperial, metric, and mixed metric units have been added.The McGill catalog was used.

�449D9?>1<�@9@5�CE@@?BD�DI@5C�81F5�255>�14454�1. Generic Guides/Anchor Boxes

2. Vessel Pipe Guides

3. Platform Pipe Guides

4. Riser Clamp

5. Base Anchor

6. General Hanger

7. Rod Spring Hanger

8. Pipe Lug Attachment

9. Elbow Lug Attachment

10. Angle Steel Trapeze Hanger Bar

11. Single C-Channel Trapeze Hanger Bar

12. Spring Can Trapeze Hanger

13. Tee Shoe with Pad

14. Pipe Insulation Saddle

15. Pipe Wear Protection Pad

16. Adjustable Post Support

17. Adjustable Elbow Spring Support

18. Base Spring Support

19. Dummy Leg Support

20. Single Pipe Trunnion Support

21. Double Pipe Trunnion Support

22. General Steel Support

23. Attached General Hanger

24. Attached Angle Steel Trapeze Hanger Bar

25. Attached Single C-Channel Trapeze Hanger Bar

26. Attached Adjustable Post Support

27. Attached Base Spring Support

28. Attached Channel Shoe Support

29. Attached Tee Shoe Support

30. Attached Slide Plate Assembly

31. Attached Generic Guide Boxes

32. Attached Generic Anchor Boxes

33. Attached U Bolt Anchor

34. Insulated Pipe Vessel Guide

�>DB?4E3D9?>�5BC9?>��5G��51DEB5C


�

�449D9?>1<�@9@9>7�3?=@?>5>DC�81F5�255>�14454�1. Trimmed 45 degree Elbow

2. Reducing Lateral

3. Long Weldneck Flange

4. Control/Ball Valve

5. Control/Globe

6. Control/Check

7. Control/Butterfly

8. Control/Angle

9. Control/3 Way

10. Control/4 Way

11. Control/Gate

12. Relief/Angle

13. Pressure Reducing/Angle

14. Pressure Reducing/Instrument Angle

15. Miscellaneous Fittings/Blinds/Restriction Plate

16. Miscellaneous Fittings/Strainers/2- Port Wye

�9C3�1449D9?>1<�3?=@?>5>DC�1. Reinforcing Pad

2. Plain Lock Coupling # 90

3. Roto Chain Links

4. Roto Chain Operator

5. Injection Quill

6. Venturi Flow meter Symbol

7. Complex Flow meter Symbol

8. Isogen Reference Dimensions

� General components have been added to the High Purity module. Ball valves have been added to theHigh Purity catalog and specs as well. The valve topworks have been improved for this module.

�>DB?4E3D9?>$5<@�1>4�?3E=5>D1D9?>


��The following table describes the help/tutorial documents provided with your software:

�9<5�1=5 �5C3B9@D9?>��335CC

AT_PIPE.PDF Description: This is an Adobe Acrobat Reader PDF version of this Tutorial.

Access: Select AutoPLANT 3D/Tutorials/Piping from your Windows Start menu.

AT_PIPE.CHM Description: This is the main PIPING application help file. It provides a detailed description of every available feature andfunction.

Access: Select Help/Contents from the Piping application menu, or select AutoPLANT 3D/Program Help Files/PIPINGHelp from your Windows Start menu.

AT_XCHG.CHM Description: This is the main Import/Export module application help file. It provides a detailed description of every availablefeature and function.

Access: Select Help/Contents from the Import/Export application menu, or select AutoPLANT 3D/Program HelpFiles/Import-Export Help from your Windows Start menu.

AT_CUS.CHM Description: This help system provides information on customizing many of the program functions provided with yourAutoPLANT applications (e.g., project customization, drawing database customization, module customization, report/BOMcustomization, etc.).

Access: Select AutoPLANT 3D/Customization Tools and Help/AutoPLANT Program Customization Help fromyour Windows Start menu.

BSCRIPT.CHM Description: This help system provides information on AutoPLANT Basic Language Extensions provided to customize almostany area of the application. Each topic provides the command/function prototype, a description of its parameters, and an example.Help is also provided for the Standard Basic language elements. Context-sensitive help is provided for almost all of theselanguage elements when using the Rebis Script Editor to customize/create basic scripts. Simply place the cursor within theelement you need help on and pressing the ‘ function key.

Access: Select AutoPLANT 3D/Customization Tools and Help/Basic Language Reference Help from yourWindows Start menu. The Rebis Script Editor may also be launched from this program group.

AT_CE.CHM Description: This is the AutoPLANT Class Editor application help file. The AutoPLANT Class Editor provides an intuitivegraphical user interface to modify the information in the configuration files that define the PIPING/ISOMETRICS modules and theindividual components available in each module. It also provides direct access to the method script files, port definition, andspecification search criteria that are used by each component class.

Access: Select Help/Contents from the Class Editor application menu, or select AutoPLANT 3D/Customization Toolsand Help/Class Editor Help from your Windows Start menu.

AT_CFG.CHM Description: This is the AutoPLANT Configuration Editor application help file. The AutoPLANT Configuration Editor wasdesigned to remove the tedious effort that would have been required to manually edit the configuration files used to create andcustomize project configurations.

Access: Select Help/Contents from the Configuration Editor application menu, or select AutoPLANT 3D/CustomizationTools and Help/Configuration Editor Help from your Windows Start menu.

DLG_EDIT.CHM Description: This is the Rebis Dialog Editor application help file. The Rebis Dialog Editor provides an intuitive graphical userinterface to create/customize AutoPLANT-compatible Basic dialogs that may be used in your Basic scripts and functions.

Access: Select Help/Contents from the Dialog Editor application menu, or select AutoPLANT 3D/Customization Toolsand Help/Dialog Editor Help from your Windows Start menu.

EBS_EDIT.CHM Description: This is the Rebis Script Editor application help file. The Rebis Script Editor provides an intuitive user interface tocreate/customize AutoPLANT Basic drawing scripts and functions. Context-sensitive help is provided to almost every standardBasic and Rebis Basic API Extension command, function, data type, etc.

Access: Select Help/Contents from the Script Editor application menu, or select AutoPLANT 3D/Customization Toolsand Help/Script Editor Help from your Windows Start menu.

�>DB?4E3D9?>$5<@�1>4�?3E=5>D1D9?>


�

EXPLORER.CHM Description: This is the Rebis Explorer/ID application help file. Rebis Explorer is an interactive 3D viewer for large models andsets of models, which may be purchased separately. You can load multiple models varying from thousands to millions of trianglesin size and interact with them at a guaranteed frame rate. It supports multiple formats via a plugin mechanism, as well as its ownnative file formats, AutoCAD’s *.dwg and *.dxf files and 3D Studio’s *.3ds files are supported. A range of navigating and viewingcontrols enable even the largest and most complex model to be explored with ease.

Access: Select Help/Help Topics from the Explorer/ID application menu, or select AutoPLANT 3D/Explorer ID/RebisExplorer Help from your Windows Start menu.

SPECGEN.CHM Description: This is the Specification Generator application help file. The Spec Generator is a stand-alone application whoseprimary function is to generate specifications for use with Rebis applications.

Access: Select Help/Contents from the Spec Generator application menu, or select AutoPLANT 3D/SpecGen/SpecGenHelp from your Windows Start menu.

MIGRATE_X.PDF Description: A migration guide is provided in PDF format that describes additions/modifications made in this release of thesoftware.

Access: This document resides in your ..\SUPPORT directory.

�� Separate help files are provided for each of the supplemental applications that ship with yourAutoPLANT software. These helps may be launched individually via the AutoPLANT/CustomizationTools and Help group in your Windows Start menu, or by starting the application and selectingHelp/Contents.

�� Rebis has developed a simple system to enable Dealers, Contractors, Users, etc. to provide links to their owncustom HTML help system within each primary AutoPLANT application’s help system.

$�%��&'

The topic Adding Your Help/Piping Customer Help that is compiled within the PIPING help file provides alink to a stand-alone HTML file named CUSTPIPE.HTM. This file may be modified to form the start pointfor your custom HTML help system. The path and name of this file is assigned in the >+HOS'RFV@ group ofyour ..\CFG\AT.INI file as shown below and may be modified.

>+HOS'RFV@

3,3( �1(7:25.B5227�?6XSSRUW?&8673,3(�KWP

,62 �1(7:25.B5227�?6XSSRUW?&867,62�KWP

(43 �1(7:25.B5227�?6XSSRUW?&86(43�KWP

$,62 �1(7:25.B5227�?6XSSRUW?&867$,62�KWP

;&+* �1(7:25.B5227�?6XSSRUW?&867;&+*�KWP

You can modify the CUSTPIPE.HTM file to include links to your own HTML help topics using any HTMLeditor (Microsoft Word 97 can be used to create HTML files).

This system was devised to enable you to create your own internal set of procedures in HTML format, whichmay then be accessed directly from within the individual AutoPLANT application help systems. This systemalso enables you to download or upgrade your existing AutoPLANT help files, while maintaining the integrityof your internally generated HTML procedures.

The following procedure explains how to modify CUSTPIPE.HTM to link your own internal procedures to aRebis application HTML help system. This example explains how to create a new HTML file namedMyProc1.HTM, then establish a link to this procedure by modifying the provided CUSTPIPE.HTM file usingMicrosoft Word 97.

�� Create a directory where you will want to store your HTML help procedures.

�� Start Word.

�� Enter some text for your topic. For example, type My Procedure and tag it using the Heading 1 style. Entersome more text as desired to define a common procedure used by your organization.

�>DB?4E3D9?>$5<@�1>4�?3E=5>D1D9?>


�� Select File/Save As, then set the Save As Type selection to HTML Document. Type the file name asMYPROC1.htm and then save the file in the directory created in Step 1.

�� Open the ..\SUPPORT\CUSTPIPE.htm file in Word 97 (you may need to change the file type selection to*.htm).

�� You can change the text "Example" to the name of your organization, or whatever you would like.

�� Create a new line and type My Procedure 1.

� Select the text My Procedure 1 with your cursor, then select Insert/Hyperlink.

� Press the Browse button next to the Link to file or URL field.

�� Select your MyProc1.htm file from the directory created in Step 1, then press OK. Press OK to assign thelink.

�� Save the file and exit. That’s all there is to it.

�� To test your link, run the PIPING application help file. Display the Adding Your Help/PIPING CustomerHelp topic, then press the Click here to display your CUSTPIPE.HTM button. Your link now appears in theCUSTPIPE.htm help topic in a separate HTML help window. Click on the My Procedure 1 link to displayyour custom help procedure.

�� There is a wealth of additional information available on HTML help via the Internet.

�(�(��#��"��$��

The Add Your Help topic above explains how you can add a link to your own HTML based help system fromwithin PIPING’s help. The main HTML page of your help system must be named CUSTPIPE.HTM and mustreside in the same directory as the PIPING help file AT_PIPE.CHM. Once you have created your helpsystem, you can click the Display your Custom HTML Help button in the PIPING Customer Help topic toaccess it. An example CUSTPIPE.HTM has been created for you and may be modified.

�� Rebis Help has been designed to provide you access to a variety of different types of help. The suggestionsbelow will make the help system more useful.

Table of Contents With our new HTML help format, a Table of Contents is always displayed in the left pane of yourhelp window. As you click on links within a topic, the topic that you jump to is automaticallyhighlighted in the left pane to enable you to more easily view where you are within the overall helpsystem.

Index An extensive index of help topics has been provided to enable you to quickly locate information ona particular topic. Click on the Index tab, then begin entering the word(s) that you want to search.As you type, the index will automatically scroll using the letters entered as a filter. When you findan entry in the index that you want to view, press the Display button.

Search A more thorough search for a specific keyword or phrase may be performed from the Search tab.Click on the Search tab, then enter the keyword or phrase that you want to find and press ListTopics. All of the topics within the help system that contain the entered keyword or phrase willappear in the selection list. Select the topic that you want to display, then press the Display buttonto view the topic.

Relationship betweenCommand Reference andHow To topics

The Command Reference folder in the help system has been organized to replicate the layout ofthe application menu system as closely as possible. Where deemed necessary, a set of How Toprocedures are provided in a separate How To folder below the actual command’s folder.

�>DB?4E3D9?>)ICD5=�*5AE9B5=5>DC


�

Printing The new organization of Rebis help systems makes printing easier than ever. To print the currenttopic, simply select it in the Table of Contents, then press the Print button. Enable the Print theselected topic radio button in the dialog displayed, then press OK. If you want to print all of thetopics that reside in a particular folder and all of its sub-folders, simply select the folder and pressPrint, then enable the Print the selected heading and all subtopics radio button, then pressOK. All topics in and below the selected folder will be printed in the order in which they are definedin the folder.

Adding Your Own Help Rebis has devised a system to enable you to add a link to your own custom set of internalprocedures, etc. from within each Rebis application help system. This information can be foundunder the folder Adding Your Help that appears at the bottom of the Table of Contents for eachhelp system.

��

� �� AutoCAD Release 14/2000 installed and fully operational.

��

��OperatingSystem

CAD Environment Processor RAM Disk Space

Windows 95, 98,NT, or 2000

AutoCAD r14, 2000,or 2000i

Pentium-Pro 200mHz 64 MB(128 MBrecommended)

650 MB(1 GB recommended)

�� OperatingSystem

CAD Environment Processor RAM Disk Space

Windows 98,NT, or 2000

AutoCAD 2000 Pentium-Pro 200mHz 64 MB(128 MBrecommended)

650 MB(1 GB recommended)

�� Supplemental applications are designed to work in the same operating environment as the primary applicationwith which it is associated. These programs usually require significantly less resources in terms of storage andmemory than do the application types listed above.

��To learn how to install the software and configure your system, refer to the Software Installation andConfiguration insert that was shipped with your CD.

��Certain assumptions are made about your knowledge of AutoCAD and your knowledge of drafting and designtechniques.

�>DB?4E3D9?>�ED8?B9J1D9?>


��Rebis assumes that you already know AutoCAD Release 14/2000 in the Windows 95/NT environment. Noattempt is made to educate you in the ways of AutoCAD. Therefore, you should refer to the documentationprovided with your AutoCAD software for answers to any questions you may have about that environmentand command set.

�� AutoPLANT is intended to make the professional drafter or designer more efficient. The documentationassumes that those who use this software are already familiar with the intricacies of these disciplines.Therefore, no attempt is made to teach drafting and design in these areas.

�� !��All software authorization for new Rebis products is handled by the new Rebis Security Manager. Thisapplication is installed when you install your AutoPLANT software. This application may be launched byselecting Rebis Security/Rebis Security Configuration Manager from your Windows Start menu. This willenable you to authorize, or request an authorization code for all of your AutoPLANT applications in one easyto use interface. When you start an application that has not been authorized, a dialog will display promptingyou to authorization the application as an Evaluation copy for a limited number of days, or to start theapplication in Demo mode. The application can only be fully authorized using the Rebis SecurityConfiguration Manager.

��%)��+

No new hardware locks will be issued upon the relase of the Rebis Security Manager. All new purchases willutilize moveable firmware.

�,��$��-%��.��&�

The old hardware locks were implemented using Alladin’s Hasp Locks. Hasp locks were attached to theprinter port and require hasp drivers to be detected by the application. All hardware locks are initially set toexpire within a month (an authorization code is required to remove the expiration date). Upon implementationof the Rebis Security Manager, no existing hardware locks will be authorized for use with applications. Thismeans the old hardware locks will not work with the new applications. Clients should keep their old hardwarelocks to allow product support for older versions. The read-only properties of the existing hardware lock canonly be viewed within the Configuration View, not authorized.

�� The Rebis Security Configuration Manager provides a help file with detailed instructions forauthorizing your software. Start the application by selecting Rebis Security/Rebis SecurityConfiguration Manager from your Windows Start menu, then select Help/Contents to view thisinformation.

�>DB?4E3D9?>?3E=5>D1D9?>�3?>F5>D9?>C


�

��A number of conventions are maintained throughout all AutoPLANT documentation to make identifying andunderstanding the information presented both quick and easy.

?>F5>D9?> �5C3B9@D9?>

�/��0 Precedes information of general importance.

$(��0 Precedes optional time-saving information.

��*�(�� Precedes information about actions that should not be performed under normaloperating conditions.

FILENAMES Directory paths and file names are italicized.Example: \PIPING directory, AUTOEXEC.BAT file.

3URJUDP�&RGH Excerpts from text or basic script files and script variables and statements appear in thefont shown.

INPUT Commands or information that must be manually entered is bolded in the font shown.Example: After selecting Setup/Drawing Preferences from the Piping menu, pressthe OK button in the dialog.

DialogsField_Name

Dialog and database table names are italicized.Example: The Preferences dialog.

Select Indicates that the command must be executed from a menu or dialog.

Pick Indicates an item (component or point) that may be picked on a drawing.

Throughout this manual, the menu command sequence required to execute a commandwill be explicitly defined in the text, along with the associated toolbar.

�>DB?4E3D9?>�538>931<�)E@@?BD�1>4��B19>9>7


�� Rebis’ trained personnel are available to provide quality support to customers on all current product lines. Toinquire about technical support options, contact Rebis’ corporate headquarters at(925) 933-2525. Be prepared to provide the information requested on the Problem Report form. You can viewthis form on-line by accessing the Rebis web site. Before calling:

+ Explore On-line Help for an answer to your question.

+ Contact your local dealer. Rebis believes that a close customer-dealer relationship is the bestmethod for receiving personalized, quality technical support.

�� + Maintenance, Enhancement and Support (MES): Users who have purchased an MES contract receive

priority Technical Support on a toll-free 800 support line. As an MES customer, Rebis will do its best toresolve your problem immediately.

�� If you would like more information on how to purchase an MES contract, please call our NorthAmerican MES Sales Manager at (925) 933-2525, ext. 251.

+ Fax Support: Fax traditional inquiries to (504) 893-5293; 24hrs, 7days/week. Our Automated FaxBackService (925) 933-2525; 24hrs, 7days/week contains answers to some of the most commonly askedquestions. After calling the service, use the phone’s keypad to select the type of product, and to stepthrough a selection of topics. If the subject about which you are inquiring is listed, simply input your faxnumber and you will receive an immediate fax response to your question.

� Internet Support: Send electronic support inquiries to [email protected]. Our staff frequently checks thesupport e-mail for inquiries, and responds to them promptly. Choosing this method of support allows youto bypass our telephone lines when they are busy. The e-mail method will also enable you to attachdrawings or files needed to help troubleshoot and solve your problem. Rebis also maintains a Web pagewhich contains several areas of interest to users of our software, including a customer service area, a filedownload area, tips and tricks, etc. Rebis’ URL is www.rebis.com.

��

This chapter will help you to get acquainted with the PIPING environment and componentplacement procedures.

PROJECT CONFIGURATION 2-2

SOFTWARE CONFIGURATION 2-3

INTERFACE 2-7

CONNECTION TECHNIQUES 2-16

DRAWING PRODUCTION OVERVIEW 2-41

SPECIFICATION OVERVIEW 2-43

� � � � �

�

�5DD9>7��D1BD54�B?:53D�#?>697EB1D9?>


�

� �"�� AutoPLANT provides tools to support a project configuration implementation. This design supports multipleproject configurations and enables you to assign application drawing/model defaults and settings on a project-wide basis. The project settings include default assignments for units, specs, drawing database format,borders, drawing templates, module and component options, etc.

This design was implemented to provide a means to create a custom project directory structure, whichbasically mirrors the shipping directory structure. You can then create custom versions of almost any of theprovided files and store them within the project directory structure without undermining the integrity of thedefault shipping version of these files.

For example, assume that you are a contractor that has two clients and each client has a set of standards forannotation styles. To support these clients, you would create two configurations. In each configuration’sdirectory structure, you would place the annotation script files that have been customized to conform witheach client’s annotation style standards. When you start a new drawing for either client you would select theconfiguration that you want to apply for that drawing. By selecting the appropriate configuration you will beinstructing AutoPLANT to search that custom directory structure for any files before searching for the file inthe standard search path. AutoPLANT will find the customized annotation script files for the selectedconfiguration and use them when you place annotation on the drawing.

This methodology enables you to keep the shipping versions of all files intact, while customized versions ofthese files reside in a centralized location within the project configuration’s directory structure. Working inthis manner will enable you to upgrade AutoPLANT software without being concerned about losingcustomized versions of specific files. You should NEVER directly modify any of the files in the shippingversion of the software. In fact, if you use AutoPLANT's Configuration Editor and Class Editor applicationsto modify files, the provided files appear locked and cannot be directly modified.

The shipping version of the software provides three base configurations: Imperial, Metric, and Mixed Metric.Each of these configurations define the drawing settings for the environment indicated and are used astemplates when you create your own custom configurations.

A number of custom application tools are provided to simplify the procedure to create and modify projectconfigurations.

� �"��!��AutoPLANT provides two tools to simplify the customization process. Each of these tools may be launchedfrom the ..\AutoPLANT 3D\Customization Tools group in your Windows Start menu, or from the Rebis mainmenu when you start AutoPLANT Plant Design or Isometrics. Each tool provides its own context-sensitivehelp file, which fully explains its features and operation.

A brief description of each of these tools is provided below. Refer to the help system provided with each ofthese tools for more information.

��.��#��-��

The AutoPLANT Configuration Editor application may be used to create/modify projects. It enables you toselect a shipping configuration (imperial, metric, mixed metric) as a template to create your new projectconfiguration directory structure and associated files. It also removes the tedious effort that would have beenrequired to manually edit the numerous application configuration files by providing a highly-intuitivegraphical user interface with tabbed dialogs to modify the configuration settings assigned to each project.

�5DD9>7��D1BD54)?6DG1B5�#?>697EB1D9?>


��.��#��-��

The Class Editor (CE) works hand-in-hand with the AutoPLANT Configuration Editor application. Theshipping version of the AutoPLANT software provides three default configuration, Imperial, Metric, andMixed Metric, which should not be modified. The intent of the system design is for you to use theConfiguration Editor application to create new configurations using the provided configurations as templates,then to use the Class Editor to create/modify the module and component scripts and methods in your customconfiguration. All modified files are stored in your custom project configuration directory; therefore,maintaining the integrity of the shipping version of all of these files.

�� This section describes the relevant files created by the installation program that initially configure yourAutoPLANT software.

�� When an AutoPLANT application is installed, the configuration files AT.INI and APLANT.INI are created onyour local drive. APLANT.INI is the primary AutoPLANT control file, which is created in your Windowsdirectory.

The install program creates a >0(5*('@ group in your APLANT.INI. In this group, the $7B&)* keyword isassigned to the path where your AT.INI control file was installed as illustrated below.

>0(5*('@

$7B&)* &�?5(%,6?86(5?&)*

The default assignment of $7B&)* in APLANT.INI points to the configuration path on your local workstation.In the local installation example from APLANT.INI above, $7B&)* indicates that AT.INI was created in the&�?5(%,6?86(5?&)* local workstation directory.

AT.INI contains a configuration group for each installed AutoPLANT application, and a >*(1(5$/@ groupthat contains key assignments that apply across all AutoPLANT applications. Each group contains keywordsthat define the paths, files, and functions required to start the application.

Pay particular attention to the >$/,$6@ group in AT.INI as illustrated below. This group contains keywordsthat assign the network, local, and custom root directories that are used to locate these specific file types whenrunning AutoPLANT software. For example, if the system needs a file that it knows is a network (shared) file,then it will generally pre-append the 1(7:25.B5227 path to its search path to find the file.

>$/,$6@

1(7:25.B5227 1�?5(%,6

/2&$/B5227 &�?5(%,6?86(5

&XVWRPB5RRW &�?5(%,6?&86720

��%��&1�.��&��(��

If a network installation is performed, the core application files are installed on the specified network drive.Each user then performs a Workstation installation to install the user configurable files on their localworkstation. When a user performs a local workstation installation, the user will be prompted to first specifythe local root installation directory (e.g., C:\REBIS), then to specify the root directory where the networkapplication files were installed (e.g., N:\REBIS). The install will then install the local workstation files andcreate AT.INI in their /2&$/B5227?&)* local workstation directory, where /2&$/B5227 is the local rootdirectory specified during the install with the USER subdirectory appended.

In this example, AT.INI would be installed in the user’s C:\REBIS\USER\CFG directory. In order for theapplication to find the core set of files that were installed on the network and local workstation drives, theinstallation program assigns the 1(7:25.B5227 keyword in AT.INI to the network root directory and the localroot directory to the /2&$/B5227 keyword. The 1(7:25.B5227 and /2&$/B5227 keywords would also have

�5DD9>7��D1BD54)?6DG1B5�#?>697EB1D9?>


�

been assigned in AT.INI as illustrated above.

If only a local installation is performed, these keywords would be assigned as shown below.

1(7:25.B5227 &�?5(%,6

/2&$/B5227 &�?5(%,6?86(5

&XVWRPB5RRW &�?5(%,6?&86720

If the network core files are moved, or the network mapping to these files changes, simply change the1(7:25.B5227 keyword in each user’s local AT.INI file to the new network path.

��

AT.INI contains a configuration group for each installed AutoPLANT application, and a >*(1(5$/@ groupthat contains key assignments that apply across all AutoPLANT applications. Each group contains keywordsthat define the paths, files, and functions required to start the application.

�� The keywords in the >$/,$6@ group were discussed in the previous topic. This group containskeywords that were assigned the 1(7:25.B5227 and /2&$/B5227 paths based on whether yourorganization works from stand-alone or network installations.

The following table lists the keywords assigned in each AutoPLANT application’s group in AT.INI.

PROGRAMDIR Example: PROGRAMDIR=%NETWORK_ROOT%\PIPING

LOCALDIR Example: LOCALDIR=%LOCAL_ROOT%\PIPING

STARTUP_FILE Example: STARTUP_FILE=at_pipe.lsp

STARTUP_FUNC Example: STARTUP_FUNC=at_pipe_startup

UNLOAD_FUNC Example: UNLOAD_FUNC=at_pipe_unload

DESCRIPTION Example: DESCRIPTION=AutoPlant Piping

REGAPP Example: REGAPP=at_pipe

MENU_SELECTABLE Example: MENU_SELECTABLE=1

HELP_FILE Example: HELP_FILE=%NETWORK_ROOT%\SUPPORT\AT_PIPE.CHM

SYS_PREF_INI_FILE Example: SYS_PREF_INI_FILE=SYSPref

COMP_PREF_INI_FILE Example: COMP_PREF_INI_FILE=COMPPref

USER_PREF_INI_FILE Example: USER_PREF_INI_FILE=UserPref

�� AutoPLANT software requires a directory to store temporary files created during normal program execution.The $3703 keyword in the >*(1(5$/@ group of the AT.INI configuration file is assigned to this directory andmay be modified. The files in this directory may be deleted periodically. Simply open the directory assignedto this keyword in Windows Explorer and delete all of the files and directories contained therein.

�� When you install AutoPLANT software, the file Rebis Setup.LOG is created in your root Windows directory.This file contains details of the Windows registry entries created during the installation of the software. Thisinformation has been provided because of numerous user requests.

�5DD9>7��D1BD54)?6DG1B5�#?>697EB1D9?>


�� #��This section provides a set of procedures that explain how to customize your Software Configuration.

)�� #��

AutoPLANT is designed to enable a user to setup multiple “system” configurations.

�� Project configurations that contains default settings and search paths are defined using theAutoPLANT Configuration Editor application.

When the software is installed, APLANT.INI is created in the \WINDOWS directory. The >*(1(5$/@ group inthis file assigns the $7B&)* keyword to the directory that contains the AT.INI file that defines the system setupfor each application.

For example, the default definition of AT_CFG in APLANT.INI points to the LOCAL_ROOT\CFG directoryon the user’s workstation.

� �?��5DE@�1>4��C5��>?D85B�?>697EB1D9?>

�� Create an alternate AT.INI in a different directory that defines a separate system configuration for theapplications.

�� Assign the $7B&)* keyword in APLANT.INI to the directory where the alternate configuration AT.INI fileresides.

�� Re-Start the system.

)��!��%��&��!

If a network installation is performed, the core application files are installed on the specified network drive,while another set of required files is installed on each user’s local workstation. When each user installs thelocal workstation files, the file AT.INI is created in the LOCAL_ROOT\CFG local workstation directory.

In order for the application to find the core set of files that were installed on the network, the installationprogram assigns the 1(7:25.B5227 keyword to the network root installation directory in AT.INI.

� �?��5D�D85�5DG?B;��1D8

�� Open /2&$/B5227\CFG\AT.INI in a text editor.

�� Assign the 1(7:25.B5227 keyword to the appropriate network path.

�� If the system cannot find the core program files, ensure that 1(7:25.B5227 keyword is properlyassigned, and that the network mapping to this directory is connected on the local workstation.

�5DD9>7��D1BD54)?6DG1B5�#?>697EB1D9?>


�

)��!�.��&��!

If a network installation is performed, the core application files are installed on the specified network drive,while another set of required files is installed on each user’s local workstation. When each user installs thelocal workstation files, the file AT.INI is created in the LOCAL_ROOT\CFG local workstation directory.

In order for the application to find the core set of files that were installed on the network and localworkstation files, the installation program assigns the 1(7:25.B5227 keyword to the network root directoryand the local root directory to the /2&$/B5227 keyword. If only a local installation is performed, thesekeywords will be assigned to the same local root directory.

� �?��5D�D85��?31<��?B;CD1D9?>��1D8


�� Assign the 1(7:25.B5227 keyword to the desired network path.

�� If the system cannot find the local program files, ensure that /2&$/B5227 keyword is properlyassigned.

)��2��-��+�� #��

When an AutoPLANT application is installed, the configuration file AT.INI is created in the/2&$/B5227\CFG local workstation directory. This file contains a configuration group for every installedapplication.

� �?��5D��?496I�1>��@@<931D9?>�?>697EB1D9?>


�� Find the name of the group for the application configuration to modify. Each application group containsa set of keywords that define the general configuration for that application.

)��!��" ��+��+

When AutoPLANT software is installed, the configuration file AT.INI is created in the LOCAL_ROOT\CFGlocal workstation directory. AutoPLANT software requires a temporary directory to store temporary filescreated during normal program execution. The $3703 keyword in the >*(1(5$/@ group in AT.INIconfiguration file is assigned to this directory.

� �?��5D�D85��5=@?B1BI��9B53D?BI


�� Assign the $3703 keyword to the desired drive and path.

�� The directories and files in the directory specified here should be deleted periodically when you arenot running an AutoPLANT application.

�5DD9>7��D1BD54(>D5B6135


�� PIPING has been designed with the professional piper and designer in mind. The interface closely followsAutoCAD’s design, with additional toolbars and menus inserted.

��

When you first load the AutoPLANT 3D software, the Rebis menu is inserted into AutoCAD’s menustructure. From this menu, AutoPLANT applications and utilities can be launched. Only those applicationswhich have been installed will be available for selection; others will be grayed out.

Select Piping from the Rebis menu to load the PIPING application.

Note that several ARX applications are loaded into the AutoCAD environment, and that the Piping menu is

�5DD9>7��D1BD54(>D5B6135


�

added to the main menu. A set of toolbars is also opened when the application is loaded.

�� Several toolbars are available to select components and execute PIPING commands.

�5DD9>7��D1BD54(>D5B6135


The toolbars can be docked along the perimeter of the drawing area, or left “floating.”

Many of the toolbars, cascade, presenting additional components or commands. Buttons associated with acascading set of toolbars have an arrow in the lower right hand corner of the button.

When a selection is made from a cascading toolbar, it becomes the default.

�5DD9>7��D1BD54(>D5B6135


�

Additional toolbars can be opened by selecting a name from the Piping/Toolbars menu.

�� To close a toolbar, press the kill button in the upper left corner (if the toolbar is docked, you will needto drag it into the application area before it can be closed).

PIPING toolbars can be viewed as either 32 (large) or 16 (small) bit images. To change the size of thetoolbars, place the cursor over any toolbar button, then right-click with the mouse. AutoCAD’s Toolbardialog is displayed. Toggle the Large Buttons check box as appropriate, then press Close to exit the dialog.

�� The large buttons are easier to see on many systems. As a new user, you may want to work with thelarge buttons until you become familiar with the graphical representations of PIPING commands andfunctions. After you become familiar with the interface, you can use the smaller buttons to regainmore screen-space.

�5DD9>7��D1BD54(>D5B6135


� �� The main application area contains the world in which the model is being created.

Models can be represented from different isometric views using standard AutoCAD view controls.

�5DD9>7��D1BD54(>D5B6135


�

Multiple viewports can also be established in model view, to aid in model creation.

When dimensioning and annotating your model, Rebis recommends the use of Paper Space and AutoCAD2000’s Layouts. This enables you to place annotation and dimension text and symbols on a virtual sheet ofpaper, without cluttering the actual model.

�5DD9>7��D1BD54(>D5B6135


After annotating a drawing and returning to model space, the drawing remains free of clutter.

�� Many commands are presented on the command line, just below the drawing area.

�5DD9>7��D1BD54(>D5B6135


�

Of particular note, component placement procedures rely heavily on the use of the command line to requestinput from the user.

�5DD9>7��D1BD54(>D5B6135


��PIPING provides many dialogs in which user input is requested. The dialogs allow a great deal of informationto be collected from the user. In most cases, these settings can be saved or defaults established.

A Help button is also available on every dialog. When pressed, context-sensitive help on that dialog functionis displayed.

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�

��This section contains walk-throughs of the connection techniques available in PIPING, including:

+ General Component Placement

+ Place a Component in Space

+ Attach to an Existing Component

+ Place a Known Distance from an Existing Component

+ Align to Existing Components

+ Automatically Place Connecting Pipe (Auto Pipe)

+ Change the Reference Point

+ Automatically Route Components

+ Place on a Smart Polyline

�� The items listed above provide an overview of connection techniques.

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�� PIPING components are placed using the following, general procedure:

�� Select the component: Components can either be selected from the menu or the component toolbars.

�� Pick the placement point: There are several ways to specify the insertion point. By default, PIPINGassumes you will want to connect to the end of the previous component. You can accept the default andpress Enter to automatically connect two components. You can also designate a new point, or specify aplacement point that is a known distance from an existing point in the model.

�� Intermediate Step: After specifying the placement point, several options are available. On asymmetricalcomponents, you can toggle the point on the component which will be placed at the insertion point. Somecomponents also have alignment ports.

�� Specify the orientation: For bends, branching and asymmetrical components, you need to specify how thecomponent is oriented.

Some of these steps may be skipped depending on the procedure. For example, when using the AutoRouterswitch, the selected component is automatically attached to the run end of the last component placed in themodel. In other instances, additional steps are required, as is the case when aligning the selected componentto the centerline of two existing components. Review the Component Placement Getting Started Topics thatfollow for more information regarding a specific connection option or technique.

��PIPING components may be placed “in space”; that is, not connected to any other component or placedwithout respect to a known point on an existing component. This section demonstrates how to place a piece ofpipe and an elbow in space.

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�

��

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


��

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�

��$��

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�

�� $��

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


��$��

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�

��%��&

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�

��

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


��

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


��

�5DD9>7��D1BD54#?>>53D9?>��538>9AE5C


�

�5DD9>7��D1BD54B1G9>7��B?4E3D9?>�/F5BF95G


� �� PIPING’s drawing production tools use the concept of defined Work Areas. A Work Area is a user-specifiedset of drawings that overlay each other. This Work Area concept was developed to provide a convenientmethod for sharing plant information between multiple drawings. For example, models from multipledisciplines (equipment, pipe, steel) can grouped together. Three dimensional Work Area Views can then beassociated with the Work Area. Exact plant coordinates can be used to define specific areas within a plant.These saved views can be shared among any AutoPLANT drawing provided the Work Area file has beensaved on a shared network drive. This technique allows multiple users to view a defined area of the plant, andto visualize how drawings from other disciplines will effect the current model.

Saved Views can also be placed as tiled viewports in Paper Space. The scaled viewports can be placed withannotated plant coordinates, and multiple viewports can be placed on the same sheet. From saved views,sectional elevations and general arrangements can be quickly placed on a sheet. Allowing multiple users tosection, dimension and annotate defined areas from within the plant ensures consistency in drawingproduction.

After placing these views as viewports in Paper Space, Rebis encourages you to remain in Paper Space toplace dimensions and annotation.

Two dialogs are associated with Work Areas: Work Area Setup and Work Area View. The first dialogestablishes the set of referenced drawings, while the View dialog defines the view coordinates and placementoptions.

In the first step, you create and save a Work Area. The Work Area is an association of referenced drawings.

After defining the Work Area, the Work Area Views dialog can be used to name and define three-dimensionalclipping areas. Various options are available from this location, and you can either input coordinates directlyor choose them manually by picking points in the current drawing.

�5DD9>7��D1BD54B1G9>7��B?4E3D9?>�/F5BF95G


�

After the views are created, you can place them as tiled viewports in Paper Space for plotting. To dimensionthe items in the viewport, remain in Paper Space and utilitize AutoCAD’s dimensioning tools. A set ofseparate Piping/Annotation commands have been provided that operate from Paper Space as well. Byremaining in Paper Space to place dimensions and annotation, you can easily return to a “clean” modelwithout needing to freeze annotation and dimensioning layers.

For more information on Drawing Production commands and dialogs, refer to the following:

+ Work Area Setup dialog

+ Work Area Views Dialog

�� For a practical example of how to create a viewport and use the dimensioning and annotation tools,refer to the PIPING tutorial.

�5DD9>7��D1BD54)@5396931D9?>�/F5BF95G


�� AutoPLANT applications are configured to use Microsoft Access formatted specification databases bydefault. The Spec Generator application enables you to convert your specs to this format.

This area of the customization help is provided primarily to point you in the right direction to findinformation regarding specification creation/modification. The Spec Generator applcation is shipped with itsown context-sensitive help file, which provides detailed explanations on how to use that application tocreate/modify specs and catalogs.

�� The format for the external specification database tables is also configured in DBCONFIG.INI. The defaultformat is defined to use a single Microsoft Access database that contains the individual tables for eachspecification. This was changed from the individual specification table default in AutoPLANT version 1.02 totake advantage of the new Specification Generator v6.0 application.

The default record in DBCONFIG.INI appears as follows:

>6SHF@

'HVFULSWLRQ� �6SHF�GDWDEDVHV

'$7$B6285&(� �06�$FFHVV�IRU�$XWR3/$17

'$7$B7<3(� �'%4

�'$7$B6285&(� �)R[3UR��IRU�$XWR3/$17

�'$7$B7<3(� �'HIDXOW'LU

�'$7$B6285&(� �G%DVH�)LOHV�IRU�$XWR3/$17

�'$7$B7<3(� �'HIDXOW'LU

The semi-colon “;” before some of these statements indicates that they are commented out. If you wanted tochange the default specification database format from MS Access for AutoPLANT to one of the otherexample formats, simply place semi-colons in front of the '$7$B6285&( and '$7$B7<3( for the MS Accessassignments, and remove them from the format that you want to use.

� ��The following catalogs are available:

+ Carbon Steel

+ Cable Tray

+ Conduit

+ Swagelok

+ Stainless Steel

+ Ductile

+ Victalic

+ Triclove

+ Rsf

+ Armstrong

+ Itt

+ Spirax

+ BPE

+ Din for metric

�5DD9>7��D1BD54)@5396931D9?>�/F5BF95G


�

The following specs are available as default test specs only and should not be considered for construction.

+ CS150

+ CS150A

+ CS300

+ CS600

+ SS150

+ Ductile

+ Victalic

+ TriClove

+ Rsf

+ Training

+ Cable Tray

+ Conduit

+ Swagelok

+ Din, DinSample, ND16, ND40 for metric

��

This chapter covers the Setup menu, which provides options to define initial drawing preferences,and other settings used during the placement and manipulation of components.

OVERVIEW 3-2

DRAWING PREFERENCES 4-3

MODULE SETUP 4-8

COMPONENT PREFERENCES 4-17

COMPONENT COPY PREFERENCES 4-18

COMPONENT UPDATE PREFERENCES 4-23

� � � � �

�

�5DE@��5>E

/F5BF95G


�

�� The Setup menu provides options to define initial drawing preferences, and other settings used during theplacement and manipulation of components.

The Setup toolbar is available as a flyout toolbar from the main Piping Functions toolbar, or may bedisplayed separately by selecting Toolbars/Function Toolbars/Pipe.

The following Setup menu options are covered in this chapter:

+ Drawing Preferences

+ Module Setup

+ Component Preferences

+ Component Copy Preferences

+ Component Update Preferences

�5DE@��5>E

B1G9>7��B565B5>35C


� �� The Drawing Preferences dialog shown below displays by selecting Setup/Drawing Preferences from thePiping menu.

A description of each of the options contained in this dialog is provided below.

Specification Path Displays the path to the specification directory as set in the configuration you select when you starta drawing. Any specification directory that resides below this path will appear in the Specificationdrop-down list in this dialog.

The Specification Path assigned in a configuration can be modified using the AutoPLANT ClassEditor, which can be launched from the Rebis main menu or toolbar.

Specification Lists the specification directories that reside below the Specification Path defined in theconfiguration. Select a spec name from this list to make it active.

Nominal Size Lists the available main nominal pipe sizes from the current specification, based on the DrawingUnits set in the selected configuration. The selected size is used when you place components tolocate the appropriate component record in the specification. The spec record contains descriptiveand parametric information used to draw the component.

Line Number Enter the Line Number in this field. Line numbers can be identified using any alphanumericcombination of characters. Subsequent components placed in the drawing will be assigned theLine Number value from this field. Line Number information is used in reporting, annotation,generating isometrics, and other functions of the program.

To change (edit) an individual component’s line number after it has been placed, use the EditComponent command. To revise a line number (change the line number of a selected group ofcomponents), use the Update Component command.

Other Database Fields The Drawing Preferences dialog also enables you to specify values for Insulation Thickness,Insulation Spec, Paint Code, Area, Unit No., and Service in the fields provided. The externaldrawing database record of subsequent components will be assigned these field values until theyare changed.

�5DE@��5>E

B1G9>7��B565B5>35C


�

Drawing Mode/Representation

The Drawing Mode area of the dialog has been re-organized into Drawing Mode andRepresentation areas to support the implementation of the new flat 2D PIPING applicationavailable in v2.0. Refer to the 2D Piping Overview for more information on this new application,which is provided free of charge if you purchase the full 3D PIPING application. Users authorizedfor 2D only, will have their 3D Drawing Mode and associated Representations disabled. Usersauthorized for 3D will have all draw modes and options available.

The following describes the Drawing Mode/Representations now available in terms of the selectionmode in the Drawing Mode and Representation areas of the dialog (e.g., 3D-Double Line will beused to denote selecting the 3D Drawing Mode and Double Line Representation):

3D-Double Line: this is identical to the previous full 3D Drawing Mode configuration. It enablesdrawing of 3D components in 3D space using Rebis custom component objects.

3D-Single Line: this configuration enables drawing of Single Line component representations in3D space using AutoCAD entities. In general, only Pipe Components, Bends and Returns, andBranching components are actually drawn as single line AutoCAD entities, with a few exceptions.All other components are drawn in standard 3D-Double Line mode.

2D-Double Line: this configuration enables drawing of "flat" (i.e., nothing will be drawn in thevertical plane) Double Line representations of components using AutoCAD entities.

2D-Single Line: this configuration enables drawing of "flat" (i.e., nothing in the vertical) Single Linerepresentations of components using AutoCAD entities.

As noted above, the 2D - Double Line mode will automatically generate and draw flat 2D entitiesfrom using their 3D custom components counterparts. This is a radical change from the previousmethod. Previously, the Double Line mode in the 3D system used a complex set of draw methodsto determine which view the component was being placed in and then determined how thiscomponent should be drawn. This method will be replaced by automatically converting, duringplacement, the 3D component into 2D native CAD objects, which have been generated via the newHidden Line Removal (HLR) interface.

Additional Options:

Surface Resolution: When you enable the 3D Drawing Mode radio button, a Surface Resolutionsetting will be activated. This value assigns AutoCAD’s SURFTAB1 and SURFTAB2environment variables that control the mesh display of component graphics. A number between 2and 32766 is required, while a setting of 12 or 16 is recommended. Changing this value does notchange the Surface Resolution setting assigned to previously placed components. You can displaythe inherent mesh representation of 3D components with the Piping Tools/3D DisplayModes/Mesh command.

2D HL Options: When you enable the 2D Drawing Mode radio button, the Surface Resolutionoption will be replaced by a 2D HL Options button. Pressing this button displays the HLR Optionsdialog, which enables you to define how hidden line removal is handled for the 2D-Double Linerepresentations. Hidden line removal is handled on a per component basis with respect to thesettings defined in this dialog.

Once these options are set, all subsequent components will be drawn in that mode until it ischanged. You can also generate existing component representations using the new settings.

A more detailed explanation of this feature is covered after this table.

�5DE@��5>E

B1G9>7��B565B5>35C


ComponentPreferences

The Color and Layer options shown below determine how PIPING assigns component layers andcolors. The actual color used for a particular value for each option, except for By Paint, is definedin the file COLOR.INI. that resides in the NETWORK_ROOT\PIPING directory.

Color Settings

BySize: Component color is determined by reading the value assigned to the current Size in the[BySize] group in COLOR.INI.

ByLayer: Component color is determined by the color assigned to the layer on which thecomponent is drawn.

BySpec: Component color is determined by reading the value assigned to the current Spec in the[BySpec] group in COLOR.INI.

ByLineNo: Component color is determined by reading the value assigned to the current LineNumber from the [ByLineNo] group in COLOR.INI.

ByPaint: Component color is determined by reading the color assigned in the Paint field of thecomponent’s specification record.

Layer Settings

BySpec: Components from the same spec are placed on the same layer.

ByLineNo: Components on the same line number are placed on the same layer.

Data Mode Determines how settings are applied when routing components:

From Connecting Component: The settings of an existing component are applied to anycomponent connected to it. This option overrides settings in the Drawing Preferences dialog inorder to provide an easy method of maintaining consistency when connecting components.

From Settings: The settings contained in the Drawing Preferences dialog are always applied,despite the settings associated with a connecting component.

Example

Assume that you want to place a pipe segment from the Victaulic spec, then connect an elbowfrom the Base Carbon Steel module to one end of this pipe. First, you should know that pipe is avariable end component. This means that the end of the pipe is not necessarily defined until youconnect a component to it. The valid ends for Victaulic pipe are IGM; BW; SCM; SWM as definedin the PORTS.INI for the Victaulic components.

Therefore, load the Victaulic module and place a pipe segment from the Victaulic Spec byselecting it from the Victalic components menu. To connect a base Carbon Steel elbow to one endof this pipe you must first set the Data Mode, either in the Component or Drawing Preferencesdialogs to From Settings (not component). Then change the spec to CS150 and select connectthe standard base elbow to one end of the pipe.

When the From Component data mode is used the connecting component will try and resolve asmuch information as possible from the connecting component, including the spec. Therefore, ifFrom Component is set and you are connecting to a Victaulic component, the system will beforced to use the Victaulic Spec. In the example above, you used the From Settings data mode tooverride the component attributes to enable you to connect the Carbon Steel elbow which is from adifferent spec.

Auto Router Mode Enable this switch to automatically connect a selected component to the run end of the previouscomponent. This is the fastest method of placing a series of connected components. If theselected component contains a branch or a bend, you will still need to specify the orientation.

Show Insulation When this switch is set, pipe insulation will be graphically displayed in the drawing for pipe, elbow,and bend components (providing an Insulation Thickness is specified in the Drawing Preferencesdialog). If you modify the insulation thickness of an existing component using the DatabaseTools/Edit Component command, the component will be redrawn and display the indicatedinsulation graphically.

Debug Mode This switch should only be enabled if you are customizing or creating new PIPING componentplacement drawing scripts or functions. It will place the execution of these scripts in debug mode,which will display the executing script in the Rebis Script Editor to enable you to step through eachstatement in the script to locate possible errors.

�5DE@��5>E

B1G9>7��B565B5>35C


�

Default Spec Choice When a component is selected for placement, PIPING searches the specification for the requestedcomponent. If more than one match is found, the Rebis Specification Selection dialog displays toenable you to select between components of the same size and type, but which have different endconditions, schedules, ratings, etc.

When the Default Spec Choice switch is enabled, PIPING will place components marked asdefaults in the specification automatically, without displaying the Rebis Specification Selectiondialog. A component may be marked as the default selection by placing a 1 in the Option Codefield of the default component’s specification record using Rebis’ Spec Generator v.5.0 application.

You were given the option to install the Spec Generator when you installed PIPING. Thisapplication has its own help file.

Weld gaps Welded joints determine the fastener used to connect welded components based on this setting. Ifthe check box is enabled, a weld gap will be inserted using the fastener basic scriptat_weldedjoint_fasteners to insert AT_WELDGAP. If this check box is disabled, then a weld gapwill not be inserted, but a buttweld fastener will be inserted using this script to insertAT_BUTTWELD.

Save CAD Links PIPING stores component entity handle information in the drawing by default. This check boxenables you to also save this information in the external drawing database.

Save Port Data Enable this option to save joint, port, and fastener data in the external drawing database. Thisinformation is saved in the drawing by default.

�$�--��.��/ ��

As mentioned in the table above, when the 2D Drawing Mode is enabled, a 2D HL Options button will replacethe 3D Surface Resolution option. This enables you to define the Hidden Line options for the 2D output.

Pressing 2D HL Options displays the dialog shown below.

The Output Hidden Geometry check box determines if hidden line output should be displayed for eachcomponent. Enabling this check box will activate the Output Properties grid in this dialog. The grid optionsdefine the manner in which hidden line output is displayed as described below:

Visibility If the "Light bulb" is ON (yellow), then visibility is turned ON and hidden lines will be visible.

Color Assigns the color of the visible hidden lines.

Linetype Selects the line type to be used for the hidden line. Only loaded line types can be used from this selection andthere will be no interface to load line types. The standard CAD interface should be used for this purpose.

Lineweight Determines the weight of the visible hidden lines. When you click within this grid field, a browse button willappear. Press this button to display the following dialog.

�5DE@��5>E


Select the desired Units, then pick the desired line weight that will be used for your 2D representations.

�5DE@��5>E

�?4E<5�)5DE@


�

��A module is a set of component draw routines, command prompts, menu, and specifications that extend thecomponent set available in the PIPING and/or ISOMETRICS applications. By loading a module, you candraw components other than the default Carbon Steel set. After a new module is loaded, you will need toreturn to the Drawing Preferences dialog to specify the specification, size, and other drawing settingsappropriate to the new module.

Click on an item in the dialog to jump to its help within this topic.

An operation is performed by selecting a module from the list, then selecting an action to perform. Next,either press the OK button to apply the action and close the dialog, or press Apply to apply the action withoutclosing the dialog.

More than one module may be loaded in the same session, but only one specification is active at a time. Eachmodule has an associated menu and toolbar. Before selecting a component from a module’s menu or toolbar,you should ensure that the specification that contains the components for that module is properly set in theDrawing Preferences dialog.

The provided modules and their associated specifications are shown below:

�?4E<5C �@53C

Ductile Iron DUCTILE (imperial), MDUCT (metric), MMDUCT (mixed metric)

Victaulic VICTALIC (imperial), MVICT (metric), MMVICT (mixed metric)

High Purity TRICLOVE (imperial), MTRIC (metric), MMTRIC (mixed metric)

Lined Pipe RSF (imperial), MRSF (metric), MMRSF (mixed metric)

Tubing SWAGELOK (imperial), MSWGLOK (metric), MMSWGLOK (mixed metric)

Cable Tray (PIPING ONLY) CABLET (imperial), MCABLET (metric), MMCABLET (mixed metric)

HVAC (PIPING ONLY) HVAC (imperial), MHVAC (metric), MMHVAC (mixed metric)

Conduit (PIPING ONLY) CONDUIT (imperial), MCOND (metric), MMCOND (mixed metric)

��

This section of the dialog lists the installed modules that have been configured to work with the application.Select a module from this list, then enable the desired action radio button in the Module Actions area of thedialog. Press Apply or OK to execute the action.

�5DE@��5>E

�?4E<5�)5DE@


��Enable this radio button, then press Apply to load all modules in the Available List group. When the dialog isclosed, the modules’ menu will be loaded. After loading a module you must return to the DrawingPreferences dialog to set the Spec to the specification that contains the module’s component records beforeyou will be able to place components available in the module’s menu.

��

Enable this radio button, then press Apply or OK to load the modules selected in the Available List area of thedialog. The selected module’ menus be accessible. After loading a module you must return to the DrawingPreferences dialog to set the Spec to the specification that contains the module’s component records beforeyou will be able to place components available in the module’s menu.

��

Enable this radio button, then press Apply or OK to unload the modules selected in the Available List group.This option will remove the selected module’s menus.

��

Enable this radio button, then press Apply or OK to unload all of the modules listed in the Available List groupif they were previously loaded. This will remove any loaded module menus and toolbars from the application.

�� Remember to reset the active specification for the component set that you will be placing.

��Select a module from the Available List group, then enable the View Module Details radio button and pressApply to display the dialog shown. This dialog displays the module definition record as defined in the fileMODULES.INI. This information can be modified using the AutoPLANT Class Editor, which may belaunched from the Rebis main menu or toolbar.

��Executes the action selected in the Module Actions area of the dialog without closing this dialog. Use thisbutton to load/unload/view several modules individually, then press OK or Cancel when you are finished toclose the dialog.

The following sections provide a brief description of each available module.

�5DE@��5>E

�?4E<5�)5DE@


�

�� %��&The Cable Tray module provides a standard set of cable tray components used in most industries. Thismodule comes with a standard set of component placement options, as well as sample specifications that maybe used to place these components.

.��-

To load this module, select Setup/Module Setup, then select Cable Tray Module from the list and press Load.You must set the active specification to a Cable Tray spec in order to place components from this module.This may be accomplished via the Piping/Setup/Drawing Preferences, or Piping/Setup/Component Preferencescommands.

) ��2#��

The Cable Tray module provides sample specifications in Imperial, Metric, and Mixed Metric units as notedbelow.

(PIPING ONLY) CABLET (imperial), MCABLET (metric), MMCABLET (mixed metric)

These sample specifications were created from the full Imperial, Metric, and Mixed Metric catalogs providedand should be modified using the Spec Generator application to contain the components that you will use onyour projects.

�� A description of the fields in these specifications is available in the Spec Generator help.

#�" ��

The Cable Tray module provides a standard set of Straight Sections, Bends, Branches, Reducers, and BoxConnector component placement options, which may be executed via the Cable Tray menu or toolbars.

��%��

The Cable Tray/Setup/Drawing Preferences command displays a dialog with two toggle switches. Enable theDraw Cover option to put a "lid" on the cable tray components, otherwise, they are drawn without a top(cables would be exposed easily accessible). Enable the Use Thickness option to use the thickness of walls ofthe trays.

��%��&The Conduit module provides a set of thin wall tubing components, which typically contains electrical wiresand are used by most industries. This module comes with a standard set of component placement options, aswell as sample specifications that may be used to place these components.

.��-

To load this module, select Setup/Module Setup, then select Conduit Module from the list and press Load. Youmust set the active specification to a Conduit spec in order to place components from this module. This maybe accomplished via the Piping/Setup/Drawing Preferences, or Piping/Setup/Component Preferencescommands.

�5DE@��5>E

�?4E<5�)5DE@


) ��2#��

The Conduit module provides sample specifications in Imperial, Metric, and Mixed Metric units as notedbelow.

(PIPING ONLY) CONDUIT (imperial), MCOND (metric), MMCOND (mixed metric)



#�" ��

The Conduit module provides a standard set of Conduit, Elbows, Condulet Outlet Bodies, a Junction Box andother Miscellaneous Fitting component placement options, which may be executed via the Conduit menu ortoolbars.

��

The Ductile Iron Pipe module provides a set of components, which are typically used for water/wasterwaterapplications. This module comes with a standard set of component placement options, as well as samplespecifications that may be used to place these components.

.��-

To load this module, select Setup/Module Setup, then select Ductile Iron Module from the list and press Load.You must set the active specification to a ductile spec in order to place components from this module. Thismay be accomplished via the Piping/Setup/Drawing Preferences, or Piping/Setup/Component Preferencescommands.

) ��2#��

The Ductile Iron module provides sample specifications in Imperial, Metric, and Mixed Metric units as notedbelow.

DUCTILE (imperial), MDUCT (metric), MMDUCT (mixed metric)



#�" ��

The Ductile Iron module provides a standard set of ductile iron flanged and mechanical joint componentplacement options, which may be executed via the Ductile menu or toolbars.

�5DE@��5>E

�?4E<5�)5DE@


�

��

The High Purity module provides a set of components, which are typically used in HiPurity, Food/Bev,Pharmaceutical, Dairy, Breweries, etc. This module comes with a standard set of component placementoptions, as well as sample specifications that may be used to place these components.

.��-

To load this module, select Setup/Module Setup, then select High Purity Module from the list and press Load.You must set the active specification to a High Purity spec in order to place components from this module.This may be accomplished via the Piping/Setup/Drawing Preferences, or Piping/Setup/Component Preferencescommands.

) ��2#��

The High Purity module provides sample specifications in Imperial, Metric, and Mixed Metric units as notedbelow.

TRICLOVE (imperial), MTRIC (metric), MMTRIC (mixed metric)



#�" ��

The High Purity module provides a standard set of high purity Pipe, Bends, Branches, Clamps, Reducers,Valves, Air-Actuated Valves, and othe Miscellaneous Fitting component placement options, which may beexecuted via the High Purity menu or toolbars.

��%��&The HVAC module provides a set of components for Heating/Ventilating/Air Conditioning. Typically, thisDuctwork is used by all industries where the plant is inside a building, including Food/Beverage,Pharmaceutical, Dairy, Breweries, etc. This module comes with a standard set of component placementoptions, as well as sample specifications that may be used to place these components.

.��-

To load this module, select Setup/Module Setup, then select HVAC Module from the list and press Load. Youmust set the active specification to a HVAC spec in order to place components from this module. This may beaccomplished via the Piping/Setup/Drawing Preferences, or Piping/Setup/Component Preferences commands.

) ��2#��

The HVAC module provides sample specifications in Imperial, Metric, and Mixed Metric units as notedbelow.

(PIPING ONLY) HVAC (imperial), MHVAC (metric), MMHVAC (mixed metric)


�5DE@��5>E

�?4E<5�)5DE@



#�" ��

The HVAC module provides a standard set of Tubes, Bends, Branches, Reducers, Valves, GeneralComponents, and other Miscellaneous Fitting component placement options, which may be executed via theHVAC menu or toolbars.

��

The Lined Pipe module provides a set of components. This module comes with a standard set of componentplacement options, as well as sample specifications that may be used to place these components.

.��-

To load this module, select Setup/Module Setup, then select Lined Pipe Module from the list and press Load.You must set the active specification to a Lined Pipe spec in order to place components from this module.This may be accomplished via the Piping/Setup/Drawing Preferences, or Piping/Setup/Component Preferencescommands.

) ��2#��

The Lined Pipe module provides sample specifications in Imperial, Metric, and Mixed Metric units as notedbelow.

RSF (imperial), MRSF (metric), MMRSF (mixed metric)



#�" ��

The Lined Pipe module provides a standard set of Pipe, Elbows, Branches, Reducers, Flanges, Spacers,Valves, and other Miscellaneous Fitting component placement options, which may be executed via theVictaulic menu or toolbars.

��

The Tubing module provides a set of components, including small bore tubing used for instrumentation linesin many industries These components are typically used in the pharmaceutical industry, and also inmechanical design applications (pump manufacturers, etc). This module comes with a standard set ofcomponent placement options, as well as sample specifications that may be used to place these components.

.��-

To load this module, select Setup/Module Setup, then select Tubing Module from the list and press Load. Youmust set the active specification to a Tubing spec in order to place components from this module. This may beaccomplished via the Piping/Setup/Drawing Preferences, or Piping/Setup/Component Preferences commands.

) ��2#��

The Tubing module provides sample specifications in Imperial, Metric, and Mixed Metric units as noted

�5DE@��5>E

�?4E<5�)5DE@


�

below.

SWAGELOK (imperial), MSWGLOK (metric), MMSWGLOK (mixed metric)



#�" ��

The Tubing module provides a standard set of Pipe, Elbows, Tees, Flanges, Valves, Reducers, and otherMiscellaneous Fitting component placement options, which may be executed via the Tubing menu ortoolbars.

��

The Victaulic module provides a set of components, which are typically used in commercial building piping.This module comes with a standard set of component placement options, as well as sample specifications thatmay be used to place these components.

.��-

To load this module, select Setup/Module Setup, then select Victaulic Module from the list and press Load.You must set the active specification to a Victaulic spec in order to place components from this module. Thismay be accomplished via the Piping/Setup/Drawing Preferences, or Piping/Setup/Component Preferencescommands.

) ��2#��

The Victaulic module provides sample specifications in Imperial, Metric, and Mixed Metric units as notedbelow.

VICTALIC (imperial), MVICT (metric), MMVICT (mixed metric)



#�" ��

The Victaulic module provides a standard set of IPS, AWWA, PressFit, Copper Tubing, Fire Protection andTransition component placement options, which may be executed via the Victaulic menu or toolbars.

�5DE@��5>E

�?4E<5�)5DE@


��!��The shipping version of the module configurations are defined in the file MODULES.INI, that resides in theNETWORK_ROOT\MODULES directory. The Ductile Iron module configuration group in MODULES.INI isshown below.

>$7B3'8&@

'LUHFWRU\1DPH� �'XFWLOH

%DVHB0RGXOH� �%DVH

'HVFULSWLRQ� �'XFWLOH�,URQ�0RGXOH

0HQXB)LOH� ��/RFDOB5RRW�?PRGXOHV?$7B3'8&�PQX

0(7+2'B6($5&+B3$7+� ��1HWZRUNB5RRW�?0RGXOHV?GXFWLOH

',$/2*B6($5&+B3$7+� ��1HWZRUNB5RRW�?0RGXOHV?GXFWLOH?GLDORJV

3,&785(B6($5&+B3$7+� ��1HWZRUNB5RRW�?0RGXOHV?GXFWLOH?SLFWXUHV

0(7+2'B35(/2$'B/,67� �&RPPRQ?&RPSXWLO��$33B',5�?GUDZ?HQGV��$33B',5�?XWLO?FRRUGV\V��$33B',5�?XWLO?RULJLQ��$33B',5�?XWLO?SRUWV��$33B',5�?XWLO?RULHQW��VSHFNH\��&RPPRQ?&RPSSURS��$33B',5�?XWLO?SRO\��&RPPRQ?SLSHGDWD��$33B',5�?XWLO?GLPQRGHV��$33B',5�?XWLO?FRRUGV

A separate group exists in MODULES.INI for each available module. The group begins with the modulename enclosed in brackets, “>@”, followed by seven keywords. These keywords specify the initial set of pathand file information required to load the module.

Module configurations may edited/modified using the AutoPLANT Class Editor application. That applicationprovides its own context-sensitive help file with a detailed explanation on editing module configurations.

You can only create/modify module configurations if you have created a project using the AutoPLANTConfiguration Editor application, then selected the configuration in the Class Editor. This process will createa copy of MODULES.INI in your project directory, which may be modified. This system was devised toprotect the integrity of the shipping version of the modules configuration file. When you create a newPIPING/ISO drawing and select your custom project configuration, any changes made to that projects moduleconfiguration file will be evident in the application.

Once a module has been added to MODULES.INI, it will appear in the Module Setup dialog for selection.The Module Setup dialog instance is defined in MODULES.EBS and should not be modified. TheMODULES.EBS method is used by the Setup/Module Setup command to manage modules loaded in thesystem. It defines the Module Setup dialog instance and reads the module definition file, MODULES.INI fromthe current project configuration directory to determine which modules have been installed on the system andare displayed in the Module Setup dialog list.

The configuration information defined in MODULES.INI may be displayed for the selected module in theModule Setup dialog by executing the View Module Details option. This information should only be modifiedusing the AutoPLANT Class Editor application, which can be executed from the Rebis main menu or toolbar.

��!��#�� This section provides a set of procedures that explain how to add a new module to a custom project

��%��-�� #��

Module configurations are defined in the file MODULES.INI. A separate group must be defined for eachmodule that assigns the module directory name and the search paths required to find the method, dialog, andpicture files used by the module.

� �?��44�1�5G��?4E<5��B?E@�?>697EB1D9?>

�� You must first create a custom project using the AutoPLANT Configuration Editor application. Refer tothat application's help file for instructions.

�� Start the AutoPLANT Class Editor and select your custom project from the Configurations drop-downlist.

�5DE@��5>E

�?4E<5�)5DE@


�

�� In the navigation tree, select the Base Piping Module, then select Insert/Module to display the CreateModule dialog.

�� Enter the name for you new module (e.g., MY_MODULE) in the Name field. Enter a brief description ofthe module (e.g., Custom Widget Module) in the Description field. Press OK.

�� A dialog displays to enable you to specify the name of the directory for your new module files. Enter thedesired directory name (e.g., Mymod), then press OK. Press Yes to confirm the creation of the module.

�� A node for your new module will now appear in the navigation tree and the module configurationinformation will display in a dialog for modification. This process created the ..\MODULES sub-directory below your ..\CUSTOM\Project_Name directory, copied the system MODULES.INI file intothat directory, then added a module group record containing the information you see in this dialog to thatfile.

��%��-��+)��

The next step required to add a new module to the system is to construct the module’s directory structure. Thestandard module directory structure should be created below your custom project's ..\MODULES directory asshown in the Base module example below.

For example, if you use the Class Editor to create a new module named MY_MODULE in a project namedMY_PROJECT, you should create the same directory structure shown in the figure below the ..\BASEdirectory under your ..\CUSTOM\MY_PROJECT\MY_MODULE\MODULES directory.

You can now use the Class Editor to add components to your new module. Refer to the Class Editor help formore information on this process.

��-��+�!��-��)��

The Module Setup dialog instance and function are defined in the MODULES.EBS method in theNETWORK_ROOT\MODULES\module_dir\DIALOGS directory. This method controls the process of loadingand unloading modules in the piping system and should NOT be modified.

�5DE@��5>E

#?=@?>5>D��B565B5>35C


�� The Component Preferences command is available in both PIPING and ISOMETRICS. It displays thefloating dialog shown below. This dialog may be left open at all times, and provides a quick and easy methodto change and view the current Specification, Size, Line Number, and Data Mode settings that may also bedefined in the Drawing Preferences dialog. If you find yourself frequently changing sizes, line numbers, etc.during production of a drawing, use this dialog like a toolbar, bypassing the need to constantly open and closeto the Drawing Preferences dialog to change these settings.

��A specification is defined as a directory in which all of the component database tables for that specificationreside. This drop-down contains a list of the specification directories that reside below the root specificationdirectory The root specification directory is defined as part of the configuration that you select when you starta drawing and appears in the Drawing Preferences dialog in the Specification Path setting. Select a Specname from the drop-down list to make it active. All subsequent component placements will use the parametricand descriptive information from the selected specification until it is changed.

��!�Lists the available main nominal pipe sizes from the current specification, based on the Drawing Units set inthe selected configuration. The selected size is used when you place components to locate the appropriatecomponent record in the specification. The spec record contains descriptive and parametric information usedto draw the component. Select a Size from the drop-down list to make it active

�� Enter the Line Number in this field. Line numbers can be identified using any alphanumeric combination ofcharacters. Subsequent components placed in the drawing will be assigned the Line Number value from thisfield. Line number information is used in reporting, annotation, generating isometrics, and other functions ofthe program.

To change (edit) an individual component’s line number after it has been placed, use the Edit Componentcommand. To revise a line number (change the line number of a selected group of components), use theUpdate Component command.

��

Determines how settings are applied when routing components:

+ From Component: The settings of an existing component are applied to any component connected to it.This option overrides settings in the Drawing Preferences dialog in order to provide an easy method ofmaintaining consistency when connecting components.

+ From Settings: The settings contained in the Drawing Preferences dialog are always applied, despite thesettings associated with a connecting component.

These settings also apply when placing components on an intelligent centerline. If From Component is set, thecomponent will assume the settings applied to the centerline when it was placed. If From Settings is set, thecomponent will assume the settings currently defined in the Drawing Preferences or Component Preferencesdialogs.

�5DE@��5>E

#?=@?>5>D�#?@I��B565B5>35C


�

�� Components may be copied in PIPING and ISOMETRICS using AutoCAD’s COPY command. TheSetup/Component Copy Preferences option enables you to establish rules that define how copied componentsare updated. When using AutoCAD’s COPY command, key fields, such as Line Number, may need to beupdated depending on where the component is copied and the intended use at the new location. TheComponent Copy Preferences dialog controls whether updates are performed manually or automatically, andenables you to select component data fields and define how they are updated.

These preferences are saved locally by configuration, which means each user must setup their own componentcopy preferences. The configured preferences will be defined for every drawing that is created using theconfiguration in which they were defined. For example, if you create a new drawing and select the Imperialconfiguration in the initial Model Setup dialog, then define your copy preferences, every drawing created bythat user using the Imperial configuration will display the last defined set of copy preferences for thatconfiguration.

�� When copying components, do NOT use the COPYCLIP command on AutoCAD’s toolbar or theEdit/Copy menu selection. These commands are related to OLE functions that are not supported.Instead, type COPY (or CP) at the command line, then select the desired component(s) in the model.

�� It is important to distinguish between the Component Copy Preferences command and theComponent Update Preferences. The former specifies the fields that are updated (either manually orautomatically) after a component or group of components is copied using AutoCAD’s COPY function.The latter is associated with updating component drawing database information with the DatabaseTools/Update Component command. These two functions are separate commands.

��#��This area of the dialog enables you to define the method used to update copied components. The options aredescribed below (only one may be selected):

��" ��%#�" ��

If this option is enabled, the Update Component Data Fields dialog will automatically display after youperform a COPY to enable you to modify the values of the configured component data fields. From this

�5DE@��5>E

#?=@?>5>D�#?@I��B565B5>35C


dialog, you can manually update/revise field values associated with the new component. The fields shown inthis dialog are defined by pressing the Component Fields Select button in the Component Copy Preferencesmain dialog, while default prefix and suffix values may be established in the Prefix and Suffix area.

)+��"��3 -��

If this option is enabled, the copied component’s data fields will be updated automatically using the systemdefaults established in the Component Fields and Prefix and Suffix areas of the Component Copy Preferencesdialog. When this option is selected, copied components are updated automatically without displaying adialog for user input.

��"��)�� 45��-3 -��

If this option is enabled, copied component data fields will be modified based on a customized Basic script.This option is only provided for advanced users who are comfortable with the Basic Script language andcommand set, and who have specific rules that they want to enforce when updating copied components.

When this option is set, the user must specify a script file and method (function) in the Basic Script Updatemethod area of the Component Copy Preferences dialog.

��The Component Field Selection dialog shown below is a common drawing database field selection dialog thatis used by several AutoPLANT functions. It displays all of the fields in the current external drawingdatabase’s PIPING table to enable you to select the desired fields as they apply to the currently executedfunction. Drawing database fields appear in the selection list at the left. Select a field then press the Add>button to add it to the list of selected fields.

�� TIP: You can use the Ctrl and/or Shift keys to select multiple fields, then Add> them to the dialogsimultaneously. To remove fields, highlight the field names in the Fields To list box, then press the<Remove button.

A description of the application of this dialog for individual functions is given below. Refer to the explanationbelow the particular function heading for more information.

#�" ��#� +��-��

The Fields To area of the dialog specifies the fields that will be updated when you copy components. Pressthe Select button to display the dialog shown above. Select a field then press the Add> button to add it to thelist of fields that will be available when updating components.

�� Only drawing database fields that have been defined in the PIPING table scheme as updatable willappear in the Available Fields list. A field is deemed updatable if the last setting for that field in..\DATABASE\PIPING.INI is set to U (updatable). This has been configured to prevent users from

�5DE@��5>E

#?=@?>5>D�#?@I��B565B5>35C


�

modifying parametric fields using this command. Only descriptive fields may be modified.

The attributes that appear in the Fields To list affect both Manual and Automatic updating of copiedcomponents. If the Prompt for New Component Value option is selected from the Post-Copy UpdateAutomation area of the dialog, these fields will display for modification in the Update Component DataFields dialog when you perform a copy. If the System Default Updating option was selected, these fields willbe updated automatically based on the established Prefix and Suffix definitions.

� ��$��$This area of the Component Copy Preferences dialog enables you to establish default prefix and suffix valuesthat will be applied to selected data fields of copied components.

If you want to apply a prefix and/or suffix simply enable the desired check box, then enter the prefix and/orsuffix in the field next to the check box. You must then press the Apply to Fields button to select thecomponent data fields to apply the prefix and/or suffix values.

When the Apply To Fields button is pressed, the dialog shown below displays. This dialog enables you toselect the fields to apply the defined prefix/suffix values. The fields that appear for selection in the AvailableFields list were previously selected from the Component Fields area of the Component Copy Preferencesdialog.

To apply the defined prefix/suffix defaults to a field, select Prefix or Suffix from the drop-down list, thenselect the desired field(s) and press the Add> button. Note that the prefix and suffix assignments must bedefined separately by making the appropriate selection from the Select Fields For selection list. Using thistechnique, a prefix can be assigned to one field type, while the suffix applied to another, or a prefix and asuffix may be applied to the same field.

If you no longer want to apply a prefix or suffix to a copied component’s data fields, simply disable the checkboxes in the Component Copy Preferences dialog. If later, you would like to apply these same values, simplyenable the check boxes. The system remembers the last prefix and suffix definitions that you defined.

If the Prompt for New Component Value radio button is enabled when you perform a copy, a dialog willdisplay listing the fields that you selected above with the default prefix/suffix values appended to the sourcecomponent’s initial field value. These values may be accepted or modified. If the Automatic Updating radiobutton is enabled when you perform a copy, the prefix/suffix values will be applied to the selected fieldsautomatically without further interaction.

�5DE@��5>E

#?=@?>5>D�#?@I��B565B5>35C


��

For more advanced users, the Component Copy Preferences function enables you to create custom BasicScript functions that control how copied component drawing database field values are updated. For theseoptions to be available in the dialog, you must first enable the Script-based Updating radio button.

To select the Basic Script File, press the Browse button (or input the path manually). You must enter thename of the Basic Script Method (function) in this file that you want to be executed immediately after thecopy is performed.

��#�� The following procedure explains how to establish rules that the system will use when a user attempts to copycomponent(s).

� �?�4569>5�@?CD#3?@I�3?=@?>5>D�E@41D5�@B565B5>35C

�� Select Setup/Component Copy Preferences to display the Component Copy Preferences dialog.

�� Select one of the Post-Copy Update Automation options. These options effect the updating of copiedcomponents as follows:

+ Prompt: After the component(s) is copied, a dialog will be displayed in which you can review andedit the field values before updating

+ System Default: After the component(s) is copied, field values will be updated automatically basedon the definitions established in this dialog

+ Script: Copied components are updated automatically as determined by a Basic Script file. If youselect this option, skip to Step 5.

�� Press the Select button from the Component Fields area of the dialog. When the Component FieldSelection dialog appears, select the desired fields from the Available list, then press Add>. After selectingthe fields which are to included in the update routine of copied components, press OK to close the dialog.

�� Set the Prefix and Suffix as desired, then skip to Step 7. If you are using the Prompt method, this step isoptional as you can edit the field as desired after the component is copied. If you are using the SystemDefault option, you must input a Prefix, Suffix, or both in these fields (if neither is specified and SystemDefault is selected as the automation type, the copied components will not be udated).

�� Input the name of the Basic script by inputting the full path and file name in the Basic Script File field(you can also press the browse button to select the proper file graphically).

�� Specify the Basic Script Method in the field provided

�� Press OK to close the Component Copy Preferences dialog.

� Copy a test component in the drawing to confirm that fields were updated accordingly. Subsequentcomponent COPY commands will update components based on the definitions established in this dialog.

�� $�� $��

� �?��5D�D85��B569H�1>4�?B��E669H�G85>�E@41D9>7�3?@954�3?=@?>5>DC

�� Select Setup/Component Copy Preferences . When the Component Copy Preferences dialog appears,set the Post Copy Update Automation option and Select the Component Fields.

�� If a prefix is to be appended to updated field values, enable the check box in the Use Program DefaultField Value Pref field. (If a Prefix is not defined, skip to Step 3.) Input the prefix that will be appendedto the front of the affected field. Separators are allowed (for example, a value of “NEW—“ isacceptable).

�5DE@��5>E

#?=@?>5>D�#?@I��B565B5>35C


�

�� If a suffix is to be attached to the end of the updated field values, enable the check box in the UseProgram Default Field Value Suff field. Input the suffix to be attached to the end of the affected field.Separators are allowed (for example “–NEW” is acceptable).

�� Both a Prefix and a Suffix can be added to the same field. Simply enable both options and inputvalues in both blank fields. Apply the Prefix and Suffix as described in the following steps.

�� Press Apply to Fields to display the Component Prefix/Suffix Field Selection dialog. The Available Fieldslist has been populated based on the selections made from the Component Fields area of the ComponentCopy Preferences dialog (Step 1).

�� Prefixes and Suffixes are assigned separately. From the Select Fields For selection list, choose Prefix.

�� Select one or more fields from the Available list, then press Add>. These fields will receive the Prefixinput in Step 4 following a copy operation.

�� From the Select Fields For selection list, choose Suffix then repeat Step 7.

� Press OK to close the Component Prefix/Suffix Field Selection dialog.

��PIPING/ISO components can be copied like any other object using the Copy command. AutoPLANTprovides the Setup/Component Copy Preferences command to customize the copy procedure.

� �?�?@I�1�?=@?>5>D

�� Type COPY at the command line (do NOT use the COPY icon on the AutoCAD toolbar, which isequivalent to the COPY_CLIP command), then press Enter.

�� The prompt

Select objects:

displays. Pick the component(s) to be copied, then press Enter.

�� The prompt

<Base point or displacement>/Multiple:

displays. Pick a point that will be used as a reference point during the copy operation. Use AutoCADOSNAP commands if necessary.

�� The prompt

Second point of displacement:

displays. Pick or input the point where the copied component(s) should be placed. Use AutoCADOSNAP commands if necessary.

�� The Update Component Data Fields dialog displays. Select the field in the left column that requiresupdating, then type the new value in the Edit Field field. Repeat this process for other fields if available.Press OK when done.

�� You can customize the fields presented for post-copy updating using the Setup/Component CopyPreferences command. Click below for more information.

�5DE@��5>E

#?=@?>5>D�3@41D5��B565B5>35C


�� It is sometimes necessary to update component drawing database field values after components have beenplaced in a drawing. For example, a piping line may be moved or copied, which would require you to updatethe Line Number drawing database field value of all components in the line. The Database Tools/Update

Component command enables you to modify a specific drawing database field value for a selection set ofcomponents.

During component updates a dialog displays to enable you to select the drawing database field(s) that youwant to update, then enter the new value for the selected field(s). The fields that are available in this dialogare assigned using the Setup/Component Update Preferences command. This enables a project manager tolimit the fields that individual users can update with the Update Component command.

To add a field, simply select it from the Available Fields list, then press Add>. To remove a field from theFields to Include list, select the field and press <Remove. Multiple fields may be selected in either list bypressing and holding down the Ctrl key, then selecting the fields. A block of fields may be selected in eitherlist by selecting the first field in the block, then pressing and holding down the Shift key and selecting the lastfield in the block.

�� Only drawing database fields that have been defined in the PIPING table scheme as updatable willappear in the Available Fields list. A field is deemed updatable if the last setting for that field in..\DATABASE\PIPING.INI is set to U (updatable). This has been configured to prevent users frommodifying parametric fields using this command. Only descriptive fields may be modified.

These preferences are saved locally by configuration, which means each user must setup their own componentupdate preferences. The configured preferences will be defined for every drawing that is created using theconfiguration in which they were defined. For example, if you create a new drawing and select the Imperialconfiguration in the initial Model Setup dialog, then define your Update Preferences, every drawing createdby that user using the Imperial configuration will display the last defined set of update preferences when theDatabase Tools/Update Components command is executed.

��Lists the fields in the external drawing database’s PIPING table that may be added to the list of fieldsdisplayed in the Update Component Data Fields dialog when you execute the Database Tools/UpdateComponent command. To add a field, simply select it from the Available Fields list, then press Add>.Multiple fields may be selected by pressing and holding down the Ctrl key, then selecting the fields. A blockof fields may be selected by pressing and holding down the Shift key, then selecting the first field in the blockand then the last field in the block.

�5DE@��5>E

#?=@?>5>D�3@41D5��B565B5>35C


�

��'Moves the selected fields from the Available Fields to the Field To Include list in the dialog.

��Moves the selected fields from the Fields to Include list back into the Available Fields list.

��Lists the fields in the drawing database that display in the Update Component Data Fields dialog when you

execute the Database Tools/Update Component command. To remove a field from the Fields to Includelist, select the field and press <Remove. Multiple fields may be selected by pressing and holding down the Ctrlkey, then selecting the fields. A block of fields may be selected by selecting the first field, then pressing andholding down the Shift key and selecting the last field in the block.

��

This chapter describes the component placement options available in the standard Piping menu.It also provides step-by-step procedures that explain how to place and manipulate componentsunder various circumstances.

PIPE COMPONENTS 4-2

BENDS AND RETURNS 4-4

BRANCHING COMPONENTS 4-5

TAP PORT 4-6

VALVES 4-8

FLANGES 4-12

REDUCERS AND SWAGES 4-12

MISCELLANEOUS FITTINGS 4-13

SUPPORTS 4-16

MISCELLANEOUS ATTACHMENTS 4-18

COMPONENT PLACEMENT - HOW TO TOPICS 4-21

COMPONENT MANIPULATION - HOW TO TOPICS 4-27

� � � � �

�

?=@?>5>D��5>EC

�9@5�#?=@?>5>DC


�

��The Pipe Components menu provides the following options to place components of this type. The associatedPipe Components toolbar button, menu command name, graphic depiction of each component, and adescription of each of option is provided in the following table.

The Pipe Components toolbar is available as a flyout toolbar from the main Piping Components toolbar, ormay be displayed separately by selecting Toolbars/Component Toolbars/Pipe.

Pipe Straight Pipe is a variable length component. After specifying the placement point, input or pick a second point toindicate the pipe’s length.

You may also use this command to stub-in pipe using the create taP prompt option that displays when youattempt to connect pipe to an existing pipe segment. Simply execute the command, select the existing pipesegment, type P and press Enter to select the create taP option, select the desired port, distance, tap port size,and orientation, then select the desired Stub In from the Joint Selection dialog.

If you select a Stub In with a reinforcing pad, a dialog will display to enable you to specify the Pad Thickness andCollar Length. The Pad Thickness value defines the width of the pad itself, while the Collar Length value definedthe length of the collar around the pipe from the tap of the pad.

Pipe Bends The Pipe Components/Pipe Bends option displays the dialog shown below to enable you to define your pipebends placement parameters. Define the variables in this dialog, then press OK.

You can either enter the desired Bend Radius in the field provided, or select one of the pre-defined values fromthe selection list (3R, 5R, or 6R). The “R” following the value instructs the system to multiply the value times thenominal size as specified in the Drawing Preferences dialog to determine the actual bend radius. You can alsoenter a value in this field, or enter a value with an “R” suffix to instruct the system to multiple this value times thenominal size.

For example, if you enter 2.5R and the size is set to 6”, then the Bend Radius is calculated as 2.5 X 6”. If youenter the value 15.0, then 15.0 is assigned as the Bend Radius.

Pipe bends require three points: the placement point, the direction, and the orientation.

Pulled Pipe Pulled Pipe allows you to run pipe and pipe bends along a predefined path that has various bends included in it.When the command is executed, you are prompted to select the beginning and ending centerline segments in thepiping path. After the path is defined, the following Pipe Bend Data dialog displays to allow for the definition of thepipe bends.You can either enter the desired Bend Radius in the field provided, or select one of the pre-definedvalues from the selection list (3R, 5R, or 6R). The “R” following the value instructs the system to multiply the valuetimes the nominal size as specified in the Drawing Preferences dialog to determine the actual bend radius. Youcan also enter a value in this field, or enter a value with an “R” suffix to instruct the system to multiple this valuetimes the nominal size.

?=@?>5>D��5>EC

�9@5�#?=@?>5>DC


If there is more than one bend to be generated for the pulled pipe the dialog will provide the Repeat Bend Radiusfor remaining bends check box option. This enables you to repeat the bend radius from the first bend to allsubsequent bends. If this option is disabled, a default will be applied.

When the pipe bends are defined, Piping places the graphic using the intelligence and geometry of the polyline

Nozzle A need has been established to create a nozzle component that will simply represent the nozzle as a symbolicrepresentation and will typically be used when the user has already modeled the nozzle but needs a connection toan existing pipe line. This would allow complete Isos to be generated as well as a complete Bill Of Materialsoutput and other requirements. To satisfy this requirement the existing nozzle component will be modified to allowa consistent interface for the user.

To insert the nozzle select the menu option Pipe Components\Nozzle. The usual spec spec selection dialog willbe displayed enabling you to select a particular nozzle from a multiple selection. Should only one nozzle beavailable in the spec, then no selection will be shown.

The following input dialog will then be presented to the user requesting some optional information and displayingadditional data retrieved from the spec:

The Vessel Name should specify the equipment tag connected to this nozzle. Enter a Nozzle Number in the fieldindicated. The Nozzle Service is for information only for output to reports etc. The Nozzle Size, Rating (orschedule for butt welded nozzles) and Nozzle Length are displayed for information only. If you attempt to place anozzle that has a zero (0.0) COMP_LEN spec database table field value, the Nozzle length field will be enabledas shown above. Enter the Nozzle length in the field provided. The nozzle will be drawn using the lengthparameter specified.

Two basic nozzle types are provided. You may either insert a nozzle Symbol using the parameters assigned forDrawing Mode/Representation in the Drawing Preferences dialog, or insert a nozzle Indicator. If the nozzle hasalready been modeled with the modeling system then the user would typically select the indicator type of nozzle.Otherwise select the symbolic representation that will draw a graphic representation of the nozzle.

By default all nozzles will be placed on the layer LineNumber_Nozzle, where LineNumber is the current linenumber for this component.

?=@?>5>D��5>EC

55>4C�1>4�*5DEB>C


�

Nipple Pipe Nipples require two picks: a placement point and a direction vector. If you attempt to place a nipple that hasa zero (0.0) COMP_LEN spec database table field value, the dialog shown below displays.

Enter the nipple length in the Component Length field, then press OK. The nipple will be drawn using the lengthparameter specified.

AutoPipe AutoPipe enables you to place connecting pipe between existing components and fittings. When the command isexecuted, the Drawing Selection Options dialog displays to enable you to select or define the selection set ofcomponents. The component selection set may include multiple components and directional/orientation changesin a single line.

After the selection set is created, connecting pipe is automatically placed between the selected fittings. If in-linereducers or branches are detected, changes in pipe size and direction are made automatically.

�� The Bends and Returns menu provides options to place components of this type. A description of each ofthese options and the associated Bends and Returns toolbar button is provided below.

The Bends and Returns toolbar is available as a flyout toolbar from the main Piping Components toolbar, ormay be displayed separately by selecting Toolbars/Component Toolbars/Bends and Returns.

90-degree LR Elbow Requires three placement points: insertion, direction, and orientation.

90-degree SR Elbow Requires three placement points: insertion, direction, and orientation.

90-degree 3R Elbow Requires three placement points: insertion, direction, and orientation.

90-degree Reducing Elbow Requires three placement points: insertion, direction, and orientation. The Specification Selectiondialog displays before placement to enable you to select the desired reducing size.

60-degree LR ElbowRequires three placement points: insertion, direction, and orientation. The Specification Selectiondialog is displayed before placement to allow you to choose the reducing size. This component isdefined in the HDPE specification.

90-degree Street Elbow Requires three placement points: insertion, direction, and orientation.

45-degree LR Elbow Requires three placement points: insertion, direction, and orientation.

45-degree 3R ElbowRequires three placement points: insertion, direction, and orientation.

30-degree LR ElbowRequires three placement points: insertion, direction, and orientation. The Specification Selectiondialog is displayed before placement to allow you to choose the reducing size. This component isdefined in the HDPE specification.

22.5-degree LR ElbowRequires three placement points: insertion, direction, and orientation. The Specification Selectiondialog is displayed before placement to allow you to choose the reducing size. This component isdefined in the HDPE specification.

?=@?>5>D��5>EC

5B1>389>7�#?=@?>5>DC


Trimmed Elbow Requires three placement points: insertion, direction, and orientation. The dialog shown below ispresented to allow you to specify the angle of the trim.

Bend Elbow Requires three placement points: insertion, direction, and orientation. The dialog shown below isdisplayed to allow you to specify the angle and radius of the elbow.

180-degree Return Requires three placement points: insertion, direction, and orientation.

� ��The Branching Components menu provides options to place components of this type. A description of eachof these options and the associated Branching Components toolbar button is provided below.

The Branches toolbar is available as a flyout toolbar from the main Piping Components toolbar, or may bedisplayed separately by selecting Toolbars/Component Toolbars/Branches.

Olets require a special placement procedure. The first step is to execute the Tap Port command, in which theport of an existing component is selected. The next step is to specify the distance from that port where the oletwill be placed. You must designate a new Tap Port for each component on which an olet will be placed.

Elbolet Requires placement on an elbow (or other bend component) with a previously defined tap port. Thecreation of the tap port for this type of olet differs from the other tap port definition procedures in thatelbolets are always placed tangential to the bend, and therefore do not require the specification of adistance from the port to the olet insertion location. The orientation of the elbolet is tangential to theselected port on the bend.

Threadolet Requires placement on a component with a previously defined Tap Port.

Sockolet Requires placement on a component with a previously defined Tap Port.

Weldolet Requires placement on a component with a previously defined Tap Port.

45 Degree Pipet Requires placement on a component with a previously defined Tap Port.

Straight Pipet Requires placement on a component with a previously defined Tap Port.

Elbow-Flanged Pipet Requires placement on a component with a previously defined Tap Port.

Thermowell Requires placement on a component with a previously defined Tap Port.

Latrolet Requires placement on a component with a previously defined Tap Port.

?=@?>5>D��5>EC

�1@��?BD


�

Nipolet Requires placement on a component with a previously defined Tap Port.

Coupolet Requires placement on a component with a previously defined Tap Port.

Saddle Requires placement on a component with a previously defined Tap Port. Spec record available in specdatabase DN40.MDB.

Sweepolet Requires placement on a component with a previously defined Tap Port.

Weldolet Insert Requires placement on a component with a previously defined Tap Port.

Straight Tee Requires placement, direction, and orientation points. The orientation determines the branch direction.

Reducing Tee Requires placement, direction, and orientation points. The orientation determines the direction of thereducing branch.

Cross Requires placement, direction, and orientation points.

Reducing Cross Requires placement, direction, and orientation points. The orientation determines the direction of thereducing branch.

Lateral Requires placement, direction, and orientation points. The orientation determines the direction of thelateral.

True Wye Requires placement, direction, and orientation points. The orientation determines the direction of thelateral.

�� The Tap Port command must be executed prior to placing an olet. This command adds a port to the selectedcomponent on which the olet will be placed. All components in PIPING have associated “ports.” These portsare important reference points on the component. The number of ports on any one component depends on thecomponent type and its function. For example, a tee has four ports: two on the main ends of the component,one on the branch end, and one in the center. A piece of straight pipe, however, has only two ports whichindicate the start and end points of the variable length component.

When the Tap Port command is executed, the following series of prompts display:

�� The first step is to specify the component to be tapped.

Pick component to be tapped

Pick the component in the model to be tapped.

�� When you select a component, one of its ports will be highlighted. The selected port will be used as thebase point from which the distance you specify in the next prompt will be measured to define the locationof the tap.

Select the base portToggle/<Enter to select currently highlighted port>:

?=@?>5>D��5>EC

�1@��?BD


Use the Toggle option (or type T and press Enter) to toggle through the component’s ports until thedesired one is selected. When the desired port is highlighted, press Enter.

�� You are now prompted to pick or input a distance from the selected port to designate the actual “Tap”location.

Toggle base port/Align/change Ref point/<Enter Distance>:

Specify the distance and press Enter.

�� The Tap Port Size dialog displays to enable you to define the main size of the component that will beinserted at the tap port. Select the size, then press OK.

�� The last step is to specify the orientation of the tap port.

Enter orientation of tap port

Pick a point on the side of the component where the olet will be placed, or use to +Z and -Z buttons onthe Direction Aids toolbar to specify an orientation in the vertical plane.

�� After the Tap Port is specified, select an olet from the toolbar or menu. When prompted for theplacement point, select the component where the tap was defined. PIPING will recognize the previouslydefined Tap point as a port and define the olets insertion points at that location.

?=@?>5>D��5>EC

�1<F5C


�

��The Valves menu provides options to place components of this type. A description of each of these optionsand the associated Valves toolbar button is provided below.

The Valves toolbar is available as a flyout toolbar from the main Piping Components toolbar, or may bedisplayed separately by selecting Toolbars/Component Toolbars/Valves.

.

Ball Requires placement and direction points.

Gate Three types of gate valves are available for placement: Gate, Extended Gate, and Valv-O-Let Gate. Eachrequires placement and direction points.

Globe Two types of globe valves are available for placement: Globe, and Y-Body Globe. Each requiresplacement and direction points.

Plug Requires placement and direction points.

Needle Requires placement and direction points.

Butterfly Requires placement and direction points.

Check Four types of check valves are available for placement: Check, Stop Check, Angle Stop Check and Y-Body Check. Each requires placement and direction points.

Control Requires placement and direction points.

Angle Requires placement, direction, and orientation points.

Relief Requires placement, direction, and orientation points. The Specification Selection dialog is displayed priorto placement to allow you to select the size of the relief end of the valve. After making this selection, theorientation point specifies the location of the relief end.

Three Way Requires placement, direction, and orientation points.

Four Way Requires placement, direction, and orientation points.

Diaphragm Two types of Diaphragms are available for placement: Diaphragm and Angle Diaphragm. Each requiresplacement, direction, and orientation points.

��

��"��(��

Valve insertion now provides automatic prompting and/or insertion of topworks after each valve placement.The default setup will automatically display a dialog that lists topworks available for selection after a valve isplaced. Simply select the desired topwork from the dialog and press OK to display its placement dialog. Enterthe desired parameters, then press OK to associate the topwork to the valve.

��(��

Topworks can be manually added to existing valves by selecting Valves/Topworks. You will be prompted toselect a valve, then the dialog shown below displays.

?=@?>5>D��5>EC

�1<F5C


Select the desired topworks from the dialog, then press OK. Each topwork option displays a dialog to enableyou to enter the parameters required to draw the topwork. Each dialog contains a bitmap that illustrates eachof the required parameters. Simply enter the parameter values and press OK to connect the topwork to thevalve.

�� %��&��"��#��"�6��

There are basically three (3) methods that you may configure to define how topworks are inserted with valves.

�� Display a list of available topworks in a dialog for selection with each valve placement. (DEFAULT)

�� Explicitly define the topwork placed with a valve type in the valve spec record.

�� Explicitly define the topwork placed with a valve type in the valve’s class record.

��)��

The default valve topworks placement option reads the file TOPWORKS.INI that resides in the currentmodule directory (e.g., the TOPWORKS.INI file for the Base carbon steel modules resides in yourNETWORK_ROOT\MODULES\BASE directory). The list of available topworks that display in the dialog aredefined in this file.

The format of a topwork definition in this file is as follows:

>&RQH@

&ODVV1DPH� �$7B723:25.6B&21(

'HVFULSWLRQ� �&RQH�2SHUDWRU

When you pick an option from the dialog list and press OK, the system will display the parameter dialog forthe selected topwork. If the specification record for the valve that you are placing assigns values for thetopwork parameters, then those values will display as the defaults in the topwork’s placement dialog. If theparameters are not defined in the specification, then they will be read from a separate TOPWORKS.INI filethat resides in the current configuration directory. For example, the topworks parameters for the providedImperial configuration are defined in the file TOPWORKS.INI that resides in yourNETWORK_ROOT\CONFIG\IMPERIAL directory.

The configuration’s TOPWORKS.INI consists of a series of multi-line records that define each topwork. Forexample, the record for the cone operator appears as shown below.

>$7B723:25.6B&21(@

+HLJKW� ��

GLDPHWHU� ��

/21*B'(6&5� �&RQH�2SHUDWRU

?=@?>5>D��5>EC

�1<F5C


�

6+257B'(6&� �7RSZRUNV

The first item enclosed in brackets is the topworks group name, which must be unique and exactly match thetopworks class name. The statements that follow enable you to assign default parameters that will appear inthe actual topwork’s placement dialog. As mentioned above, if the specification record for the valve that youare placing assigns values for these same fields, then those values will display as the defaults in the topwork’splacement dialog.

) ��)��

If you want a particular topworks type always placed with a specific valve type, you can define the topworkstype in the Operator field of the valve’s specification record. For example, if you always want the conetopwork placed with a ball valve, you can assign AT_TOPWORKS_CONE to the Operator field in all of yourvalve spec records.

In this instance, when you place a valve with the Operator field defined, the system will not display thetopworks selection dialog, but will still display the cone operator’s parameter dialog to enable you to modifythe defaults. As stated previously, the defaults will be read from the spec if they are defined, otherwise, theywill be read from the TOPWORKS.INI file.

#��)��

If you want a particular topworks type always placed with a specific valve type, you can define the topworkstype by assigning the topwork’s class to the 723:25.6B&/$66 keyword in the valve’s class record inCLASS.INI. For example, if you always want the handwheel topwork placed with a ball valve, you can assignAT_TOPWORKS_HANDWHEEL to the 723:25.6B&/$66 keyword to the desired valve class records inCLASS.INI.

In this instance, when you place a valve with the 723:25.6B&/$66 keyword defined, the system will notdisplay the topworks selection dialog, but will still display the defined topwork’s parameter dialog to enableyou to modify the defaults. As stated previously, the defaults will be read from the spec if they are defined,otherwise, they will be read from the TOPWORKS.INI file.

��/�� %��&��"��

The reason that all of this works is because the ,1387B0(7+2' for the valves that generally require topworksspecifies that topworks placement is required. The input method for each valve type is defined in that valve’smethod’s record in METHODS.INI. All valve’s except for check valves currently use the same input method(i.e., the prompt for topworks insertion). Therefore, the ,1387B0(7+2' keyword for all valves, except checkvalves, is defined in the >%$6(B9$/9(6B0(7+2'@ group in METHODS.INI as follows:

,1387B0(7+2'� �&RPPRQ?YOYLQSXW��DWB9DOYHBLQSXW

This indicates that the function DWBYDOYHBLQSXW in the file ..\COMMON\VLVINPUT.EBS will be run for eachvalve insertion. All valves use the methods defined in the %$6(B9$/9(6B0(7+2' group, unless they explicitlydefine a method in their individual group. For example, the check valves, which do not require topworks,explicitly define the ,1387B0(7+2' as follows:

,1387B0(7+2'� �&RPPRQ?YOYLQSXW��DWB9DOYHBLQSXW'XPP\

This indicates that the function DWBYDOYHBLQSXW'XPP\ in the file ..\COMMON\VLVINPUT.EBS will be runfor check valve insertion. DWBYDOYHBLQSXW'XPP\ is a special function that was added, which basically doesnot include topworks placement. You could explicitly assign this same ,1387B0(7+2' to other valve types ifyou did not want topworks placed with those types.

?=@?>5>D��5>EC

�1<F5C


�� The User Valves command displays the AutoPLANT Selections dialog shown below.

Select the desired user valve placement option from the dialog, then press OK.

�--��#��"#�" ��

The default valve placement option reads the file VALVES.INI that resides in the current module directory(e.g., the VALVES.INI file for the Base carbon steel modules resides in yourNETWORK_ROOT\MODULES\BASE directory). A sample record has been provided in this file that executesthe already existing gate valve component placement.

The format of a user valve definition in this file is as follows:

>*DWH9DOYH@

&ODVV1DPH� �$7B9$/9(B*$7(

'HVFULSWLRQ� �([DPSOH�RI�D�XVHU�FRPSRQHQW��VDPH�DV�WKH�*DWH�YDOYH

The first item enclosed in brackets is the user valve group name, which must be unique and exactly match thevalve class name as defined in the module’s CLASS.INI file. Each module has its own CLASS.INI file. In orderto add a new user valve class, you must first use the Configuration Editor application to create a customconfiguration, then use the Class Editor application to add the new user valve class to the customconfiguration’s CLASS.INI file. Each of these applications provide their own help file with instruction on howto perform these tasks.

?=@?>5>D��5>EC

�<1>75C


�

��The Flanges menu provides options to place components of this type. A description of each of these optionsand the associated Flanges toolbar button are provided below:

The Flanges toolbar is available as a flyout toolbar from the main Piping Components toolbar, or may bedisplayed separately by selecting Toolbars/Component Toolbars/Flanges.

Weldneck Requires placement and direction points.

Threaded Requires placement and direction points.

Socketweld Requires placement and direction points.

Blind Requires placement and direction points.

Expander Requires placement and direction points.

Slip-On Requires placement and direction points.

Lap-Joint Stub End Requires placement and direction points.

Orifice Requires placement and direction points.

Reducing Flange Threaded and Slip-On selections are available. Requires placement and direction points.

Pick from Spec This command enables you to select the flange directly from the specification. The SpecificationSelection dialog displays a list of flanges matching the requested size. Select from the list.

��

The Reducers and Swages menu provides options to place components of this type. A description of each ofthese options and the associated Reducers and Swages toolbar button are provided below:

The Reducers and Swages toolbar is available as a flyout toolbar from the main Piping Components toolbar,or may be displayed separately by selecting Toolbars/Component Toolbars/Reducers and Swages.

Concentric Reducer Requires placement and direction points. A dialog is displayed for the selection of a reduced size

Eccentric Reducer Requires placement, direction, and orientation points. The Specification Selection dialog opens to allowyou to select the reduced size. The orientation point determines the location of the flat end of thereducer.

Concentric Swage Requires placement and direction points. A dialog is displayed for the selection of a reduced size.

Eccentric Swage Requires placement, direction, and orientation points. The Specification Selection dialog opens to allowyou to select the reduced size. The orientation point determines the location of the flat end of the swage.

?=@?>5>D��5>EC

�9C35<<1>5?EC��9DD9>7C


��The Miscellaneous Fittings menu provides options to place components of this type. A description of each ofthese options and the associated Miscellaneous Fittings toolbar button is provided below.

The Miscellaneous Fittings toolbar is available as a flyout toolbar from the main Piping Components toolbar,or may be displayed separately by selecting Toolbars/Component Toolbars/Miscellaneous Fittings.

General Components Menu

Straight Requires placement and direction picks.

Return Requires placement, direction, and orientation picks.

Bend Requires placement, direction, and orientation picks.

Offset Requires placement, direction, and orientation picks.

Branch Requires placement, direction, and orientation picks.

Lateral Requires placement, direction, and orientation picks.

Wye Requires placement and direction picks.

Cross Requires placement, direction, and orientation picks.

End Requires placement and direction picks.

Blinds Menu

Paddle Requires placement, direction, and orientation points. The orientation determines the flat side of the paddleblind.

Spacer Requires placement, direction, and orientation points. The orientation determines the flat side of the spacerblind.

Bleed Ring Requires placement and direction points.

SpectacleOpen

Requires placement, direction, and orientation points. The orientation determines the flat side of the openspectacle blind.

SpectacleClosed

Requires placement, direction, and orientation points. The orientation determines the flat side of the closedspectacle blind.

Orifice Plate When you attempt to place an Orifice Plate, you are first prompted to pick the insertion point, then select thedesired record from the Specification Selection dialog. When you select a record and press OK, a dialogdisplays to accept/modify a few of the component’s drawing database field values. The default dialog field valuesare initially retrieved from the spec (if it exists). The input dialog enables you to change these values before theactual creation of the component. A bitmap graphic illustrating the parametric fields that may be modified is alsoprovided in these dialogs.

Restriction Plate When you attempt to place a Restirction Plate, you are first prompted to pick the insertion point, then select thedesired record from the Specification Selection dialog. When you select a record and press OK, a dialogdisplays to accept/modify a few of the component’s drawing database field values. The default dialog field valuesare initially retrieved from the spec (if it exists). The input dialog enables you to change these values before theactual creation of the component. A bitmap graphic illustrating the parametric fields that may be modified is alsoprovided in these dialogs.

Strainers Menu

Startup Requires placement and direction picks.

?=@?>5>D��5>EC

�9C35<<1>5?EC��9DD9>7C


�

Basket Requires placement, direction, and orientation picks.

Angle Requires placement, direction, and orientation picks (spec records in spec database DN40.MDB).

Wye Requires placement, direction, and orientation picks.

2-Port Wye Requires placement, direction, and orientation picks.

Steam Traps Menu

Straight Requires placement and direction picks.

Tee Requires placement and direction picks.

Wye Requires placement and direction picks.

Wye w/SwivelConnector

Requires placement, direction, and orientation picks.

Return Requires placement, direction, and orientation picks.

In-Line Requires placement, direction, and orientation picks.

Union Menu

Union Requires placement, direction, and orientation picks.

UnionElbow


Union TeeRequires placement, direction, and orientation picks.

Other Miscellaneous Fittings Menu

Coupling Requires placement and direction points.

Half Coupling Requires placement and direction points.

Boss Requires placement and direction points.

Pipe Cap Requires placement and direction points.

Plug Requires placement and direction points.

ExpansionJoint


Bushing Requires placement and direction picks.

ReducerInsert

Requires placement and direction points.

Ejector/Eductor


Venturi FlowMeter

When you attempt to place a Ventrui Flow Meter, you are first prompted to pick the insertion point, then selectthe desired record from the Specification Selection dialog. When you select a record and press OK, a dialogdisplays to accept/modify a few of the component’s drawing database field values. The default dialog field valuesare initially retrieved from the spec (if it exists). The input dialog enables you to change these values before theactual creation of the component. A bitmap graphic illustrating the parametric fields that may be modified is alsoprovided in these dialogs.

?=@?>5>D��5>EC

�9C35<<1>5?EC��9DD9>7C


Complex FlowMeter

When you attempt to place a Complex Flow Meter, you are first prompted to pick the insertion point, then selectthe desired record from the Specification Selection dialog. When you select a record and press OK, a dialogdisplays to accept/modify a few of the component’s drawing database field values. The default dialog field valuesare initially retrieved from the spec (if it exists). The input dialog enables you to change these values before theactual creation of the component. A bitmap graphic illustrating the parametric fields that may be modified is alsoprovided in these dialogs.

Injection Quill Requires placement, direction, and orientation picks.

�� The User Fittings command displays the AutoPLANT Selections dialog shown below.

Select the desired user fitting placement option from the dialog, then press OK.

�--��#��"#�" ��

The default fitting placement option reads the file FITTINGS.INI that resides in the current module directory(e.g., the FITTINGS.INI file for the Base carbon steel modules resides in yourNETWORK_ROOT\MODULES\BASE directory). A sample record has been provided in this file that executesthe already existing 90 degreee elbow component placement.

The format of a user valve definition in this file is as follows:

>6WDQGDUG�(OERZ@

&ODVV1DPH� �$7B(/%2:B/5B��

'HVFULSWLRQ� �8VHU�GHILQHG�ILWWLQJ��VDPH�DV�D��GHJUHH�HOERZ�

The first item enclosed in brackets is the user fitting group name, which must be unique and exactly match thefitting class name as defined in the module’s CLASS.INI file. Each module has its own CLASS.INI file. Inorder to add a new user fitting class, you must first use the Configuration Editor application to create acustom configuration, then use the Class Editor application to add the new user fitting class to the customconfiguration’s CLASS.INI file. Each of these applications provide their own help file with instruction on howto perform these tasks.

?=@?>5>D��5>EC

)E@@?BDC


�

�� The Supports menu in PIPING and ISOMETRICS provides options to place supports. Selecting any of theseoptions will display an AutoPLANT Selections dialog listing the available support placement types for theselected menu option.

Select the desired component from the dialog, then press OK. Each support option displays a dialog to enableyou to enter the parameters required to draw the support. Each dialog contains a bitmap that illustrates eachof the required parameters. Simply enter the parameter values and press OK to draw the support.

�� The selection dialog instance is defined in the SELECT.EBS file in yourNETWORK_ROOT\MODULES\BASE\DIALOGS directory.

��Each of the support menu placement options reads an INI file to determine the list of supports for that typedisplayed in the selections dialog. For example, the supports displayed by the Supports/Anchors and Guidescommand are defined in the file ANCHORS.INI that resides in the current module directory (e.g., theANCHORS.INI file for the Base carbon steel modules resides in your REBIS\MODULES\BASE directory).Several support records have been provided in each of these INI files. The INI files used by the other Supportmenu commands are listed below:

Supports/Hangers HANGERS.INI

Supports/Supports on Supports COMPSUPP.INI

Supports/Misc. Supports MISCSUPP.INI

Supports/Shoes SHOES.INI

Supports/User Supports SUPPORTS.INI

The format of a support definition in these files is as follows:

>8%ROW@

&ODVV1DPH� �$7B6833257B8%2/7

'HVFULSWLRQ� �8�%ROW�6XSSRUW

The first item enclosed in brackets is the support group name, which must be unique and exactly match thesupport class name as defined in the module’s CLASS.INI file. Each module has its own CLASS.INI file. Inorder to add a new support class, you must first use the Configuration Editor application to create a customconfiguration, then use the Class Editor application to add the new support class to the custom configuration’sCLASS.INI file. Each of these applications provide their own help file with instruction on how to performthese tasks.

?=@?>5>D��5>EC

)E@@?BDC


The User Supports menu option and associated SUPPORTS.INI file is provided to enable you to add yourown supports to the system.

��

� �?��<135�1��E@@?BD

�� Select an option from the Supports menu.

�� The prompt

Select the component

displays. Pick the component to support.

�� A dialog displays listing available support placement options. Select the desired support, then press OK.

�� The prompt

Select the base port Toggle/<Enter to select currently highlighted port>:

displays. The port closest to the end of the component you selected will appear highlighted. You mayaccept this port, or type T and press Enter to toggle to a different port on the selected component. Whenthe desired port is highlighted, press Enter.

�� The prompt


displays. Enter the first letter of the desired option, or input a distance to specify the distance from theselected port where the support will be placed.

�� Another dialog will display to define the parameters required to place the selected support. Enter theparameters in the dialog, then press OK.

�� The prompt

Up/Down/East/West/North/South/Align/Rotate/<Enter support direction or press Return when done>

displays. Pick a point, or enter one of the provided options to define the orientation of the support.

?=@?>5>D��5>EC

�9C35<<1>5?EC��DD138=5>DC


�

��The Miscellaneous Attachments command displays the AutoPLANT Selections dialog shown below.

Select the desired miscellaneous attachment placement option from the dialog, then press OK.

��In PIPING, the following Misc. Attachments enable you to insert a detail item that can be exported toAutoISO and displayed on the resulting Iso drawings.

+ Flow Arrow

+ Insulation Symbol

+ Location Point (designed to indicate a point on a pipe line, at which a dimension is required).

+ Comment

+ Floor Opening

+ Grate Opening (the same as a floor, but displayed as a grate on the Iso).

+ Wall Opening

+ Additional Material

+ Reference Dimension: this is a special type of attachment provided to enable you to specify that adimension be placed from a point on a component to a disconnected item on an ISOGEN isometricgenerated using AutoPLANT Import/Export. Click the Reference Dimension link for moreinformation on this attachment type.

�� The same options indicated above are available in ISOMETRICS to allow for the manual insertion of thesedetail items in an isometric drawing. The following options are also provided in ISOMETRICS to allow forthe insertion of additional items that are not component attachments, but add detail to the drawing and can bedimensioned to using the Reference Dimension option. These items are:

+ Equipment Vessel

+ I-Beam

+ Ground

?=@?>5>D��5>EC

�9C35<<1>5?EC��DD138=5>DC


+ Reference Dimension Item (this is a general item that can be inserted and dimensioned to, using theReference Dimension option.)

��The default attachment placement option reads the file MISCATT.INI that resides in the current moduledirectory (e.g., the MISCATT.INI file for the Base carbon steel modules resides in yourNETWORK_ROOT\MODULES\BASE directory). Several sample records have been provided in this file.

The format of a miscellanous attachment definition in this file is as follows:

>)ORZB$UURZ@

&ODVV1DPH� �$7B$77$&+B)/2:

'HVFULSWLRQ� �)ORZ�$UURZ

The first item enclosed in brackets is the attachment group name, which must be unique and exactly matchattachment class name as defined in the module’s CLASS.INI file. Each module has its own CLASS.INI file. Inorder to add a new user attachment class, you must first use the Configuration Editor application to create acustom configuration, then use the Class Editor application to add the new attachment class to the customconfiguration’s CLASS.INI file. Each of these applications provide their own help file with instruction on howto perform these tasks.

�� The Reference Dimension attachment is available for placement by executing the Miscellaneous Attachmentsoption from the Piping/Iso menu, then selecting the Reference Dimension option an pressing OK. Thisattachment is provided to enable you to dimension from a point on a component to a disconnected item in anISOGEN isometric drawing generated from a PIPING model or ISOMETRICS drawing using AutoPLANTImport/Export. This capability was added to enable you to identify the component and the item to which itreferences.

Selecting the Reference Dimension option from the Miscellanous Attachments dialog and pressing OKprompts you to select the parent, or reference, component.


The next step is to define the define the desired component reference location, which is the coordinates on thecomponent from which the reference dimension will be placed. When the component was selected above, oneof its ports was highlighted. The following prompt enables you to toggle the selected port to one of the othercomponent ports by typing T and pressing Enter. When the desired port is selected press OK.

Select the base port

Toggle/<Enter to select currently highlighted port>:


The following prompt enables you specify the location of the reference item.

Pick the reference item location

When the component reference location has been defined, the dialog shown below displays.

?=@?>5>D��5>EC

�9C35<<1>5?EC��DD138=5>DC


�

A description of the individual options in this dialog is provided below:

�?>7��5C3B9@D9?>

The data entered in the Long Description field will be saved in the attachment’s drawing database record. Youmay optionally append the reference item location to the Long Description value by enabling the Appendreference location to the description check box. This value will be written to the external drawing databaserecord and displayed as annotation in the generated ISOGEN isometric.

565B5>35�5>D5B<9>5

The Reference Centerline list defines the line type of the item used for this reference object. The followingline type selections are currently available.

Isogen Default (normal) default for the type of reference item selected

Dashed/Existing __ __ __ __ __ __ __ __ __

Centerline _ _ ___ _ ____ _ ____ _

Phantom __ _ _ __ _ _ __ _ _ __ _ _

Hidden/Dotted _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

Short Centerline __ _ __ _ __ _ __ _ __ _ __

1D57?BI

The Category list enables you to select the type of item being referenced. Describes the category for the typeof component that the referenced item belongs to, the following options are currently available and will bedisplayed as part of the resulting reference dimension:

Building Equipment Item Floor Level Grid Line Horizontal Steel Equipment Pipeline Vertical Steel Equipment Wall Miscellaneous

?=@?>5>D��5>EC

#?=@?>5>D��<135=5>D�4�$?G��?��?@93C


�>>?D1D9?>�?>D19>5B

The tag annotation can optionally be enclosed by one of the following container types: round, square, orpointed by selecting the desired option from the Annotation Container drop-down list.

565B5>35��2:53D��B95>D1D9?>

This option indicates the orientation of the referenced object. Your may either select an orthogonalprojection, North, South, East, West, Up or Down. Alternately, if you select Angled, on completion of theinput to this dialog you will be prompted to specify the direction of the referenced item by selecting twopoints in space.

�9=5>C9?>�?>��C?

This option will allow a location dimension to be generated for the selected pipeline component, not thereference.

�;5G54��9=5>C9?>

Determines if the dimension to the reference item should be in the form of skewed movements between apoint on the pipeline and the centerline of the item to be referenced. If this item is left disabled then themovements of the dimension lines will follow the primary planes. One, two or three movements may benecessary depending n the location of the referenced item.

#��"�6��#��-��

In order to implement this functionality, we had to add a script to output reference dimensions to PCF forISOGEN, and add the ability to create reference dimension attachments in ISOMETRICS. This requiredmodification of the PIPING/ISOMETRICS scripts and INI files to handle an AT_ATTACH_REFDIM classand by adding a PCF script for output.

��#��This area provides step-by-step instructions that walk you through several component placement techniques.

�� %�� &PIPING and ISOMETRICS now automatically prompt you for topwork placement when you insert a valve.You can cancel this option at the time of placement, then manually insert topworks at a later time using theValves/Topworks command.

� �?��44��?@G?B;C��@5B1D?BC�D?��1<F5C

�� Select Valves/Topworks .

�� The prompt:

Select the component:

displays. Select a valve to display a dialog of available topworks.

�� Select the desired operator from the dialog and then press OK. Another dialog will display that containsparameter fields that must be defined in order to draw the operator. Each dialog also contains a bitmapgraphic that illustrates the parameters required.

�� Define the parameters for the operator in the dialog, then press OK.

�� The prompt

Enter Topworks Direction:

?=@?>5>D��5>EC

#?=@?>5>D��<135=5>D�4�$?G��?��?@93C


�

displays, and the starting point is anchored to the center of the selected valve. Pick a point to orient theoperator.

��$��A component can be placed so that its centerlines are aligned with existing components in the model. This isuseful for placing bends and branching components, which are connecting existing components at differentelevations and in different planes of the model.

� �?��<97>�D?��H9CD9>7�?=@?>5>DC

�� Ensure that the Auto Router switch is disabled, then select the branching or bend component.

�� The prompt

Relative/Toggle/Elev/<Pick point or Return for fit to fit)>: R

displays. Select the endpoint of the first component to align to (if it is not already selected). After the first

relative point is selected, type R and press Enter to select the Relative option , then press Enter.

�� The prompt

Align/change Ref point/Elev/<Enter Distance or press return for fit to fit>: A

displays. Type A and press Enter to select the Align to option.

�� The prompt

Pick component to align to:

displays. Pick the second component. The two ports are highlighted. Press Enter to accept the selection.PIPING automatically determines the point where these two components’ centerlines intersect.

�� An outline of the component is placed at the point, and the prompt

Toggle insertion point/<Return to select>:

displays. If desired, Toggle the insertion point of the component (in most cases you’ll want to acceptthe default to place the new component’s center at the intersection of the two component centerlines).Press Enter.

�� (Branching components only:) The prompt

Toggle alignment port/<Press enter to select>: T

displays. Toggle the port alignment, then press Enter.

�� The prompt

Up/Down/East/West/North/South/Align/Rotate/<Enter orientation or press Return when done>

displays. Indicate the orientation by picking a point in the drawing or by using one of the commands onthe Responses toolbar.

?=@?>5>D��5>EC

#?=@?>5>D��<135=5>D�4�$?G��?��?@93C


��$��When routing components, the most common method of connection is “Fitting to Fitting.” In Auto Routermode, this type of connection is made automatically. In manual routing mode, follow the procedure below.

� �?��DD138�D?�1>��H9CD9>7�?=@?>5>D

�� Select the new component from the menu or toolbar.

�� The prompt

Relative/Elev/<Pick point or Return for fit to fit)>:

displays. Press Enter to accept the default “Fitting to Fitting” method. The component is attached to therun direction end of the component.

�� If the component contains a bend or branch, the prompt

Up/Down/East/West/North/South/Align/Rotate/<Enter orientation or press return when done>:

displays. Pick a point in the drawing to orient the component, or select a command from the Responsestoolbar to orient along a particular axis.

�� If you are not connecting to the last component placed in the drawing, you will need to specify a newreference point before attaching. To do this, simply select the component you want to attach to inStep 3, then continue the procedure normally.

�� The Auto Router mode is the fastest method of connecting a series of components together. This option shouldnot be used if special placement procedures are required.

� �?��ED?=1D931<<I� ?ED5�?=@?>5>DC

�� Select Setup/Drawing Preferences to open the Drawing Preferences dialog.

�� Enable the Auto Router switch (located in the Other Settings area of the dialog).

��%��&The AutoPipe command will automatically place connecting pipe between existing fittings. Main Size isdetermined by the connecting components, and the command will recognize in-line reducers and change thenominal size accordingly.

� �?��ED?=1D931<<I��<135�?>>53D9>7��9@5�%�ED?�9@5&

�� Select Pipe Components/Auto Pipe .

�� The Drawing Selection Options dialog displays. Select the components between which connecting pipeshould be placed using the tools in this dialog.

�� After the selection set is created, the connecting pipe is placed.

?=@?>5>D��5>EC

#?=@?>5>D��<135=5>D�4�$?G��?��?@93C


�

�� When routing in PIPING, a reference point is always indicated in your drawing. This symbol indicates thecurrent point from which all commands will be executed. If you are connecting two components using thefitting to fitting method, the new component will be connected to the reference point. In some cases, you maywant to change the reference point so that, for example, you can place a component a specified distance fromthe center point of an elbow instead of its endpoint.

� �?�81>75�D85� 565B5>35��?9>D

�� The reference point can only be changed while using the Relative option during a placement routine.When one component is placed relative to another the prompt:

Align to/change Ref point/Elev/<Enter Distance or press return for fit to fit>: R

displays. Indicate the change Reference point option . The reference point toggles to any otheravailable locations on the current component. If you’d like, you can pick a valid point on anothercomponent in the model.

�� Input a distance or select the Align to option to continue with the placement procedure.

�� Before an olet can be attached to an existing pipe, you must define a new port at the desired location on theexisting pipe. Once the port is defined, the olet can be attached to it.

� �?��569>5�1��1@��?BD

�� Select Branching Components/Olets/Tap Port .

�� The prompt

Pick component to be tapped

displays. Pick the pipe in the model on which the olet is to be placed.

�� The prompt

Toggle/<Enter to select currently highlighted port>

displays. Tap Ports are defined a specified distance from an existing port. Either press Enter to accept the

default port, or Toggle to designate the port at the opposite end of the pipe.

�� The prompt


displays. Enter a distance from the reference point at the command line, or pick a point in the model. (Ifthe olet is to be placed a known distance from another point, you can change the reference point by

designating the change Ref point option.)

�� The Tap Port Size dialog displays to enable you to define the main size of the component that will beinserted at the tap port. Select the size, then press OK.

�� The prompt

Enter orientation of tap port

displays. Specify the edge of the pipe where the olet will be placed. To specify a vertical direction, use

the or keys on the Responses toolbar.

�� The new port is defined at the specified location and orientation. You can now place an olet directly onthis port by selecting and olet placement command, then picking the component on which you defined

?=@?>5>D��5>EC

#?=@?>5>D��<135=5>D�4�$?G��?��?@93C


the tap. PIPING will automatically locate the tap port on the selected component and make it the defaultinsertion point for the olet.

��In most cases you will either be connecting components directly or placing them relative (at known distances)to one another. In some cases, however, you may want to place a component “in space”; that is, at a specificlocation or coordinate with no respect to other component locations.

� �?��<135�1�?=@?>5>D�9>��@135

�� Ensure Auto Router is OFF.

�� Select the component.

�� The prompt

Relative/Elev/<Pick point or Return for fit to fit)>:

displays. Select a point in the drawing, or input the (x,y,z) coordinates using standard AutoCADtechniques.

�� After the point is selected, an outline of the component is placed in the model and the prompt

Toggle insertion point/<Return to select>:

displays. Toggle the component to designate its insertion point. Depending on the component, theremay be anywhere from two to four possible insertion points. After the desired point is specified, pressEnter.

�� The next step depends on the type of component that was selected:

+ variable length: input a distance to indicate the length of the component, then press Enter.

+ branch or bend: specify a direction and orientation by picking a point in the drawing or using thebuttons on the Resonses toolbar, then press Enter.

�� $��Component may be placed a relative distance from an existing point on a reference component. You may, forexample, place a bend 10’ from the center point of a tee that is already placed in the model.

� �?��<135�1� >?G>��9CD1>35�6B?=�1>��H9CD9>7�?=@?>5>D


�� The prompt:

Relative/Elev/<Pick point or Return for fit to fit)>: R

displays. Select the component you want to use as a reference (if it is not already selected). Specify the

Relative option .

�� The prompt

Align to/change Ref point/Elev/<Enter Distance or Return for fit to fit>:

displays. Examine the reference component and ensure that the reference point is at the proper location.By default, this will be the endpoint of the component. If you’d like to place relative to the center of thecomponent, change the reference point.

�� Input a distance at the command line, then press Enter (you may also indicate the distance by picking anew point in the drawing).

?=@?>5>D��5>EC

#?=@?>5>D��<135=5>D�4�$?G��?��?@93C


�

�� An outline of the component is placed in the drawing. To place it, press Enter. If you’d like to change the

insertion point, use the Toggle option until the component appears as desired, then press Enter.

�� (Branching components and bends only:) The prompt

Up/Down/East/West/North/South/Align/Rotate/<Enter orientation or press Return when done>

displays. Indicate the orientation by picking a point in the drawing, or by selecting one of the commandsfrom the Responses toolbar.

�� (Asymmetrical components only:) The prompt

Toggle alignment port/<Press enter to select>: T

displays. Press Enter to place the component as shown, or use the Toggle option to change thealignment of the component. Press Enter when done.

�� Components may be placed on smart polylines which are placed into a model to define one or more pipingpaths. This method ensures the proper alignment of several objects and allows vector data and other settingsto be extracted directly from the intelligence of the smart polyline.

� �?��<135�1�?=@?>5>D�?>�1��=1BD��?<I<9>5


�� The prompt

Relative/Toggle/<Pick point (Component, Routing Line, Space, or Enter for fit to fit)>:

displays. Select a point on the polyline. Use AutoCAD’s OSNAP commands to select a specificendpoint, intersection point, or XYZ distance from a specific reference point (refer to AutoCADdocumentation/help for more information on the use of OSNAPS).

�� PIPING places the component at the specified point, using the intelligence and geometry of the line toplace the component. If the “Connect from Existing” option is specified as the Data Mode, thecomponent will automatically be assigned the line’s settings (size, insulation, etc.). Otherwise, the valuesestablished in the Drawing Preferences dialog will be applied.

?=@?>5>D��5>EC

#?=@?>5>D��1>9@E<1D9?>�4�$?G��?��?@93C


��#��This area provides procedures that walk you step-by-step through common component manipulation tasks.

�� After a component is placed in a model, many of its attributes can be modified directly by editing the externaldrawing database record associated with the component. As a general rule, dimensional and position data maynot be modified.

� �?��49D�?=@?>5>D��>6?B=1D9?>

�� Select Database Tools/Edit Component .

�� Select a component to display the first page of the Component Information dialog. The first page of thisdialog contains the most common component drawing database record information. Most of theinformation is provided for information purposes only. The field data that may be modified is presentedin white editable text boxes. Simply move the cursor into the desired text box and modify the informationas desired. Changes made in this dialog will update the respective field information in the component’sdrawing database record.

�� Press Next Page to display the second page of the dialog. The second page contains component positionand port information. It also provides a complete list of all of the component’s drawing database recordfield values.

�� Press OK to close the dialog.

�� The Database Tools/Update Component command may be used to globally update the value of specificexternal drawing database fields for a selection set of components in the current or from multiple drawings.

� �?�E@41D5�3?=@?>5>D�9>6?B=1D9?>

�� Select Database Tools/Update Component .

�� The Drawing Selection Options dialog displays. Select the components to update using the toolsavailable in the dialog.

�� After selecting the components, the Update Component Data Fields dialog displays.

�� Select a field from the List of Fields to be Updated list, then enter the new value for that field in the EditField box. Repeat this process to modify the value for any other fields in the list.

�� Press OK to update the field values for all selected components.

�� You can customize the list of fields that appear in the Update Component Data Fields dialog usingthe Setup/Component Update Preferences command.

?=@?>5>D��5>EC

#?=@?>5>D��1>9@E<1D9?>�4�$?G��?��?@93C


�

��PIPING/ISO components can be copied like any other object using the Copy command. AutoPLANTprovides the Setup/Component Copy Preferences command to customize the copy procedure.

� �?�?@I�1�?=@?>5>D

�� Type COPY at the command line (do NOT use the COPY icon on the AutoCAD toolbar, which isequivalent to the COPY_CLIP command), then press Enter.

�� The prompt

Select objects:

displays. Pick the component(s) to be copied, then press Enter.

�� The prompt

<Base point or displacement>/Multiple:

displays. Pick a point that will be used as a reference point during the copy operation. Use AutoCADOSNAP commands if necessary.

�� The prompt


displays. Pick or input the point where the copied component(s) should be placed. Use AutoCADOSNAP commands if necessary.

�� The Update Component Data Fields dialog displays. Select the field in the left column that requiresupdating, then type the new value in the Edit Field field. Repeat this process for other fields if available.Press OK when done.

�� You can customize the fields presented for post-copy updating using the Setup/Component CopyPreferences command. Click below for more information.

?=@?>5>D��5>EC

#?=@?>5>D��1>9@E<1D9?>�4�$?G��?��?@93C


��#�� The following procedure explains how to establish rules that the system will use when a user attempts to copycomponent(s).

� �?�4569>5�@?CD#3?@I�3?=@?>5>D�E@41D5�@B565B5>35C

�� Select Setup/Component Copy Preferences to display the Component Copy Preferences dialog.

�� Select one of the Post-Copy Update Automation options. These options effect the updating of copiedcomponents as follows:

+ Prompt: After the component(s) is copied, a dialog will be displayed in which you can review andedit the field values before updating

+ System Default: After the component(s) is copied, field values will be updated automatically basedon the definitions established in this dialog

+ Script: Copied components are updated automatically as determined by a Basic Script file. If youselect this option, skip to Step 5.

�� Press the Select button from the Component Fields area of the dialog. When the Component FieldSelection dialog appears, select the desired fields from the Available list, then press Add>. After selectingthe fields which are to included in the update routine of copied components, press OK to close the dialog.

�� Set the Prefix and Suffix as desired, then skip to Step 7. If you are using the Prompt method, this step isoptional as you can edit the field as desired after the component is copied. If you are using the SystemDefault option, you must input a Prefix, Suffix, or both in these fields (if neither is specified and SystemDefault is selected as the automation type, the copied components will not be udated).

�� Input the name of the Basic script by inputting the full path and file name in the Basic Script File field(you can also press the browse button to select the proper file graphically).

�� Specify the Basic Script Method in the field provided

�� Press OK to close the Component Copy Preferences dialog.

� Copy a test component in the drawing to confirm that fields were updated accordingly. Subsequentcomponent COPY commands will update components based on the definitions established in this dialog.

��PIPING/ISO components can be moved like any other AutoCAD entity.

� �?��?F5�1�?=@?>5>D

�� Type MOVE at the command line, then press Enter.

�� The prompt

Select objects:

displays. Pick the component(s) to be moved, then press Enter.

�� The prompt

<Base point or displacement>/Multiple: is displayed.

displays. Pick a point that will be used as a reference point during the move operation. Use AutoCADOSNAP commands if necessary. Press Enter.

�� The prompt


displays. Select the point where the component should be moved. Use AutoCAD OSNAP commands if

?=@?>5>D��5>EC

#?=@?>5>D��1>9@E<1D9?>�4�$?G��?��?@93C


�

necessary. Press Enter.

�� If you intend to move a set of components and connect the open end of this set to an existingcomponent, you should use the Piping Tools/Join Components command to connect the twocoincident welded components together. For example, if you move/copy a pipeline connected to onebuttweld component to the end of another buttweld component, you can use this command toproperly connect the second buttweld component with the copied pipeline. Flanges and othercomponents that are not coincident cannot be connected with this function.

�� $�� $��

� �?��5D�D85��B569H�1>4�?B��E669H�G85>�E@41D9>7�3?@954�3?=@?>5>DC

�� Select Setup/Component Copy Preferences . When the Component Copy Preferences dialog appears,set the Post Copy Update Automation option and Select the Component Fields.

�� If a prefix is to be appended to updated field values, enable the check box in the Use Program DefaultField Value Pref field. (If a Prefix is not defined, skip to Step 3.) Input the prefix that will be appendedto the front of the affected field. Separators are allowed (for example, a value of “NEW—“ isacceptable).

�� If a suffix is to be attached to the end of the updated field values, enable the check box in the UseProgram Default Field Value Suff field. Input the suffix to be attached to the end of the affected field.Separators are allowed (for example “–NEW” is acceptable).

�� Both a Prefix and a Suffix can be added to the same field. Simply enable both options and inputvalues in both blank fields. Apply the Prefix and Suffix as described in the following steps.

�� Press Apply to Fields to display the Component Prefix/Suffix Field Selection dialog. The Available Fieldslist has been populated based on the selections made from the Component Fields area of the ComponentCopy Preferences dialog (Step 1).

�� Prefixes and Suffixes are assigned separately. From the Select Fields For selection list, choose Prefix.

�� Select one or more fields from the Available list, then press Add>. These fields will receive the Prefixinput in Step 4 following a copy operation.

�� From the Select Fields For selection list, choose Suffix then repeat Step 7.

� Press OK to close the Component Prefix/Suffix Field Selection dialog.

��

This chapter covers the Piping Tools menu, which provides numerous tools to increase theefficiency and accuracy of component placement.

OVERVIEW 5-2

CENTERLINE ROUTERS MENU 5-2

REPRESENTATIONS 5-20

3D DISPLAY MODES 5-22

3D DISPLAY UTILITIES MENU 5-25

CONNECTIVITY CHECKER 5-27

DIMENSION NODES 5-30

JOIN COMPONENTS 5-31

STOP SIGNS 5-32

� � � � �

�

�9@9>7��??<C��5>E

/F5BF95G


�

�� The Piping Tools menu provides numerous tools to enable you to increase the efficiency and accuracy ofcomponent placement. These commands may also be executed via the Piping Tools toolbar. This toolbar isavailable as a flyout toolbar from the main Piping Functions toolbar, or may be displayed separately byselecting Toolbars/Function Toolbars/Piping Tools. This toolbar contains flyouts that display additionalcommands for each Piping Tools category.

��

The Centerline Router options enable you to define a piping path and then place components directly on it.This method has the advantage of placing component centerline, bend, and branch information all in a singlestep. It is also the best method for drawing rolls and defining slopes on the piping path, eliminating the needto calculate roll and placement points individually for specific components. The centerlines are intelligent,and elevation parameters and other data are transferred to the components placed on the line.

Several different types of routers have been provided to accommodate the different working styles of ourusers. Review the choices offered in the menu, then select a method, which best meets the needs of yourproject.

�� Many AutoPLANT commands display the following dialog to enable you define the settings that will applyfor that function. This is a reduced version of the Drawing Preferences dialog, which only displays thecomponent attributes that may be defined for the command executed. For example, the Draw IntelligentCenterline command in ISOMETRICS and the Piping Tools/Centerline Routers/From Dialog command inPIPING displays this dialog to assign the attributes established when you initially draw a centerline.Components placed on this line will assume these settings for placement.

Set the Specification, Nominal Size, Line Number, Insulation Thickness and Insulation Spec as desired, thenpress OK.

�9@9>7��??<C��5>E

#5>D5B<9>5�*?ED5BC��5>E


� ��The From Dialog router is the most versatile. It provides a dialog interface for changing elevations,specifying slope parameters, and otherwise controlling the construction of the centerline.

When the command is first executed, the Info Mode dialog is displayed. Specify whether or not the centerlineshould be drawn using a smart info line. If this switch is ON, an additional dialog is displayed for the settingof the main size, line number, specification, and insulation thickness values associated with the centerline.Any components subsequently placed on the line will extract these values from the line itself.

After specifying the Info Mode, the prompt

([LW��2SWLRQV!�3LFN�3RLQW�

is displayed. Pick the starting point in the drawing to begin routing the centerline. If you select the endpointof an existing component or nozzle, the router will automatically extract the correct elevation parameter.Otherwise, press Enter or the right mouse button to open the router dialog shown below. A description of allof the options in this dialog is provided after this figure. Click on an area of the dialog to quickly jump to thehelp on a specific option.

The dialog provides tools for defining the next point on the current centerline. After the point is defined, thedialog will close to allow you to specify in-plane points using standard AutoCAD techniques. To re-open thedialog at any time, simply press Enter or the right mouse button.

/ ��

The following options aid in adding a point to the centerline. In many cases, these options are used inconjunction with the Distance/Angle fields.

?>5

No point creation commands or options selected. You can set this option to clear the current settings.

�?G1B4C��G1I��?<1B

The Towards (+Z) and Away (-Z) options will activate the Distance field. Specify the distance from theprevious point.

The Polar option will activate the Distance and the X-Y Angle fields. Input the distance and angle at which thenext point should be placed. For example, to place the next point 45-degrees from the current point, 6 feet

�9@9>7��??<C��5>E

#5>D5B<9>5�*?ED5BC��5>E


�

away, input -6 in the Distance field and 45 in the X-Y Angle field.

�<?@9>7

Activates the Z Angle field. The Sloping command enables you to input the angle the pipe line runs towardsor away from the current point. After pressing OK from the Routing dialog, the dialog shown below isdisplayed. Specify whether or not the pipe line is sloping towards or away from the viewer (looking down onthe drawing in the plan view).

You will be prompted to select the (XY) location of the next point. The router will automatically calculate theproper Z value based on the requested slope angle.

!#�9CD1>35

Activates the Distance, Z-Distance and X-Y Angle fields. The Z-Distance command enables you to input apolar coordinate and then specify a Z-distance above or below that coordinate where the point will be placed.For example, refer to the graphic below. The Distance and X-Y Angle fields define Point A, then the Z-Distance value specifies the new centerline point as 48 units above Point A.

�9@9>7��??<C��5>E

#5>D5B<9>5�*?ED5BC��5>E


9C5# E>

Select the Rise-Run option then press OK to open the following dialog.

The Rise-Run dialog enables you to specify the amount a certain pipe line should rise over a specifieddistance, and calculates a Z Angle value for information purposes (press Enter or move the cursor to a newfield to calculate the angle). Input the Rise and Run values in the appropriate fields, then press OK. The newpoint is placed in the model.

�@��?G>�?BD8��?ED8��1CD��5CD

Activates the Distance field. Select the appropriate command to indicate the general direction the pipe line isturning, then input the length the line proceeds along that direction before the next point is reached.

5<1D9F5

Disables the Distance/Angles fields. The Relative commands will determine the intersection between theprevious centerline point and a point that already exists in the model (such as the endpoint of a component ora point on another centerline). This can be very useful when routing a centerline to connect two componentsthat lie in different planes and at different elevations. For example, refer to the Figure below.

�9@9>7��??<C��5>E

#5>D5B<9>5�*?ED5BC��5>E


�

Suppose you are routing off the nozzle. Having already determined that the first point extends a knowndistance from the nozzle, you now need to calculate the point that will align with the centerline of the teewhere an elbow will be placed. Select Relative from the Routing dialog, then press OK. The dialog closes andthe prompt 3LFN�'LUHFWLRQ is displayed. Indicate the direction in which the next point will be located. Youare next prompted to�3LFN�5HODWLYH�(QG�3RLQW. Use the AutoCAD ENDP OSNAP to select the centerlineof the tee. The line is routed from the previous point to the selected end point, with a 90 bend in the line.

565B5>35

The Reference command enables you to select a reference point that already exists in the model, then specifya distance from that point. A line from the new point is then drawn back to the centerline’s previous point.Refer to the Figure below

Suppose you are routing from the tee in the Figure and you want to route the line down and place an elbow aknown distance away from the previous elbow. You also want the two elbows placed on the same plane sothey can be supported at the same elevation. Select the Reference command, then select the intersection pointof the elbow to use as reference. Next, specify a distance away from that point. The centerline continues tothe newly defined point. You can then continue routing. The result is shown in red in the Figure.

�<5F1D9?>

Activates the Distance and Pipe O.D. fields. Input the elevation at which you want the next point placed inthe Distance field. Input the nominal pipe diameter in the Pipe O.D. field to ensure that the centerline will beplaced at the proper location.

��<5F1D9?>

Activates the Distance and Pipe O.D. fields. First ensure that the Pipe OD field correctly describes thenominal pipe size that will be placed at that point, then specify the elevation at which point should be placed.If Top Elev is selected, the router will calculate where the centerline should be placed so that the top of thepipe is at the requested elevation. If Bottom Elev is selected, the router will place the centerline so that the

�9@9>7��??<C��5>E

#5>D5B<9>5�*?ED5BC��5>E


bottom of the pipe will be placed at the requested elevation. If Center Elev is selected, the pipe isautomatically placed at the centerline elevation with no adjustments.

�?H� ?ED5B��93;

If you are connecting two points that lie in different planes at different elevations, you can use the Box RouterPick command to aid in the routing of 90-degree connections. For example, refer to the Figure below.

After routing to Point A, you want to connect to the centerline of the tee using two 90-degree bends. SelectBox Router Pick from the Router dialog, then use the ENDP OSNAP to pick the endpoint of the tee. A three-dimensional box is drawn between the two points as shown in the Figure. The following prompt is presented:

([LW�&RQQHFW�5HGUDZ�%R[�3RLQWV�6ORSH�,QFUHPHQW�$XWR�.HHS��1H[W!�

Note that a yellow line is extends from the starting point to one of the corners on the box. Type A and pressEnter at the command line to go into Auto Mode. The yellow line indicates a possible path to the opposite endof the box. Accept the routing by pressing K to Keep it, or press Enter or the right mouse button to togglethrough the possibilities. After “Keeping” the route, press E to Exit the command.

Other options are also available from the Box Router Pick prompt as follows:

+ Connect: Turns the Segment Connect switch OFF, enabling you to designate lines which are notconnected. Use this option to draw reference line for placement later in the model.

+ Redraw Box: Regenerates the box if a PAN or other operation was performed which interrupted thedisplay of the routing box.

+ Points: If you have entered Auto mode, typing P at the command line will place you back in Points mode,which lets toggle through the points one by one, rather than the complete path method used in the Automode.

+ Slope: Allows you to define an anchor point for the slope, then specify a corner on the box where the lineshould slope to. You can then continue routing from that point.

+ Increment: Allows you to “break” the box into smaller pieces by specifying a percentage or distance

�9@9>7��??<C��5>E

#5>D5B<9>5�*?ED5BC��5>E


�

along a selected leg where a new point can be placed. Once that point is specified, the original boxdisappears and you are prompted to re-select the opposite corner of what will be the new box.

+ Auto: If currently in Points mode, places the router in Auto mode, where the user is presented withchoices for routing between opposite corners of the box.

�?H� ?ED5B

Activates the Distance, Z Distance, and X-Y Angle fields. This option is similar to the Box Router Pick option,except that the point which defines the opposite corner of the box is specified by entering values in theDistance, Z Distance, and X-Y Angle fields (instead of picking an existing point). Input values in the fields todraw the box, then route as described in the Box Router section of this help file.

�>4?

Deletes the last point defined on the centerline.

�9CD1>35

The distance from the previous point in current drawing units (negative values are accepted).

!#�9CD1>35

The Distance in the Z plane from the previous point. This value may be used in combination with others todefine elevation and polar points.

$#��>7<5

The X-Y Angle from the previous point. This value is used in combination with Distance and Z-Distancevalues to specify polar coordinates on the centerline.

!#�>7<5

The Angle from the previous point measured in the vertical (or Z) plane. This value is used in combinationwith other values to specify polar coordinates on the centerline.

�9@5��

Inset the Pipe Outside Diameter in this field when specifying elevation points. The Pipe OD is needed inorder to determine where the centerline should be placed when the user requests pipe to be placed at a certainelevation with respect to either its top or bottom.

5G��D1BD��?9>D

Allows you to specify a new start point. In effect, this command begins a new centerline routing session.

!??=

Opens the following dialog, which presents methods for transparently zooming and panning during thedefinition of a centerline path.

�9@9>7��??<C��5>E

#5>D5B<9>5�*?ED5BC��5>E


!??=

Provides access to the standard AutoCAD ZOOM command prompt:

$OO�&HQWHU�'\QDPLF�([WHQWV�/HIW�3UHYLRXV�9PD[�:LQGRZ��6FDOH�;�;3�!�

After changing the zoom factor, you are immediately returned to the centerline routing session where you leftit.

��!??=

Provides access to the standard AutoCAD RTZOOM command, which enables you to interactively zoom inand out of the drawing by dragging the RTZOOM icon towards or away from the center of the drawing area.After changing the zoom factor, you are immediately returned to the centerline routing session where you leftit.

�1>

Provides access to the standard AutoCAD PAN command, which enables you to select a point in the drawingand then pick a displacement distance. After panning the drawing, you are immediately returned to thecenterline routing session where you left it.

��1>

Provides access to the standard AutoCAD RTPAN command, which enables you to interactively Pan thedrawing by picking a point and then dragging it to the desired location. After panning the drawing, you areimmediately returned to the centerline routing session where you left it.

�@?9>D

Accesses the AutoCAD VPOINT command, which enables you to interactively select the viewpoint of themodel. After choosing a viewpoint, you are returned to the centerline routing session where you left off.

�<1>

Views the current model in Plan view.

�B565B5>35C

If Info Mode is set to ON, press this button to access the Component Preferences dialog.

�9@9>7��??<C��5>E

#5>D5B<9>5�*?ED5BC��5>E


�

1<3E<1D?B

The Calculator can be used to calculate distance and other values and then to pass the result on to specifiedfields of the Router dialog.

Compute the value using the keys provided (mouse or keyboard input accepted), then press a button in thePass To area of the calculator to paste the value in the register into the desired field.

�95G��@D9?>C��>9DC

Select from the view options to input values in different formats. The System selection uses the units currentlydefined for the drawing. If one of the other options is selected (i.e., Architectural) you can specify the units ina different format. When the value from the register is passed to the Route dialog, the result will beautomatically converted to system units.

�H9D

Closes the Router dialog and discontinues centerline routing.

EBB5>D��<5F1D9?>

Displays the current system elevation (the elevation of the last point defined on the centerline) forinformational purposes.

�>6?��?45

Indicates whether Info Mode is ON or OFF. To change the Info Mode setting, you must exit the routingsession and re-start it. When the Info Mode dialog appears, make the appropriate selection.

�9@9>7��??<C��5>E

#5>D5B<9>5�*?ED5BC��5>E


��When you place a centerline in PIPING, the dialog shown below displays. This dialog enables you to specifywhether or not you want to associate intelligence (Spec, Size, Line Number, and Insulation Thickness) to theline.

If you enable the Info Mode On option and press OK, the Component Preferences dialog displays as shownbelow.

This dialog may also be activated by pressing Preferences from the main dialog router dialog.

Set the Specification, Nominal Size, Line Number, and Insulation Thickness as desired, then press OK. Thesevalues will be extracted from the centerline and applied to any components placed on it.

�9@9>7��??<C��5>E

#5>D5B<9>5�*?ED5BC��5>E


�

� ��The From Polyline command enables you to convert an existing AutoCAD polyline into an intelligentcenterline on which components can be placed. AutoCAD’s PLINE command may be used to route acenterline, then the From Polyline command may be executed on the polyline to convert it to an intelligentPIPING centerline.

This command does not actually convert the existing polyline, but only creates a new AutoPLANT intelligentcenterline on top of the existing polyline. If you want the existing polyline deleted after the new intelligentcenterline is created you can set the CL_DEL_PLINE_FLAG AutoPLANT system variable prior to executingthis command. The variable is initially set to zero (0), which will not erase the existing polyline. If you wantthe polyline erased after the conversion, type the following at the AutoCAD command prompt:

�DWBSLSLQJV\VWHPBVHWYDULDEOH��FOBGHOBSOLQHBIODJ��

When the From Polyline command is executed, the Component Preferences dialog displays as shown below toenable you to define the attributes that will be applied to the line.

Set the attributes as desired and press OK, then select the polyline to assign these attributes.

�9@9>7��??<C��5>E

#5>D5B<9>5�*?ED5BC��5>E


� ��The points required to define a polyline’s geometry can be specified in an external text file. The file can thenbe read to draw the line and associate intelligence with it. When the From File command is executed, theSelect Centerline Input File dialog displays. Highlight the desired file, then press OK. The parameters will beread from the selected file to draw the centerline.

��)��/,1(180%(5 3��

63(& PPFV��

120,1$/ ��

,167+,&. ��

376 ��?

��?

��

/,1(180%(5 3��

120,1$/ �

63(& PPFV��

,167+,&. ��

376 ��?

��?

��

LINENUMBER Specifies the pipe line number

SPEC Specifies the specification

NOMINAL Specifies the nominal pipe size (decimal values only)

INSTHICK Specifies the insulation thickness (decimal values only)

PTS Specifies the points that define the pipe route. Multiple lines with the same data could be specified by havingmultiple PTS variables in the same section . Each PTS definition constitutes a continuous centerline.

� �#�� PRO-PIPE's 3D-Polyline Router function has been incorporated into PIPING. It provides several options todefine a piping path with a 3D polyline. You can change elevation, move toward or away, specify polarcoordinates, use previously placed components as a reference, slope down a specified angle and distance, orspecify an exact XYZ offset. Components may then be placed on the line using the geometry of the line todetermine the elevation and orientation. Before loading the command, the Info Mode dialog is displayed.

When the command is executed, the following prompt is displayed at the command line:

3UHVHQW�(OHYDWLRQ��^FXUUHQW�HOHYDWLRQ`

3LFN�VWDUW�SRLQW�RU�SUHVV�&DUULDJH�5HWXUQ�WR�FKDQJH�HOHYDWLRQ�

Pick the starting point or press Enter to change the system elevation. To change the elevation, press Enter theninput a new elevation or pick a point in the drawing to extract the Z value and reset the elevation to that value.When changing elevations, you must also specify whether you want to place components using the (T)op ofPipe, (B)ottom of Pipe, or (C)enter of Pipe techniques, then input a POD (pipe outside diameter).

Once the elevation and starting point have been specified, the following prompt is presented:

�(�OHY��$�ZD\��7�RZDUGV��3�RODU��2�IIVHW��6�ORSLQJ��5�HIHUHQFH��1�RGH��8�QGR��H�;�LW!�

The options are as follows:

Option Description

(E)lev Picks the next polyline end point straight up or straight down to the elevation value entered.

(A)way Picks the next polyline end point in the negative vertical direction away from you in the current UCS view at the exactdistance specified, and resets the system elevation to the elevation of the point picked.

(T)owards Picks the next polyline end point in the positive vertical direction towards you in the current UCS view at the exactdistance that you specify and resets the system elevation to the elevation of the point picked.

�9@9>7��??<C��5>E

#5>D5B<9>5�*?ED5BC��5>E


�

(P)olar Prompts you to enter an angle and a distance from the current point.

(O)ffset Allows you to specify an exact offset in the X,Y, and Z directions, or enables you to enter the desired elevation andpick the offset distance and the direction point.

(S)loping Prompts you to specify the slope angle up or down from the current UCS, then to pick the end point of the sloping line.The end point elevation will be automatically set based on the X and Y distances of the point picked and the anglespecified.

(R)eference Prompts you to pick any object as a reference to reset the system elevation for the next prompt picked.

(N)ode Prompts you to pick a previously placed node marker as a reference to reset the system elevation for the next pointpicked.

(U)ndo Removes the last end point picked from the polyline and continues the command from the previous point.

e(X)it Ends the PRO-PIPE router command.

�� AutoPLANT’s DESIGNER router has been included in PIPING to enable users familiar with this techniqueof routing to use the same methods to route centerlines in the new system.

When the command is first executed, the prompt:

&HQWHUOLQH�IURP�

displays. Select the starting point in the drawing, then respond to the

%DVH�(OHYDWLRQ� ��

5HIHUHQFH�SRLQW�(OHYDWLRQ�RI�FHQWHUOLQH��!�

by inputting a starting elevation value at the command line. To extract the elevation from the Z value of anexisting point, type R and press Enter, then pick the reference point.

After the starting point and the elevation have been specified, the prompt

9HUWLFDO��1H[W�FHQWHUOLQH�SRLQW!��RU�UHWXUQ�ZKHQ�GRQH

displays. Pick the next point in the drawing. To define a point in the vertical plane, type V and press Enter,then respond by specifying an elevation. After the point is specified, the prompt

5HIHUHQFH�SRLQW�(OHYDWLRQ�RI�FHQWHUOLQH��!�

displays. The Designer router will prompt you for the elevation after the XY value of the point is specified.To place it in the current X-Y plane, simply press Enter or the right mouse button. To slope the line up, inputan elevation value.

To exit the line routing command, press Enter or the right mouse button at the

9HUWLFDO��1H[W�FHQWHUOLQH�SRLQW!��RU�UHWXUQ�ZKHQ�GRQH

prompt.

�9@9>7��??<C��5>E

#5>D5B<9>5�*?ED5BC��5>E


� ��The From Points centerline router presents a command line interface for routing a points. After the commandis executed, the prompt

(QWHU�VWDUWLQJ�HOHYDWLRQ��!�

displays. Input the starting elevation. Next, the following prompt is presented:

3LFN�VWDUWLQJ�SRLQW

Specify the starting point of the centerline. You can now begin routing the line. In addition to standardAutoCAD controls, the From Points command provides the following options, which are available at thecommand line at all times during the routing session.

A description of each of these options is provided below.

5��&

Removes the previously defined point, and enables you to continue routing.

*�-��%

Performs a regeneration of the current view without leaving the routing session.

*��

The Ref command enables you to select a reference point that already exists in the model, then specify adistance from that point. A line from the new point is then drawn back to the centerline’s previous point. (usethe REdraw afterwards to remove the reference line). Refer to the Figure below

�9@9>7��??<C��5>E

#5>D5B<9>5�*?ED5BC��5>E


�

Suppose you are routing from the tee in the Figure and you want to route the line down and place an elbow aknown distance away from the previous elbow. You also want the two elbows placed on the same plane sothey can be supported at the same elevation. Select the Reference command, then select the intersection pointof the elbow to use as reference. Next, specify a distance away from that point. The centerline continues tothe newly defined point. You can then continue routing. The result is shown in red ink.

�7�

If one of the direction vectors is chosen (North, South, East, West, Up, Down), you can then input an absolutecoordinate where the next point will be placed.

��!

Select this option to place the next point North of the previous point. You are then prompted to input adistance or an absolute coordinate.

)��!

Select this option to place the next point South of the previous point. You are then prompted to input adistance or an absolute coordinate.

��

Select this option to place the next point West of the previous point. You are then prompted to input adistance or an absolute coordinate.

��

Indicates that the next point should be East of the current point. You are then prompted to input a distance oran absolute coordinate.

3

Indicates that the next point should be above (+Z direction) the current point. You are then prompted to inputa distance or an absolute coordinate.

�%�

Indicates that the next point should be below (-Z direction) the current point. You are then prompted to inputa distance or an absolute coordinate.

��&��,��

Pick (graphically select) the next point on the centerline.

�9@9>7��??<C��5>E

#5>D5B<9>5�*?ED5BC��5>E


�� #��This are provides a set of procedures that explain how to perform many common centerline router tasks.

*��#��"��

Centerline routing from a dialog allows access to a variety of routing tools to define the centerline of a pipingpath.

� �?� ?ED5�1�5>D5B<9>5��C9>7�1��91<?7

�� Select Piping Tools/Centerline Routers/From Dialog .

�� The Router Line Info dialog displays. Select ON to place an intelligent centerline. If OFF is selected, skipto Step 4.

�� The Component Preferences dialog displays. You can select the Specification, Nominal Size, LineNumber, and Insulation Thickness values from this dialog, and then assign these attributes to the lineitself. Components placed on this line will use these component preferences when placing thecomponents.

�� The prompt

Exit/<Options>/Start Point:

displays. Select the starting point for the centerline, or press Enter to open the Routing dialog. If youselect an existing component, the elevation will automatically be set based on the elevation of theexisting component’s centerline (use AutoCAD OSNAP commands to ensure you have selected itproperly). Otherwise, the first step should be to set the elevation.

�� Routing is accomplished by selecting an Option from the selection list, then inputting parameters in theDistance/Angle area of the dialog. Afterwards, press OK to route that point. The dialog closes and thepolyline is routed to the new point. To re-open the dialog, press Enter then route additional point(s). Youmay also route points using the standard (AutoCAD) line routing techniques.

�� From the command prompt, type E and press Enter to exit the polyline command.

*��#��"��

Centerline routing from points displays a number of routing options to define a centerline of a piping path.

� �?� ?ED5�1�5>D5B<9>5�2I��569>9>7��?9>DC

�� Select Piping Tools/Centerline Routers/From Points .

�� The Component Preferences dialog displays. You can select the Specification, Nominal Size, LineNumber, and Insulation Thickness values from this dialog, and then assign these attributes to the lineitself. Components placed on this line will use these component preferences when placing thecomponents.

�� The prompt

Set elevation/ <Pick starting point or component>

Input a starting elevation, then press Enter (selecting the endpoint of an existing component’s centerlinewill NOT reset the system elevation using this command; if you need to set the elevation based on anexisting component, use the From Dialog option instead).

�� The prompt

Back/REdraw/Ref/Abs/North/South/East/West/Up/Down/<Pick next point>:

displays. These options allow you to define the geometry of the centerline. Route the line using these

�9@9>7��??<C��5>E

#5>D5B<9>5�*?ED5BC��5>E


�

options, then press Enter to exit the command and complete the line.

*��#��"��+��

Centerline routing from a polyline enables the user to draw a polyline using standard AutoCAD PLINEcommands, then to define the line as a smart polyline on which components can be placed. The currentsettings in the Drawing Preferences dialog are applied to the line.

� �?� ?ED5�1�5>D5B<9>5�2I��5<53D9>7�1>��H9CD9>7��?<I<9>5

�� Draw a polyline using the AutoCAD PLINE command. The line should accurately describe the pipingpath, including placement at appropriate elevations.

�� Select Piping Tools/Centerline Routers/From Polyline to display the Component Preferences dialog.

�� Set the centerline parameters as desired, then press OK. The prompt

Pick polyline that defines pipe route:

displays. Select the polyline drawn in Step 1 to apply the attributes defined in the dialog.

*��#��4��*��

The AutoPLANT DESIGNER router, has been included in PIPING for AutoPLANT users familiar with thatcenterline routing function. The functionality is the same.

� �?� ?ED5�1�5>D5B<9>5��C9>7�D85�� ?ED5B

�� Select Piping Tools/Centerline Routers/Designer Router .

�� The prompt

Centerline from:

displays. Pick the starting point of the centerline.

�� Set the system elevation and continue routing the line. The following options are presented:

Vertical/Info Mode/<Next centerline point>

Define the line using standard AutoCAD techniques, or use the command line to specify additionaloptions.

�9@9>7��??<C��5>E

#5>D5B<9>5�*?ED5BC��5>E


*��#��4�� *��

The PRO-PIPE polyline router has been included in PIPING for PRO-SERIES users familiar with thatcenterline routing function . The functionality is the same. For new users, you might appreciate this quick,concise method of pipe routing with options presented at the command line.

� �?� ?ED5�1�5>D5B<9>5��C9>7�D85�� #�� ?ED5B

�� Select Piping Tools/Centerline Routers/Pro-Pipe Router .

�� The prompt

Pick start point or press Carriage Return to change elevation:

displays. Select the starting point in the drawing. If the selected point is the centerline of an existingcomponent, the system elevation will be reset to that value automatically. To manually input theelevation, press Enter then type in a new value at the command line.

�� Route the line as you would any AutoCAD polyline. To access additional options, press Enter at thecommand line to display the following prompt:

E)lev/(A)way/(T)owards/(P)olar/(O)ffset/(S)loping/(I)nfo/(R)eference/(N)ode/(U)ndo/<e(X)it>:

Manipulate the geometry of the line, then press X to exit.

*��#��"��

Centerlines can also be routed automatically based on values read from an external file. The file contains thedescriptions of the coordinate locations and other factors such as layer, line number, and size variables.

� �?� ?ED5�1�5>D5B<9>5�6B?=�1��9<5

�� Select Piping Tools/Centerline Routers/From File .

�� The Centerline Input File dialog displays. Select the file containing the text description of the centerline.The ASCII textfile can have any extension, but must conform to the file format expected by the program.After the file is selected, press OK.

�� The polyline is placed in the drawing based on the parameters and coordinate locations contained in thefile.

�-��#��

When you route a centerline using one of the PIPING commands, you are prompted to specify the Spec, Size,Line Number, and Insulation Thickness that will be associated with the centerline. This command enables youto select an existing centerline and modify the settings defined when it was placed.

� �?��49D�5>D5B<9>5��B565B5>35C

�� Select Piping Tools /Centerline Routers/Edit Centerline Preferences .

�� The prompt

Select centerline to edit

displays. Pick the centerline to display the Centerline Preferences dialog.

�� Modify the settings as desired, then press OK to update the centerline attributes.

�9@9>7��??<C��5>E

*5@B5C5>D1D9?>C


�

� �� The Piping Tools/Representations command displays the following dialog, which enables you to generatevarious representations of your PIPING components.

Enable the desired Drawing Mode radio button, and then its associated Representation radio button that youwant to work with. The following describes the Drawing Mode/Representation optoins now available interms of the selection made in the Drawing Mode and Representation areas of the dialog (e.g., 3D-Double Linewill be used to denote selecting the 3D Drawing Mode and Double Line Representation):

� 3D-Double Line: this is identical to the previous full 3D Drawing Mode configuration. It enables drawingof 3D component representations in 3D space using Rebis custom component objects.

� 3D-Single Line: this configuration enables drawing of Single Line component representations in 3D spaceusing AutoCAD entities. In general, only Pipe Components, Bends and Returns, and Branchingcomponents are actually drawn as single line AutoCAD entities, with a few exceptions. All othercomponents are drawn in standard 3D-Double Line mode.

� 2D-Double Line: this configuration enables drawing of "flat" (i.e., nothing will be drawn in the verticalplane) Double Line representations of components using AutoCAD entities.

� 2D-Single Line: this configuration enables drawing of "flat" (i.e., nothing in the vertical) Single Line representations ofcomponents using AutoCAD entities.

The following operations may then be executed for the selected Drawing Mode/Representation:

�� ON Displays the currently selected Drawing Mode/Representation of a component, and hides the

current active representations of the component, if different. This command will also generate theselected representation for the component if one does not already exist.

OFF Hides existing representations of the selected Drawing Mode/Representation.

Redraw Re-displays the selected Drawing Mode/Representation that has already been generated (but arecurrently turned OFF, or which have been hidden due to the generation of other representations).

Delete Deletes (removes) existing representations from the model for the currently selected DrawingMode/Representation. Before deleting these representations, ensure that at least a single line or2D rep exists for the selected components.

After selecting the desired operation, the Drawing Selection Options dialog displays to enable you to definethe selection set of components that will be included in the representation. If you generate or redraw 3D

�9@9>7��??<C��5>E

*5@B5C5>D1D9?>C


representations, any active representation is automatically turned OFF. Note that polyline visibility iscontrolled by the current 3D Display Mode setting.

��The AutoCAD Entities area of the dialog provides three options, which enable you to generate the denotedAutoCAD entity representation of your PIPING components. Each of these options is described below.

�#()

The ACIS button creates an AutoCAD 3D ACIS representation of the current view of the selected componentgraphics on the current layer. The 3D representation is not associated with the existing component graphic inany manner. It is created from standard ACIS 3D entities. These entities can be treated as any standard ACISentity. Before you generate a 3D representation, you should use the AutoCAD LAYER command to set thelayer on which the representation will be generated.

�-��%

The 2d View button creates a 2D representation of the current view of the selected component graphics on thecurrent layer. The 2D representation is not associated with the existing component graphic in any manner. Itis created from standard AutoCAD 2D entities (lines, arc, ellipses, etc.). These entities can be moved,trimmed, deleted, as any standard AutoCAD entity. Before you generate a 2D representation, you should usethe AutoCAD LAYER command to set the layer on which the representation will be generated.

��!

The Mesh button creates an AutoCAD 3D representation of the current view of the selected componentgraphics on the current layer. The 3D representation is not associated with the existing component graphic inany manner. It is created from standard AutoCAD 3D entities. These entities can be treated as any standardAutoCAD entity. Before you generate a 3D representation, you should use the AutoCAD LAYER command toset the layer on which the representation will be generated.

�9@9>7��??<C��5>E

8�9C@<1I��?45C


�

(��

The Piping Tools/3D Display Modes menu provides options that enable you to toggle the display of PIPINGcomponents.

These modes enable you to instantaneously toggle the display 3D custom objects in a variety of inherit styles.Do not confuse 3D Display Modes with the generation of different representations of a component graphic.The 3D Display commands toggle the display of existing 3D objects only, and will not generate 3Drepresentations from single line graphics.

��

��

�9@9>7��??<C��5>E

8�9C@<1I��?45C


��

Note the difference between this mode and standard Wireframe. A close examination of the elbow shows anatural centerline that follows the curve of the elbow. This is to be distinguished from the smart polyline thatdescribes the piping path. If the component is drawn without the polyline, you can still distinguish the naturalcenterline with the Wireframe w/Centerline option.

��

Displays 3D components as a 3D wireframe mesh. The AutoCAD SURFTAB1 and SURFTAB2 environmentvariables that define the mesh resolution may be defined in the Surface Resolution in the DrawingPreferences dialog. This value must be set prior to component placement.

For example, if the Surface Resolution is set to 8 and a number of components are drawn, then the SurfaceResolution is set to 16 and a number of components are drawn, then when the Mesh Display Mode isselected, the components mesh representation will reflect the Surface Resolution setting when it was placed.

�9@9>7��??<C��5>E

8�9C@<1I��?45C


�

��

The Set Viewport Draw Mode option in the Piping Tools/3D Display Modes menu enables you to set the 3DDisplay Mode for individual viewports. The first four commands in the 3D Display Modes menu set theactive System display mode. All viewports that do not have a display mode set using the Set Viewport DrawMode command display using the active System display mode.

The command displays the following prompt:

6HOHFW�GUDZPRGH�IRU�FXUUHQW�YLHZSRUW

�6\VWHP�&HQWHUOLQH�&HQWHU:LUHIUDPH�:LUHIUDPH�0HVK!�

A description of each of these options is provided below.

System sets the active viewport display mode to the current System display mode setting.

Centerline sets the active viewport display mode to Centerline.

Wireframe w/Centerline sets the active viewport display mode to Wireframe w/Centerline.

Wireframe sets the active viewport display mode to Wireframe.

Mesh sets the active viewport display mode to Mesh.

To select an option, type the capitalized letter in the option name and press Enter.

��

The Reset All Viewport Draw Modes option in the Piping Tools/3D Display Modes menu resets all of yourindividual viewport display modes to System. The System display mode is set by executing one of the firstfour options in the 3D Display Modes menu.

��

In the same manner as AutoCAD’s REGENALL command may be executed to regen all open viewports, theShade All Viewports command in the Piping Tools/3D Display Modes menu may be executed to perform aSHADE on all viewports.

��

In the same manner as AutoCAD’s REGENALL command may be executed to regen all open viewports, theHide All Viewports command in the Piping Tools/3D Display Modes menu may be executed to perform aHIDE on all viewports.

�� (��

3D representations of components can be displayed as either wireframe, centerline, wireframe with centerline,or 3D mesh graphics. To set the 3D Display Mode, follow the procedure outlined below.

�9@9>7��??<C��5>E

8�9C@<1I�3D9<9D95C��5>E


(��

The 3D Display Utilities menu provides options that enable you to manipulate the display of 3D PIPINGcomponent graphics. A description of each of these options is provided below.

��"�� The end of all components are displayed as open by default. The Set Object Rims On option in the PipingTools/3D Display Utilities menu enables you to change the display property of these ends to appear as if theywere closed.

When executed, the following prompt displays:

6WDUW��!��(QG��!�RU�%RWK��!�ULPV"�

This enables you to define whether the Start, End, or Both ends of the component graphic will be closed.Simply enter the desired option number, then press Enter. You will then be prompted to select thecomponents to execute the operation.

�� This command will only work on components whose ends are drawn using Rebis DWBF\OLQGHU,DWBWRUXV, and DWBFRQH custom objects.

��"�� The end of all components are displayed as open by default. The Set Object Rims Off option in the PipingTools/3D Display Utilities menu enables you to change the display property of these ends to appear as if theywere open, if they were previously closed using the Set Objects Rims On option.


6WDUW��!��(QG��!�RU�%RWK��!�ULPV"�

This enables you to define whether the Start, End, or Both ends of the component graphic will be opened.Simply enter the desired option number, then press Enter. You will then be prompted to select thecomponents to execute the operation.

�� This command will only work on components whose ends are drawn using Rebis DWBF\OLQGHU,DWBWRUXV, and DWBFRQH custom objects.

�� The Set Centerline Color option in the 3D Display Utilities menu displays a color palette to enable you toselect the centerline color for all components.

Simply select the desired centerline color from the dialog and press OK. BYLAYER is the default centerlinecolor setting. You will need to REGEN for the change to appear on your display.

�9@9>7��??<C��5>E

8�9C@<1I�3D9<9D95C��5>E


�

�� Centerlines only appear when the Centerline or Wireframe w/Centerline 3D Display Mode isactive.

�� The Set Centerline Type option in the 3D Display Utilities menu displays a dialog to enable you to select thecenterline type for all components.

Simply select the desired centerline type from the dialog and press OK. BYLAYER is the default centerlinetype setting. You will need to REGEN for the change to appear on your display.

�� This command only works on At_Cylinder and At_Torus entities. Centerlines only appear when theCenterline or Wireframe w/Centerline 3D Display Mode is active.

�� The Set Centerline Visibility option in the 3D Display Utilities menu enables you to control the visibility ofcenterlines for individual components when a HIDE is performed. This setting only takes affect when the 3DDisplay Mode is set to Wireframe w/Centerlines.


'R�\RX�ZDQW�WR�VKRZ�FHQWHUOLQHV�GXULQJ�D�KLGH��<HV�1R!�

This prompt enables you to specify whether or not the centerlines for the components you will select will beshown or hidden when a HIDE is executed. Type Y or N and press Enter, then select the components toperform the operation.

�� This command only works on At_Cylinder and At_Torus entities.

�9@9>7��??<C��5>E

#?>>53D9F9DI�#853;5B


�� The Set Torus Centerline Type option in the 3D Display Utilities menu prompts you to select the desired modefor displaying torus centerlines for components that are drawn using the torus object.

�� Centerlines only appear when the Centerline or Wireframe w/Centerline 3D Display Mode isactive.

�� Enables you to toggle the display of clipped cylinder (pipe) graphics to either Baseballs or Quadrant displayas shown below. You may also enter SETCLIPPEDGRAPHICS at the command line to manually toggle thisclipped graphics display of individual cylinders.

�� The Piping Tools/Connectivity Checker menu provides options that enable you to confirm properconnectivity along piping runs. It should be noted that PIPING checks for connectivity during normal routingactivities. Reasons for improper connections are most commonly a result of moving or copying components,then improperly placing them at new locations.

The first command in this menu will check a selected group of components, report all disconnects detected,then allow you to view specific port information related to each of the problem areas. The second commandprompts you to select a set of components on a run, then specify the starting component. The command thenhighlights each component in the run individually, progressing down the line until an improper connection isdetected. The command then exits to allow you to correct the problem at that location. The third commandallows you to resume a connectivity check on a group of components that may have been previouslysuspended.

�� The Checker command enables you to check a selected group of components for proper connectivity. Whenthe command is executed, the Drawing Selection Options dialog displays to enable you to define the selectionset of components that you want to test (e.g., you may only want to check consistency for a specific linenumber). Once the component selection set has been defined, the first disconnect (if one is found) and theConnectivity Check dialog display as shown below.

�9@9>7��??<C��5>E

#?>>53D9F9DI�#853;5B


�

A description of the options in this dialog is provided below:

+ - Press + to zoom into the currently displayed disconnect, or press - to zoom out from the currently displayeddisconnect.

< > Press > to move to the next disconnect, or press < to move to the previous disconnect.

Repair Press Repair and you will be prompted to select the desired connecting component to attempt to repair thedisconnect. If the disconnect distance is within the allowable range, the connection will be repaired;otherwise, a dialog will display the reasons the connection cannot be repaired.

More... Displays an expanded version of this dialog as shown below that provides a Suspend option and a moredetailed explanation of the disconnect.


First, Prev, Next, and Last Press these buttons to scroll through the disconnects. Information about the disconnectat the selected port is displayed in the bottom pane of the dialog, while the displayzooms into that area of the drawing for closer examination.

Zoom In/Out Press these buttons to zoom into or away from from the currently displayed disconnect.

Repair Press this button to attempt to repair the connection between two coincident weldedcomponents. For example, if you copy a pipeline connected to one buttweld componentto the end of another buttweld component, you can use this command to properlyconnect the second buttweld component with the copied pipeline. Flanges and othercomponents that are not coincident cannot be connected with this function.

Suspend Press this button to temporarily suspend the Checker command. This process can becontinued at any time using the Resume Checker command.

Brief Displays the Brief version of this dialog as shown previously.

When finished viewing connection information, press the Done button to close the dialog.

�9@9>7��??<C��5>E

#?>>53D9F9DI�#853;5B


�� The Check Run command prompts you to select a set of components in a run, then to designate a startingcomponent. Each component connection is then checked. The component is highlighted and you areprompted to press Enter to continue. The routing progresses down the pipe run until a disconnect is detected,at which point the command terminates to allow you to correct the error.

�� The Resume Checker command enables you to resume a previously suspended Checker command execution.Upon executing this command, the Connectivity Checker dialog displays the last disconnect that was shownwhen the Checker command was suspended.

��#��The following procedures explain how to perform common connectivity tasks.

#!��&)��-#�" ��#��1��+

� �?�853;��5<53D54�?=@?>5>DC�6?B�?>>53D9F9DI

�� From PIPING select Piping Tools/Connectivity Checker/Checker , or from ISOMETRICS select ISOTools/Connectivity Checker/Checker .

�� The Drawing Selection dialog appears. Choose All to select all of the components in the drawing, orchoose Manual to individually select the components to be checked. Press OK to close dialog.

�� The prompt

Select objects

displays. Define a selection set of components by selecting them individually or using AutoCAD’sWINDOW and CROSSING qualifiers. When selecting objects, be sure to include fasteners, welds, andother connector symbols.

�� The Connectivity Check dialog displays. The number of disconnects in the selection set is listed.

�� Press Next to view the first disconnect in the run. A description of each disconnect is provided in thebottom of the dialog while the screen zooms into that particular area.

�� View each disconnect in turn, then press Done to close the dialog.

�� Correct any errors as necessary, then run the checker again to confirm proper connectivity.

#!��&��*��

� �?�853;�1>��>D9B5� E>)C�?>>53D9F9DI

�� From PIPING select Piping Tools/Connectivity Checker/Check Run , or from ISOMETRICS select ISOTools/Connectivity Checker/Check Run .

�� The Drawing Selection dialog is displayed. Choose All to select all of the components in the drawing, orchoose Manual to individually select the components to be checked. Press OK to close dialog.

�� The prompt:

Select objects

displays. Define the run by windowing the objects. Press Enter when done.

�� The prompt

�9@9>7��??<C��5>E

9=5>C9?>��?45C


�

Select the starting component

displays. Pick the object which defines the beginning of the run, then press Enter.

�� The prompt

Done/Enter to continue to connected component

displays. Press Enter to check the connectivity of the next component in the run.

�� When the run is complete, type D to end the sequential checking of the pipe run.

*��"�#!��&��

� �?� 5CE=5�D85�853;5B�?==1>4

�� From PIPING select Piping Tools/Connectivity Checker/Resume Checker , or from ISOMETRICS

select ISO Tools/Connectivity Checker/Resume Checker .

�� Select Piping Tools/Connectivity Checker/Resume Checker.

�� The Connectivity Check dialog displays beginning with the disconnect that was shown when the Checkercommand was suspended. If a previous execution of the Checker command was not executed, theChecker command will be executed by this option.

�� Continue viewing disconnects in turn, making any necessary repairs, then press Done to close the dialog.

��The following commands are provided to enable you to place dimension nodes on PIPING components.These nodes must be placed in Model Space, and will enable you to create a snap point from which to placedimensions while in Paper Space. This is not required unless the component that you want to dimension fromdoes not have already have a node at the desired location.

Insert Reinserts dimension nodes for all selected components.

Show Turn on dimension nodes for selected components.

Hide Turn off dimension nodes for selected components.

Edit Edit (add/delete) dimension nodes for selected components.

Clear Deletes "added" dimension nodes for selected components.

�9@9>7��??<C��5>E

9?9>�#?=@?>5>DC


"��The Join Components command is provided to enable you to properly connect two coincident componentstogether. For example, if you copy a pipeline connected to one buttweld component to the end of anotherbuttweld component, you can use this command to properly connect the second buttweld component with thecopied pipeline. Flanges and other components that are not coincident cannot be connected with this function.

When you execute Join Components you will be prompted to pick the two components that you want to join.

The function will attempt to determine every type of join that may be connected between every port on thefirst component and every port on the second component. If multiple join types are found, a dialog similar tothe following will display enabling you to select the desired join type.

If possible, the system will join the components, adding a weld symbol and then will display the followingmessage:

Components joined together successfully.

to indicate that the join has been made successfully. If no joint is completed, then a dialog similar to thefollowing will display, which describes the attempts made and the problem with each attempt. The samefunctions that are called to validate and create joints during component insertion in fitting-to-fitting mode arecalled for each attempted connection, and therefore the same connection rules apply during the join commandas during component insertion.

�� The joint gap tolerance is defined by the configuration that you selected when you created thedrawing. You can view/modify this setting using the AutoPLANT Configuration Editor application. Thisapplication may be launched from the AutoPLANT 3D/Customization Tools and Help group in yourWindows Start menu. Open the configuration to view/modify, then select Edit/Piping ConfigurationGroup or Edit/Iso-Auto-Iso Configuration Group. In either dialog, select the Preferences tab. Thegap is assigned in the Maximum Joint Gap field.

�9@9>7��??<C��5>E

)D?@�)97>C


�

��Stop Signs can be placed within a PIPING model to designate points at which ISOMETRICS lines shouldbreak when running AUTO-ISO.

After selecting the command, you are prompted to select the component where the stop sign is to be placed.Pick the component in the model. The next step is to designate the port on the component where the stopshould be placed. A hollow circle is placed at the designated port.

From the ISOMETRICS application, you can enable the Stop Signs setting in the Preferences dialog. Refer toISOMETRICS’ on-line Help for more information.

��

� �?�@<135�1��D?@��97>�9>�1��=?45<

�� Select Piping Tools/Stop Signs .

�� The prompt


displays. Select the component on which the stop sign should be placed.

�� The prompt

Toggle/<Enter to select currently highlighted port>

displays. Note that a reference node appears on one of the ports of the selected component. If thereference point represents the location where the stop sign should be placed, press Enter; otherwise, typeT or use the Toggle button on the Responses toolbar until the reference point appears at the desiredlocation. Press Enter after the desired port is highlighted.

�� The Stop sign in placed at the selected port.

��

This chapter covers the Database Tools menu, which provides a number of options toview/manipulate information in the external drawing database.

OVERVIEW 6-2

EDIT COMPONENT 6-2

UPDATE COMPONENT 6-5

CLEAN DATABASE 6-6

VIEW DATABASE 6-8

DATABASE INFORMATION 6-8

UPDATE FROM SPEC 6-9

DATABASE - HOW TO TOPICS 6-11

DRAWING DATABASE CUSTOMIZATION 6-13

� � � � �

�

�1D121C5��??<C��5>E

/F5BF95G


�

�� The Database Tools menu provides a number of options to view/manipulate information in the externaldrawing database.

These commands may also be executed via the Database Toolbar toolbar. This toolbar is available as a flyouttoolbar from the main Piping Functions toolbar, or may be displayed separately by selectingToolbars/Function Toolbars/Database Tools.

�� The PIPING and ISOMETRICS applications use a common set of dialogs to view/modify componentexternal drawing database records with the Edit Component command. When the command is executed, theprompt


displays. Select a component to display its external drawing database information in a dialog as shown below.The dialog shown is an example only. Separate dialogs are provided for the following component types:Bolts, Couplings, Fasteners, Fittings, Flanged Components, General Components, Olets, Pipe, Reducers, andValves. These dialog instances are defined in the individual component scripts in theNETWORK_ROOT\MODULES\BASE\COMMON sub-directory.

The first page of this dialog contains the most common component drawing database record information.Most of the information in this dialog is provided for information purposes only. The field data that may bemodified is presented in white editable text boxes. Simply move the cursor into the desired text box andmodify the information as desired. Changes made in this dialog will update the respective field information inthe component’s drawing database record. A description of the fields in this dialog are provided below:

�1D121C5��??<C��5>E

�49D�#?=@?>5>D


Component Type The general Component Type (i.e., PIP, 90L, TEE, etc.), which was read from the GTYPEfield in the specification database table when the component was placed. This value isstored in the GTYPE in the drawing database’s PIPING table.

Component Sub Type The Component Sub-Type (i.e., LR, STR), which was read from STYPE field in thespecification database table when the component was placed. This value is stored in theSTYPE field in the drawing database’s PIPING table.

Specification The Specification from which the component was drawn. This value is stored in the SPECtable in the drawing database’s PIPING table.

Spec Table The Specification Table in the specification that contains the database record that wasused to draw the component. This value is stored in the component’s XDATA in thedrawing.

Line Number The component Line Number, which was read from the Drawing Preferences dialog whenthe component was placed. This value is stored in the component’s LINENUMBER field inthe drawing database’s PIPING table.

Tag Displays the user-defined Tag associated with the component. You may define the tagvalue by entering a value in the space provided. This value will be stored in theTAGNUMBER field in the drawing database’s PIPING table.

Existing component Enable this check box to label the component as “Existing.” Components marked in thismanner may be excluded from a generated Bill of Materials, and are used to distinguishbetween components that already exist in the field and those being added to the design. Ifthis check box is enabled, the value “1” will be written in the EXISTING field in thecomponent’s drawing database record. If you are modifying existing designs and wish todesignate a large group of components as “Existing,” add the field Existing to the list offields to be updated using the Setup/Component Update Preferences command.

Main Size The nominal Main Size of the component, which was read from the MAIN_SIZE field in thespecification database table when the component was placed. This value is stored in thecomponent’s MAIN_SIZE field in the drawing database’s PIPING table.

Component TileWindow

Displays a graphical representation of the component and illustrates where its ports arelocated.

Short Description The Short Description of the component, which was read from the SHORT_DESC field inthe specification database table when the component was placed. This value is stored inthe component’s SHORT_DESC field in the drawing database’s PIPING table.

Spec Tag The Specification Tag of the component, which was read from the TAG field in thespecification database table when the component was placed. This value is stored in thecomponent’s TAG field in the drawing database’s PIPING table.

Piece Mark The Piece Mark of the component, which was read from the PIECE_MARK field in thespecification database table when the component was placed. This value is stored in thecomponent’s PIECE_MARK field in the drawing database’s PIPING table.

Sort Code The Sort Code determines the order in which components are listed in a Bill of Materials.This value was read from the SORT_CODE field in the specification database table whenthe component was placed. This value is stored in the component’s SORT_CODE field inthe drawing database’s PIPING table.

Description The full Long Description of the component, which was read from the LONG_DESCR fieldin the specification database table when the component was placed. This value is storedin the component’s LONG_DESCR field in the drawing database’s PIPING table.

Insulation Spec The specification containing the insulation description; the insulation spec can bespecified by editing the component with the Update Component command.

Insulation Thick The Insulation Thickness which was read from the Drawing Preferences dialog when thecomponent was placed. This value is stored in the component’s INSTHICK field in thedrawing database’s PIPING table.

�1D121C5��??<C��5>E

�49D�#?=@?>5>D


�

Rating/Schedule The Rating/Schedule of the component, which was read from the RATING andSCHEDULE fields in the specification database table when the component was placed.These value are stored in the component’s RATING and SCHEDULE fields in the drawingdatabase’s PIPING table.

Field Fit Excess (Pipecomponents ONLY)

The Field Fit Excess field accepts any value, including negative parameters.

Shop/Field Indicates whether the component is a “Shop” or “Field” component. The AutoPLANTReport Generator provides the BOMCADSFCutLengths report to enable you to generate aBOM on the drawing that separates components into Shop or Field groups. If the field isenabled (checked), the component will appear in the “Shop” section of the BOM;otherwise, the component will be listed in the “Field” section when generating this BOM.The default value was read from the SHOP_FLD field in the specification database tablewhen the component was placed. This value is stored in the component’s SHOP_FLDfield in the drawing database’s PIPING table.

Press Next Page to display the second page of the dialog. The second page contains component position andport information. It also provides a complete list of all of the component’s drawing database record fieldvalues. The second dialog instance is common to all components and is defined in theNETWORK_ROOT\MODULES\BASE\COMMON\COMPUTIL.EBS file.

��#��The second page of the Edit Component option contains two windows of information. The top windowdisplays positional and vector information related to the component ports and the direction factors specifiedduring placement. This information is especially useful to users creating custom draw routines to verify howthe port information on a component is being assigned.

The second window contains a complete listing of the database fields associated with that component in thedrawing database record. Scroll through the listing to find a particular value. You can click on a field in thebottom pane of the dialog to edit its value. If a field that you select is READ-ONLY, a message dialog willdisplay indicating that this field cannot be edited.

�1D121C5��??<C��5>E

3@41D5�#?=@?>5>D


��The Database Tools/Update Component option is provided in PIPING and ISOMETRICS to enable you tochange component drawing database field values in the current drawing and/or attached xreferenceddrawings. For example, a design change may require you to change the Line Number of a select group ofcomponents from L100 to L200. This command may be used to select the components to modify, then updatethe Line Number value in the drawing database.

When the Database Tools/Update Component command is executed, the Drawing Selection Options dialogdisplays to enable you to define the selection set of components. After the selection set has been defined, theUpdate Component Data Fields dialog displays as shown below. Select each database field and enter its newvalue in the Edit Field and then press OK to perform the update.

�� Only drawing database fields that have been previously assigned in the Component UpdatePreferences dialog can be modified. Modify the list of fields using the Setup/Component UpdatePreferences option.

�9CD�?6��95<4C��?��5��@41D54

Lists the fields in the current external drawing databases PIPING table that may be updated. This list ispopulated with the field names assigned using the Setup/Component Update Preferences command. Select afield name in this list to display to the associated values in the Field Values portion of the dialog.

�95<4��1<E5C

Lists all the unique field values for the selected group of components. Select a field to edit its value.

�49D��95<4

When you select a field, its current value displays in this text box. Define a new value by overwriting theexisting value. Press OK to apply the changes, or select another field from the list to edit its value.

�1D121C5��??<C��5>E

#<51>�1D121C5


�

��A record is written to the external drawing database each time a component is placed. If you delete thesecomponents later in the drawing process, the records still exist in the database until they are permanentlydeleted using this command. The Clean Database function reconciles the components in the model with therecords in the external drawing database. It removes records from the database that do not have matches inthe drawing.

When you execute the command, the following dialog displays to enable you to specify the clean parametersthat will be used.

A brief description of each of these options is provided below.

Clean Database Records Enable this check box to clean the database so that it will match the contents of thecurrent drawing. Any database record that exists without a corresponding graphiccomponent is removed.

Clean Fasteners Enable this check box to remove both the CAD and external database entries for thosefasteners that are no longer joining two components together. For example if a weld isconnecting a pipe and an elbow and the elbow is removed, the weld is left, unless alsomanually removed. This operation will clean up such fasteners.

Clean Graphics Data On rare occasions a graphic component is created without a corresponding databaserecord. This implies there is no intelligence for this component. Enable this check box tomove those graphical components that exist without an associated database record tothe piping_orphan layer.

Display Status Dialogs This enables you to "quietly" clean the database, current cleaning statistics are stillreported to the command line but the total information dialog will not be reported if thisoption is left unchecked. This enables an operator to request the clean operation andallow the entire process to be executed without interaction.

A problem may result when more than one user is connected to the database, the CleanDatabase command will not allow the cleanup of any tables that are not being used. Theseare typically temporary tables that are used during a session named AT_XXXX. However, ifyou crash out or the system goes down, the connection you have cannot clean upautomatically, therefore, the system believes a user is still logged on. If you are certain thatyou are the only one that has a connection to the database, execute the Database Tools/DatabaseInformation command to clear up lost connections. On the Database Information dialog andpress the Clear Connections button (this will be active if more than one connection exists).

�1D121C5��??<C��5>E

#<51>�1D121C5


This will warn of the potential dangers of doing this, if you press OK the number ofconnections will be restored to one and the button will be greyed out.

This was imposed as some users were going into the database as a second user and clearing out an active tableof the first, which resulted in lost data.

�� The Bill of Materials and Generate Report functions automatically clean the drawing databaseupon execution.

Clean Database command will clean:

1. Database entries that have no graphics equivalent.

2. Database fasteners that have no graphics equivalent.

3. Graphic entries that have no database equivalent.

The first of these scenarios will be used most often as database entries get left whenever a graphic componentis erased. Cleaning the database will have the effect of reducing the size of the database and making thedatabase consistent with the graphics data. This operation is very efficient and will only take a few seconds tocomplete, depending on the size of the database.

The second option is much more expensive to use, but will clean out any unwanted fasteners from thedrawing that are now considered obsolete.

The last option is less expensive (in terms of time to execute) than the second but a little more expensive thanthe first. If this option reports that components exist in the drawing but do not exist in the database, then theyare moved to the "PIPING_ORPHANS" layer so that a user can determine which components have noassociated database entries. If any components are moved to this layer, this problem could be the result of amore serious problem and should be investigated by your systems administrator.

The symptoms of this problem are that components are being created in the drawing but not in the database.The user should have been warned that the database was inaccessible before this problems occurs, however ifthe user ignores these warning the result will be shown in the clean database.

Finally, but very rarely, components described as "Lonely Masters" are removed from the drawing. These arecomponents that only have the hidden intelligent piping block (named AT_MASTER_PIPING) left for thiscomponent and because of this are rendered useless and therefore cleaned by the Clean Database operation.For this to function the "Clean Graphics Data" option must be set. These "Lonely Masters" have been knownto be created when operations are not fully executed or the user decides to Escape from a command whileonly mid way through its execution. The existence of these lonely masters in the drawing has the singularimpact of consuming unnecessary space.

Finally, when a drawing is opened a temporary copy of the external database is made using a temporaryfilename in the form of "AT_xxxxx". From time to time these tables can be left inadvertently in the database,by the system. Again the only impact of this is that the database consumes additional, unneccessary space. Ifthere is only a single connection to this database and the user has the "Clean Graphics Data" option set for adrawing that contains no "Lonely Masters" or graphic components that do not have a database entry, obsoletetemporary tables are dropped (removed) from the database.

For all of these cases the effect of cleaning the database is not actually committed until the drawing is saved.

�1D121C5��??<C��5>E

�95G�1D121C5


�

��The View Database command enables you to view current drawing component records in its external drawingdatabase’s PIPING table. When the command is first executed, the Drawing Selection Options dialogdisplays to enable you to filter the selection set of component records that will display. After creating yourselection set, a dialog similar to the one shown below displays. Use the scroll bar to view the entire list.

To move to a specific view of a component in the drawing, select its record in this list, then press the Go Tobutton. The selected component will be centered in the drawing display window.

To edit a component, select its record and press the Edit button. This will display the component's externaldrawing database in a dialog in the exact same manner as if you had selected the Database Tools/EditComponent, then selected the component.

�� The Database Information option displays the dialog shown below, which provides a brief view of the currentdrawing database status. This dialog notes the number of component records currently saved in each of theexternal database tables, as well as the actual number of components in the drawing. For example, if you havesaved the drawing, then drawn additional components, this will reflect a difference in these two values. Forthe Database Information option to function, you must have the Piping system loaded.

�1D121C5��??<C��5>E

3@41D5�6B?=�)@53


�� The Clear Connections button is provided to free latent database connections. The external database mustknow how many users are attached to it to remain in sync, especially when a clean is performed. If a useropens a drawing to modify it and another opens the drawing simply to view it, then you don not want thesecond user performing a clean database, as this action will remove the temporary table used by the first user.

Since the external database cannot be locked during a clean, they system tracks the number of connectionscurrently associated with the database. This is fine, except for the instance where the application abnormallyterminates. In this instance, the lock, or connection, is never removed. The Clear Connections button may bepressed to manually remove, or clean up, these latent locks on the external database.

�� The View Transactions button displays the dialog shown below, which denotes the transactions currentlystored in the database. The Purge button on this dialog will delete all transactions currently recorded. Thisdoes not delete any component records, but simply deletes all of the transaction records themselves. It enablesyou to track all transactions recorded from the last time a purge was executed.

�� The Database Tools/Update from Spec command is provided to synchronize component data in the drawingdatabase with component information that was modified in your specifications. This command overwrites theexisting drawing database information for the selection set of components with any data that was modified inthe spec.

�� Warning: If you have manually edited component information in the drawing database using theDatabase Tools/Edit Component command or by some other method, then this data will also beoverwritten if it is defined in the specification.

When the command is executed, the standard selection dialog displays to enable you to define the selectionset of components to be updated. Note that drawings other than the current drawing can be selected forupdate. In this instance, you cannot undo the change. If the current drawing is selected, you can always quitwithout saving to avoid actually changing the drawing.

Once the selection has been made the following dialog displays to enable you to select the method used toupdate the data from the spec.

�1D121C5��??<C��5>E

3@41D5�6B?=�)@53


�

The methods modify different fields from the spec, which are self explanatory.

The method SPEC_UPDATE_DATA_METHOD is executed for all components. This method executes the file,..\MODULES\BASE\COMMON\SPECUPD.EBS for the function at_SpecUpdate_updateData. Eachcomponent’s data is read in the usual way and stored in the components data structure, the equivalent specrecord used for the component is dumped into a dynamic text buffer accessible by the suite of functions,at_ScriptBuffer_getXXX. Therefore, when the method at_SpecUpdate_updateData isexecuted for a component the method can read any of the current spec data from the scriptbuffer functionsand overwrite the current component data using the external database function at_DbExt_put, henceupdating the component.

�� As noted in this dialog, only descriptive information will be modified. Changes will not modify thegraphic representation of components.

To add to the list of methods available, you can manually edit your copy of the fileMODULES\BASE\COMMON\SPECUPD.EBS. To add a new method you will first need to change the dialogselection method, this is the dialog that the user selects which method to update from the available list. Thisdialog can be found in ..\MODULES\BASE\DIALOGS\SELSPCUP.EBS. From this dialog the user should adda new entry to the selection, which will always call the method in..\MODULES\BASE\COMMON\SPCUPD.EBS with the function specified by the one selected in the script..\MODULES\BASE\DIALOGS\SELSPCUP.EBS.

�1D121C5��??<C��5>E

1D121C5�4�$?G��?��?@93C


��#��This area contains that explain how to use the options in the Database Tools menu.

�� After a component is placed in a model, many of its attributes can be modified directly by editing the externaldrawing database record associated with the component. As a general rule, dimensional and position data maynot be modified.

� �?��49D�?=@?>5>D��>6?B=1D9?>

�� Select Database Tools/Edit Component .

�� Select a component to display the first page of the Component Information dialog. The first page of thisdialog contains the most common component drawing database record information. Most of theinformation is provided for information purposes only. The field data that may be modified is presentedin white editable text boxes. Simply move the cursor into the desired text box and modify the informationas desired. Changes made in this dialog will update the respective field information in the component’sdrawing database record.

�� Press Next Page to display the second page of the dialog. The second page contains component positionand port information. It also provides a complete list of all of the component’s drawing database recordfield values.

�� Press OK to close the dialog.

�� The Database Tools/Update Component command may be used to globally update the value of specificexternal drawing database fields for a selection set of components in the current or from multiple drawings.

� �?�E@41D5�3?=@?>5>D�9>6?B=1D9?>

�� Select Database Tools/Update Component .

�� The Drawing Selection Options dialog displays. Select the components to update using the toolsavailable in the dialog.

�� After selecting the components, the Update Component Data Fields dialog displays.

�� Select a field from the List of Fields to be Updated list, then enter the new value for that field in the EditField box. Repeat this process to modify the value for any other fields in the list.

�� Press OK to update the field values for all selected components.

�� You can customize the list of fields that appear in the Update Component Data Fields dialog usingthe Setup/Component Update Preferences command.

�1D121C5��??<C��5>E

1D121C5�4�$?G��?��?@93C


�

�� The Database Tools/Clean Database command reconciles the external drawing database by removing recordsfrom the drawing database for which a component graphic no longer exists (i.e., the component has beendeleted).

� �?�<51>�D85��B1G9>7��1D121C5

�� Select Database Tools/Clean Database .

�� Select the Clean Database parameters that you want executed for this operation, then press OK.

�� The Database Tools/View Database command enables you to view all of the component records in the externaldrawing database’s PIPING table while running an AutoPLANT application.

� �?��95G�D85��B1G9>7��1D121C5

�� Select Database Tools/View Database .

�� A dialog will display that contains a list of database records for the components in the current drawing.

�� Select a component record, then press Go To to zoom into a view of the selected component.

�� You should execute Database Tools/Clean Database prior to performing this function if you havedeleted components from the drawing. These component records will not be removed from theexternal drawing database and will appear in the View Database listing until the database has beencleaned.

�1D121C5��??<C��5>E

B1G9>7�1D121C5�#ECD?=9J1D9?>


� ��!��AutoPLANT stores drawing and component information in an external ODBC-compliant drawing database.When you install an AutoPLANT application, ODBC drivers are installed and system data sources aredefined on your system to enable you to determine the database format that you want to use on your projects.Currently, Rebis supports and has tested Microsoft Access and dBASE database configurations. While youmay elect to configure the system for other database formats, they have not been tested and are not supportedat this time.

� �� The external drawing database may be configured as a single Microsoft Access database with multiple tables(default), or multiple dBASE formatted database tables. The drawing database format should be configured atthe start of a project and used throughout.

Models that contain components from both the EQUIPMENT and PIPING applications share a commonexternal drawing database, while drawings created with ISOMETRICS will have their own external drawingdatabase.

The drawing database configuration is defined in the >3/$17@ group in the file DBCONFIG.INI as shownbelow. This file is located in your NETWORK_ROOT\DATABASE sub-directory.

>3ODQW@

'HVFULSWLRQ� �$OO�3ODQW�GDWDEDVHV

'$7$B6285&(� �06�$FFHVV�IRU�$XWR3/$17

'$7$B7<3(� �'%4

&RQWURO'E� �06$&&(66�0'%

7UDQVDFWLRQV� �<(6

%DFNXSV� �<(6

�&RPSDFW([W� �0';

The following table describes each of the keywords that may be assigned in this group.

Description Brief description that defines the database group record.

DATA_SOURCE This keyword is assigned to the ODBC System DSN Name as defined on your system. When AutoPLANT 97 isinstalled, two System Data Sources are created on your system:

dBase files for AutoPLANT

MS Access for AutoPLANT

This keyword must be assigned to an ODBC System DSN Name that exists on your system. You can view/editthese data sources by launching the 32-bit ODBC Administrator from the AutoPLANT/Odbc group in yourWindows Start menu, then clicking on the System DSN tab.

DATA_TYPE The ODBC data type for the data source being defined.

ControlDb This keyword assigns the template database used for the MS Access database format. ODBC has no way ofcreating an Access database, therefore, the template is copied to create the MS Access drawing database. Thisalso controls which version of the Access driver used. If the Access database was built with version 8.0 ofAccess, then the 8.0 driver will be used and an 8.0 or later version of Access is required to view the database.

The default Access database is currently using version 8.0 (Access 97). To use an MS Access 7.0 database(Access 95) or older, backup the current template database Rebis\Database\MSACCESS.MDB to some othername (e.g. Rebis\Database\MSACCESS.80) and rename the template databaseRebis\Database\MSACCESS.20 to Rebis\Database\MSACCESS.MDB.

Transactions This toggle may be set to specify if transactions should be logged or not. If the assignment is missing or set toNO then transactions will not be logged. If set to YES (default) they will be logged.

�1D121C5��??<C��5>E

B1G9>7�1D121C5�#ECD?=9J1D9?>


�

Backups This keyword setting determines if backup tables should be created by AutoPLANT when a drawing database issaved. If set to Yes, the following additional access tables will be created on a save

Piping_Backup

Nozzle_Backup

Equip_Backup

These are specified in DBCONFIG.INI.

Note: dBase databases will not support backups.

Should a piping, nozzle or equip tables become corrupt during a session and before the next save, the backuptables can be copied to the appropriate name piping_backup to piping etc., to recover the data.

CompactExt When a drawing is saved or closed using the Save, Save As, Quit or Exit commands the associated database iscompressed to save space and to keep the database a manageable size. To improve the performance andreliability of the database the method of compression has changed. On previous releases the database wasalways directly compressed into the same file. The database is now compressed into a local file under thedirectory %local_root%\databasebackup. Once compressed this backup is then copied to the original source ofthe database and the temporary backup is removed.

By default this temporary backup database uses a file extension of .MDX (instead of the original file name withextension .MDB). You can modify this extension in DBCONFIG.INI to change of the extension of this temporarydatabase to some other (e.g., .XXX) by setting the &RPSDFW([W�key.

;CompactExt = MDX

Note that this is commented out in the production version as the default is .MDX internally. To change theextension to .XXX use the setting:

CompactExt = XXX

This has the added effect of preserving this temporary backup file as it will not be removed after compressionshould this value be set, even if it is set to .MDX. Therefore, making this setting will have the added effect ofretaining a local backup of the database for those clients that wish to have this functionality.

If an MS Access drawing database is configured, a single database file that contains multiple tables will becreated for each drawing. If a dBASE database is configured, a separate file will be created for each of thedrawing database tables, with a unique extension as configured in DBCONFIG.INI.

� ��The tables that comprise the drawing database are also configured in the >3/$17@ group in DBCONFIG.INI.The 7DEOHB1DPHV keyword assigns the tables that will be included in the external drawing database asillustrated below.

7DEOHB1DPHV� �3LSLQJ��(TXLS��1R]]OH��&RQWURO��7UDQVDFW��3RUW��-RLQW��)DVWHQHU��&$'/LQN��&113RUW�&11)DVW��&11-RLQW��&QQ$WFK

The structure, or schema, that defines the structure for each of these table names is defined in correspondingINI files of the same name. For example, the PIPING table schema is defined in PIPING.INI.

Tables themselves are configured by including a line for each table in the >3/$17@ group as shown below:

&RQWURO� �&RQWURO�'DWD��GEI��6\VWHP

3LSLQJ� �3LSLQJ�'DWD��GE��$SSOLFDWLRQ��3LSLQJB%DFNXS

(TXLS� �(TXLSPHQW�'DWD��GE��$SSOLFDWLRQ��(TXLSB%DFNXS

1R]]OH� �1R]]OH�'DWD��GE��$SSOLFDWLRQ��1R]]OHB%DFNXS

7UDQVDFW� �7UDQVDFWLRQ�'DWD��GE��6\VWHP

3RUW� �3RUW�'DWD��GE��6\VWHP

-RLQW� �-RLQW�,QIRUPDWLRQ��GE��6\VWHP

)DVWHQHU� �)DVWHQHU�'DWD��GE��6\VWHP

&$'/LQN� �&$'�GUDZLQJ�/LQNV��GE��6\VWHP

&113RUW� �&RQQHFWLYLW\�3RUW�'DWD��GE��6\VWHP

&11-RLQW� �&RQQHFWLYLW\�-RLQW�,QIRUPDWLRQ��GED��6\VWHP

&11)DVW� �&RQQHFWLYLW\�)DVWHQHU�'DWD��GEE��6\VWHP

&QQ$WFK� �$WWDFKPHQWV��GEF��6\VWHP

�1D121C5��??<C��5>E

B1G9>7�1D121C5�#ECD?=9J1D9?>


Each table assignment is described by the following properties:

Table INIFile Name

The structure, or schema, of each table is defined in an INI file in the same directory as DBCONFIG.INI. The INI filename is used as the keyword in each table definition assignment.

Description Description used when the table is presented to the user within the application (e.g., component selections).

ExtensionName

Used for those drivers that create a file per table (xBase driver). For example, if the system is configured to createdBASE drawing databases, and you create a drawing named MYPIPE.DWG, then individual tables will be creatednamed MYPIPE.DBF, MYPIPE.DB1, MYPIPE.DB2, MYPIPE.DB3, etc.

Mandatoryfields

Number of mandatory fields used with the table. These fields are fixed and up to three are allowed. Irrespective of howthe user defined a table these fields will always be included.

0 - No mandatory fields included in the table1 - Include the COMP_ID field2 - Include COMP_ID and MODULE fields3 - Include the COMP_ID, MODULE and CLASS fields

You may notice that none of these fields are actually defined in the schema INI files for these tables. This is becausethey are consisdered mandatory and should not be modified by the user. They are created automatically by thesystem, before the other columns are created. For example, if this value is set to 3 then the columns:

COMP_ID text size 20Module Text size 20ClassName text size 32

are created before any of the user fields.

Table Type Type of database table, currently two types are available:

System: This table is managed by the system and not by applications

Application: This table is modified by the application

BackupTable

Name of the backup table, if any. Only available with non-file based database tables (i.e., not available for xBasedatabases).

$�%��&�

If the system is configured to create MS Access drawing databases, and the name of the drawing isPIPE01.DWG, then a single MS Access drawing database file named PIPE01.MDB will be created thatcontains the individual tables. If the system is configured to create dBASE drawing databases, then individualtables will be created named PIPE01.DBF, PIPE01.DB1, PIPE01.DB2, PIPE01.DB3, etc., which will storethe table-specific drawing data. The extensions for each table may be configured as described above.

The tables that are actually created for a drawing depends on a number of factors. When a PIPING drawing isfirst created, the system creates the PIPING and CONTROL tables.

If the piping drawing is loaded into EQUIPMENT, the EQUIP and NOZZLE tables are added. If you startwith a EQUIPMENT drawing instead of a PIPING drawing, the EQUIP, NOZZLE, and CONTROL tables arecreated first. If you later bring the drawing into PIPING, the PIPING table would be added.

If you create an ISOMETRICS drawing, the system creates the PIPING and CONTROL tables.

In addition to these tables, in PIPING or ISOMETRICS you may specify that extra JOINT, FASTENER, andCADLINK tables and data are created and stored in the external drawing database. The data in these tables isautomatically stored in the drawing’s XDATA, but a mechanism is provided to enable you to also store thisdata in the external drawing database if you desire. This is accomplished via the Drawing Preferences dialog.To add the CADLINK table and write that data to the drawing database, enable the Save Cad Links check boxin the Drawing Preferences dialog. To add the JOINT, PORT, and FASTENER tables and write their data tothe drawing database enable the Save Port Data check box. The default value of these settings may be set ineach of your project configurations.

�1D121C5��??<C��5>E

B1G9>7�1D121C5�#ECD?=9J1D9?>


�

� ��The structure, or schema, of each table in the drawing database is configured in a separate INI file, whichresides in the same directory as DBCONIFG.INI. For example, the structure of the PIPING drawing databasetable is defined in the file PIPING.INI, while the structure of the EQUIP drawing database table is defined inEQUIP.INI.

The following table lists each of the drawing database table schema INI files and provides a description ofeach.

CONTROL.INI The CONTROL data table stores general drawing information in the external drawing database (e.g., drawingname, user who last modified the drawing, etc.). CONTROL.INI defines the structure, or schema, of the controlinformation stored in the CONTROL table.

PIPING.INI The PIPING data table stores all data for components placed in a PIPING or ISOMETRICS drawing. PIPING.INIdefines the structure, or schema, of the component information stored in the PIPING table.

EQUIP.INI The EQUIP data table stores all data for equipment components placed using the EQUIPMENT application.EQUIP.INI defines the structure, or schema, of the equipment information stored in the EQUIP table.

NOZZLE.INI The NOZZLE data table stores all data for nozzles placed using the EQUIPMENT application. NOZZLE.INIdefines the structure, or schema, of the nozzle information stored in the NOZZLE table.

PORT.INI The PORT data table stores all component port data in a model. Port data is stored in the drawing, but may alsooptionally be stored in the external drawing database by enabling the Save CADLinks check box in the DrawingPreferences dialog. PORT.INI defines the structure, or schema, of the link information stored in the PORT table.

TRANSACT.INI The TRANSACT table contains a record of significant transactions that have taken place and can by viewedexecuting Database Tools/Database Information, then pressing the View Transactions button. Thesetransactions can be purged by excuting the Purge Transaction option from that dialog. In addition, under the>3/$17@ group the Transactions flag may be set to specify if transactions should be logged or not. If theproperty is missing or set to NO then transactions will not be logged. If set to YES (default) they will be logged.

JOINT.INI(optional)

The JOINT data table stores the joint connection data for connected components in a PIPING or ISOMETRICSdrawing. These joints are checked whenever you attempt to connect components. Joint data is stored in thedrawing, but may also optionally be stored in the external drawing database by enabling the Save Port Data checkbox in the Drawing Preferences dialog. JOINT.INI defines the structure, or schema, of the joint information storedin the JOINT table.

FASTENER.INI(optional)

The FASTENER table stores fastener component data for fasteners placed between components in a PIPING orISOMETRICS drawing. Fastener data is stored in the drawing, but may also optionally be stored in the externaldrawing database by enabling the Save Port Data check box in the Drawing Preferences dialog. FASTENER.INIdefines the structure or schema for all fastener component data stored in the FASTENER table.

CADLINK.INI(optional)

The CADLINK table stores information to link the external drawing database to the CAD drawing (e.g., entityhandle). Link data is stored in the drawing, but may also optionally be stored in the external drawing database byenabling the Save CADLinks check box in the Drawing Preferences dialog. CADLINK.INI defines the structure, orschema, of the link information stored in the CADLINK table.

CNNxxx Tables In addition to these tables, there are a number of temporary tables used by the application to temporarily storedrawing port, joint, fastener, and attachment data used during the operation of the program. These table namesstart with the CNN prefix and should not be removed from the database format configuration.

)�!�"��

The >'HIDXOW'%@ group in each of the table schema INI files defines the fields that will be included in thattable of the external drawing database. A part of this definition in the PIPING.INI file is shown below.

>'HIDXOW'%@

6+257B'(6&� �6+257B'(6&�&��8

6257B&2'(� �6257B&2'(�1��8

6+23B)/'� �6+23B)/'�1��8

3,(&(B0$5.� �3,(&(B0$5.�&��8

7$*� �7$*�&��8

/21*B'(6&5� �/21*B'(6&5�&��8

581B6,=(� �581B6,=(�&��

0$,1B6,=(� �0$,1B6,=(�&��

�1D121C5��??<C��5>E

B1G9>7�1D121C5�#ECD?=9J1D9?>


%5$1B6,=(� �%5$1B6,=(�&��

)$&,1*B�� )$&,1*B��&��8

6&+('8/(� �6&+('8/(�&��

3,3(B2'B0� �3,3(B2'B0�1��

5$7,1*� �5$7,1*�&��

�

�

�

The syntax of each field assignment is described below:

Field Name The name of the field as it will appear in the table (blank spaces are not allowed).

Map Name Name of the field to be mapped to component field.

Data Type The field data type (C=Character; N=Numeric).

Width The field width.

Precision The field precision (if numeric).

Updatable (Optional): Placing a U in this position indicates that the field is updateable. This setting should not be altered unlessyou are absolutely certain that the field is descriptive ONLY. Enabling the update of fields that contain dimensionalinformation will have adverse affects to the model.

A separate group may be defined for each component Class in each table’s INI file, which contains the tablestructure for that component Class. The >'()$8/7'%@ table structure will be used for all component classeswhose table structure is not explicitly defined. For example, the PIPING table provides two additional schemagroups: >$7B%877:(/'@, >$7B7+5($'@, and >$7B62&.(7:(/'@ for fasteners of these types.

�� When a component is placed from PIPING or ISOMETRICS all data defined in its spec record will bewritten to its PIPING drawing database table. Additional data that is written into the drawing database (e.g.,Line Number, Insulation Thickness, etc.) are defined in functions in PIPEDATA.EBS, which resides in theNETWORK_ROOT\MODULES\BASE\COMMON directory.

PIPEDATA.EBS is a common utility method that contains functions that define additional data written to acomponent’s drawing database record. The data method and function that is executed for a specificcomponent placement is defined by the '$7$B0(7+2' keyword in the module’s METHODS.INI file.PIPEDATA.EBS is the shipping version of the software’s only data method. This file, however, contains five(5) functions for specific component types:

+ at_Piping_Data: Default function to write the additional external drawing database record for all pipingcomponents.

+ at_Fastener_Data: Default function to write the additional external drawing database record for fasteners.

+ at_Support_Data: Default function to write the additional external drawing database record for supports.

+ at_Topworks_Data: Default function to write the additional external drawing database data for valvetopworks.

+ at_HeaderWeld_Data: Default function to write the additional external drawing database data forcomponents that stub-in to another pipe and produce a weld (e.g., if you stub-in a weldolet then theheader weld is created, which is usually different than a regular weld and therefore billed as a differentitem).

If a field is added to the PIPING table, you may add this field to the Drawing Preferences dialog, then addthe appropriate commands to the PIPEDATA.EBS functions to write this new field data to the drawingdatabase when a component is placed. You could also add this field to the Edit Component dialog to enablethe user to edit the field after a component has been placed with the Database Tools/Edit Database function.

�1D121C5��??<C��5>E

B1G9>7�1D121C5�#ECD?=9J1D9?>


�

PIPING’s Drawing Preferences dialog is defined in the PREFRENC.EBS file, while ISOMETRICS’ isdefined in the ISOPREF.EBS file. These files reside in your ..\MODULES\BASE\DIALOGS directory. Inaddition to these files, separate basic script dialogs are defined for each component type in component scriptsin the NETWORK_ROOT\MODULES\BASE\COMMON sub-directory. These may be modified to enable theuser to edit the field using the DatabaseTools/Edit Database command. The second page of this dialog iscommon for all components and is defined in the COMPUTIL.EBS file in the same directory.

��When an equipment or primitive component is placed in a model, a record is written to the drawing’s EQUIPdatabase table. The DWBHTS'E(TXLS�� function in theNETWORK_ROOT\EQUIP\METHODS\UTIL\COMPDB.EBS file defines the data written to the drawingdatabase for equipment components (equipment number and insulation thickness).

When a nozzle component is placed in a model, a record will be written to the drawing’s NOZZLE drawingdatabase table. The DWBHTS'E1R]]OH�� function in COMPDB.EBS defines the data written to the drawingdatabase for nozzles (projection, tag, spec, line number, iso name, size, O.D., long description, and shortdescription, etc.).

Either of these functions may be modified to include additional data in the component’s drawing databaserecord.

Separate forms are provided to modify the drawing database information for equipment/primitives andnozzles. The Database Tools/Edit Database function displays the appropriate dialog when executed. Theseforms are defined in the NETWORK_ROOT\EQUIP\METHODS\UTIL\EDITDB.EBS file and may bemodified to include additional drawing database field data in the same manner as described for thePIPING/ISO component dialogs.

� ��!��#��This section provides a set of procedures that explain how to perform common drawing databasecustomization tasks.

)��!��%��7��"��)��-5�)�

The external drawing database format may be configured as any ODBC-compliant database format.Currently, only MS Access, dBASE, and Oracle database types are supported. If a MS Access database isconfigured (default), a single file that contains multiple tables will be created for each drawing. If a dBASEdatabase is configured, a separate file will be created for each of the drawing database tables, with a uniqueextension as configured in DBCONFIG.INI.

The drawing database format should be configured at the start of a project and used throughout.

�� At this time, the project implementation structure does not support multiple DBCONFIG.INI files orindividual table schemas within a project. Therefore, you must modify the shipping version of thesefiles located in your NETWORK_ROOT\DATABASE directory. Please backup these files beforemodfiication.

�1D121C5��??<C��5>E

B1G9>7�1D121C5�#ECD?=9J1D9?>


� �?��5D�D85��B1G9>7��1D121C5��?B=1D

�� Open NETWORK_ROOT\DATABASE\DBCONFIG.INI in a text editor.

�� In the >3/$17@ group, the '$7$B6285&( and '$7$B7<3( keywords define the drawing database format.

�� To set the format to an MS Access drawing database type, set the keywords as follows:

Description = All Plant databases

DATA_SOURCE = MS Access for AutoPLANT

�� To set the format to a dBASE drawing database type, set the keywords as follows:

DATA_SOURCE = dBase Files for AutoPLANT

DATA_TYPE = DefaultDir

�� Save DBCONFIG.INI, exit, then re-start the system.

)��!��,��-5�)��%��7��7��

The drawing database format may be configured as MS Access or dBASE format in DBCONFIG.INI. If adBASE drawing database is configured in the >3/$17@ group in DBCONFIG.INI, a separate file will becreated for each of the drawing database tables, with a unique extension. The procedure to define theextension for each of these tables is covered below.

� �?��5D�D85��HD5>C9?>�6?B�4��B1G9>7��1D121C5��12<5C

�� Open NETWORK_ROOT\DATABASE\DBCONFIG.INI in a text editor.

�� The 7$%/(B1$0(6 keyword in the >3/$17@ group lists the individual drawing database tables, separatedby semi-colons. Directly after this keyword, the individual table definitions are defined. For example, thetable definition for the PIPING table is as follows:

Piping = Piping Data ; db1 ; 3 ; Application ; Piping_Backup

where, the first parameter to the left of the assignment symbol “=” is the table name; the secondparameter is the table description; the third parameter is the table extension; the fourth parameter is therequired fields (which cannot be modified); the fifth parameter is the database table type (application orsystem); and the sixth parameter is the name of the backup table, if any.

�� When a drawing is created, the system will create separate drawing database table files for each of thesetables using the drawing name with the extensions defined in each table definition. These extensions willonly be used if your external drawing database table type is xBASE. If MS Access is configured, all ofthese tables will be created in a single external drawing database. The extension parameter must beunique for each table and may be modified here. In this example, the PIPING table for a drawing namedSAMPLE.DWG would be SAMPLE.DB1. if using an xbase type external drawing database.

�--��7��!��%��7��

The drawing database is currently opened before the configuration is determined, therefore, the database isconsidered system wide. However, you can change the system to add your own tables as described below.

The following example describes how to add a new MYTABLE table to the system.

�� Edit ..\DATABASE\DBCONFIG.INI to add the new MYTABLE table by modifiying the 7DEOHB1DPHVkeyword as shown below.

Table_Names = Piping; Equip; Nozzle; Control; Transact; Port; Joint; Fastener; CADLink; CNNPort; CNNFast; CNNJoint;CnnAtch; MYTABLE

�� Add the table definiton for the new table using the following format.

TableName = Description ;Needs Comp_ID;Its an application Table; Backup table name

�� The new record for the MYTABLE table would appear as shown below.

�1D121C5��??<C��5>E

B1G9>7�1D121C5�#ECD?=9J1D9?>


�

MYTABLE = MYTABLE Piping Data; dbd; 1; Application; MYTABLE_Backup

�� An application table is one that is modified by the user. A temporary copy is created when the drawing isopened. When the drawing is saved, this table copy is flushed to the permanent table, very much like thePIPING table.

�� Finally, modify the PIPEDATA.EBS script to write to this table, use "MYTABLE" instead of PIPING.Note the component ID should be written to this table also if you want to join them later.

�--2��-��+�!��%��7��7��)��-�

The external drawing database is configured in the DBCONFIG.INI file. The structure of each table in thedrawing database is defined in a separate INI file. For example, the structure of the PIPING drawing databasetable is defined in the file PIPING.INI, while the structure of the EQUIP table is defined in EQUIP.INI.

In each table’s INI file, a separate group may be defined for each component class, which defines the tablestructure applied to that component Class. A special Class, >'()$8/7'%@, defines the table structure for allcomponent classes whose table structure is not defined explicitly in each of these INI files. The procedure toadd an example COMMODITY field to the PIPING table’s default component class is covered below.

� �?��44�1��95<4�D?�D85��B1G9>7��1D121C5��12<5

�� Open NETWORK_ROOT\DATABASE\PIPING.INI in your text editor.

�� In the >'()$8/7'%@ group add a statement to define the new field. For example:

COMMODITY = COMMODITY C 10 0 U

defines a &KDUDFWHU field named COMMODITY that is 10-characters in length.

�� The left side of the assignment defines the external database field to be added. The first parameter on theright side of the assignment is the name of the field to be mapped to component field. The secondparameter defines the type of data (C=Character,N=Numeric). The third parameter defines the fieldwidth and the fourth defines its precision. The fourth optional parameter indicates whether or not thefield is updatable.

�� When you have finished adding a field to the structure, save PIPING.INI and exit.

�� The next time you create a drawing, the COMMODITY field will be added to the external drawingdatabase’s PIPING table.

��!��!��%��7��

The data output to a component’s drawing database record during placement is defined in the Basic Script filePIPEDATA.EBS. That resides in the NETWORK_ROOT\MODULES\BASE\COMMON directory. By default,all fields in the component’s specification record are automatically written to its drawing database record.Other fields, such as Nominal size, Line Number, etc. must be explicitly defined in the appropriatePIPEDATA.EBS function to be written to the drawing database.

This procedure is primarily used when an input field has been added to the Drawing Preferences dialog thatyou want written to the drawing database when a component is placed. The procedure to specify that the datafor a new field named COMMODITY that was added to the PIPING table schema in PIPING.INI and wasadded to the Drawing Preferences dialog is covered below.

�1D121C5��??<C��5>E

B1G9>7�1D121C5�#ECD?=9J1D9?>


� �?��B9D5�D85��95<4�D?�D85��B1G9>7��1D121C5

�� Open NETWORK_ROOT\MODULES\BASE\COMMON\PIPEDATA.EBS in the Rebis Script Editor.

�� Add the following statement to the DWB3LSLQJB'DWD�� function to get the COMMODITY value from theDrawing Preferences dialog and store it in the &RPPRGLW\�6WULQJ variable.

Dim Commodity As String

status = at_Component_getString (Commodity, compID, "COMMODITY")

�� Add the following statement to the DWB3LSLQJB'DWD�� function to put the &RPPRGLW\�6WULQJ variablevalue into the component’s drawing database record COMMODITY field.

status = at_DbExt_put (Commodity, AT_DB_TABLE_PIPE, AT_CURRENT_DOCUMENT, compID, "COMMODITY")

�� Save PIPEDATA.EBS and exit.

�--��%��7��-��!��%��

PIPING’s Drawing Preferences dialog is defined in the file PREFRENC.EBS, while ISOMETRICS’sDrawing Preferences dialog is defined in the file ISOPREF.EBS. Both of these files reside in theNETWORK_ROOT\MODULES\BASE\DIALOGS directory. This procedure explains the steps required to addan existing drawing database field to this dialog, then lists links to the procedures required to write the newfield information to the drawing database each time a component is placed.

This example explains how to add an example COMMODITY field to the dialog.

� �D5@�*��44�1��95<4�D?�D85��B1G9>7��B565B5>35C��91<?7

�� Make a backup copy of the file NETWORK_ROOT\MODULES\BASE\DIALOGS\PREFRENC.EBS(PIPING) or ISOPREF.EBS (ISO).

�� Start the Rebis Script Editor and open the PREFRENC.EBS or ISOPREF.EBS.

�� Select Edit/Find, then enter Begin Dialog and press Find Next. The statements between the %HJLQ�'LDORJand (QG�'LDORJ statements define the dialog instance.

�� To edit the dialog, select all of the statements from %HJLQ�'LDORJ to (QG�'LDORJ, including thosestatements, then select Edit/Edit Dialog. The dialog instance will display in the Rebis Dialog Editor.

�� Press the Text Box control button , then pick a point on the dialog to place the Text Box control. Youmay need to move the existing preferences to open an area for the new setting. Double-click on thecontrol to display its properties dialog, then enter Commodity in the Identifier field and press OK.

�� To place a label for this field, press the Text control button , then pick a point to place the label.Double-click on the text label and then enter Commodity: in the Text$ field and press OK.

�� Select File/Update, then File/Exit and Return to update the dialog instance in PREFRENC.EBS.

� In the 6\VWHP3UHIHUHQFHV,QLWLDOL]H�� function defined above the dialog instance in the file, initializethe new Text Box control by entering the following statement:

Call At_SetControl(AT_TB, AT_COMP_PREF,"Commodity","COMMODITY","Commodity")

� Save and exit.

�1D121C5��??<C��5>E

B1G9>7�1D121C5�#ECD?=9J1D9?>


�

� �D5@��44�D85��95<4�D?�D85��B1G9>7��1D121C5��12<5

The PIPING drawing database table is defined in the file PIPING.INI. The procedure to add the exampleCOMMODITY field to this table is covered below.

�� Open NETWORK_ROOT\DATABASE\PIPING.INI in your text editor.

�� In the >'()$8/7'%@ group add the statement to define the field as a character field, ten characters inlength:

COMMODITY = COMMODITY C 10 0

�� Save PIPING.INI and exit.

� �D5@�(��B9D5�D85��95<4�D?�D85��B1G9>7��1D121C5

The function that writes the drawing database record for a component is defined in the PIPEDATA.EBSmethod. The procedure to write the example COMMODITY field data to the PIPING table is covered below.

�� Make a backup copy of NETWORK_ROOT\MODULES\BASE\COMMON\PIPEDATA.EBS.

�� Open PIPEDATA.EBS in the Rebis Script Editor.

�� The DWB3LSLQJB'DWD�� function defines the data written to the external drawing database for allcomponents, except for fasteners and supports. The first step is to declare the String variable that willstore the value of the Commodity field that you will get from the Drawing Preferences dialog. Add thefollowing statement in the declaration area of this function.

Dim commodity As String

�� Add the following statement after the VWDWXV� �DWB&RPSRQHQWBJHW&XUU,'�FRPS,'� statement of thisfunction to get the value of the Commodity field from the Drawing Preferences settings and store it in thecommodity variable that you declared above. It must be placed after this statement because the functionrequired the component’s ID to get the value of the field.

status = at_Component_getString(commodity, compID, "Commodity")

�� Add the following statement after the previous one to write the value in the commodity variable into theCOMMODITY field in the PIPING table of the external drawing database.

status = at_DbExt_put(commodity, AT_DB_TABLE_PIPE, AT_CURRENT_DOCUMENT, compID, "Commodity")

�� You can click on the functions in the above statements for more information.

�� Save PIPEDATA.EBS and exit.

� �D5@�+��>9D91<9J5�D85��5DD9>7�9>�D85�?>697EB1D9?>

The final required step is to initialize the Commodity setting in each of the configurations that you will beusing. This can be accomplished using the AutoPLANT Configuration Editor.

�� The >6\VWHP�&RPS3UHI@ group in CONFIG.INI initializes and sets the defaults for componentpreferences defined in the Drawing Preferences dialog. In this example, you will manually add theCommodity default to this group for the Imperial configuration. You can repeat this process for any otherconfigurations that you are using.

�� Open CONFIG.INI that resides in your NETWORK_ROOT\CONFIG\IMPERIAL directory.

�� Search or scroll down until you locate the >6\VWHP�&RPS3UHI@ group. Add the following statement toinitialize the Commodity field. You can set the default value as desired (it cannot be blank).

Commodity = 0

�� To test, you must restart the PIPING system. Select Drawing Preferences and enter a value in theCommodity field, then press OK. Draw a component. Select Database Tools/Edit Component, then select

�1D121C5��??<C��5>E

B1G9>7�1D121C5�#ECD?=9J1D9?>


the component. Press Next Page, then scroll down the list of fields and you will notice that the value youentered was written to the Commodity field in the external drawing database.

�--2��-��+�!��-��!��-��#�" ��

The Database Tools/Edit Component command displays the selected component’s drawing databaseinformation in two dialogs. The first dialog displays the most common component drawing database recordinformation. Each component type has its own version of this dialog defined in its Edit Component drawingscript. These scripts reside in the NETWORK_ROOT\MODULES\BASE\COMMON sub-directory.

The second dialog displays component position and port information. It also provides a list of all of thecomponent’s drawing database record field values. This dialog instance is defined in the fileCOMPUTIL.EBS that resides in the same directory.

The following procedure explains how to add an existing drawing database field to the first page of a pipingcomponent’s Edit Component dialog. This example will add a COMMODITY field to the dialog. Thisprocedure assumes that you have already added this field to the PIPING table schema in PIPING.INI asdescribed in the previous procedure.

� �?��44�1��95<4�D?�D85�?=@?>5>D��>6?B=1D9?>��91<?7

�� Start the Rebis Script Editor and open the fileNETWORK_ROOT\MODULES\BASE\COMMON\PIPE.EBS.

�� Select Edit/Find, then enter Begin Dialog and press Find Next. The statements between the %HJLQ�'LDORJand (QG�'LDORJ statements define the dialog instance.

�� To edit the dialog, select all of the statements from %HJLQ�'LDORJ to (QG�'LDORJ, including thosestatements, then select Edit/Edit Dialog. The Script Editor will launch the Dialog Editor and display thedialog instance defined in the selected statements.

�� Press the Text Box control button , then pick a point on the dialog to place the Text Box control.Double-click on the control to display its information dialog, then enter Commodity in the Identifier fieldand press OK.

�� To place a label for this field, press the Text control button , then pick a point to place the label.Double-click on the text label and then enter Commodity: in the Text$ field and press OK. You can re-sizeor move the control if desired.

�� Select File/Update, then File/Exit and Return to update the dialog instance in PIPE.EBS.

�� In the 3LSHBHGLW,QLWLDOL]H�� function defined after the dialog instance in the file, you will find a seriesof $WB&RPSRQHQW'LDORJB6HW7%&RQWURO�� function calls that initialize the Text Box controls on the firstpage of the Edit Component dialog. To initialize the new Text Box control added above, add the functioncall:

Call at_ComponentDialog_setTBControl ("Commodity", "COMMODITY")

+ �� : is the function to initialize Text Box controls.

+ “Commodity”: is the name entered in the Text Box control’s Identifier field in Step 5 above.

+ “COMMODITY”: is the actual PIPING drawing database table field name.

� Save PIPE.EBS and exit. To test your dialog modification, draw a piece of pipe, then execute theDatabase Tools/Edit Component command and pick the pipe.

��

This chapter covers the commands in the new Drafting Tools menu.

2D PIPING APPLICATION OVERVIEW 7-2

DRAFTING TOOLS MENU 7-6

SYMBOL MANAGER 7-6

TITLE BLOCK 7-9

2D SYMBOLS 7-10

INSULATE PIPE 7-11

PIPE END SYMBOL 7-11

2D EDITING MENU 7-11

BROKEN PIPE 7-12

� � � � �

�

��1>4�D85��B16D9>7��??<C��5>E

��9@9>7��@@<931D9?>�/F5BF95G


�

�� The 2D Piping product is an application required to provide a user the ability to design and draw a plantlayout in a 2D "flat" mode. The aim is to provide this functionality as a subset of the existing 3D product. Tothis end the following changes to the existing 3D product have been implemented.

�� The 2D PIPING product will be installed in the same manner as the 3D PIPING product. The functionalitywill be controlled by the Rebis Security system. The security system will control whether a user has access tothe 2D or 3D PIPING environment and the associated commands and functions. When an Authorizationrequest is made, the request will be specifically for the use of 2D or 3D PIPING. This will be controlled bythe creation of either a 2D or 3D piping model, export to PCF etc.

�� The current 3D system uses a method of draw scripts to define and draw the resulting 3D entities forAutoPLANT. In 3D, when a component is created, the draw method utilizes a series of interface functions tocreate custom entities in true 3D. The 2D PIPING product will continue to use this technique, however thedefault system draw mode variable will be set internally from 3D double line to 2D double line.

If a user is only authorized for 2D the placement of and insertion of a component will look exactly like the 3Dinsertion. Internally the 3D custom entities will be converted through the new HLR interface into CADentities and lines, resulting in a flat 2D output.

�� *+��This new method of dynamically producing HLR 2D output is only available under the AutoCAD 2000product. To this end the 2D product will use a less sophisticated method of generating the 2D output in R14by simply replacing the custom entities with AutoCAD primitives, lines, arcs, etc. Due to the constraints inthis release of AutoCAD, two serious limitations will exist.

1. The CAD primitives generated will not be generated through an HLR scheme, hence overlapping entitieswill exist within a single component.

2. Lines may be generated where arcs are expected e.g. at the edge of elbows and this will remain for theR14 release.

�� The following describes the Drawing Mode/Representations now available in terms of the selection mode inthe Drawing Mode and Representation areas of the dialog (e.g., 3D-Double Line will be used to denoteselecting the 3D Drawing Mode and Double Line Representation):

� 3D-Double Line: this is identical to the previous full 3D Drawing Mode configuration. It enables drawingof 3D components in 3D space using Rebis custom component objects.

� 3D-Single Line: this configuration enables drawing of Single Line component representations in 3D spaceusing AutoCAD entities. In general, only Pipe Components, Bends and Returns, and Branchingcomponents are actually drawn as single line AutoCAD entities, with a few exceptions. All othercomponents are drawn in standard 3D-Double Line mode.

� 2D-Double Line: this configuration enables drawing of "flat" (i.e., nothing will be drawn in the verticalplane) Double Line representations of components using AutoCAD entities.

��1>4�D85��B16D9>7��??<C��5>E

��9@9>7��@@<931D9?>�/F5BF95G


� 2D-Single Line: this configuration enables drawing of "flat" (i.e., nothing in the vertical) Single Linerepresentations of components using AutoCAD entities.

As noted above, the 2D - Double Line mode will automatically generate flat 2D entities from existing 3Dcustom components. This is a radical change from the previous method. Previously, the Double Line mode inthe 3D system used a complex set of draw methods to determine which view the component was being placedin and then determined how this component should be drawn. This method will be replaced by automaticallyconverting, during placement, the 3D component into 2D native CAD objects, which have been generated viathe new Hidden Line Removal (HLR) interface described below.

Internally the draw mode settings will remain the same, i.e., "3D", "Double" and "Single". The actual drawmodes available will be controlled by the Rebis Security System. If the user is only authorized for 2DPIPING then the system will set the default draw mode to Double Line/2D, otherwise the default will remainDouble Line/3D.

Users authorized for 2D only, will have their 3D - Double Line draw mode disabled. Users authorized for 3Dwill have all draw modes and options available.

��When the 2D Drawing Mode is enabled, a 2D HL Options button will replace the 3D Surface Resolutionoption. This enables you to define the Hidden Line options for the 2D output. Pressing 2D HL Optionsdisplays the dialog shown below.




Linetype Selects the line type to be used for the hidden line. Only loaded line types can be used from this selection andthere will be no interface to load line types. The standard CAD interface should be used for this purpose.

Lineweight Determines the weight of the visible hidden lines. When you click within this grid field, a browse button willappear. Press this button to display the dialog shown below.

Select the desired Units, then pick the desired line weight that will be used for your 2D representations.

��1>4�D85��B16D9>7��??<C��5>E

��9@9>7��@@<931D9?>�/F5BF95G


�

��

Once of the most important aspects of the 2D PIPING product is the ability to place simple shapes instead ofcomplete arrangements. For this purpose a symbol manager will be provided, which will enable the creation,insertion, deletion and modification of symbols. The full scope of this development is outside of thisdocument and will be presented as a separate design or prototype.

�� (�� The 2D PIPING product does not allow the following commands/options, which can only be used whiledesigning in the 3D mode.

1. PXF Import/Export

2. Export to PCF will not be available from a 2D PIPING drawing.

3. ISOGEN output will not be available as a consequence of the previous limitation.

4. AutoISO will not be allowed from a 2D PIPING drawing.

5. ISOMETRICS: this product must be licensed in its current form as a separate product. There will be noability to export to a 2D PIPING drawing from and ISOMETRICS drawing as is available in the full 3Dproduct.

6. The REDRAW command will be not available on 2D PIPING drawings.

7. Bill of Materials will be available.

8. All existing modules will be available in 2D.

9. A 3D drawing cannot be generated from a 2D PIPING drawing.

The user can only work in a 2D-drawing environment. Under these constraints any custom Rebis objects thatare drawn will be shown as flat entities in any view. The following features, which were derived from the 3DPiping User Interface, will not be available.

�� 1. Centerline Routers

a) From Dialogb) From Filec) Pro-Pipe Routerd) Designer Router

2. Representations

a) 3D Repsb) AutoCAD Entities

3. 3D Display Modes

4. 3D Display Utilities

5. Connectivity Checker

6. Isometric Stop Signs

7. Drawing Production Options

��1>4�D85��B16D9>7��??<C��5>E

��9@9>7��@@<931D9?>�/F5BF95G


� �� The current 3D draw scripts will remain intact. However the current use of draw scripts for flat, double linemode will be removed and replaced using the preferred internal method of drawing components in a flat 3Dmode. This will greatly enhance the layout of scripts, which were formerly overly complex because of theinclusion of having to determine which view the user was currently in before deciding how to draw acomponent in the current 2D mode. Instead, the scripts will still support 3D, Double and Single mode, but forthe most part 3D and 2D will use the same code from the draw script. Internally, the system will recognize 2Dmode and automatically transform the current 3D component into its flat AutoCAD counterpart. The endresult is that the contents of most draw script will be considerably reduced and simplified.

The current 2D mode will still be available to users and the scripts in the event that the user might want todraw a different representation of a component in 2D than its 3D counterpart. For example some valves mayuse a symbolic representation instead of flattening the current 3D representation.

�� In the Draing Preferences dialog, when you enable the 2D Draiwng Mode radio button, the SurfaceResolution option will be replaced by a 2D HL Options button. Pressing this button displays an HLR Optionsdialog, which enables you to define how hidden line removal is handled for the 2D-Double Linerepresentations. Hidden line removal is handled on a per component basis with respect to the settings definedin this dialog.




Linetype Selects the line type to be used for the hidden line. Only loaded line types can be used from thisselection and there will be no interface to load line types. The standard CAD interface should beused for this purpose.

Lineweight Determines the weight of the visible hidden lines. When you click within this grid field, a browsebutton will appear. Press this button to display the dialog shown below.

Select the desired Units, then pick the desired line weight that will be used for your 2Drepresentations.

��1>4�D85��B16D9>7��??<C��5>E

B16D9>7��??<C��5>E


�

� ��

The Drafting Tools menu provides a number of options for and manipulating 2D symbology on your model.The Drafting Tools toolbar shown below provides quick access to these commands

��

The operation of the Symbol Manager varies depending on your version of AutoCAD. If running inAutoCAD 2000, the Drafting Tools/Symbol Manager command displays a dockable dialog as shown at leftbelow. If running in ACAD R14, the dialog shown at right displays.

ACAD 2000 ACAD R14

The following section explain use of the Symbol Manager in AutoCAD 2000 and AutoCAD R14

��The user can double-click on folders to open them. Drag symbols from the symbol manager into AutoCAD.You may be prompted for scale and rotation, depending on the way the symbol was defined. The standardblock insertion function is used.

If you want to create your own symbols, there are two ways to do this. Drag and drop or add an existingsymbol. To use drag and drop, draw the symbol in AutoCAD, select it and then drag it into the requiredfolder. A dialog box pops up to fill in the symbol name, scale factors, rotation, etc. If you fill these in, it willuse them. Otherwise it will prompt the user for them when the block is inserted.

You can also insert an existing block into the symbol manager by using the right click menu and selecting"create symbol". This will bring up the same dialog box described above and allow you to indicate whichsymbol to use. You can also create new folders using the right mouse click menu and move symbols betweenfolders using drag and drop.

��1>4�D85��B16D9>7��??<C��5>E

)I=2?<��1>175B


�� *+��Select the desired symbol folder from the Folders drop-down list. A list of symbols assigned to that folderwill appear in the Symbols area of the dialog.

To place a symbol, simply select it from the dialog, then press Insert. Symbol must be added to the SymbolManager by manually editing the SYMBOL.INI file. This procedure is explained later in this topic.

� �� The following exercises provide an example of how to place and add a symbol. The operation of the SymbolManager varies depending on your version of AutoCAD. These differences are noted in the followingprocedures.

� �<139>7�1��E=@��I=2?<

1. Select Piping/Drafting Tools/SymbolManager&ldots; to display the Symbol Manager.

2. AutoCAD 2000: Double click on the User Root folder to expand it, then click on the [+] symbol next to theEquipment folder to expand it as shown below.

AutoCAD R14: Select Equipment from the Folders list to display a list of symbols assigned to that folder.

3. AutoCAD 2000: Drag the Pump1 symbol onto the AutoCAD drawing screen. To do this, place your mousepointer over the symbol, hold down the right button while you move the mouse cursor to a point over theAutoCAD drawing screen. Release the right mouse button.

AutoCAD R14: Select the Pump1 symbol, then press the Insert button.

4. Respond to the prompts as follows to insert the pump:

Specify insertion point or [Scale/X/Y/Z/Rotate/PScale/PX/PY/PZ/PRotate]: Pick a point on the drawing.

Enter X scale factor, specify opposite corner, or [Corner/XYZ] <1>: Type 1 and press Enter to specify the X scale factor.

Enter Y scale factor <use X scale factor>: Press Enter to accept the default of 1 that was defined for the X scale factor.

Specify rotation angle <0>: Pick a point below the pump symbol, making sure the AutoCAD ORTHO mode is enabled.

5. The pump is inserted into the drawing.

In this section, you will learn how to add a new pump symbol to the Symbol Manager interface. Thisprocedure varies depending on your version of AutoCAD. Separate procedures are provided below to add asymbol if using AutoCAD 2000 and AutoCAD R14. Complete the procedure for your version of AutoCAD.

� ��449>7�1��I=2?<�D?�D85��I=2?<��1>175B�%��&

1. Draw a rectangle by typing Rectangle at the command prompt, or by selecting Draw/Rectangle from theAutoCAD pull-down menu.

2. Pick oposite corners to create a rectangle approximately 3’ x 6’.

3. Highlight the rectangle by picking it in the AutoCAD window.

4. Place the cursor over a point along the edge of the rectangle. While holding down the right mouse button,drag the rectangle over the icon of the Equipment folder in the Symbol Manager and then release themouse button.

5. The following dialog appears.

��1>4�D85��B16D9>7��??<C��5>E

)I=2?<��1>175B


�

6. Enter a name for the new symbol (like Pump 3) in the required Symbol Name field, then press OK.

�� If you always want the scale or rotation to be a static value, you can assign the desired values in thedialog fields provided. If you do not enter values, the user will be prompted for these parameterswhen placing your symbol.

7. Notice that your new symbol has been added to the Symbol Manager dialog. You can now place thissymbol in the same manner as you placed the pump in the previous exercise.

8. You can close the symbol manager by right clicking in the dialog and selecting Hide or by selecting the[X] in the upper right of the symbol manager window.

9. You can delete the rectangle from your drawing as it will not be used in this Tutorial.

� �449>7�1�5G��E=@��I=2?<�%�� *+&

1. Draw a rectangle by typing Rectangle at the command prompt, or by selecting Draw/Rectangle from theAutoCAD pull-down menu.

2. Pick oposite corners to create a rectangle approximately 3’ x 6’.

3. Use the WBLOCK command to Write Block the symbol. The file should be placed inREBIS\USER\CONFIG\IMPERIAL\SYMBOLS\ directory.

4. Using a text editor, add a new entry to the REBIS\USER\CONFIG\IMPERIAL\SYMBOLS\SYMBOL.INIsimilar to example that follows:

>3XPS��@)LOHQDPH 3803�7\SH 6\PERO3DUHQW 1HZ�)ROGHU��7KLV�PXVW�EH�WKH�IROGHU�\RX�ZDQW�LW�WR�UHVLGH�LQ&RORU ��RSWLRQDO��H[DPSOH�ZRXOG�SODFH�EORFN�UHG/D\HU P\OD\HU��RSWLRQDOOGRWV�H[DPSOH�ZRXOG�SODFH�EORFN�RQ�QHZ�OD\HU�QDPHG�E\OD\HU;VFDOH ��RSWLRQDO<VFDOH ��RSWLRQDO5RWDWLRQ ��RSWLRQDO

5. The symbol will now be available in the Symbol Manager the next time it is executed. You can delete therectangle from your drawing if desired.

��1>4�D85��B16D9>7��??<C��5>E

�9D<5�5<?3;


�� The program has been designed to use a system, custom, and user directory for storing symbols. Only theUser directory is currently being used. If you create your own symbols, it will put them in the User directory.In theory, the program should also recognize symbol libraries in the network root and custom directories.

The program reads the AutoPLANT ini files to find the user\config directory and looks for a Symbolsdirectory under the current configuration directory. If it can’t find it, it will create it. The list of symbols that isdisplayed is read from the SYMBOL.INI file in this directory.

The symbol ini also contains the folders, names and which symbols are stored under which folders. Eachentry (other than the root) contains a value for Parent and type. The three valid types are Root, Node (folder),and Symbol. To make renaming and reordering easier, the Nodes and Root contain a Display name, which iswhat the user sees. The symbols just display the name of the section. The names of the folders are randomlygenerated. A future enhancement might be to use a global unique ID to generate initial values for the folders.

>8VHU�5RRW@

7\SH 5RRW

'LVSOD\QDPH 8VHU�5RRW

>1HZ�)ROGHU��@

'LVSOD\QDPH (TXLSPHQW

W\SH 1RGH

3DUHQW 8VHU�5RRW

>3XPS��@

)LOHQDPH 3803�

7\SH 6\PERO

3DUHQW 1HZ�)ROGHU��

�� The Drafting Tools/Title Block command displays a dialog similar to the one shown below, which lists titleblock drawings available for the configuration selected when you created the current drawing.

Select the desired title block drawing, then press OK. You will be prompted to enter the desired Scale Factorand the Insertion Point to place the title block.

��1>4�D85��B16D9>7��??<C��5>E

��)I=2?<C


�

��The Drafting Tools menu provides a number of 2D piping symbol placement options, which place genericAutoCAD blocks. Some of these blocks contain attributes, which you are given the option to assign duringplacement. These components are not "AutoPLANT intelligent," and therefore will not appear in generatedBOM’s or reports. Most of these commands display a dialog of options for placement and include:

� Horizontal Vessel

� Vertical Vessel

� Misc. Equipment Symbols

� Arrows

� Revision Symbols

� Section Markers

� Piping Symbols

� Spec Breaks

� Misc. Markers

��!��The blocks are defined in the AutoCAD drawing file SYMLIB.DWG, which resides in yourNETWORK_ROOT\SUPPORT directory. The insertion routines themselves are defined in theBLKINSRT.EBS basic script, which resides in your network ..\MODULES\BASE\COMMON directory.

Adding a new block insertion is a simple process, which requires you to add the block to the SYMLIB.DWG,then write the insertion script in BLKINSRT.EBS. The easiest way to accomplish this, is to copy one of theexisting functions in BLKINSRT.EBS and change the function name and the block definitions assigned in thefunction. You can then execute the following command, or program it in your menu file to execute yourscript. Replace My_Block with the name of your new block insertion function in BLKINSRT.EBS.

�DWB%DVLFBH[HFXWH6FULSW��VWUFDW��DWB6\VBJHW1HW'LU��0RGXOHV??EDVH??FRPPRQ??EONLQVUW�HEV��0\B%ORFN��

��1>4�D85��B16D9>7��??<C��5>E

(>CE<1D5��9@5


��The Drafting Tools/Insulate Pipe command prompts you to select an existing pipe segment, then displays thedialog shown below.

Enter the desired Insulation Thickness and Insulation Spec in the fields provided, then press OK. You willthen be prompted to pick the desired start and end points for the insulation on the pipe segment selectedpreviously.

��The Drafting Tools/Pipe End Symbol command prompts you to select the existing pipe segment on which youwant to place a pipe end symbol. The system will place the end symbol on the end of the pipe closest to thepoint along the pipe segment that you pick.

��

The Drafting Tools/2D Editing menu provides the following options:

Trim Works in the same manner as AutoCAD’s TRIM command on 2D AutoPLANT components. You will first beprompted to pick the cutting edges, then the objects to trim.

Ungroup Prompts you to select a 2D AutoPLANT component, then ungroups all of the elements in the component.Particularly useful if you want to perform some trimming, or other editing, then regroup the component.

Regroup Prompts you to select an entitiy that is part of an AutoPLANT 2D component, then automatically regroups all of theentities that were originally part of that group.

Add to group Prompts you to select an existing AutoPLANT 2D component, then the entities that you want to add to its group.

Delete from Prompts you to select any entity that is part of an AutoPLANT 2D component’s group, then will delete that entityfrom the drawing.

Remove from Prompts you to select any entity that is part of an AutoPLANT 2D component’s group, then will remove this entityfrom that group.

��1>4�D85��B16D9>7��??<C��5>E

5B?;5>��9@5


�

� � ��The commands in the Drafting Tools/Broken Pipe menu enable you to break pipe for annotating pipe atdifferent elevations in paper space. The Mend and Mend All commands restore broken pipe to its original state.

� �� Allows you to select a pipe to break. The user is prompted to select the pipe to break, then indicate thestarting and ending points of the break. A pipe break symbol is inserted at both ends of the break, and thecenterline remains to indicate the pipe is continuous. An example of a pipe break is shown below.

Pipe can be broken to display objects beneath it. Broken Pipe is shown in the current viewport only.After apipe is broken, it can be mended with either the Mend or Mend All commands.

� �?��B51;��9@5

1. Select Drafting Tools/Broken Pipe/Break .

2. The prompt

Select cylinder to break/adjust:

displays. Select the pipe to be broken.

3. The prompt

Enter distance of break from start:

displays, and a port on the selected pipe segment becomes the reference. Select a point on the pipe thatwill define the first point of the break.

4. The prompt

Enter distance of break from end:

displays, and the opposite port on the pipe segment becomes the reference. Select a second point to definewhere the break will end. The pipe is broken between the selected points, and pipe break symbols areplaced on the open ends of the pipe.

You can mend pipe with the Mend Pipe and Mend All Pipe commands.

��1>4�D85��B16D9>7��??<C��5>E

5B?;5>��9@5


��

Repairs a selected piece of pipe that has been “broken” with the Break Pipe command.

� �?��5>4��9@5

1. Select Drafting Tools/Broken Pipe/Mend

2. The prompt

Select cylinder to remove break:

displays. Select the pipe segment which has been broken. The pipe is repaired.

If you have more than one segment to mend, use the Mend All command instead.

��Repairs all pipe in a drawing (or viewport) that has been “broken” with the Break Pipe command. The MendAll command will repair a selected group of pipe segments on which a Break Pipe command was executed.

� �?��5>4��5<53D54��9@5��57=5>DC

1. Select Drafting Tools/Broken Pipe/Mend All .

2. All broken cylinders in the current viewport are mended.

��

This chapter covers the Annotation menu, which provides a number of options to enable you toannotate your PIPING components.

OVERVIEW 8-2

ANNOTATION PREFERENCES 8-2

EDIT ANNOTATION 8-5

DATABASE FIELD ANNOTATION 8-6

LINE NUMBER ANNOTATION 8-6

NOTES ANNOTATION 8-7

ELEVATION ANNOTATION 8-7

COORDINATE ANNOTATION 8-7

TAGS 8-7

INSTRUMENT BALLOONS 8-8

ANNOTATION - HOW TO TOPICS 8-9

� � � � �

�

�>>?D1D9?>��5>E

/F5BF95G


�

�� The Annotation menu provides a number of options to enable you to annotate your PIPING components.These commands may also be executed via the Database Toolbar toolbar. This toolbar is available as a flyouttoolbar from the main Piping Functions toolbar, or may be displayed separately by selectingToolbars/Function Toolbars/Annotation. This toolbar contains flyouts that display additional commands foreach annotation category.

The style and format of annotation may be defined using the Annotation/Annotation Preferences option. Anumber of options display on the command line when you place annotation. These options are also availableby executing the Edit Annotation command, then selecting an existing annotation element.

�� The Annotation Preferences dialog provides a centralized location for establishing annotation preferences.Separate settings can be specified for different types of annotation, and these settings can be saved along withthe drawing or saved as a new set of default preferences.

A description of each dialog option is provided below:

��The Annotation Style list box presents all the different types of annotations that are available in PIPING.Select the type of annotation from this list then define it in the fields provided in other areas of the dialog.The fields will filter based on the values previously defined for that style.

The Default Settings option lets you set the default parameters that will be applied globally to all theindividual annotation types. The Default Settings functions as a template. Define the general characteristics ofall the annotation that will be placed in the drawing, then select an individual style to specify preferences thatare unique to that annotation type. If a setting is specified for an individual style, it overrides the defaultsettings. For example, the default annotation settings might specify that containers are to be disabled, but youcan edit the GenNote style so general notes are placed with a container box around it.

The annotation styles include the following choices:

Default Settings Default settings applied to all the styles listed below. These settings are applied unlessmodifications are made to a specific annotation style

General Note Inserts general information notes into a drawing

Coordinate Annotates the absolute coordinates of a point.

Main Size The main size of the selected component.

Description Annotates the short description of the selected component.

Long Description Annotates the long description of the selected component.

Spec Annotates the specification from which the component was drawn.

Cut Length Annotates the cut length of the selected pipe.

Insulation Annotates the insulation value associated with the selected component.

Tag Annotates the tag assigned to the selected component.

Line Number Annotates the line number on which the selected component is placed.

�>>?D1D9?>��5>E

�>>?D1D9?>��B565B5>35C


Line Number Long Annotates an expanded version of the line number information that includes commodity andinsulation values along with the line number.

Line Number with Centerline Line number annotation preceded by the centerline symbol.

Line Number Long withCenterline

Long line number annotation preceded by the centerline symbol.

Instrument Bubbles (various types can be defined individually)

Mark Allows you to place section and elevation marks in your drawing.

Top of Pipe Elevation Annotates the elevation of the selected component with respect to the top of pipe location.

Center of Pipe Elevation Annotates the elevation of the selected component with respect to the center of pipe location.

Bottom of Pipe Elevation Annotates the elevation of the selected component with respect to the bottom of pipe location.

Northeast Coordinate Annotates the selected point’s North/East coordinate.

Northsouth Coordinate Annotates the selected point's North/South coordinate.

EastWest Coordinate Annotates the selected point's East/West coordinate.

��The Placement options control how annotation gets placed in a drawing. You can have access to extraplacement options, edit text before it is placed, exit the command automatically or continue selectingcomponents for annotation, and other options as explained below.

� ��

The Normal mode is the standard method for placing annotation. It involves the four general steps outlinedbelow:

�� Select the component to annotate. If the annotation style has an associated leader line, the selected pointalso becomes the leader line’s anchor point.

�� Drag the annotation text from the anchor and pick a second point for placement.

�� Respond to the annotation command line prompt. Press Enter to exit the command or select an optionfrom those presented.

�� Select a new component/element for annotation, or press Enter to exit the command.

��$��

The Text mode enables you to edit the annotation text before it is placed. The general steps are outlinedbelow.

�� Select the component to annotate. If the annotation style has an associated leader line, the selected pointalso becomes the leader line’s anchor point.

�� Drag the annotation text from the anchor and pick a second point for placement.

�� Respond to the annotation command line prompt. Press Enter to exit the command or select an optionfrom those presented.

�� Edit the text. AutoCAD’s Mtext dialog is displayed. You may edit the text or the properties of the textbefore it is placed in the drawing.

�� Select a new component/element for annotation, or press Enter to exit the command.

�>>?D1D9?>��5>E


�

��$��The options in the Text group box determine how text gets placed in the drawing. These are the equivalentsof AutoCAD’s MTEXT commands/options of the same name.

�� The Block option enables you to associate an AutoCAD block with a selected annotation style. Input a blockname in the field provided, then specify rotation and scaling factors as desired. In order for PIPING to locatethe block, it needs to be included in the block drawing file, ANNOTATE.DWG.

Open this drawing in AutoCAD and define the block, save it, then specify the block name in the Name field.

�� The Container section of the dialog defines whether or not containers are drawn around the annotation text.Enable the check box to include a container, then specify a type from the selection list. The Offset Ratiodetermines the spacing between bounding lines of the container and the text placed inside it.

�� The Leader group box contains options and settings associated with leader lines. Leader lines are anchored atthe point selected when an annotation command is selected, and extend to a user-specified placement point.Options are as follows:

Leader Line Enable this option to draw the leader line when the annotation is placed. If this option is disabled, theannotation is placed without a leader line.

Splined Splines the leader line so that angles or directional changes in the leader line are drawn as smoothcurves.

Hookline Enable this option to automatically draw the leader line as hooked if the angle of the leader line isgreater that 15 degrees from horizontal or vertical.

Arrowhead Enable this option to draw the open end of the leader line as an arrow head which points to thecomponent (or object) selected for annotation.

Dim Style Allows you to apply an existing dimension style to the current annotation style. The dimension stylemust have been previously defined in the current drawing for it to be valid input in this field.

Dim StyleTemplate

This field is reserved for future functionality.

Color Allows you to specify the color applied to the annotation. Valid input includes “BYLAYER,” an AutoCADcolor number, or an AutoCAD color string (text description, i.e., “Blue”)

�>>?D1D9?>��5>E

�49D��>>?D1D9?>


��The annotation command prompt shown below enables you to edit existing annotation elements. Thecommand prompt is displayed automatically during annotation placement (unless one of the “exit” placementoptions was specified). It is also displayed when the Annotation/Edit Annotation command is executed.

Format/Edit vertex/Rotate/Move/Annotation/eXit:

�� If you want to edit annotation text ONLY, the easiest method is to use AutoCAD’s DDEDITcommand.\

A description of each of these options is provided below:

�� When this command is selected, the following prompt is displayed.

Spline/sTraight/Arrow/No arrow/<Exit>:

These options control the leader line as follows:

� Spline: Converts existing vertices on a leader line to smooth curves.

� Straight: Converts existing curves on a leader line to vertices.

� Arrow: Attaches an arrow head to the anchor point of the leader line.

� No Arrow: Removes existing arrow heads from the anchor point of the leader line.

� Hooktoggle: Toggles the display of the hook in the leaderline line leading to the annotation text.

� Reverse: Toggles the side of the annotation text which the leaderline connects to the text.

�� $Allows you to re-position the current vertex on the selected leader line.

� Insert: Allows you to insert a new vertex on the selected leader line.

� Remove: Allows you to remove the current (highlighted) vertex from the selected leader line.

� Next/Previous: Selects the next/previous vertex on the current leader line.

��Rotates the text and the associated leader line a user-specified angle.

��

Enables you to select a new point to change the start point of the leader line.

��This command displays the command prompt shown below.

Attachpoint/Edit/Info/eXit:

�>>?D1D9?>��5>E

1D121C5��95<4��>>?D1D9?>


�

These options control the annotation text as follows:

� Attachpoint: Controls how the text is positioned in relation to the leader line. The Attachpoint option isthe same as the Attachment field in the Annotation Preferences dialog.

� Edit: Displays AutoCAD’s Mtext dialog which enables you to edit the selected annotation text and textproperties.

�$��Exits the annotation command prompt.

��These commands annotate the field value stored in a component’s database record. The annotation procedureis the same for all the database annotation commands: select the command then the component whosedatabase value you want to extract and place as annotation.

Main Size The Main Size of the component.

Short Desc The Short Description of the selected component.

Long Desc The Long Description of the selected component.

Spec The Specification from which the selected component was drawn.

Cut Length The cut length value of the selected component.

Insulation The insulation thickness of the selected component.

�� These commands annotate the line number stored in a component’s database record. Line numbers areassigned during component placement, and can either be read from the value specified in the DrawingPreferences dialog, or from the connecting component. The annotation procedure is the same for all the LineNumber annotation commands: select the command then the component whose Line Number value you wantto extract and place as annotation.

Line No. Short Annotates the line number-specification-main size.

Line No. Long Annotates the line number-specification-main size - Commodity (if specified) - Insulation (if specified)

Line No. Short w/CL The Centerline symbol followed by the Line No Short annotation method described above.

Line No. Long w/CL The Centerline symbol followed by the Line No Long annotation method described above.

�>>?D1D9?>��5>E

�?D5C��>>?D1D9?>


��These commands allow you to place general note annotation in your drawings. The procedure is to select thecommand then indicate the placement options. AutoCAD’s Mtext dialog is displayed to allow you to input thetext and control formatting and placement options.

General Note Allows for the annotation of general notes in your drawing.

��These commands allow you to edit the elevation of a selected piece of pipe. You can annotate the top, center,or bottom of the pipe elevation. Select the command, pick the pipe whose elevation you wish to annotate, thenselect the location in the drawing where the leader line will be placed.

TOP Elevation Top of Pipe Elevation

COP Elevation Center of Pipe Elevation

BOP Elevation Bottom of Pipe Elevation

�� NE Coordinate Annotates the North, East coordinate location of the selected point

NS Coordinate Annotates the North or South coordinate of the selected point. If the selected point is below the origin (0,0),the annotation will report South coordinates. If the selected point is above (0,0) it will report Northcoordinates. NS Coordinate annotation is placed as horizontal text only.

EW Coordinate Annotates the East or West coordinate of the selected point. If the selected point is to the right of the origin(0,0), the annotation will report East coordinates. If the selected point is to the left of the origin (0,0), Westcoordinates are reported. EW Coordinate annotation is placed as vertical text only.

Coordinate Annotates the (x,y,z) coordinate location of the selected point.

��Material Tag Annotates components with Bill of Materials markers whose values directly correspond to the BOM

material tags generated during the last execution of the BOM command. If a value is defined in theselected component’s MAT_MARK field, then it will display as the default in the dialog displayed. Once youhave defined the tag, press OK to place the annotation.

Component Tag Annotates the component tag for a selected component. If a value is defined in the selected component’sTAGNUMBER field, then it will display as the default in the dialog displayed. Once you have defined thetag, press OK to place the annotation.

�>>?D1D9?>��5>E

(>CDBE=5>D�51<<??>C


�

�� The dialog shown below is presented for the placement of instrument balloons.

Select the type of instrument bubble that should be placed in the drawing, then press OK. You are thenprompted to select the anchor point and the placement point. Afterwards, the Enter Attributes dialog isdisplayed. Enter the T-tag attributes in the fields provided, then press OK. The instrument bubble is placed inthe drawing at the points specified, and with the attributes entered in the dialog.

�>>?D1D9?>��5>E

�>>?D1D9?>�4�$?G��?��?@93C


��#��This area provides procedures that explain how to perform common annotation tasks.

��

� �?�549D�5H9CD9>7�1>>?D1D9?>

�� Select Piping/Annotation/Edit .

�� The prompt

Select annotation group to edit:

displays. Select an existing annotation element.

�� The editing prompt

Format/Edit vertex/Rotate/Move/Annotation/eXit <X>:

displays. Click on the More Information button below to explore the editing options available from thiscommand prompt.

�� The Annotation/Tags/Material Tag command enables you annotate components with Bill of Materials markerswhose values directly correspond to the BOM material tags generated during the last execution of the BOMcommand.

� �?��<135�1��1D5B91<��17

�� Select Piping/Annotation/Tags/Material Tags

�� The prompt:


is displayed. Select the component that you want to annotate. It is important to note that the point youspecify becomes the anchor to the annotation’s leader line, so select the point where you want the leaderline to connect to the component.

�� The prompt:

Annotation Location

is displayed. Pick the location where the center of the mark balloon will be placed

�� The editing prompt:


is displayed. This prompt enables you to edit the existing annotation elements. If the BOM mark requiresno changes, press X to exit the editing mode.

�� The prompt:


is re-displayed. Select another anchor point to place and define a new BOM mark, or press Enter to exitthe command.

�>>?D1D9?>��5>E

�>>?D1D9?>�4�$?G��?��?@93C


�

�� PIPING contains balloons for labeling and identifying instrumentation placed in a piping drawing.

� �?��<135�1>��>CDBE=5>D��1<<??>

�� Select Piping/Annotation/Instrument Balloons .

�� The Instrument Balloons dialog displays. Select the type of instrument balloon appropriate to your needs.

�� The prompt

Select the anchor point of annotation:

displays. Pick the point where the leader line will be located.

�� The prompt

Annotation location:

displays. Pick the point where the center of the instrument bubble will be placed.

�� The Enter Attributes dialog displays. All instrument balloons are placed with four attribute fields asfollows. Complete the fields necessary to adequately define the instrument.

�� FUNCTION: Abbreviated functional description of the instrument; default is T1 INST_ID: Uniqueinstrument number; default is T2 SEQUENCE: Letter or number which indicates the sequential position;default is T3 NPS_MAIN: Main nominal pipe size; default is T4 After defining the fields, press OK toclose the dialog.




� The prompt


is re-displayed. Select another anchor point to place and define a new instrument bubble, or press Enterto exit the command.

�>>?D1D9?>��5>E

�>>?D1D9?>�4�$?G��?��?@93C


��#��This area provides procedures that explain how to perform common database field annotation tasks.

��:��)�6�:��

� �?��>>?D1D5�1�?=@?>5>D)C��19>��9J5

�� Select Annotation/Database Fields/Main Size .

�� The prompt


displays. Pick a point on a component. The point becomes the anchor of the annotation leader line.

�� The prompt


displays. Pick a point to place the annotation.




�� The prompt


is re-displayed. Select another component to annotate, or press Enter to exit the command.

��:�� :��

� �?��>>?D1D5�1�?=@?>5>D)C�%�8?BD&��5C3B9@D9?>

�� Select Annotation/Database Fields/Description .

�� The prompt



�� The prompt






�� The prompt



�>>?D1D9?>��5>E

�>>?D1D9?>�4�$?G��?��?@93C


�

��:.�� :��

� �?��>>?D1D5�1�?=@?>5>D)C��?>7��5C3B9@D9?>

�� Select Annotation/Database Fields/Long Desc .

�� The prompt



�� The prompt






�� The prompt



��:) ��:��

� �?��>>?D1D5�1�?=@?>5>D)C��@5396931D9?>

�� Select Annotation/Database Fields/Spec .

�� The prompt



�� The prompt






�� The prompt



�>>?D1D9?>��5>E

�>>?D1D9?>�4�$?G��?��?@93C


��:�� #��.��!:��

� �?��>>?D1D5�1��9@5)C�ED��5>7D8

�� Select Annotation/Database Fields/Pipe Cut Length .

�� The prompt


displays. Pick a point on a piece of pipe. The point becomes the anchor of the annotation leader line.

�� The prompt





is displayed. This prompt enables you to edit the existing annotation elementsIf the BOM mark requiresno changes, press X to exit the editing mode.

�� The prompt


is re-displayed. Select another length of pipe to annotate, or press Enter to exit the command.

��:(��:��

� �?��>>?D1D5�1�?=@?>5>D)C��>CE<1D9?>

�� Select Annotation/Database Fields/Insulation .

�� The prompt



�� The prompt






�� The prompt



�>>?D1D9?>��5>E

�>>?D1D9?>�4�$?G��?��?@93C


�

�� #��This area provides procedures that explain how to perform common line number annotation tasks.

��)!��.��"7��

This selection will place a short line number description in the form:

/LQH�1XPEHU��6SHFLILFDWLRQ��0DLQ�6L]H

� �?��<135��8?BD��9>5�E=25B��>>?D1D9?>

�� Select Annotation/Line Number/Line No. Short .

�� The prompt


displays. Select the component whose line number you wish to annotate. It is important to note that thepoint you specify becomes the anchor to the annotation’s leader line, so select the point where you wantthe leader line to connect to the component, then press Enter.

�� The prompt


displays. Pick the location where the annotation text will be placed. Annotation styles and placementoptions are established in the Annotation Preferences dialog.




�� The prompt


is re-displayed. Pick another component to continue placing line number annotation, or press Enterwithout picking a point to exit the command.

��.��.��"7��

This selection will place a long line number description in the form:

/LQH�1XPEHU��6SHFLILFDWLRQ��0DLQ�6L]H��&RPPRGLW\��LI�VSHFLILHG��,QVXODWLRQ��LI�VSHFLILHG�

� �?��<135��?>7��9>5�E=25B��>>?D1D9?>

�� Select Annotation/Line Number/Line No. Long .

�� The prompt



�>>?D1D9?>��5>E

�>>?D1D9?>�4�$?G��?��?@93C


�� The prompt


displays. Pick the location where the annotation text will be placed. Annotation styles and placementoptions are established in the Annotation Preferences dialog.




�� The prompt



��)!��.��"7��%��!#��)+"7��

This selection will place a short line number description with a centerline symbol in the form:

&HQWHUOLQH�6\PERO��/LQH�1XPEHU��6SHFLILFDWLRQ��0DLQ�6L]H

� �?��<135��8?BD��9>5�E=25B��>>?D1D9?>�G9D8�5>D5B<9>5��I=2?<

�� Select Annotation/Line Number/Line No. Short w/CL .

�� The prompt



�� The prompt


displays. Pick the location where the annotation text will be placed. Annotation styles and placementmethods are established in the Annotation Preferences dialog.




�� The prompt



�>>?D1D9?>��5>E

�>>?D1D9?>�4�$?G��?��?@93C


�

��.��.��"7��%��!#��)+"7��

This selection will place a long line number description with a centerline symbol in the form:

&HQWHUOLQH�6\PERO��/LQH�1XPEHU��6SHFLILFDWLRQ��0DLQ�6L]H��&RPPRGLW\��LI�VSHFLILHG��,QVXODWLRQ�LI�VSHFLILHG�

� �?��<135��?>7��9>5�E=25B��>>?D1D9?>�G9D8�5>D5B<9>5��I=2?<

�� Select Annotation/Line Number/Line No. Long w/CL .

�� The prompt



�� The prompt


displays. Pick the location where the annotation text will be placed. Annotation styles and preferences areestablished in the Annotation Preferences dialog.




�� The prompt



��#��This area provides procedures that explain how to perform common note annotation tasks.

(��

� �?��>C5BD�1��5>5B1<�?D5

�� Select Annotation/Notes/Gen Note .

�� The prompt


displays. Select an anchor point in the drawing then press Enter.

�� The prompt

Enter location:

displays. Pick a point in the drawing to place the notes.

�� The Edit Mtext dialog is displayed, with the words “General Notes” already completed. Type additionalnotes below this header, using the formatting controls available in this dialog if desired. Press OK whendone to close the dialog. The text is top-left justified at the specified point.

�>>?D1D9?>��5>E

�>>?D1D9?>�4�$?G��?��?@93C


�� Three commands are available for annotating elevation values in a model. Elevation values can reflect theTop of Pipe (TOP), Center of Pipe (COP) or the Bottom of Pipe. The placement procedure for these types ofannotation differs only in the initial command selection.

� �?��>C5BD��<5F1D9?>��>6?B=1D9?>

�� Select one of the following commands, depending on the type of elevation annotation desired:

Annotation/Elevation/TOP Elevation

Annotation/Elevation/COP Elevation

Annotation/Elevation/BOP Elevation

�� The prompt


displays. Pick the point on the component whose elevation is to be annotated. The point you pickbecomes the anchor of the annotation’s leader line.

�� The prompt


displays. Select the point where the annotation will be placed.

�� The editing prompt



�� The prompt:


is re-displayed. Select another anchor point to place and define a new elevation or press Enter to exit thecommand.

�>>?D1D9?>��5>E

�>>?D1D9?>�4�$?G��?��?@93C


�

�� #��This area provides procedures that explain how to perform common coordinate annotation tasks.

��2�)2��#��-��

� �?��>>?D1D5�1��??B49>1D5

�� Select one of the following commands:

Annotation/Coordinates/NE Coordinate .

Annotation/Coordinates/NS Coordinate

Annotation/Coordinates/EW Coordinate

�� The prompt


displays.

�� The prompt


displays. Pick the point in the drawing where the North and East coordinate location information will beplaced. The selected point becomes the anchor point of the leader line.



is displayed. This prompt enables you to edit the existing annotation elements. If the coordinate requiresno changes, press X to exit the editing mode.

�� The prompt:


is re-displayed. Select another anchor point to place and define a new coordinate or press Enter to exit thecommand.

��#��-��

� �?��>>?D1D5�1��5>5B1<�??B49>1D5

�� Select Annotation/Coordinates/ Coordinate .

�� The prompt


displays. Pick the exact coordinate that you want to annotate.

�� The prompt


displays. Select a second point to place the annotation in the drawing. The coordinate annotationexpresses the X,Y,Z values of the coordinate.

��

There are two types of reports available in this menu. The Bill of Materials option generates aBOM for placement in the current drawing. The Generate Reports option enables you to directoutput to a file or a viewing window, and to customize the type of report and the informationcontained in it.

OVERVIEW 9-2

BILL OF MATERIALS 9-2

GENERATE REPORTS 9-19

� � � � �

5@?BDC��5>E

/F5BF95G


�� There are two types of reports available in this menu. The Bill of Materials option generates a BOM forplacement in the current drawing. The Generate Reports option enables you to direct output to a file or aviewing window, and to customize the type of report and the information contained in it.

These commands may also be executed via the Reports toolbar. This toolbar is available as a flyout toolbarfrom the main Piping Functions toolbar, or may be displayed separately by selecting Toolbars/FunctionToolbars/Reports.

��

PIPING and ISOMETRICS provide a Report/Bill of Materials option, which displays the dialog shown below.This dialog enables you to set the parameters that will be used to format a BOM for placement in the currentdrawing. It extracts data from component information in the current, or from multiple drawing’s externaldrawing database(s).

AUTO-ISO provides a Bill of Materials Configuration command to enable you to configure the format of theBOM output that will be placed on generated isometric drawings. AUTO-ISO will use the last BOMconfiguration defined to format the generated BOM. In order to automatically place a BOM on an iso, youmust also enable the Auto Bill of Materials check box in the Control Settings dialog.

5@?BDC��5>E

59<<�?6��1D5B91<C


�� 1. The content of the BOM is controlled by the Report selected. Select the desired Report, and set the other

options as desired.

2. If you want to customize the format (font, line type, column, etc.) press the Options button. A tabbeddialog will display to enable you to customize the format of the BOM.

�� When you have finished defining the BOM options, press OK. The Drawing Selection Optionsdialog will display to enable you to define the selection set of components that you want toappear in your BOM. When you have finished defining the selection set, the BOM will beplaced on the drawing using the method that you defined in the General tab of the Bill ofMaterials Configuration dialog.

A description of all of the options in this dialog is provided below.

�� The Report drop-down list enables you to select the report file that will be used to process the componentdata that will be presented in the generated BOM. The following BOM reports are provided with thesoftware:

� BOMCADCutLengths: uses the BOMCUTLN.RPT Report File to generate a BOM that lists cut-lengths ofpipe individually and then all other components grouped by size.

� BOMCADStandard: uses the BOMCAD.RPT file to generate a BOM that accumulates pipe lengths by size.

� BOMCADSFCutLengths: uses the BOMSFCUT.RPT Report File to generate a BOM that also lists pipe cutlengths individually, and sorts the remaining components in the report into shop and field components.

� BOMCADMaintenance: uses the BOMMAINT.RPT file to generate a BOM that lists pipe cut lengths andall components individually.

� BOMTotal: Uses BOMTOTAL.RPT file to generate a BOM with accumulated cutlengths and weight.

� BOMWeight: uses BOMWEIGHT.RPT to generate a BOM with accumulated pipe lengths and weights.

� BOMRounded: uses the ROUNDED.RPT to generate a BOM that lists cutlengths rounded up to thenearest foot or meter and then all other components grouped by size.

5@?BDC��5>E

59<<�?6��1D5B91<C


�� This read-only field displays the path to the currently selected report name. The report files can becustomized directly with the Crystal Reports application.

�� Units The units reported on the Bill of Materials. The units on the BOM can be different than the units in the

current drawing. The choices are Metric, Imperial, and Mixed Metric.

Precision Select the level of precision reported for pipe lengths.

Bore Precision Allows you to select a different bore precision for mixed metric units ONLY.

Suppress 0 Feet/Inches These options are read-only, and display the settings as set for by AutoCAD’s DIMZIN environmentvariable. Only the imperial (architectural) settings are currently honored. Refer to your AutoCADdocumentation for more information.

��Omit Codes Whenever you place an AutoPLANT component the SORT_CODE value from its spec record is written to its

drawing database record (e.g., SORT_CODE=17 for pipe, and SORT_CODE=1 for Weldneck Flange). Thisvalue controls which components will be omitted from B.O.M. processing. Components whose sort order codeis greater than this value are omitted from the BOM. If an invalid omit code is entered (i.e., <=0 or a blankspace or a non-numeric value), this will effectively turn off the OMIT CODES option, allowing the report togenerate all records into the output.

Ignore ExistingComponents

Components can be marked as Existing to distinguish between components that already exist in the field, andthose which are part of new design configurations. This enables you generate a Bill of Materials that reflectsonly components that are new to the design. Enable the Ignore Existing Components check box to omitcomponents marked as Existing from the BOM.

In PIPING and ISOMETRICS, you can use the Database Tools/Update Components command to define aselection set of components to mark as existing, or set this value for individual components using theDatabase Tools/Edit Component command.

Clean DatabaseFasteners

This option removes those fasteners that are no longer used for connecting components. For example if apipe is welded to an elbow and the elbow is removed but the weld is left, this action will remove the weld fromthe pipe.

Append Pipe EndPreparations

Adds pipe end preparation to the end of the pipe description in a report. ( e.g. BE X PE or BBE etc.) A methodexists for all components, %20B'(6&5B0(7+2', that determines how the BOM descriptions are generated.This method is stored in ..\BASE\COMMON\BOMDESCR.EBS. Any component that does not have thismethod will inherit the default from the %$6(B&20321(176B&/$66. During BOM generation if the flags forappending topworks descriptions and pipe end code preparations are set in the user interface a temporarypiping system variable is set and read by the script. The script will act on this variable as shown below for thepipe end preparations:

status = at_Preference_getString(appendDescription, "AppendPipeEnds")If ((status = AT_SUCCESS) And (appendDescription = "1")) ThenendsCode = at_Pipe_getEndsDescription (compID)

To determine the pipe end preparations the file PIPEENDS.INI is scanned from the current configuration, forImperial for example look in the file ..\CONFIG\IMPERIAL\PIPEENDS.INI.

Append TopworkDescriptions

Adds topworks description to the end of a valve's description in a report. A method similar to that explained forthe Pipe End Preparation is used for the topwork's descriptions being appended to the valve descriptions.

AscendingSort_Code Order

When enabled, this option will list the components in the BOM in a ascending order using the SORT_CODEvalues. For example, the default pipe SORT_CODE=17, and the Weldneck Flange SORT_CODE=1. In theBOM, the Weldneck Flange will be listed first and pipe second because of the SORT_CODE values. If thisoption is not enabled, then the components will be listed in a descending order using the SORT_CODEvalues.

5@?BDC��5>E

59<<�?6��1D5B91<C


�� When the BOM executes in PIPING it will update the necessary material tag fields according to the selectionmade. However, material tag balloon annotation will only be placed in ISOMETRICS/AUTO-ISO. Whentagging attempts to create balloons for the tags in a PIPING drawing a warning message is issued, indicatingthat the material database tags have been updated only (no graphics will be generated). If you want to placematerial balloon tags in a PIPING drawing after a BOM has been generated, you may do so using the newAnnotation/Tags/Material Tags command.

Tag Format The option enables you to specify how you want the balloon material tags formatted. Two options areavailable.

Starting Tag Number The text box enables you to explicitly define the starting number for material tagging of components.

No Material Tags Enable this option to disable the placement of material tags on each component. Enabling this radiobutton will automatically disable the associated Show Material Tags, Fastener Tags, and Support Tagsoptions.

Update Material Tags Enable this option to update the MAT_MARK field with the new material tag for component records in theexternal drawing database.

Reinsert Material Tags Enable this option to automatically update existing material balloon tags that may have been placed froma previous BOM run.

Do Not Update ExistingMaterial Tags

Enable this option to leave the existing tags and use them in the BOM, then only generate and placematerial tags for new items that were not tagged from the previous BOM run.

Show Material Tags

Show Fastener Tags

Show Support Tags

This option is only available when generating a BOM with AutoPLANT ISOMETRICS or AUTO-ISO. Ifenabled, the system will attach a material balloon tag to each component in the report selection set. Thistechnique makes it easy to pair components in the drawing with records in the report. If the ShowMaterial Tags check box is enabled, the Show Fastener Tags and Show Support Tags options willalso be made available to enable you to optionally display tags for supports and fasteners.

�� Refer to the Bill of Materials folder in the AutoPLANT Program Customization help file forcustomization information. This help file may be displayed by selecting AutoPLANT3D/Customization Tools and Help/AutoPLANT Program Customization from your Windows Startmenu.

5@?BDC��5>E

59<<�?6��1D5B91<C


�� The Options button on the Bill of Materials dialog displays another dialog that enables you to customize theformat of your BOM. This includes the line type and thickness, title, and the data columns that will actuallybe presented in the BOM output. Click below for more information on BOM configuration options.

The Reports/Bill of Materials command in PIPING/ISOMETRICS uses a format configuration to determinehow the BOM output is formatted on the drawing. This includes the line type and thickness, title, and the datacolumns that will actually be presented in the BOM output. The Bill of Materials Configuration dialog shownbelow displays by pressing the Options button on the main BOM dialog. It enables you to select the formatconfiguration that you want to use to generate your BOMs. New configurations may be created and existingconfigurations may be modified in this dialog.

AUTO-ISO provides a Bill of Materials Configuration command to enable you to configure the format of theBOM output that will be placed on generated isometric drawings. AUTO-ISO will use the last BOMconfiguration defined to format the generated BOM. In order to automatically place a BOM on an iso, youmust enable the Auto Bill of Materials check box in the Control Settings dialog.

When the Bill of Materials Configuration dialog displays, select a configuration from the drop-down list inthe General tab to make it active. The selected configuration will be used when you generate a BOM. Whenyou select a configuration from the drop-down list, the settings currently defined for that configurationdisplay in each tab of the dialog. Also note that the active configuration name always displays in the dialog’stitle bar for reference. You can modify any of the active configuration’s settings in the dialog tabs. BOMformat configuration settings are saved locally, which means that each user may have his own set of BOMformat configurations.

�� If you are running AUTO-ISO and have enabled the Bill of Materials check box in the AnnotationOptions/Component Data dialog, AUTO-ISO will use the last known BOM configuration to place theautomatic BOM on your isometrics. You can run the Annotation Options/Bill of Materialscommand to set these options for AUTO-ISO.

5@?BDC��5>E

59<<�?6��1D5B91<C


��7�5/�#��

The General Tab in the Bill of Materials Configuration dialog enables you to create/modify BOM formatsettings. When you select a format from the drop-down list, all settings previously defined for that format willappear in this tab and all of the other tabs of this dialog to enable you to view/modify these settings. You canalso create new format configurations on this tab.

A description of each of the settings in the General tab is provided below:

5@?BD��?B=1D�?>697EB1D9?>

The Format drop-down lists all of the available BOM format configurations. The configuration that youselect is used to generate your BOM. When you select a configuration from the drop-down list, the settingsdefined for that configuration display in all of the options in the dialog tabs. The active configuration namealways displays in the dialog’s title bar. If you modify a value on any of the tabs it will be saved locally withthe selected configuration. The following format configurations are provided:

� Standard: standard BOM with columns: MAT_MARK, TYPE, SIZE, SHORT_DESC, and QUANT.

� ThickBorder: same as standard BOM with a thicker surrounding border line.

� MarkAndDescription: BOM with columns: MAT_MARK, TYPE, LONG_DESC, and QUANT.

� TallRows: BOM with larger row height and columns: MAT_MARK, TYPE, LONG_DESC, andQUANT.

� NarrowRows: BOM with smaller column width and columns: MAT_MARK, TYPE, SIZE,SHORT_DESC, and QUANT.

Press the New button to add a new configuration, or press Delete to delete the current configuration. BOMconfigurations are stored locally, therefore, each user may have a set of BOM format configurations.

5@?BDC��5>E

59<<�?6��1D5B91<C


�<135=5>D��5D8?4

There are three placement methods available: Node, Origin and By Pick. These options determine how theBill of Materials is placed on the drawing.

� Node: The application will search for the node name entered in this field. The BOM will be placed at thenode listed in this field, from the corner defined in the Placement Corner area of this dialog. This optionis primarily used by AUTO-ISO to enable you to insert a node at the location that you want automaticBOMs placed on the drawing. This will enable you to run AUTO-ISO in batch mode to generate severalisometrics in one run without being prompted to pick the location of the BOM on each drawing. A BOMnode can be placed in your AUTO-ISO template drawing manually entering the command(at_border_addnode nodename nodelocation) where: nodename is the name of your node andnodelocation is the XY coordinate that defines the node location with respect to the plant origin.

� Origin: If Origin is selected, the BOM will be placed at the origin. By default, the origin is defined as(0,0), but you can enter new origin XY coordinates in the fields provided. The BOM will be placed atthis point, from the corner defined in the Placement Corner area of this dialog.

� By Pick: If this option is enabled, the application will prompt you to pick the BOM insertion point, thento specify the Placement Corner from which the BOM will be drawn.

�<135=5>D�?B>5B

The BOM placement method is defined in the Placement group in the General tab. The Placement Corneroptions define which corner of the BOM is placed at the insertion point. Options are as follows:

� Upper Left

� Lower Left

� Upper Right

� Lower Right

The BOM will be drawn from the corner specified.

�?B45B��B?@5BD95C

The Border Properties define the properties of the Bill of Materials border. This is the line that surrounds allof the cells in the table including the headers and the report title.

� Layer: Enter the drawing layer name where you want the generated BOM placed. If the layer does notexist in the drawing, it will be created automatically before placing the Bill of Materials. If this field isleft blank, the BOM will be placed on the current drawing layer.

� Line Type: The AutoCAD name for a line with pre-defined properties. These include continuous lines,and others that are a combination of lines, dots, dashes, and spaces. Refer to your AutoCADdocumentation for the list of linetypes and their corresponding names. If you do not want lines at all, setthis field value to none (must be all lowercase letters).

� Weight: The thickness of the line in current units.

� LTScale: The relative length of dash-dot line types per drawing unit.

5@?BDC��5>E

59<<�?6��1D5B91<C


�5HD��66C5D

The distance the text is offset from the vertical borders and column lines as measured in current drawingunits.

5G

Press this button to add a new BOM format configuration. The following dialog displays to enable you toenter the new format configuration name. Enter the configuration name and press OK. The new configurationwill appear in the selection list. Select the configuration to set/modify its settings.

�5<5D5

Press this button to delete the configuration currently selected. You will be prompted to confirm the deletion.

��7�5/�#��

These settings define how the Bill of Materials Title is formatted. The title will appear at the top of the report.

A description of the fields in this tab is provided below:

Title String The text that appears in the title of a Bill of Materials report. The default value is “Bill of Materials.

Height The height of the text.

Spacing The spacing applied above and below the text in the BOM.

Style The name of an AutoCAD font style that will be used to format the text.

Line Type The AutoCAD name for a line with pre-defined properties. These include continuous lines, and others that are acombination of lines, dots, dashes, and spaces. Refer to your AutoCAD documentation for the list of linetypes andtheir corresponding names. If you do not want lines at all, set this field value to none (must be all lowercase letters).

Line Weight The thickness of the line in current units.

LTScale The relative length of dash-dot line types per drawing unit.

5@?BDC��5>E

59<<�?6��1D5B91<C


$��-��7�5/�#��

These settings define how Bill of Materials Headers are formatted. Headers separate groups of objects in thereport, such as “Shop” and “Field.”





Line Type The AutoCAD name for a line with pre-defined properties. These include continuous lines, and others that are acombination of lines, dots, dashes, and spaces. Refer to your AutoCAD documentation for the list of linetypes andtheir corresponding names. If you do not want lines at all, set this field value to none (must be all lowercaseletters).



5@?BDC��5>E

59<<�?6��1D5B91<C


*�%��7�5/�#��

These settings define how the Bill of Materials rows in individual sections are formatted.





Line Type The AutoCAD name for a line with pre-defined properties. These include continuous lines, and others thatare a combination of lines, dots, dashes, and spaces. Refer to your AutoCAD documentation for the list oflinetypes and their corresponding names. If you do not want lines at all, set this field value to none (must beall lowercase letters).



5@?BDC��5>E

59<<�?6��1D5B91<C


#��"��7�5/�#��

These settings define the properties of the Bill of Materials lines and columns.


�561E<D�?<E=>��9>5

� Line Type: The AutoCAD name for a line with pre-defined properties. These include continuous lines,and others that are a combination of lines, dots, dashes, and spaces. Refer to your AutoCADdocumentation for the list of linetypes and their corresponding names.

� Line Weight: The thickness of the line in current units.

� LTScale: The relative length of dash-dot line types per drawing unit.

�B?@5BD95C

� Column Name: The column Name drop-down lists the fields that will appear as columns in the generatedBOM. Press Organize to display a dialog to select the fields that you want to appear as columns in theBOM output. To add a field, simply select if from the left list, then press Add. To remove a field, select itfrom the right list and press Remove. Columns will appear in the BOM output in the order that theyappear in the Current list. You can change the order of a field by selecting the field in the Current listand pressing the Up or Down Arrows to move the field to the desired position. When you are finishedselecting and arranging the column fields, press OK. The column Name drop-down contains a list of all ofthe selected column fields.

5@?BDC��5>E

59<<�?6��1D5B91<C


The settings that appear in the remaining Properties group options apply to the currently selected columnName only. This enables you to select each column in the Name drop-down list, then define individualproperties for that column. When you select a column name from the list the settings defined for that columnwill display.

Column Header This field enables you to define the text that appears at the top of a column. Select acolumn Name from the drop-down list, then enter the desired header in the field provided.Repeat this process for each column Name.

Justification This field enables you to define how the text in a column is justified horizontally within thecolumn cell. Select a column Name from the drop-down list, then select the desiredJustification from the drop-down list (options include L (Left), C (Center), and R (Right)).Repeat this process for each column Name.

Line Type The AutoCAD name for a line with pre-defined properties. These include continuous lines,and others that are a combination of lines, dots, dashes, and spaces. Refer to yourAutoCAD documentation for the list of linetypes and their corresponding names. If you donot want lines at all, set this field value to none (must be all lowercase letters).



Width The width of the column in current units.

�� The system is delivered with an option to omit certain components from a report. If a component hasa SORT_CODE field value greater than the field specified under the field entry OmitCodes = 99 in the file ..\USERS\REPORTS\RPTOPT.INI, then these components will be omitted from the report.You can manually modify this assignment to change the results.

�� #��This area of the help provides procedures specific to the generation of a Bill of Materials on your CADdrawing using the Reports/Bill of Materials command.

��5��

The Reports/Bill of Materials command in PIPING in ISOMETRICS generates a report for placement on adrawing. AUTO-ISO provides a BOM Configuration option to enable you to set the format of BOMsautomatically placed on generated isometric drawings. The procedure to generate a BOM fromPIPING/ISOMETRICS is provided below.

� �?��5>5B1D5�1��9<<�?6��1D5B91<C

�� Select Reports/Bill of Materials to display the Bill of Materials dialog.

�� Select the desired Units and Precision, then define the remaining options in the dialog byenabling/disabling the options as desired.

�� If you want to create/modify the format of the BOM (linetype, font, column, title, etc.), press the Optionsbutton.

�� When you have finished configuring the BOM, press OK to generate the BOM.

�� The Drawing Selection Options dialog displays. Define the selection set of components that you want toappear on the BOM using the tools presented in this dialog.

�� If the Material Tags option was enabled, these tags are placed now.

5@?BDC��5>E

59<<�?6��1D5B91<C


�� The placement of the BOM is determined by the Placement option selected in the General tap of the Billof Materials Configuration dialog. The default is placement by pick point to define the upper left cornerof the BOM. The following prompt displays:

Select upper left point:

�� Pick a point in the model (or in Paper Space) to place the BOM.

�� The Bill of Materials will place a formatted report in the current drawing. To generate reports whichare output to a viewing window or a file, use the Reports/Generate Reports option.

)��!�5/��"��#��

� �?�3ECD?=9J5�D85��9<<�?6��1D5B91<C

�� Select Reports/Bill of Materials to display the Bill of Materials dialog

�� Press Options to display the Bill of Materials Configuration tabbed dialog.

�� The current BOM format configuration is selected in the Configuration field on the General tab. Whenyou select a format configuration from this tab, all of the settings defined for that configuration willdisplay in the tabs in the dialog.

�� If you modify a setting for the current configuration, it will be saved in a local configuration file.Therefore, the next time you select that format configuration the last settings will display as the default.

�� Select the desired format configuration, then press OK to close the dialog.

�--2��-��+�5/��"��#��

The format of the border, lines, text, column, etc. of a BOM that is placed on a drawing is stored in a BOMformat configuration. The shipping version of the software provides several sample format configuration tochoose from. These formats may be modified, or new ones created. The following procedure explains how tocreate a new BOM format configuration.

� �?�B51D5�1�5G��?B=1D�?>697EB1D9?>

�� Select Report/Bill of Materials to display the Bill of Materials main dialog.

�� Press Options to display the tabbed Bill of Materials Configuration dialog. The format configuration thatwill be used when you generate a BOM may be selected from the Configuration drop-down list on theGeneral tab in this dialog.

�� When you select a configuration, all of the settings that are defined for that configuration will display inthe fields of each tab on the dialog. The current active configuration always displays in the Title bar ofthe dialog for reference.

�� To modify a configuration, simply select it from the list in the General tab, then modify the desiredparameters. The configuration will be saved locally, so that each user may modify and have his own setof configurations on their local drive.

�� To add a new configuration, press New. A dialog displays to enable you to enter the name of the newconfiguration. Enter the new name and press OK. The new configuration will become the selectedconfiguration in the drop-down list. Define the parameters for the configuration in each of the tabs. Thenew configuration and its settings will be saved locally.

�� When you are finished adding/modifying configurations, select the configuration that you want to applyto the next generated BOM in the General tab, then press OK to close the dialog.

5@?BDC��5>E

59<<�?6��1D5B91<C


)��!�5/��"��!�-

The format of the border, lines, text, column, etc. of a BOM that is placed on a drawing is stored in a BOMformat configuration. The shipping version of the software provides several sample format configuration tochoose from. These formats may be modified, or new ones created by pressing the Options button in the Billof Materials dialog. The following procedure explains how to modify the method used to place a BOM onyour drawing.

� �?��5D�D85��<135=5>D��5D8?4

�� Select Reports/Bill of Materials to display the Bill of Materials dialog. Press Options to display the Bill ofMaterials Configuration dialog.

�� Select the BOM format Configuration that you want to use/modify in the General tab.

�� The Placement area on the General tab enables you to specify the method that you want to use to placethe BOM.

�� Select By Node and then enter the BOM node name if you have previously defined and placed a node onthe drawing to define the BOM insertion point. A BOM node may be placed by manually entering thecommand

(at_border_addnode nodename nodelocation)

where: QRGHQDPH is the name of your node and QRGHORFDWLRQ is the XY coordinate that defines the nodelocation with respect to the plant origin. Select Origin to place the BOM at the origin. By default, theorigin is defined as (0,0), but you can enter new origin XY coordinates in the fields provided. Select ByPick to instruct the function to prompt you for the insertion point every time you place a BOM.

�� The final step is to define which corner of the BOM is placed at the insertion point. This is accomplishedby enabling the desired radio button in the Placement Corner area of the General tab.

�� Press OK to save the format configuration settings. These settings are saved locally to enable each user tohave their own set of BOM format configurations.

)��!�5/�5��-��

The format of the border, lines, text, column, etc. of a BOM that is placed on a drawing is stored in a BOMformat configuration. The shipping version of the software provides several sample format configuration tochoose from. These formats may be modified, or new ones created by pressing the Options button in the Billof Materials dialog. The following procedure explains how to modify the properties of the border that will bedrawn around the BOM placed on your drawing.

� �?��5D�D85��<135=5>D��5D8?4



�� The properties of the border that surrounds the BOM are defined in the Border Properties area of theGeneral tab.

�� Enter the name of the layer where you want the BOM drawn in the Layer field. If this layer does not existit will be created for you. If you leave this field blank, the BOM will be drawn on the current layer.

�� Enter the desired line type in the Line Type field. This must be an AutoCAD name for a line with pre-defined properties. These include continuous lines, and others that are a combination of lines, dots,dashes, and spaces. Refer to your AutoCAD documentation for the list of line types and theircorresponding names.

�� Enter the desired thickness of the border lines in the Line Weight field in current units.

5@?BDC��5>E

59<<�?6��1D5B91<C


�� Enter the relative length of dash-dot line types per drawing unit in the LT Scale field.

� Press OK to save the format configuration settings. These settings are saved locally to enable each user tohave their own set of BOM format configurations.

)��!�5/�$��-��

The format of the border, lines, text, column, etc. of a BOM that is placed on a drawing is stored in a BOMformat configuration. The shipping version of the software provides several sample format configuration tochoose from. These formats may be modified, or new ones created by pressing the Options button in the Bill ofMaterials dialog. The following procedure explains how to modify the properties of the Header text used toplace a BOM on your drawing. Headers separate groups of objects in the report, such as “Shop” and “Field.”

� �?��5D�D85��<135=5>D��5D8?4



�� Click on the Header tab to display the properties used to format the BOM Header text.

�� Enter the text height, spacing above and below the text, and the AutoCAD font style that you want to useto format the Header text in the Height, Spacing, and Style fields.





)��!�5/��

The format of the border, lines, text, column, etc. of a BOM that is placed on a drawing is stored in a BOMformat configuration. The shipping version of the software provides several sample format configuration tochoose from. These formats may be modified, or new ones created by pressing the Options button in the Billof Materials dialog. The following procedure explains how to modify the Title that will be placed at the topof the BOM on your drawing.

� �?��5D�D85��<135=5>D��5D8?4



�� Click on the Title tab to display the BOM Title properties.

�� Enter the title that you want to appear at the top of your BOM in the Title field.

�� Enter the text height, spacing above and below the text, and the AutoCAD font style that you want to useto format the Title text in the Height, Spacing, and Style fields.


5@?BDC��5>E

59<<�?6��1D5B91<C



� Enter the relative length of dash-dot line types per drawing unit in the LT Scale field.


)��!�5/�*�%��

The format of the border, lines, text, column, etc. of a BOM that is placed on a drawing is stored in a BOMformat configuration. The shipping version of the software provides several sample format configuration tochoose from. These formats may be modified, or new ones created by pressing the Options button in the Billof Materials dialog. The following procedure explains how to modify the properties of the text in the row ofthe BOM placed on your drawing.

� �?��5D�D85��<135=5>D��5D8?4



�� Click on the Row tab to display the properties used to format the text in each BOM row.

�� Enter the text height, spacing above and below the text, and the AutoCAD font style that you want to useto format the Row text in the Height, Spacing, and Style fields.





)��!�5/�#��"��

The format of the border, lines, text, column, etc. of a BOM that is placed on a drawing is stored in a BOMformat configuration. The shipping version of the software provides several sample format configuration tochoose from. These formats may be modified, or new ones created by pressing the Options button in the Billof Materials dialog. The following procedure explains how to modify the columns used to place a BOM onyour drawing.

� �?��5D�D85��<135=5>D��5D8?4



�� Click on the Column tab to display the properties used to format and select the columns that will appearin your BOM.

�� In the Default Column Line group, enter the desired line type in the Line Type field. This must be anAutoCAD name for a line with pre-defined properties. These include continuous lines, and others that area combination of lines, dots, dashes, and spaces. Refer to your AutoCAD documentation for the list ofline types and their corresponding names. Enter the desired thickness of the border lines in the LineWeight field in current units. Enter the relative length of dash-dot line types per drawing unit in the LT

5@?BDC��5>E

59<<�?6��1D5B91<C


Scale field.

�� The Name drop-down list includes the columns that will appear in your BOM. Press Organize to add orremove columns from the BOM. The fields shown in this dialog are defined configured in eachconfiguration’s CONFIG.INI file in the [Reports] group. This list much match what is actually reportedin the Report File (*.RPT) file. Obviously as we read the output from this file the columns must exist.When you are finished selecting the fields to include in the BOM, press OK to return to the Column tab.Use the arrows to position each field in the order that you want them to appear in the BOM output.

�� The remaining fields in the Properties area of the dialog enable you to configure the format propertiesfor each column in the BOM output. To configure a columns properties, select the column from theName list, then define its properties as follows.

�� Enter the Title that you want to appear for the selected column in the Header field. Select the way youwant the header text justified within the column header box from the Justification drop-down list. Enterthe desired line type in the Line Type field. This must be an AutoCAD name for a line with pre-definedproperties. These include continuous lines, and others that are a combination of lines, dots, dashes, andspaces. Refer to your AutoCAD documentation for the list of line types and their corresponding names.Enter the desired thickness of the border lines in the Line Weight field in current units. Enter the relativelength of dash-dot line types per drawing unit in the LT Scale field. Enter the width of the column in theWidth field.


�� !��

$�%��&'

The following provides a brief overview of the process that the Bill of Materials function executes to generateand place a BOM on a drawing.

The BOM function uses Seagate Software’s® Crystal Reports™ run-time engine to process the componentdata that will appear in the report output. When you generate a BOM, the Drawing Selection Options dialogdisplays to enable you to define the selection set of components in the current drawing, or across multipledrawings (including xrefs). The BOM function extracts the component drawing database records defined inthe selection set from the drawing databases into a temporary database. It then cleans this database, removingrecords for components that no longer exist in the drawing, and re-calculates the pipe cut lengths.

Now that the temporary databases is ready, the function runs the report writer (run-time version of CrystalReports) which extracts the data from the temporary databases, and processes it using the selected Report file.The report file is basically a Crystal Reports report file (*.RPT), that contains filters that define the actualfields that will appear in the BOM and how they will be presented (e.g., show pipe cut lengths as a total, orshow individually). The report writer takes this data, along with the formatting options configured in the Billof Materials configuration dialog, and generates a text file. This text file is formatted in a special way that isrequired by a LISP pre-processor that then actually draws the BOM on the drawing.

*� ��

The Reports that are available for selection in the Bill of Materials dialog are configured to use a specificCrystal Reports (*.RPT) file to process the component data. You must purchase this software in order togenerate a new Report File for use with this function. The software currently ships several Crystal Reports(*.RPT) files that are configured for use with the software.

You should use these Report Files as templates to create your own report files. The fields that are availablefor BOM output are defined in the >5HSRUWV@ group of each configuration’s CONFIG.INI file. This groupcontrols the available fields in the Name field in the Column tab of the Bill of Materials Configuration dialog.If you create a new RPT file that contains new fields that you want to appear on your BOM, you must add thefield to the &ROXPQV variable assignment in that group.

5@?BDC��5>E

�5>5B1D5�*5@?BDC


Once you have created a new RPT file, you should must create a new BOM Report and configure it to use thenew RPT file to make it available in the Bill of Materials dialog.

�� The Generate Reports option displays a dialog to enable you to generate a report that can be sent to theprinter, a file, or pre-viewed in a separate window on-screen. You can select between default report types, orcreate unique reports that can be generated on the current drawing or on a project-wide basis. Options areprovided to enable you to define the units, precision, and whether or not existing components are presented inthe report output.

A description of the settings in each area of this dialog is provided below:

5@?BDC��5>E

�5>5B1D5�*5@?BDC


�� Four Report Types are available: BOM, EQUIPMENT LIST, NOZZLE TAKEOFF, and USER1. Afterselecting a report type, the Report Name field is filtered with the list of reports associated with that type.

+ BOM: Bill of Materials list for the current drawing or the selection set. Note that the Generate Reportsoption will allow you to generate a Bill of Materials for more that one drawing if the Build Selectionoption is enabled.

+ EQUIPMENT LIST: Generates a list of the equipment in the model (or the selection set). Can only be usedto report on equipment that was generated using AutoPLANT EQUIPMENT.

+ NOZZLE TAKEOFF: Generates a standard nozzle-takeoff schedule. Can only be used to report on nozzlesthat were placed using AutoPLANT EQUIPMENT.

Report Types may be added/modified in the following dialog that displays by pressing the Configure buttonnext to the Report Type drop-down list in the Report Generator dialog.

This dialog enables you to add Reports Types available for selection in the Report Generator dialog. ReportTypes are saved in RPTTYPE.INI in the format shown below.

>%20@

'HVFULSWLRQ� �5HSRUWV�IRU�%LOO�RI�0DWHULDOV

7DEOH7\SH� �3LSLQJ

'%7\SH� �3ODQW

This file contains a group record for each report type, which indicates the report type, a description that willappear in the Report Type drop-downlist, the table in the external drawing database that will be used, and thedatabase type. Rebis provides pre-defined report types to generate reports based on data in the PIPING,EQUIP, and NOZZLE tables.

�� The Report drop-down list enables you to select the report file that will be used to process the componentdata that will be presented in the generated BOM. The following BOM reports are provided with thesoftware:

+ BOMCADCutLengths: uses the BOMCUTLN.RPT Report File to generate a BOM that lists cut-lengths ofpipe individually and then all other components grouped by size.

+ BOMCADStandard: uses the BOMCAD.RPT file to generate a BOM that accumulates pipe lengths by size.

+ BOMCADSFCutLengths: uses the BOMSFCUT.RPT Report File to generate a BOM that also lists pipe cutlengths individually, and sorts the remaining components in the report into shop and field components.

5@?BDC��5>E

�5>5B1D5�*5@?BDC


+ BOMCADMaintenance: uses the BOMMAINT.RPT file to generate a BOM that lists pipe cut lengths andall components individually.

+ BOMTotal: Uses BOMTOTAL.RPT file to generate a BOM with accumulated cutlengths and weight.

+ BOMWeight: uses BOMWEIGHT.RPT to generate a BOM with accumulated pipe lengths and weights.

+ BOMRounded: uses the ROUNDED.RPT to generate a BOM that lists cutlengths rounded up to thenearest foot or meter and then all other components grouped by size.

The options in the Report Name drop-down list are filtered based on the selected Report Type. Reports maybe added to a Report Type group by pressing the Configure button next to the Report Name drop-down list.

Press the Configure button next to the Report Name field in the main AutoPLANT Report Generator dialog todisplay the dialog shown below.

This dialog enables you to add Reports available for selection in the Report Generator dialog are defined inREPORTS.INI. This file contains a group record for each report type, which indicates the report type, thereport format file, and whether or not the report can be placed on a drawing or output as an external report.

A pre-defined set of reports provided with the application, and you can create and save custom reports. Theoptions in the Report Name drop-down list is filtered based on the selected Report Type. The table below liststhe default Report Names associated with each of the Report Types provided with the software. Theserepresent the default set of reports only. You can easily create a new report name, and associate it with one ofthe Report Types, or create a new Report Type with an entirely new set of reports.

BOM EQUIPMENT LIST NOZZLE TAKEOFF

BOMBRIEF EQUIPSTANDARD NOZZSTANDARD

BOMCUSTOM

BOMCUTLENGTHS

BOMDESIGNER

BOMSFCUTLENGTHS

BOMSTANDARD

5@?BDC��5>E

�5>5B1D5�*5@?BDC


�� This read-only field displays the path to the currently selected report name. The report files can becustomized directly with the Crystal Reports application.

��Omit Codes Whenever you place an AutoPLANT component the SORT_CODE value from its spec record is written to its

drawing database record (e.g., SORT_CODE=17 for pipe, and SORT_CODE=1 for Weldneck Flange). Thisvalue controls which components will be omitted from B.O.M. processing. Components whose sort order code isgreater than this value are omitted from the BOM.

Ignore ExistingComponents

If this switch is enabled, items marked as "Existing" will automatically be excluded from the selected report.Items can be marked as “Existing” in order to distinguish between components which currently exist in the field,as opposed to those which are being added to existing elements.

Clean DatabaseFasteners

This option removes those fasteners that are no longer used for connecting components. For example if a pipeis welded to an elbow and the elbow is removed but the weld is left, this action will remove the weld from thepipe.

PreviousSelection

Select this option to use the same selection set defined in your previous report-building session. This option isuseful when applying the previous filter to a new drawing database or set of databases.

Material TagOptions

The Material Tag Options button displays the dialog shown below to place material tags on the drawing whosegroup numbers correspond with the report that is generated.

When the report executes it will update the necessary material tag fields according to the selection made.However, material tag balloon annotation will only be placed if enabled in ISOMETRICS/AUTO-ISO. Whentagging attempts to create balloons for the tags in a PIPING drawing a warning message is issued, indicatingthat the material database tags have been updated only (no graphics will be generated). If you want to placematerial balloon tags in a PIPING drawing after a report has been generated, you may do so using the newAnnotation/BOM Mark command.

Material Tags

The Tag Format option enables you to specify how you want the balloon material tags formatted. Two optionsare available.

The Starting Tag Number text box enables you to explicitly define the starting number for material tagging ofcomponents.

The Show Material Tags check box is only available when generating a report with AutoPLANT ISOMETRICSor AUTO-ISO. If enabled, the system will attach a material balloon tag to each component in the report selectionset. This technique makes it easy to pair components in the drawing with records in the report.

Tag Options

No Material Tags: Enable this option to disable the placement of material tags on each component.

Update Material Tags: Enable this option to update the MAT_MARK field with the new material tag forcomponent records in the external drawing database.

5@?BDC��5>E

�5>5B1D5�*5@?BDC


Reinsert Material Tags: Enable this option to automatically update existing material balloon tags that may havebeen placed from a previous report run.

Do Not Update Existing Material Tags: Enable this option to leave the existing tags and use them in the report,then only generate and place material tags for new items that were not tagged from the previous report run.

AppendTopworksDescription

Adds topworks description to the end of a valve’s description in a report.

Append PipeEndPreparations

Adds pipe end preparation to the end of the pipe description in a report. ( e.g. BE X PE or BBE etc.)

A method exists for all components, %20B'(6&5B0(7+2', that determines how the BOM descriptions aregenerated. This method is stored in ..\BASE\COMMON\BOMDESCR.EBS. Any component that does not havethis method will inherit the default from the %$6(B&20321(176B&/$66. During BOM generation if the flagsfor appending topworks descriptions and pipe end code preparations are set in the user interface a temporarypiping system variable is set and read by the script. The script will act on this variable as shown below for thepipe end preparations:

status = at_Preference_getString(appendDescription, "AppendPipeEnds")

If ((status = AT_SUCCESS) And (appendDescription = "1")) Then

endsCode = at_Pipe_getEndsDescription (compID)

To determine the pipe end preparations the file PIPEENDS.INI is scanned from the current configuration, forImperial for example look in the file ..\CONFIG\IMPERIAL\PIPEENDS.INI.

AscendingSort_Code Order

When enabled, this option will list the components in the BOM in a ascending order using the SORT_CODEvalues. For example, the default pipe SORT_CODE=17, and the Weldneck Flange SORT_CODE=1. In theBOM, the Weldneck Flange will be listed first and pipe second because of the SORT_CODE values. If thisoption is not enabled, then the components will be listed in a descending order using the SORT_CODE values.

�� Units Select from Imperial, Metric, and Mixed Metric. If the report units differ from the model units, report values will be

converted to the units selected from this list.

Supress 0Feet/Inches

These options are read-only, and display the settings as set for by AutoCAD’s DIMZIN environment variable.Only the imperial (architectural) settings are currently honored. Refer to your AutoCAD documentation for moreinformation.

Precision Select the level of precision to be used in the report.

Bore Precision Allows you to select a different bore precision for mixed metric units ONLY.

��Select a radio button to define how the results of the report should be output. You can direct the report toappear in an on-screen viewing window (from which you can optionally print the report), to be sent directly toan attached Windows printer, or to an ASCII formatted file.

� When this button is pressed, the report is generated. The Selection Data dialog displays to enable you todefine the selection set of components from the current drawing, or across multiple drawings, which willdisplay in the report output. The user must then define the databases to be included in the report and to applyany filters as desired.

�� Refer to the Generate Reports folder in the AutoPLANT Program Customization help file forcustomization information. This help file may be displayed by selecting AutoPLANT/CustomizationTools and Help/AutoPLANT Program Customization from your Windows Start menu.

5@?BDC��5>E

�5>5B1D5�*5@?BDC


�� #��This area of the help lists procedures specific to the generation of a Reports that can output to a Printer, File,or viewed on-screen.

��*� ��

AutoPLANT includes an application called the Rebis Report Writer, which provides a powerful interface forgenerating and modifying reports.

� �?��5>5B1D5�1� 5@?BD

�� Select Reports/Generate Reports . To display the AutoPLANT Report Generator dialog.

�� Select a Report Type. When generating a report for PIPING components, you should select the BOMreport type.

�� The Report Name list box is filtered based on the selected type. Select a type from this list.

�� Select the desired Units, Precision, and define whether or not you want existing components included inthe report by setting the options in the Options group.

�� From the Selection group, determine the set of components that will be included in the report. If the BuildSelection option is enabled, the Drawing Selection dialog will display when Apply is pressed. This willenable you to create a query that filters the components in the current drawing (or across multipledrawings). If the Current Drawing option is selected (the default), a report will be generated based on allthe objects in the current drawing.

�� Select the desired Output. Preview will open a viewing window containing the report. From this windowyou can print the report if desired. Printer will send the report directly to the printer, while Export to Filewill permit you to create a file of user-specified type.

�� After selecting the report type and name, determining the output type, and specifying the selectionoptions, press Apply to begin generating the report. If the Build Selection option was enabled, theDrawing Selection dialog displays. If the Output was set to Preview, a window is opened which containsthe selected report.

�� !��The Report Generator is a common AutoPLANT application that may be launched from any AutoPLANTapplication’s Reports menu. It enables you to generate a report that may be output to a printer, file, ordisplayed on screen in preview mode.

$�%��&'

The following provides a brief overview of the process that the AutoPLANT Report Generator functionexecutes to generate a report.

The Report Generator function uses Seagate Software’s® Crystal Reports™ run-time engine to process thecomponent data that will appear in the report output. When you generate a report, the Drawing SelectionOptions dialog displays to enable you to define the selection set of components in the current drawing, oracross multiple drawings (including xrefs). The Report Generator function extracts the component drawingdatabase records defined in the selection set from the drawing databases into a temporary database. It thencleans this database, removing records for which components no longer exist in the drawing, and re-calculatesthe pipe cut lengths.

Now that the temporary databases is ready, the function runs the report writer (run-time version of CrystalReports) which extracts the data from the temporary databases, and processes it using the selected Report file.

5@?BDC��5>E

�5>5B1D5�*5@?BDC


The report file is basically a Crystal Reports report file (*.RPT), that contains filters that define the actualfields that will appear and how they will be presented and formatted in the report.

*� ��

The Reports that are available for selection in the Report Generator dialog are configured to use a specificCrystal Reports (*.RPT) file to process the component data. You must purchase this software in order togenerate a new Report File for use with this function. The software currently ships nine Crystal Reports(*.RPT) files that are configured for use with a specific report name and/or type.

*� ��+ ��

The Report Generator function enables you to setup report types, which enable you to group your reports bytype. For example, you may have a set of reports that you use for a particular client. You could setup a newreport type for that client. Then define a set of reports of that type. When you execute the Report Generatoroption, and select the new clients Report Type, only those reports that are defined of the client’s Report Typewill appear available for selection in the Report Name field.

Report types are defined in NETWORK_ROOT\REPORTS\RPTTYPE.INI. This file contains group records,which specify the database table type and the table name that will be used to generate reports of that type.Each group begins with a report type group name enclosed in brackets >@.

This is an example of a report type group configuration in RPTTYPE.INI. This group indicates that anyreports defined in REPORTS.INI that have their TYPE keyword set to BOM will generate the report based ondata in the Piping table of the Plant (drawing) database.

>%20@

'HVFULSWLRQ� �5HSRUWV�IRU�%LOO�RI�0DWHULDOV

7DEOH7\SH� �3LSLQJ

'%7\SH� �3ODQW

A description of the available keywords follows:

+ Description: Brief description of the report type.

+ TableType: The name of the table from which the report data will be extracted.

+ DBType: The database type. The available types are defined in DBCONFIG.INI. These currently include:Plant, Catalog, and Spec database types.

*� ��

This is an example of a report definition group configuration in REPORTS.INI. Each configuration has itsown REPORTS.INI file, which resides in the root configuration directory. The 7\SH keyword indicates thatthe report type is defined in the >%20@ group in RPTTYPE.INI. The 6FKHPD keyword indicates thatBOMSTAND.RPT is the Crystal Reports report definition file. The 6FKHPD1DPH and 'HVFULSWLRQ keywordsindicate that Standard BOM Report is the report description. The 'UDZLQJ2XSXW keyword indicates that thisreport is available only for generating an external report and may not be placed on a CAD drawing.

>%206WDQGDUG@

7\SH� �%20

6FKHPD� ��1HWZRUNB5RRW�?5HSRUWV?ERPVWDQG�USW

6FKHPD1DPH� �6WDQGDUG�%20�5HSRUW

'HVFULSWLRQ� �6WDQGDUG�%20�UHSRUW�ZLWK�DFFXPXODWHG�SLSH�OHQJWKV�IRU�YLHZLQJ��SULQWLQJ�RU�H[SRUWLQJ�WRD�ILOH�

'UDZLQJ2XWSXW� �1R

5@?BDC��5>E

�5>5B1D5�*5@?BDC


�� !��#��This area of the help system provides links to procedures to customize the AutoPLANT Report Generator.

�--2��-��+�*� ��+ �

A report’s type is defined by the 7<3( keyword in the report definition group in REPORTS.INI. This keyworddefines a group in RPTTYPE.INI that defines the table and database type from which the report data will beextracted. Rebis provides pre-defined report types to report on the Plant (drawing) databases’ Piping, Nozzle,and Equip tables. The following procedures explain how to add a new report type to report on the Controltable in the Plant database.

� �?��44��?496I�1� 5@?BD��I@5

�� Select Reports/Generate Reports.

�� Press Configure to display the Report Definitions dialog. The Report Type field in this dialog indicatesthe report type defined for the report selected in the Report drop-down list.

�� Press the Configure button next to the Report Type field to display the Report Types dialog. The Typedrop-down lists all of the report types configured in RPTTYPE.INI. To modify an existing report type,select it from the drop-down list, then modify the information as desired.

�� To add a new report type to report on the Control Plant database table, type CONTROLRPT in the Typefield. Type Report for Control Data in the Description field. Select All Plant Databases from the DatabaseType drop-down list. Select CONTROL DATA from the Table drop-down list.

�� Press Add to add the new report type group to RPTTYPE.INI as shown below. Select CONTROLRPT fromthe Type field to view/modify the new report type record. This report type will now be available forselection from the Report Definitions dialog’s Type drop-down list.>&21752/537@

'HVFULSWLRQ� �5HSRUWV�IRU�&RQWURO�'DWD

7DEOH7\SH� �&RQWURO

'E7\SH� �3ODQW

#��%*� ��

The Report Generator function uses Seagate Software’s® Crystal Reports™ run-time engine to process thecomponent data that will appear in the report output. You must purchase this software in order to generate anew Report File for use with this function. The software currently ships with several Crystal Reports (*.RPT)files for use with this function..

You should use these reports as templates to create your own. Once you have created a new RPT file, youshould must create a new Report Definition and configure it to use the new RPT file to make it available inthe AutoPLANT Report Generator dialog.

�--��%*� ��

Reports available for selection in the Report Generator dialog are defined in REPORTS.INI. This filecontains a group record for each report type that indicates the report type, the report format file, and whetheror not the report can be placed on a drawing or output as an external report. Rebis provides pre-definedreports to generate an external BOM, nozzle schedule, and equipment list. The following procedure explainshow to add a new report type to report on the data in the Control Plant (drawing) databases table.

�� This procedure assumes that you have previously created the CONTROLRPT type and theCTRLSTD.RPT report definition file as outlined in the previous two How To customizationprocedures.

5@?BDC��5>E

�5>5B1D5�*5@?BDC


� �?��44��?496I�1� 5@?BD��569>9D9?>

�� Select Reports/Generate Reports.

�� Press Configure next to the Report Name field to display the Report Definitions dialog. The Report drop-down lists all report definitions that are currently defined for the type of report selected in the Type drop-down list. To modify a report definition, select the type of report from the Type drop-down list, thenselect the report definition from the Report drop-down list. Modify the Description and Report DefinitionFile as desired.

�� To add a new report definition to report on the Control Plant database table, select CONTROLRPT fromthe Type drop-down list. The Reports drop-down list is empty to indicate that no reports have beendefined of this type.

�� Type ControlStandard in the Reports field.

�� Type Standard Control Data Report in the Description field.

�� Press the browse button, then select the report format file, CTRLSTD.RPT, and press OK.

�� Control will be returned to the Generate Reports dialog to enable you to select the new report forgeneration.

�--��#�""��-��) ��,��*� ��

In many instances, your organization may setup a standard set of reports that must be generated for eachdrawing. The DWBUSW�� function may be used to define menu commands to execute a specific reports of aspecific types. The format of this function is as follows:

�DWB5HSRUWBORDG��DWB5SW��5HSRUW�1DPH��

where 5HSRUW�1DPH is the name of the desired Report Definition.

For example, the EQUIPMENT application has two commands setup in the menu to work in this manner. TheReports/Equipment List command configures the Report Generator to generate the provided EquipmentListreport.

If you want to add a command to the menu to configure the Report Generator to generate this report, youwould use the function as follows:

�DWB5HSRUWBORDG��DWB5SW��(TXLSPHQW/LVW��

� ��

This chapter covers the Drawing Production menu options that enable you to create and saveWork Areas and define and assign Views to these Work Areas, which may be applied in PaperSpace to quickly generate section view drawings of the latest state of the Work Area drawings

OVERVIEW 10-2

DRAWING SETUP 10-2

WORK AREA SETUP 10-3

WORK AREA VIEWS 10-7

UPDATE WORK AREA 10-12

� � � � �

�

�B1G9>7��B?4E3D9?>��5>E

/F5BF95G


�

�� The Drawing Production menu provides access to options that enable you to create and save Work Areas. AWork Area is simply a set of one or more xreferenced drawings. You may also define and assign Views tothese Work Areas, which may be applied in Paper Space to quickly generate section view drawings of thelatest state of the Work Area drawings

The Drawing Production toolbar is available as a flyout toolbar from the main Piping Function toolbar, ormay be displayed separately by selecting Toolbars/Function Toolbars/Drawing Production.

� ��The Drawing Setup function is a modified version of AutoCAD’s MVSETUP command. It enables you tomove into Paper Space, select one of the pre-defined borders available for the current configuration, andplace a title block on the user-configured sheet. To create and place viewports, we encourage you to utilizethe Drawing Production/Work Area Views command. A general description of the operation of the DrawingSetup command is provided below.

� �?��5DE@��1@5B��@135

�� Open your PIPING/EQUIPMENT model and start the AutoPLANT application.

�� Type PLAN, then press Enter twice to view the entire model.

�� Select Drawing Production/Drawing Setup to display the following prompt.

Enable paper space? (No/<Yes>):

Type Y and press Enter to move into Paper Space (if working in ACAD 2000, this effectively opens aLayout tab). The Paper Space icon replaces the standard Model Space UCS icon to indicate that you arenow defining objects that will go on the sheet.

�� The next step is to insert a title block. The prompt

Align/Create/Scale viewports/Options/Title block/Undo: t

displays. Type T, then press Enter to insert a title block.

�� The prompt

Delete objects/Origin/Undo/<Insert title block>:

displays. Press Enter to display a list of title blocks defined for the current configuration as shown for thedefault Imperial configuration below.

�B1G9>7��B?4E3D9?>��5>E

�?B;��B51�)5DE@


The title block drawings shown in this dialog are defined in the current configuration. In theconfiguration you can define the directory used to display the available border drawings. Select thedesired border file, then press OK.

�� The selected title block is placed in Paper Space. Press Enter to end the title block insertion command.

�� If you are working in ACAD 2000, the selected title block may not fit on the paper size defined for thecurrent layout. Select File/Page Setup to display the Page Setup dialog. Click on the Plot Device tab andselect your plotter. If you don’t have a plotter installed, select one of the DWF plotter drivers suppliedwith AutoCAD. These plotter drivers provide a full set of imperial and metric sheet sizes. Click on theLayout Settings tab and then select the Paper size for the border drawing selected above.

� To create and place viewports, we encourage you to utilize the Drawing Production/Work Area Viewscommand.

�� For more information on the use of Paper Space, refer to your AutoCAD documentation.

�� The Work Area Setup command enables you to create and save Work Areas. A Work Area is simply a set ofone or more xreferenced drawings. The dialog provides options to create new or open existing work areas andto select the drawings that will included in the work area. When the dialog is closed, the work area drawingswill be xreferenced into the current drawing as you specify.

�B1G9>7��B?4E3D9?>��5>E

�?B;��B51�)5DE@


�

A description of the settings and buttons in this dialog are provided below.

�� To create a new work area, you must first press the New button and define the work area file. Next, enter adescription of the new work area in the title field. Enter a description in this field when defining a new workarea.

��

This window lists the xreferenced drawings that have been added to the Work Area. To add a new drawing,press Add then navigate to the desired drawing file and press OK.

�� This utility now supports the specification of explicit network (UNC) paths for your referenceddrawings. In general, most organization define drive letters for their network paths. This enables themto move an entire set of files from one network server to another network server without losing thepathing information as long as the same drive letter is defined on both servers. Other organizationsmay always use one specific server name. For example, if you have a network server named\\REBIS, which contained a sub-directory named ..\MYDWGS, and contains a file namedTEST.DWG, to add this drawing to the Work Area using a UNC path, simply select NetworkNeighborhood and then browse to the \\REBIS\MYDWGS directory and select the drawing. The pathin the Reference Drawings area of this dialog will appear in this dialog as\\REBIS\MYDWGS\TEST.DWG. On the other hand, if your organization had mapped the drive letterZ to the \\REBIS\MYDWGS directory, then you added this drawing as a reference by selecting the Z:drive, it would appear in the Reference Drawings area of this dialog as Z:\TEST.DWG. UNC pathsare preferred when mapped drive letters are not consistent across work stations. Drive letter-basedpaths are preferred when standardized drive letters map to the same locations across work groupsthat will share work areas. The decision to use UNC paths vs. drive letter-based paths is based onyour organization’s preference.

If the current drawing has xreferenced drawings attached using either the Drawing Production utilities, orusing AutoCAD’s Xref/Attach command, then another dialog will display when you press the Add button,which enables you to specify whether you want to add a drawing from a file, or that you want to add adrawing that is currently attached as an xref to the current drawing. This feature is provided to enable you toquickly add drawings that are attached as xrefs in the current drawing to the Work Area. If you select the XrefDrawing option, a dialog will display listing all xrefs currently attached to the current drawing. This dialogindicates the xref drawing’s file name, the attachment type, the path to the drawing, the insertion point used toattach the drawing, and the insertion angle specified. Simply select a drawing from the dialog and press OK toadd it to the Work Area. If the drawing already exists in the Work Area nothing will be done here.

Use the <-Remove option to remove a drawing from the work area.

The files added to this list can be xreferenced into the named views associated with the Work Area,depending on the current Member Status. For example, the current drawing is automatically added to the listof reference drawings if the Member Status is set to Member.

Also note that each xreferenced drawing is associated with an insertion point. This is the point you wouldspecify when xreferencing a drawing manually. If an insertion points is not specified, the global origin (0,0,0)is assumed.

When the Work Area Setup dialog is closed, the referenced drawings immediately appear in the display. Youcan attach directly to components or nozzles on xreferenced drawings and begin your routing from theseshared points.

�B1G9>7��B?4E3D9?>��5>E

�?B;��B51�)5DE@


�� Drawings are referenced using AutoCAD’s XREF/Overlay command (as distinguished from theXREF/Attach command. Refer to your AutoCAD documentation for more information on thesecommands.

�� The Insertion Point indicates where one drawing is placed in relation to the others. To define the insertionpoint for an xreferenced drawing, you must select the drawing in the Reference Drawings list, then enter thedesired East, North, and Elevation coordinates in the fields provided. If an insertion point is not specified, theglobal origin (0,0,0) is assumed. To manually specify this point, press the Pick button.

�� The insertion point is always relative to the current model’s Plant Orgin.

�� You can manually pick the insertion point for the drawing selected in the Reference Drawings area of thedialog. Select a drawing name in the Referenced Drawings list, then press Pick. The dialog temporarily closesto enable you to pick a point in the current drawing.

��The Rotation enables you to specify the angle at which the drawing will be inserted into the Work Area withrespect to the Insertion Point.

The Pick button may be pressed to manually define the desired rotation angle.

�� The Membership Status determines the relationship between the current drawing and the referenced drawingsas follows:

+ Guest: The current drawing is not added to the list of drawings associated with the current Work Area.Joining as a guest enables you to see how the current drawing is positioned in relation to the referenceddrawings, but does not allow Members of the Work Space to view your drawing.

+ Member: The current drawing is permanently added to the list of referenced drawings. Provided the WorkArea is saved on a network directory where it can be shared, the current drawing becomes available toother users who select the same work area.

+ Non-Member: When this option is selected, the referenced drawings are not visible inside the currentdrawing. Use this option to recall saved views or to place view ports in Paper Space using the Work AreaView coordinates.

$ ��If the current drawing has xreferenced drawings attached, using either the Drawing Production utilities, orusing AutoCAD’s Xref/Attach command, then another dialog will display when you press the Add button,which enables you to specify whether you want to add a drawing from a file, or that you want to add adrawing that is currently attached as an xref to the current drawing. This feature is provided to enable you toquickly add drawings that are attached as xrefs in the current drawing to the Work Area. If you select the XrefDrawing option, a dialog will display listing all xrefs currently attached to the current drawing. This dialogindicates the xref drawing’s file name, the attachment type, the path to the drawing, the insertion point used toattach the drawing, and the insertion angle specified. Simply select a drawing from the dialog and press OK toadd it to the Work Area. If the drawing already exists in the Work Area nothing will be done here.

�B1G9>7��B?4E3D9?>��5>E

�?B;��B51�)5DE@


�

��Press New to create and name a new Work Space file. A file selection dialog is displayed. Name the file, andsave it in the desired directory (you must use the default RWA extension).

The location where you save new RWA files is very important, as it determines whether or not the file can beshared in a network environment. To allow other users to add drawing to (or remove them from) the WorkArea, the file must be stored on a shared network drive.

��Press Open to load saved settings from an existing *.RWA (Rebis Work Area) file.

��Press this button to save changes made to existing *.RWA files. The directory path where this file is saved willbe saved with your drawing. In the same manner that you can use explicit (UNC) network paths to adddrawings to the work area, you can specify explicit network paths to define the location for this file.

��Press Save As to save the current Work Area file under a new name or in a new location. You must retain theRWA file extension.

��Closes the Work Area Setup dialog. Prompts you if there are any unsaved changes.

��Closes the Work Area Setup dialog without saving changes.

�B1G9>7��B?4E3D9?>��5>E

�?B;��B51��95GC


��

The Work Area Views dialog lists the views associated with a Work Area, and enables you to edit and createnew views.

A description of the options available in this dialog is provided below:

� �� Lists the current Work Area. Initially, the dialog opens with the last active Work Area. To select a differentWork Area, press the Browse button.

��Opens the View Properties dialog for the definition of a new Work Area View.

��Removes the currently highlighted Work Area View from the list of those associated with the Work Area.

��

Lists the drawings which have been added to the current Work Area.

��Opens the View Properties dialog with the properties of the currently highlighted Work Area View.

�B1G9>7��B?4E3D9?>��5>E

�?B;��B51��95GC


�

��Creates a copy of the selected View. A dialog is displayed in which to input a new name. You can then Editthe copied view to create a new one.

��

This button is redefined according to the current Tilemode setting.

7LOHPRGH �

When Tilemode=1 (Model Space), the button reads Apply in Drawing. Press Apply in Model to re-display themodel using the defined View Properties . This allows several drawings to share a Work Area view. If adrawing is joined to the Work Area as a Guest or Member, xreferenced drawings are displayed in the view. Ifjoined as a Non-member, the viewing planes defined in the Work View are used, but the referenced drawingsare not visible.

7LOHPRGH ��3DSHU�6SDFH�ZLWK�RU�ZLWKRXW�IORDWLQJ�YLHZSRUWV�

When Tilemode=0, the button reads Insert in Drawing. Press the Insert button to place a scaled, tiled viewportinto the drawing. The viewport is inserted at the scale specified from the View Properties dialog.

� ��When Tilemode=1, you can press the Preview button to view the boundaries of the selected Work Area View.The Preview displays the Work Area View boundaries only, not the actual view. For example, if you are in anisometric view of the model and press Preview, you may see a three-dimensional box in the model. However,since Work Area Views are based on Orthogonal projections only, the actual view displayed when Apply inDrawing is pressed may be from a Plan or an Elevation perspective (according to the setting in the View fieldof the View Properties dialog.

�� When Tilemode=0, the Preview option is grayed-out (disabled).

��!��When Tilemode=1, the Auto Zoom option becomes available. Enable Auto Zoom to automatically zoom outto create enough space to place a new viewport in Paper Space. For example, suppose you are zoomed in to atight area of Paper Space and are placing a viewport which would normally extend beyond the boundaries ofthe current zoom factor. If this option is enabled, AutoPLANT will automatically zoom out to create enoughspace for you to place the new tile.

�� The Auto Zoom option is not available in Model Space.

�B1G9>7��B?4E3D9?>��5>E

�?B;��B51��95GC


�� The properties of Work Area Views are defined in the dialog shown below. Fields are provided to define thecoordinates of a three-dimensional box. A side of the box is selected for projection in the view. Objects thatlie outside the boundaries of the box may be clipped from the view. Settings are also available fordetermining the annotation and dimension settings applied when the view is placed as a tile in Paper Space.Select an area of the dialog below for more information about a particular field or command.

�� When specifying the properties of a view, you must be in Model Space. Additionally, if you will bemanually picking points in the model to define coordinate locations, you must be in Plan view.

��%��

The name of the view being defined/edited. This name will appear in the view list in the Work Area Viewsdialog.

��%

This setting determines the orthogonal projection (the side of the box) which is associated with the savedview. The selected view is highlighted in red in the tile to the left. The coordinates of the box itself aredefined in the 3D Envelope section of this dialog.

)��

The Scale of the view port. The selection list displayed is based on your current drawing units settings (i.e., ifyour drawing units is set to Architectural, then Architectural scales will appear in the selection list.

�B1G9>7��B?4E3D9?>��5>E

�?B;��B51��95GC


�

This setting only effects Work Area Views that are placed as viewports in Paper Space. Select from the list ofavailable scales, or select By Window to manually create an UNSCALED viewport in Paper Space. If youselect the By Window option, you will need to manually scale the viewport.

Press the Edit button next to this field to display a dialog to modify/add drawing scales.

��;��

The graphic shown in the window illustrates the orthogonal projection plane indicated by the selected View.

��%/ ��

These setting do not effect Work Space Views applied in Model Space.

+ Match Line: Controls whether or not a dashed match line is placed around the view port. Note that if boththis option and the Viewport Visibility option is enabled, there will be two bounding boxes around theviewport when it is placed in Paper Space.

+ Coordinates: Controls whether plant coordinates are displayed around the viewport. These coordinatesare relative to the current viewport, and specify the coordinates from which the view was “cut.” Thecoordinate text size is determined by the current DIMTXT system variable.

+ Front Clip: Specifies whether or not the Front clipping plane is enforced in the current view.

+ Back Clip: Specifies whether or not the Back clipping plane is enforced in the current view.

+ Viewport Visibility: Determines whether or not a solid border line is drawn around ALL AutoCADviewports (global). Note that if both this option and the Match Line option are enabled, there will be twobounding boxes around the viewport when it is placed in Paper Space.

��!.��/ ��

The properties of the Match Line are determined in this area of the dialog.

+ Thickness: Input the thickness of the line in current units.

+ Linetype: Press this button to open a dialog of available linetypes. Select a type from the list then pressOK.

�� These settings do not effect Work Area Views applied in Model Space.

8��%��1��

The coordinates specified in this area of the dialog define the clipping planes of a three dimensional box. Thebox defines the objects that are included in the view. The View selection determines the orthogonal projectionfrom which the view is created.

The Coordinate System setting is provided to enable you to specify views based on the Plant coordinatesystem that you defined when you created this drawing, or based on some user-define UCS. The coordinatesystem that you want to use in defining a view is displayed to the right of the Coordinate System button. Thedefault coordinate system is the World coordinate system. Press the Coordinate System button to display adialog to change the coordinate system.

The First Point and Second Point fields determine the opposite corners of a single clipping window. You canmanually specify these points by inputting coordinates in the East and North fields. You can also press Pick < to manually designate the point in the model. Select Pick View Area by Window to manually designate

�B1G9>7��B?4E3D9?>��5>E

�?B;��B51��95GC


the East and North coordinates in both the First Point and Second Point fields. The command works byallowing for the selection of opposite corners of a window. When manually picking points, you MUST BE INPLAN VIEW.

The Elevation fields determine the top and bottom clipping planes. These values are ALWAYS world Zcoordinates. The Elevation values define the height of the 3D Viewing box.

If you are creating a View that is projected from the Top or Bottom, you can leave the Elevation values blank(null); otherwise, Elevation values must be present in order to define the top and bottom boundaries ofelevation Views (Front, Back, Left, Right).

/<

Press OK to apply an editing changes you have made to the saved view (the View Title).

#��

Press Cancel to discard any changes you have made to the saved view (the View Title).

�-��)��

This dialog displays when you press the Edit button next to the Scale field in the View Properties dialog. Thisdialog is provided to enable you to add/modify the available scales for each AutoCAD units setting. Thescales displayed in the view properties dialog are filtered based on the current drawing AutoCAD Unitssetting.

� To display a list of scales defined for a particular drawing unit, simply click the symbol to the left ofthe units.

� To modify a scale, select it from the list, then modify its Scale Text and Scale Value settings. The ScaleText is the label that will appear to select the scale in the View Properties dialog, while the Scale Value isthe desired scale.

� To add a new scale, first select the units type that you want to add a scale for, then press Add. Enter thelabel for the new scale in the Scale Text field, then enter the desired scale in the Scale Value field.

� Restore Defaults resets all of the scale entries to the original set of hard coded defaults.

�B1G9>7��B?4E3D9?>��5>E

3@41D5��?B;��B51


�

565B5>35��31<5

The radio buttons in this area of the dialog enable you to Reference or Copy scales from one group toanother. For example, if you want to copy all of the scales defined in the DECIMAL group to theENGINEERING group, simply select the ENGINEERING group in the left pane, then enable the Copy FromScale radio button, then select DECIMAL from the drop-down list. This will replace the existingENGINEERING scales by copying all of the scales defined in the DECIMAL group, which may then bemodified.

#��-��)+��"

This setting is provided to enable you to specify views based on the Plant coordinate system that you definedwhen you created this drawing, or based on some user-define UCS. The coordinate system that you want touse in defining a view is displayed to the right of the Coordinate System button. The default coordinate systemis the World coordinate system. Press the Coordinate System button to display the following dialog to changethe coordinate system.

If you want to define a view based on the Plant coordinate system that you assigned when you created thedrawing, press the Plant button. The Origin and X/Y Axis points for this coordinate system will display in thedialog and may be modified.

If you want to define a view based on a UCS, you should first set the UCS, then execute the DrawingProduction command and access this dialog to change the desired coordinate system to UCS. You maymodify the Origin and X/Y Axis points for the UCS.

In either instance, when you select a coordinate system and return to the View Properties dialog, the pointspreviously defined for the view will be modified to reflect the selected coordinate system.

�� This function applies any changes made to your current work area (if a work area has been defined for thedrawing), bypassing the work area definition dialog.

��(��

This chapter covers the 2D to 3D component mapping functionality between Rebis’ AutoPLANTP&ID drawings and AutoPLANT PIPING

OVERVIEW 11-2

PROCESS OVERVIEW 11-2

SET PROJECT 11-5

BROWSE/INSERT COMPONENTS 11-6

PREFERENCES 11-7

� � � � �

��

��D?�(��5>E

/F5BF95G


��

�� 2D to 3D component mapping functionality is provided between Rebis’ AutoPLANT P&ID drawings andAutoPLANT PIPING. PIPING and/or EQUIPMENT provide the following options. Click on an option todisplay its help.

� �� In order for the 2D to 3D functionality to operate you must have access to an AutoPLANT 2D project. The2D to 3D functionality provided in PIPING and EQUIPMENT is basically accomplished via a series ofmappings defined in external text files. These mappings enable the system to accurately map an AutoPLANTP&ID component to its AutoPLANT PIPING equivalent. If you are familiar with the customization of theP&ID system, you will understand that what this functionality actually accomplishes, on the most generallevel, is a mapping of a P&ID component’s key to a PIPING component class.

�� You must also install the AutoDESK® Volo View Express™ application from your CD.

Central to the successful implementation of a 2D to 3D integration solution is a flexible mapping scheme fortranslation of data from the 2D to 3D systems. Currently class mapping is restricted to a one-to-one scheme(i.e., one 2D class maps to one 3D class). One-to-one mapping between 2D and 3D field names is providedon a class category basis.

Configuration dependent (e.g. Imperial vs. Metric) field value mappings on either a field name only basis or aclass category plus field name basis is provided as follows:

+ Pass-through (or no mapping) where values are copied verbatim. This is the default behavior.

+ One-to-one (one 2D field value maps to one 3D field value)

�� Value mapping is configuration dependent primarily because of different units settings perconfiguration. If you use the option to place valves in P&ID using the PIPING system's specifications,you will ensure that PIPING uses the same spec record when placing the valve in your PIPINGdrawing via the 2D to 3D insert function.

�� The following briefly describes the order in which the INI files are referenced to implement the mapping of a2D item to 3D:

�� The user selects a 2D project to initialize the sytem using the 2D to 3D/Setup Project command.

�� The user selects an option from the 2D to 3D/Insert menu to filter the 2D component selection dialogbased on the selected option.

�� The user selects a 2D item from the dialog’s navigation tree, then presses OK. This returns the selecteditem’s field names and values to the calling function.

�� The 2D class name is extracted from the returned field list and is mapped to the 3D class name byreferencing the 2D class name in the CLASSMAP.INI file.

�� The PIDFLD.INI file is referenced to map the 2D field names to 3D and the 2D3D.INI file is referencedto map 2D field values to appropriate 3D values if required. If a field is missing from the 2D3D.INI file,the 2D value is copied verbatim.

��To implement this process, four (4) external text files are used. A brief description of each of these isprovided below:

��D?�(��5>E

�B?35CC�/F5BF95G


#.�))��(�(

File name for PIPING: %NETWORK_ROOT%\modules\<module name>\classmap.ini

File name for EQUIPMENT: %NETWORK_ROOT%\equip\classmap.ini

Description: Used to map 2D class names to 3D class names.

Format:

>��'�FODVV�FDWHJRU\!@

��'�FODVV�QDPH�!� ��'�FODVV�QDPH!

Where valid values for ��'�FODVV�FDWHJRU\! include: InLine, Process, Instruments, Equipment, and Nozzles

�� Including the wildcard character, "*", for <2D class name> indicates that all classes of the givencategory map to the indicated 3D class name.

Examples:

>,Q/LQH@

%$//� �$7B9$/9(B%$//

&%$//� �$7B9$/9(B%$//

�

>,QVWUXPHQWV@

&9$/9(� �$7B9$/9(B&17/

025,)� �$7B25,)

�

>1R]]OHV@

� �$7B12==/(

�(�.�(�(

File name: %NETWORK_ROOT%\xchg\pid\pidfld.ini

Description: Used to map 2D field names to 3D. 3D fields may be duplicated, if necessary. When mapping a2D field to a 3D field, if a field value is not present for a given 3D field in the 2D database and another 2Dfield exists that maps to the same 3D field, the second (and subsequent) fields are examined until a value isfound. Therefore, 3D field names should be listed in order of precedence. For example, in the InLine samplebelow, when retrieving a value for the 3D NOMINAL field, if no value exists in the 2D database for VSIZE,PSZ will be used instead for mapping the value. In this case, VSIZE has precedence over PSZ. Only 3D fieldnames that are present in the 2d3d.ini file (see below) will have their values mapped from 2D to 3D accordingto the values in the 2d3d.ini mapping file. All other field values are copied verbatim. Nozzles must be scopedto either Piping or Equipment because these systems have different implementations of nozzles. This isaccomplished by suffixing the "Nozzles" INI group name with either ".Piping" or ".Equipment".

Format:

>��'�FRPSRQHQW�W\SH!@

��'�ILHOG�QDPH!� ��'�ILHOG�QDPH!

Where valid values for ��'�FRPSRQHQW�W\SH! include: InLine, Process, Instruments, Equipment, and Nozzles

��D?�(��5>E

�B?35CC�/F5BF95G


��

Examples:

>,Q/LQH@

/7$*� �/,1(180%(5

96,=(� �120,1$/

36=� �120,1$/

363(&� �63(&

�

>3URFHVV@

7$*B12� �/,1(180%(5

36=� �120,1$/

363(&� �63(&

37(03� �7(03(5$785(

�

>1R]]OHV�(TXLSPHQW@

7$*B12� �7$*

(7$*� �(48,3B12

�

>1R]]OHV�3LSLQJ@

7$*B12� �7$*180%(5

�8�(�(

File name: %NETWORK_ROOT%\config\<config name>\2d3d.ini

Description: Used to map 2D field values to 3D field values. Field values may be mapped explicitly orprocedurally. Only fields listed here will be mapped. Fields not listed here will be copied verbatim from 2Dto 3D. For procedural mapping, the name of the conversion script and function must be specified. The scriptconversion function retrieves the string parameter which represents the 2D value to be mapped/converted bycalling DWB6FULSW%XIIHUBJHW6WULQJ�YDOXH7R0DS��0$33('B9$/8(��. The converted 3D value is set in thescript conversion function by calling DWB6FULSW%XIIHUBSXW6WULQJ�PDSSHG9DOXH��0$33('B9$/8(��.

Format 1 - Explicit field value mapping:

>��'�ILHOG�QDPH!@

��'�ILHOG�YDOXH!� ��'�ILHOG�YDOXH!

Format 2 - Procedural field value mapping:

>��'�ILHOG�QDPH!@

��&RQY0HWKRG�� %$6,&�VFULSW�FRQYHUVLRQ�ILOH!��%$6,&�VFULSW�FRQYHUVLRQ�IXQFWLRQ!

Examples:

��,PSHULDO�FRQILJXUDWLRQ�LQ��1(7:25.B5227�?FRQILJ?,PSHULDO?�G�G�LQL

>120,1$/@

��

��

��

�

>7(03(5$785(@

��&RQY0HWKRG�� &RQYHUW�HEV�&RQYHUW'HJUHHV

��0HWULF�FRQILJXUDWLRQ�LQ��1(7:25.B5227�?FRQILJ?0HWULF?�G�G�LQL

�

>120,1$/@

�� PP

�� PP

�� PP

�

>7(03(5$785(@

��&RQY0HWKRG�� &RQYHUW�HEV�&RQYHUW&HOVLXV

��D?�(��5>E

)5D��B?:53D


�(�*��(�(

File name: %NETWORK_ROOT%\xchg\pid\pidpref.ini

Description: Used to specify 2D component specific drawing preference 3D field names. 3D field nameslisted in this file are grouped by 2D component type. at_2dTo3d_setPrefs and at_2dTo3d_setPref referencethese field names for a given 2D component type to set the piping system variables if no fields are explicitlypassed to these functions.

Format:

>��'�FRPSRQHQW�W\SH!@

��'�GUDZLQJ�SUHIHUHQFH�SLSLQJ�V\VWHP�ILHOG�QDPH!

Where valid values for ��'�FRPSRQHQW�W\SH! include: InLine, Process, Instruments, Equipment, and Nozzles

�� An equal sign ’=’ must proceed the field name.

Examples:

>3URFHVV@

/,1(180%(5

120,1$/

63(&

�� "��The 2D to 3D/Set Project option displays the dialog shown below. The function initially will try to locate your2D projects automatically and display them for selection. If these projects cannot be found, a Browse buttonis provided to enable you to navigate to and select the desired 2D project.

�� In general, the system will locate 2D projects if they exist on the same workstation as the 3D systemrunning 2D to 3D.

To enable a project, select it from the list and then press OK, or press Browse to navigate to and select thedesired 2D project.

��D?�(��5>E

5B?GC52(>C5BD�#?=@?>5>DC


��

� �� The ../Browse and ../Insert submenus under the 2D to 3D menu in PIPING and EQUIPMENT provide a set ofoptions that enable you to filter the active 2D project component information available to view/insert from thedialog’s navigation tree as illustrated below. You must initialize a 2D project using the Setup Project/2D to 3Dcommand before this command will operate.

The primary difference between the Browse and Insert dialogs is the functionality of the OK button. If thisdialog is displayed from a Browse menu selection, the OK button will simply close the dialog. If displayedfrom an Insert menu selection, the OK button will prompt you to insert the currently selected item in thedialog’s navigation tree.

The Browse option on the dialog expands the dialog to display two tabs, which provide specific informationabout the item selected in the navigation tree.

The View tab uses AutoDESK® Volo View Express™ to display the current drawing. An option to installthis application separately is provided on your CD.

��D?�(��5>E

�B565B5>35C


� �� The 2D to 3D/Preferences option is available in the PIPING application ONLY. This option displays thedialog shown below to enable you to set the active 3D drawing preferences from 2D, including: Line Number,Nominal Size, and Specification.

Enable the check box next to each of the preferences that you want to set from 2D, then press the Set from 2Dbutton. You will be prompted to select a 2D component from the navigation tree to apply the setting. Thesettings from the selected component will appear in the dialog after selected. Press Done when you arefinished to begin placing PIPING components using these settings.

��

This chapter covers other PIPING commands and/or functions that may or may not be availablefor execution from the menu or toolbars.

SCRIPTING TOOLS MENU 12-2

SPECIFICATION SELECTION DIALOG 12-2

DRAWING NODES AND DRAWING BORDER CUSTOMIZATION 12-3

SPECIFICATION SELECTION ERROR 12-3

SPECIFICATION VALIDATION 12-4

DRAWING SELECTION OPTIONS 12-6

� � � � �

��

�D85B�?==1>4C��E>3D9?>C)3B9@D9>7��??<C��5>E


��

� ��

The Scripting Tools menu provides a number of options to simplify the customization of the AutoPLANTBasic commands and functions. A description of each of these options is provided below:

��Displays a file selection dialog. Select an existing script (*.EBS), then press OK to load it. Any functionsdefined in the script can then be executed with the Basic Scripts/Execute command.

��Unloads a script that has already been loaded. The command line will prompt for the name of the script. Typethe filename, then press Enter.

�$��Executes a function defined in a script that has already been loaded with the Basic Scripts/Load command.The prompt:

Enter function name:

is displayed at the command line. Type in the name of the function, then press Enter to execute it.

��Turns on a debugging mode for detecting errors in a user-defined function contained in a Basic Script.

��When you attempt to place a component in which there are more than one specification records that matchesthe search critera, a Specification Selection dialog as shown below will display. This dialog lists all recordsthat match the current search criteria to enable you to select the specification record that you want to use todraw the component.

Select the desired record, then press OK to place the component.

�D85B�?==1>4C��E>3D9?>CB1G9>7��?45C�1>4�B1G9>7�5?B45B�#ECD?=9J1D9?>


� �� !��Border nodes are special points associated with the border, such as the location of the north arrow in anIsometrics drawing. These nodes are used by the AutoPLANT application for default placement ofinformation with respect to the border. The border editor provides a user interface allowing the user tomanipulate border nodes. To execute the border editor feature enter the following command at the AutoCADcommand line:

��DWB%RUGHUBHGLW1RGHV�

A dialog displays that enables you to display, add, move, rename and delete border nodes existing in thecurrently opened border drawing. This feature can only be executed with the AutoPLANT module loaded andwhen a border drawing has been inserted into the drawing. This feature can also be run inside Piping orIsometrics once a border is inserted into the Piping or Isometric drawing. Once the user has edited the bordernodes, he should save the border drawing.

The default set of AutoPLANT borders each contain four border nodes:

AT_NORTH_ARROW for placement of the north arrow in an Isometric drawing

BOM-PT for placment of the bill of materials

AISOLL Lower left corner of the Auto Isometrics boundary

AISOUR Upper right corner of the Auto Isometrics boundary

�� A dialog similar to the one shown below will appear when you attempt to place a component that does nothave a record in the selected specification that matches the defined search criteria. It is provided to enableyou to determine the reason a particular component record was not available. You can either add a record tothe spec, or reset incorrect component preferences to place the desired component.

For example, if you attempt to place a 6” needle valve from the default CS150 specification, since CS150does not have a record that matches that Size, then the dialog will display as shown below.

This dialog lists the error, the Spec, the Spec Tables in the selected Spec, and the WHERE CLAUSE, that wasused as the search criteria to find the component record.

�D85B�?==1>4C��E>3D9?>C)@5396931D9?>��1<941D9?>


��

��

��In AutoPLANT, a component’s SYS_ID field value is used when the system needs to re-read data from thespecification or component data that is neither stored in the model or the external drawing database. If aspecification record has been manually deleted, or has been copied using some other third party applicationinstead of the Spec Generator, then errors may result.

When the specs and catalogs included in the shipping version of the software were built, component data wascopied from the catalogs into the specs, using the Spec Generator application. This process generates aunique SYS_ID field value for each spec record. If a third party application such as Microsoft Access is usedto copy spec records, then the SYS_ID field in the spec records will be duplicated and basically rendereduseless. In addition, if an existing component was placed using a specification record that has since beendeleted, the result is the same, the component data cannot be re-read from the spec.

In most cases there is no indication of this problem manifesting itself. However, when you attempt to placedimensions some of the data that is currently only stored in the spec is required. If the spec item cannot befound an undetermined dimension will result, possibly zero.

You may turn OFF automatic Spec validation in your configuration by disabling the Spec Validation checkbox on the System dialog, either by using the Configuration Editor or editing the appropriate configurationfile, CONFIG.INI and setting the following variable.

[SYSTEM]

...

Spec_Validation = 0

The following procedures explain how to repair your specs, catalogs, and to update/repair your drawings toreflect these changes.

�� The following procedure explains how to repair your specifications.

1. Start the Spec Generator application from the AutoPLANT/SpecGen program group in your WindowsStart menu.

2. Select Tools/Repair SYS_ID.

3. Enable the Specs radio button from the dialog displayed, then use the Browse button to select the spec(s)that need to be repaired. This application can scan multiple specs from the root directory selected if youenable the Include subdirectories radio button. This function scans the selected specs and repairsduplicate IDs by providing replacement SYS_IDs.

�� The following procedure explains how to repair your catalogs. This procedure should be run on catalogsgenerated using third party applications (e.g., Microsoft Access).

1. Start the Spec Generator application from the AutoPLANT program group in the Windows Start menu.

2. Select Tools/Repair SYS_ID.

3. Enable the Catalogs radio button from the dialog displayed, then use the Browse button to select thecatalog(s) that need to be repaired. This application can scan multiple catalogs from the root directoryselected if you enable the Include subdirectories radio button. This function scans the selected catalogsand repairs duplicate IDs by providing replacement SYS_IDs. It also generates and propagates theSYS_ID, COMP_IDX, PIECEMARK fields if your catalog was generated using a third party application.

�D85B�?==1>4C��E>3D9?>C)@5396931D9?>��1<941D9?>


��

If the Spec radio button is enabled, and a catalog is selected, then only the SYS_IDs entries in the catalog willbe repaired. If the Catalog radio button is enabled, and a spec is selected, then the application will abort.

� �� Once your specs have been repaired, you can repair affected drawings by opening each drawing. When thedrawing is opened for the first time, AutoPLANT will ask if you want to attempt to repair the references tothe drawing spec data. Press Yes if you want this function executed automatically, or press No if you want toexecute this command later. If you pressed Yes the system will process all of the components in the currentdrawing to determine if any need to be repaired. If components are found that need to be repaired, thefollowing dialog will display with a list of the affected components.

If you pressed No above, you can manually run this function later by entering AT_SPEC_SCAN at theAutoCAD command line to process the components and display the dialog shown above. Once the drawinghas been scanned for invalid references, Save the drawing so that you will not need to scan it again.

For each component, the function detects and displays the error in the Status field as described below:

� Updateable SysID using Where Clause: This indicates that the system could not find the original specrecord’s SYS_ID, but using the WHERE CLAUSE, it found a single instance that should be the correctspec record. You should check this entry in your spec to ensure that the new record that will replace theoriginal record is the spec record that you expected.

� Selectable SysID using Where Clause: This indicates that the system could not find the original specrecord’s SYS_ID, but using the WHERE CLAUSE, it found multiple records that could be the correct specrecord. Update will allow you to select one of these records to correct the problem.

� No Spec Records found using Where Clause: This indicates that the original spec record used for thiscomponent could no longer be found using the same WHERE CLAUSE. You should add the spec recordfor this component (i.e., it may either have been deleted accidently, or modified to no longer match theWHERE CLAUSE).

If you want to view an affected component, select it in the dialog list, then press Go To. To repair acomponent, select it from the list and then press Update.

You are not required to repair all of the affected components at this time, you can display this same dialog,listing only those components that have not been repaired by entering AT_SPEC_REPAIR at the AutoCADcommand line. Before you can execute this function, you must have scanned the drawing by either pressingYes from the initial dialog that displayed when you opened the drawing, or by manually running theAT_SPEC_SCAN function.

You must Save the drawing after performing updates if you want these changes to take effect.

�D85B�?==1>4C��E>3D9?>CB1G9>7�)5<53D9?>�/@D9?>C


��

If a drawing has been scanned and saved, the automatic detection will be disabled. For example, if you repaira drawing, then add a number of components, then come back to the drawing later and want to ensure that it issynchronized with the spec, you should manually run the AT_SPEC_SCAN function to check the consistencyof the entire drawing again.

� ��AutoPLANT applications use a common tool to enable you to define a selection set of components based on auser-defined criteria that will be applied to the executed command.

Whenever one of these commands is selected, the Drawing Selection dialog shown below displays. From thisdialog, you can define the selection set of components that will be processed by the command. You can selectAll the components in the current drawing, Manually pick individual components, or use the Advanced optionto filter one or more drawings for components that contain user-specified attributes.

�� In AUTO-ISO, the Run Auto-Iso command will display this dialog only if you have opened a PIPINGdrawing prior to executing the command. If you do not have a PIPING drawing open, the commandwill jump to the dialog that displays when you enable the Advanced and Multiple Drawing Selectionoptions in this dialog.

A more detailed explanation of each of these options is provided below:

��Selects all components in the current drawing.

��

Closes the dialog and enables you to manually select components in the model. You can select componentsindividually, or use AutoCAD’s Window, Fence, Crossing, etc. qualifiers to build a selection set.

��#��

When you select the Advanced option and do NOT enable the Multiple Drawing check box in the DrawingSelection Options dialog, the Component Update Selection dialog displays as shown below. This method isused to define a selection set of components in the current drawing based on its component's drawingdatabase field values, or AutoCAD color/layer attributes.

�D85B�?==1>4C��E>3D9?>CB1G9>7�)5<53D9?>�/@D9?>C


A description of the options in this dialog is provided below.

�"��

Two domains are available: User and Project. The User option displays a list of queries that have been savedon the user’s local drive, while the Project domain displays a list of queries that have been saved on thenetwork drive, and are therefore available to all members of a project. These definitions are saved in separateQUERIES.INI files.

)��2��

Saved query definitions can be selected from this list. Once a named query is selected, the remaining areas ofthe dialog are propagated in with the previously saved information. For example, the “Select by line number”query automatically sets the Attribute Field to LINENUMBER and the Constraint to =. The next step is tosimply input (or select) the desired Line Number to query on, then press the OK button.

You can select a saved query from this list, create and save your own queries, or build and execute a newquery without saving.

�+ �

Select the type of database being queried from this selection list. The default, Piping Data, will populate theAttribute Field selection list (below) with the fields of the drawing database. The other option, Drawing, willenable you to select objects which share an AutoCAD color or layer name.

��7��-

This selection list is populated with attributes, which may be queried on for the current selection set. If theType field (above) is set to Piping Data, then the selection list contains attributes from the drawing database. Ifset to Drawing, the attributes will include COLOR and LAYER.

#��

�D85B�?==1>4C��E>3D9?>CB1G9>7�)5<53D9?>�/@D9?>C


��

The constraint describes the relationship between the attribute field value and the user-specified query value.Constraints are as follows:

= The attribute value must be EQUAL TO the user-specified query value.

LIKE The value in the attribute field must match a user-defined pattern such as LIKE ‘%C’ (begin with the letter “C”) or LIKE‘%VALVE%’ (contain the string “VALVE”). AutoPLANT will add the necessary apostrophes (‘) to the pattern. Refer to SQLdocumentation for more information on the use of this command.

< The attribute value must be LESS THAN the user-specified query value.

<= The attribute value must be LESS THAN OR EQUAL TO the user-specified query value.

> The attribute value must be GREATER THAN the user-specified query value.

>= The attribute value must be GREATER THAN OR EQUAL TO the user-specified query value.

!= The attribute value must NOT EQUAL the user-specified query value.

��7��

The user-specified attribute value. You can either manually input a value in this field, or press the Browse

button next to the Attribute Value field to select one or more attributes from the dialog shown below. Thesystem will search the selected drawing(s) for all unique values of the current Attribute Field to propagate thisdialog list.

Ths dialog lists unique records for the current Attribute Field. For example, if the Attribute Field is set toLINENUMBER and the browse button is pressed, a list of unique line numbers will display in this dialog.You can press and hold down your Ctrl key and then select multiple entries in the list, or press hold hold theShift key and then select the first and then last entry to select a group of entries. If multiple entries areselected, then you press OK, the entries will appear in the Attribute Value field separated by semi-colons.When you press Add, each entry will be used to create a new constraint in the active queries list.

The Filter List Content field in this dialog enables you to filter the list of entries displayed in the dialog. Forexample, if you have a large drawing that has hundreds of line number and only want to select from linenumbers that begin with the characters L2, you can filter the display of line number entries in this dialog byentering L2% in the Filter List Content field, then pressing Reselect. The "%" implies a wild card of anynumber of characters. You may also use the underscore character "_" to imply a wild card of any singlecharacter.

�D85B�?==1>4C��E>3D9?>CB1G9>7�)5<53D9?>�/@D9?>C


/ ��

The operator is associated exclusively with defining a complex query. For example, after defining the firstquery, press Add-> from the Active Query group box. Next, highlight the “CONSTRAINT=” line in the ActiveQueries window. You can now define an additional query, select an Operator, then press Add to build acomplex constraint such as

&21675$,17 �/,1(180%(5 ·/��·��$1'��0$,1B6,=( ·�·�

The operator determines the relationship between the two queries as follows:

AND Components must meet the conditions of BOTH constraints to be included in the selection set; this is known as an Exclusiveconstraint.

OR Components which meet at least ONE of the conditions are included in the selection set; this is known as an Inclusiveconstraint.

��1�=��

This area of the dialog lists the queries that have been defined. Queries can be added to this list by definingthem in the Define Query area of the dialog, then pressing the Add-> button. For each query, the followinginformation is displayed:

+ Type: Piping Data or Drawing

+ Constraint: The expression which defines the search.

�� Because the drawing name is not associated with this type of query, you can save it and use it againwith any other drawing.

��-�%)��

Enable this dialog to further restrict the query by manually selecting components in the current drawing. Forexample, you can specify a filter, enable this option, then press OK. AutoPLANT then asks you to selectcomponents in the drawing. Only those objects which match the criteria of the query AND exist within themanual selection set will be returned.

�� This option is available ONLY for the current drawing. You cannot window-select objects in anXREFed drawing.

(��-�>*��

Enable this option to include XREFed drawings in the current query.

)�1�

Modified query definitions can be saved in an INI file. This enables you to recall and re-execute the query.From the Select Components dialog, press Save. The dialog shown below is displayed.

Modify the existing description in the QUERY field. Press Save to store the modified query in the INI file for

�D85B�?==1>4C��E>3D9?>CB1G9>7�)5<53D9?>�/@D9?>C


��

future use. A dialog will display asking you to confirm that you would like to overwrite the existingdefinition.

�� To create a new query, press New from the Select Components dialog.

��%

Select this option to display the following dialog to create and save a new query definition.

Select the domain where the new query will be saved, then type a description of the query in the Query field.

��

Press this button to delete the current query.

�D85B�?==1>4C��E>3D9?>CB1G9>7�)5<53D9?>�/@D9?>C


��#��

When you select the Advanced option and enable the Multiple Drawing check box in the Drawing SelectionOptions dialog, the Component Update Selection dialog displays as shown below. This method may be usedto define a selection set of components across multiple drawings based on their drawing database field values,or their AutoCAD color/layer attributes.

�� In AUTO-ISO, the Run Auto-Iso command will instantly display this dialog only if you have NOTopened a PIPING drawing prior to executing the command. If you do have a PIPING drawing open,the command will display the Drawing Selection Options dialog to enable you to specify how youwant to define your selection set for the current/multiple drawings.


�"��

Two domains are available: User and Project. The User option displays a list of queries that have been savedon the user’s local drive, while the Project domain displays a list of queries that have been saved on thenetwork drive, and are therefore available to all members of a project. These definitions are saved in separateQUERIES.INI files.

)��2��

Saved query definitions can be selected from this list. Once a named query is selected, the remaining portionsof the dialog are filled in with the previously saved information. For example, the “Select by line number”query automatically sets the Attribute Field to LINENUMBER and the Constraint to =. The next step is tosimply input (or select) the desired Line Number to query on, then press the OK button.

You can select a saved query from this list, create and save your own queries, or build a new query withoutsaving.

�D85B�?==1>4C��E>3D9?>CB1G9>7�)5<53D9?>�/@D9?>C


��

�--��%��

The Add Drawings group box provides an Add button to open a standard Windows file selection dialog.Select the drawing files you want included in the query, then press Open. To remove drawings from the list,press the <Remove button. After specifying the drawings, you must continue defining the query in other areasof the dialog described below.

�+ �

Select the type of database being queried from this selection list. The default, Piping Data, populates theAttribute Field selection list (below) with the fields of the drawing database. The other option, Drawing,enables you to select objects that share an AutoCAD color or layer name.

��7��-

This selection list is populated with attributes, which may be queried on for the current selection set. If theType field (above) is set to Piping Data, then the selection list contains attributes from the drawing database. Ifset to Drawing, the attributes will include COLOR and LAYER.

#��

The constraint describes the relationship between the attribute field value and the user-specified query value.Constraints are as follows:

= The attribute value must be EQUAL TO the user-specified query value.

LIKE The value in the attribute field must match a user-defined pattern such as LIKE ‘%C’ (begin with the letter “C”) or LIKE‘%VALVE%’ (contain the string “VALVE”). AutoPLANT will add the necessary apostrophes (‘) to the pattern. Refer to SQLdocumentation for more information on the use of this command.

< The attribute value must be LESS THAN the user-specified query value.

<= The attribute value must be LESS THAN OR EQUAL TO the user-specified query value.

> The attribute value must be GREATER THAN the user-specified query value.

>= The attribute value must be GREATER THAN OR EQUAL TO the user-specified query value.

!= The attribute value must NOT EQUAL the user-specified query value.

��7��

The user-specified attribute value. AutoPLANT will search through the selected Attribute Field for this value.Only those records which meet the Constraint will be added to the selection set.

You can either manually input a value in this field, or press the Browse button to select one or more fromthe Select Attribute Value dialog shown below.

�D85B�?==1>4C��E>3D9?>CB1G9>7�)5<53D9?>�/@D9?>C


Ths dialog lists unique records for the current Attribute Field. For example, if the Attribute Field is set toLINENUMBER and the browse button is pressed, a list of unique line numbers will display in this dialog.You can press and hold down your Ctrl key and then select multiple entries in the list, or press hold hold theShift key and then select the first and then last entry to select a group of entries. If multiple entries areselected, then you press OK, the entries will appear in the Attribute Value field separated by semi-colons.When you press Add, each entry will be used to create a new constraint in the active queries list.

The Filter List Content field in this dialog enables you to filter the list of entries displayed in the dialog. Forexample, if you have a large drawing that has hundreds of line number and only want to select from linenumbers that begin with the characters L2, you can filter the display of line number entries in this dialog byentering L2% in the Filter List Content field, then pressing Reselect. The "%" implies a wild card of anynumber of characters. You may also use the underscore character "_" to imply a wild card of any singlecharacter.

/ ��

The operator is associated exclusively with defining a complex query. For example, after defining the firstquery, press Add-> from the Active Query group box. Next, highlight the “CONSTRAINT=” line in the ActiveQueries window. You can now define an additional query, select an Operator, then press Add to build acomplex constraint such as

&21675$,17 �/,1(180%(5 ·/��·��$1'��0$,1B6,=( ·�·�

The operator determines the relationship between the two queries as follows:

AND Components must meet the conditions of BOTH constraints to be included in the selection set; this is known as an Exclusiveconstraint.

OR Components which meet at least ONE of the conditions are included in the selection set; this is known as an Inclusiveconstraint.

�D85B�?==1>4C��E>3D9?>CB1G9>7�)5<53D9?>�/@D9?>C


��

��1�=��

This area of the dialog lists the queries that have been defined. Queries can be added to this list by definingthem in the Define Query area of the dialog, then pressing the Add-> button. For each query, the followinginformation is displayed:

+ Document: Each query condition is associated with a specific drawings that you added in the AddDrawings area of this dialog. The Active Queries window displays the full path to the drawing associatedwith each query.

+ Type: Piping Data or Drawing

+ Constraint: The expression which defines the search.

�� To define the same query for multiple drawings, highlight the desired drawings in the Add Drawingsarea of the dialog, define the query, then press Add. Multiple entries will be written into the ActiveQueries window.

)�1�

Modified query definitions can be saved in an INI file. This enables you to recall and re-execute the query.From the Select Components dialog, press Save to display the dialog shown below.

Modify the existing description in the QUERY field. Press Save to store the modified query in the INI file forfuture use. A dialog will be displayed asking you to confirm that you’d like to overwrite the existingdefinition.

�� To create a new query, press New from the Select Components dialog.

��%

Select this option to display the following dialog to create and save a new query definition.

Select the desired domain under which the new query will be saved, then type a description of the query in theQuery field.

��

Press this button to delete the current query.

�D85B�?==1>4C��E>3D9?>CB1G9>7�)5<53D9?>�/@D9?>C


��Many of the functions provided in AutoPLANT applications can be performed on multiple components.Where this option is available, the Drawing Selection dialog will be displayed after selecting the command.Component selection sets can be specified manually, or a dialog can be displayed to enable you to build aselection set based on desired component attributes. This area provides procedures that explain how toperform common drawing selection tasks.

)��!��" ��!��-��%��

� �?�C5<53D�1<<�3?=@?>5>DC�9>�D85�3EBB5>D�4B1G9>7

�� Select the command that may be performed on a selection set of components (i.e., Reports, BOM,Update Components etc.).

�� When the Drawing Selection dialog displays, enable the All radio button and then press OK.

�� The command is executed on All of the components in the current drawing.

��+��" ��!��-��%��

� �?�=1>E1<<I�C5<53D�3?=@?>5>DC

�� Select the command that may be performed on a selection set of components (i.e., Reports, BOM,Update Components etc.).

�� When the Drawing Selection dialog displays, enable the Manual radio button and then press OK.

�� Select the components to add to the selection set. Pick components individually, or use AutoCAD’sWindow, Fence, Crossing, etc. qualifiers to group-select objects.

�� Press Enter when finished to build the selection set. The command is executed on the selectedcomponents.

��"�� -��%��?��

� �?�3B51D5�1�69<D5B�21C54�?>�=E<D9@<5�4B1G9>7C

�� Select the command that may be performed on a selection set of components (i.e., Reports, BOM).

�� When the Drawing Selection dialog displays, enable the Advanced radio button and the Multiple DrawingSelection check box, then press OK.

�� The Advanced Selection dialog displays (the title on this dialog is determined by the command selectedin Step 1).

�� From the Select/Enter field, select the pre-defined query definition that most closely matches the type ofquery you would like to perform.

�� From the Add Drawings group, press Add.

�� A file selection dialog displays. Select the desired drawings then press OK to add them to the list ofdrawings available to the query.

�� If the drawings exist in the same directory, you can use Ctrl and Shift selection techniques to selectand add them as a group. Otherwise, you must Add the drawings individually.

�� Note that the drawings selected in Step 6 are, by default, highlighted. At this point you can define thequery, then press Add. If you examine the Active Queries window, you will find that a query expressionhas been built for each of the highlighted documents.

� Press OK to create the selection set of components based on the query definition. Control is now passed

�D85B�?==1>4C��E>3D9?>CB1G9>7�)5<53D9?>�/@D9?>C


��

to the command specified in Step 1.

��-��%��?��+

� �?�4569>5�1�C9=@<5�AE5BI�?>�D85�3EBB5>D�4B1G9>7

�� Select the command that may be performed on a selection set of components (i.e., Reports, BOM,Update Components).

�� When the Drawing Selection dialog displays, enable the Advanced radio button and then press OK.

�� An Advanced Selection dialog displays (the title on this dialog is determined by the command selected inStep 1).

�� From the Select/Enter field, select the pre-defined query definition that most closely matches the type ofquery you would like to perform. (Certain queries, such as Select by line number, have already beendefined, and you will only be required to specify the desired attribute in Step 8).

�� In Steps 5-8 you will build a query statement that expresses a relationship between a field and its value.From the Define Query portion of the dialog, select the query Type. Piping Data enables you to selectattributes from the drawing database, while Drawing permits you to select objects that share an AutoCADcolor or layer.

�� Select the Attribute Field from the selection list. If Piping Data was selected in Step 5, this list ispopulated with fields from the external drawing database.

�� Select a Constraint from the selection list to establish the relationship between the Attribute Field(specified in Step 6) and its value (specified in Step 8).

� In the Attribute field, enter the value that should be searched for. You can type the value directly into theinput box, or press the Browse button. When browse is pressed, AutoPLANT will compile a list of allunique values for the selected attribute. You can then select a value form this dialog.

� After the query is defined, press Add->. The query appears in the Active Queries window.

�� Press OK to create the selection set of components based on the query definition. Control is now passedto the command specified in Step 1.

#��-)�1��=��+

� �?�3B51D5�1>4�C1F5�1�AE5BI

�� Select the command that may be performed on a selection set of components (i.e., Reports, BOM,Update Components).

�� When the Drawing Selection dialog displays, enable the Advanced radio btton. If this query is beingdefined for multiple drawing selection, enable the Multiple Drawing Selection option. Press OK.


�� From the Select/Enter field, select the pre-defined query definition which most closely matches the typeof query you would like to create.

�� Define the query.

�� Press New.

�� The New Query dialog displays. From the Domain list, make one of the following selections:

+ User: saves the new query definition on the local workstation drive;

+ Project: saves the new query definition on a network drive; the new definition will be available toall members of the current project

�D85B�?==1>4C��E>3D9?>CB1G9>7�)5<53D9?>�/@D9?>C


� Enter a short description in the Query field. This is the text that will appear in the Select/Enter field ofthe previous dialog.

� Enter a name (no spaces allowed) that will be used to identify the definition in the QUERIES.INI file.This is the file in which the new definition will be stored.

�� Press OK to close the New Query dialog and save the query definition.

��-��+��,��?��+

� �?�=?496I�1>�5H9CD9>7�AE5BI


�� When the Drawing Selection dialog displays, enable the Advanced radio button. If this query is beingdefined for multiple drawing selection, enable the Multiple Drawing Selection option. Press OK.


�� From the Select/Enter field, select the pre-defined query definition for modification.

�� Make changes to the existing query definition as desired, then press Save.

�� The Save Selections Query dialog displays. Press Save again to save the changes and close the dialog, oredit the Domain, Query (description), or INI Group fields as desired, then press Save.

�� If you pressed Save without changing any of the values in the Save Selections Query dialog, aconfirmation dialog displays.

��" ��,?��+�"��

� �?�4569>5�1�3?=@<5H�AE5BI


�� When the Drawing Selection dialog displays, enable the Advanced radio button. If this query is beingdefined for multiple drawing selection, enable the Multiple Drawing Selection check box. Press OK.


�� Define one or more queries.

�� In the Active Queries window, select the CONSTRAINT = expression to which an additional constraintwill be added.

�� Select the Operator.

�� From the Define Query area of the dialog, build a new query.

� Press Add. The two expressions are combined to create a complex query. For example, the query

CONSTRAINT=(LINENUMBER=’L100’)AND(MAIN_SIZE=’6’)

will only return 6” components on line L100.

� Press OK to create the selection set of components based on the query definition. Control is now passedto the command specified in Step 1.

�� If there are multiple active queries, be aware that complex constraints can only be associated withone query at a time. You must highlight the appropriate CONSTRAINT= line in the Active Querieswindow, then define each individually.

�D85B�?==1>4C��E>3D9?>CB1G9>7�)5<53D9?>�/@D9?>C


��

��?��+

� �?�45<5D5�1�AE5BI


�� When the Drawing Selection dialog displays, enable the Advanced radio button. If this query is beingdefined for multiple drawing selection, enable the Multiple Drawing Selection option. Press OK.


�� From the Select/Enter field, select the pre-defined query definition for modification.

�� Press Delete.

�� A confirmation dialog displays to warn you that the query is about to be removed. Press Yes.

Documents

AT_PIPERG_V_02_00