1 ED?

@<1>D@9@9>7

85<@B565B5>357E945
FUbcY_^"

REBIS 1600 RIVIERA AVENUE., SUITE 300 WALNUT CREEK, CALIFORNIA 94596 USA PHONE (925) 933-2525 FAX (925) 933-1920 WEB WWW.REBIS.COM

B 565B5>35

?@IB978D9>6?B=1D9?>

?G>5BC89@
Rebis documentation is copyrighted material. Reproduction of this material in any manner, in whole or in part, is strictly forbidden by Rebis. ALL rights reserved.

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

49C3<19=5B
Although Rebis programs have been tested and appear to produce satisfactory results, no warranty is expressed or implied, by the authors or by Rebis, as to the accuracy or functioning of the program, and no responsibility is assumed in connection therewith. All information presented is for review, interpretation, approval, and application by authorized personnel.

DB145=1B;C
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 respective owners.

QA - AP020010

D12<5?63?>D5>DC
CHAPTER 1: INTRODUCTION
ABOUT THIS MANUAL ..............................................................................................................................1-2 NEW FEATURES IN V2.0 ...........................................................................................................................1-3 VERSION 2.0 NEW FEATURES .................................................................................................................1-3 2D PIPING APPLICATION..............................................................................................................1-3 GENERAL .......................................................................................................................................1-3 DRAFTING TOOLS MENU (* NEW *).............................................................................................1-4 MISCELLANEOUS ATTACHMENTS..............................................................................................1-4 PIPING TOOLS MENU ...................................................................................................................1-4 COMPONENTS ..............................................................................................................................1-4 HELP AND DOCUMENTATION..................................................................................................................1-7 ADDING YOUR HELP.....................................................................................................................1-8 HOW DOES IT WORK?............................................................................................................1-8 PIPING CUSTOMER HELP......................................................................................................1-9 TIPS ON USING REBIS HELP .......................................................................................................1-9 SYSTEM REQUIREMENTS ......................................................................................................................1-10 GRAPHICS ENVIRONMENT ........................................................................................................1-10 SYSTEM .......................................................................................................................................1-10 AUTOPLANT APPLICATIONS......................................................................................................1-10 STRUCTURAL APPLICATIONS ...................................................................................................1-10 SUPPLEMENTAL/OTHER APPLICATIONS.................................................................................1-10 INSTALLATION.............................................................................................................................1-10 ASSUMPTIONS ............................................................................................................................1-10 KNOWLEDGE OF AUTOCAD ......................................................................................................1-11 KNOWLEDGE OF DRAFTING AND DESIGN TECHNIQUES......................................................1-11 AUTHORIZATION .....................................................................................................................................1-11 NEW SECURITY...........................................................................................................................1-11 EXISTING HARDWARE LOCKS ..................................................................................................1-11 DOCUMENTATION CONVENTIONS........................................................................................................1-12 TECHNICAL SUPPORT AND TRAINING.................................................................................................1-13 TYPES OF TECHNICAL SUPPORT.............................................................................................1-13

12<5?6

?>D5>DC

CHAPTER 2: GETTING STARTED

PROJECT CONFIGURATION.....................................................................................................................2-2 PROJECT CUSTOMIZATION TOOLS............................................................................................2-2 AUTOPLANT CONFIGURATION EDITOR...............................................................................2-2 AUTOPLANT CLASS EDITOR .................................................................................................2-3 SOFTWARE CONFIGURATION.................................................................................................................2-3 SOFTWARE CONFIGURATION FILES..........................................................................................2-3 NETWORK VS LOCAL WORKSTATION INSTALLATIONS.....................................................2-3 AT.INI KEYWORDS ........................................................................................................................2-4 TEMPORARY FILES ......................................................................................................................2-4 WINDOWS REGISTRY ENTRIES ..................................................................................................2-4 SOFTWARE CONFIGURATION - HOW TO TOPICS ....................................................................2-5 SETUP MULTIPLE CONFIGURATIONS..................................................................................2-5 SET THE NETWORK PATH.....................................................................................................2-5 SET THE LOCAL WORKSTATION PATH................................................................................2-6 SET/MODIFY AN APPLICATION CONFIGURATION ..............................................................2-6 SET THE TEMPORARY FILES DIRECTORY ..........................................................................2-6 INTERFACE ................................................................................................................................................2-7 MENUS ...........................................................................................................................................2-7 TOOLBARS.....................................................................................................................................2-8 DRAWING AREA ..........................................................................................................................2-11 COMMAND PROMPTS ................................................................................................................2-13 DIALOGS ......................................................................................................................................2-15 CONNECTION TECHNIQUES ..................................................................................................................2-16 GENERAL COMPONENT PLACEMENT......................................................................................2-17 PLACE A COMPONENT IN SPACE .............................................................................................2-17 PLACE A PIECE OF PIPE IN SPACE...........................................................................................2-18 PLACE AN ELBOW IN SPACE.....................................................................................................2-21 ATTACH TO AN EXISTING COMPONENT..................................................................................2-24 PLACE A KNOWN DISTANCE FROM AN EXISTING COMPONENT..........................................2-26 ALIGN TO EXISTING COMPONENTS .........................................................................................2-29 AUTOMATICALLY PLACE CONNECTING PIPE (AUTO PIPE) ...................................................2-34 CHANGE THE REFERENCE POINT............................................................................................2-36 AUTOMATICALLY ROUTE COMPONENTS ................................................................................2-37 PLACE ON A SMART POLYLINE.................................................................................................2-39 DRAWING PRODUCTION OVERVIEW....................................................................................................2-41 SPECIFICATION OVERVIEW...................................................................................................................2-43 SPEC DATABASE TABLE FORMAT............................................................................................2-43 PROVIDED SPECS AND CATALOGS .........................................................................................2-43

ii

AutoPLANT PIPING

12<5?6

?>D5>DC

CHAPTER 3: SETUP MENU

OVERVIEW .................................................................................................................................................3-2 DRAWING PREFERENCES .....................................................................................................................4-3 2D HIDDEN LINE OPTIONS .......................................................................................................................4-6 MODULE SETUP ......................................................................................................................................4-8 AVAILABLE MODULES ..................................................................................................................4-8 LOAD ALL.......................................................................................................................................4-9 LOAD MODULE ..............................................................................................................................4-9 UNLOAD MODULE.........................................................................................................................4-9 UNLOAD ALL MODULES ...............................................................................................................4-9 VIEW MODULE DETAILS...............................................................................................................4-9 APPLY.............................................................................................................................................4-9 CABLE TRAY MODULE (PIPING MODULE ONLY) .....................................................................4-10 LOAD ......................................................................................................................................4-10 SPECS/CATALOGS ...............................................................................................................4-10 COMPONENTS ......................................................................................................................4-10 DRAWING PREFERENCES...................................................................................................4-10 CONDUIT MODULE (PIPING MODULE ONLY)...........................................................................4-10 LOAD ......................................................................................................................................4-10 SPECS/CATALOGS ...............................................................................................................4-11 COMPONENTS ......................................................................................................................4-11 DUCTILE IRON MODULE ............................................................................................................4-11 LOAD ......................................................................................................................................4-11 SPECS/CATALOGS ...............................................................................................................4-11 COMPONENTS ......................................................................................................................4-11 HIGH PURITY MODULE...............................................................................................................4-12 LOAD ......................................................................................................................................4-12 SPECS/CATALOGS ...............................................................................................................4-12 COMPONENTS ......................................................................................................................4-12 HVAC MODULE (PIPING MODULE ONLY) .................................................................................4-12 LOAD ......................................................................................................................................4-12 SPECS/CATALOGS ...............................................................................................................4-12 COMPONENTS ......................................................................................................................4-13 LINED PIPE MODULE ..................................................................................................................4-13 LOAD ......................................................................................................................................4-13 SPECS/CATALOGS ...............................................................................................................4-13 COMPONENTS ......................................................................................................................4-13 TUBING MODULE ........................................................................................................................4-13 LOAD ......................................................................................................................................4-13 SPECS/CATALOGS ...............................................................................................................4-14 COMPONENTS ......................................................................................................................4-14 VICTAULIC MODULE ...................................................................................................................4-14 LOAD ......................................................................................................................................4-14 SPECS/CATALOGS ...............................................................................................................4-14 COMPONENTS ......................................................................................................................4-14 MODULE CUSTOMIZATION ........................................................................................................4-15 MODULE SETUP CUSTOMIZATION - HOW TO TOPICS...........................................................4-15 DEFINE A NEW MODULE GROUP CONFIGURATION ........................................................4-15 DEFINE A NEW MODULE DIRECTORY STRUCTURE.........................................................4-16 MODIFY THE MODULE SETUP DIALOG..............................................................................4-16 COMPONENT PREFERENCES................................................................................................................4-17 SPECIFICATION...........................................................................................................................4-17 NOMINAL SIZE.............................................................................................................................4-17 LINE NUMBER..............................................................................................................................4-17
Reference Manual iii

12<5?6

?>D5>DC

DATA MODE.................................................................................................................................4-17 COMPONENT COPY PREFERENCES ...................................................................................................4-18 POST-COPY UPDATE AUTOMATION.........................................................................................4-18 PROMPT FOR NEW COMPONENT VALUE..........................................................................4-18 SYSTEM DEFAULT UPDATING ............................................................................................4-19 AUTOMATIC SCRIPT-BASED UPDATING............................................................................4-19 COMPONENT FIELDS .................................................................................................................4-19 COMPONENT COPY PREFERENCES DIALOG ...................................................................4-19 PREFIX AND SUFFIX...................................................................................................................4-20 BASIC SCRIPT UPDATE METHOD .............................................................................................4-21 ESTABLISH POST-COPY COMPONENT UPDATE PREFERENCES.........................................4-21 SET THE PREFIX AND/OR SUFFIX WHEN UPDATING COPIED COMPONENTS....................4-21 COPY A COMPONENT ................................................................................................................4-22 COMPONENT UPDATE PREFERENCES ..............................................................................................4-23 AVAILABLE FIELDS .....................................................................................................................4-23 ADD > ...........................................................................................................................................4-24 REMOVE.......................................................................................................................................4-24 FIELDS 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-8 TOPWORKS .................................................................................................................................4-8 AUTOMATIC INSERTION ........................................................................................................4-8 MANUAL INSERTION ..............................................................................................................4-8 TOPWORKS PLACEMENT CUSTOMIZATION .......................................................................4-9 DIALOG SELECTION...............................................................................................................4-9 SPEC SELECTION.................................................................................................................4-10 CLASS SELECTION...............................................................................................................4-10 TURN OFF TOPWORKS PLACEMENT.................................................................................4-10 USER VALVES ...........................................................................................................................4-11 ADDING A CUSTOM COMPONENT ............................................................................................4-11 FLANGES..................................................................................................................................................4-12 REDUCERS AND SWAGES .....................................................................................................................4-12 MISCELLANEOUS FITTINGS ..................................................................................................................4-13 USER FITTINGS .........................................................................................................................4-15 ADDING A CUSTOM COMPONENT......................................................................................4-15 SUPPORTS ...............................................................................................................................................4-16 ADDING A CUSTOM COMPONENT ............................................................................................4-16 PLACE A SUPPORT.....................................................................................................................4-17 MISCELLANEOUS ATTACHMENTS .....................................................................................................4-18 PIPING..........................................................................................................................................4-18 ISOMETRICS................................................................................................................................4-18 ADDING A CUSTOM COMPONENT ............................................................................................4-19 REFERENCE DIMENSION ATTACHMENT .................................................................................4-19 CUSTOMIZATION CONSIDERATIONS.................................................................................4-21 COMPONENT PLACEMENT - HOW TO TOPICS....................................................................................4-21 ADD OPERATORS TO VALVES (TOPWORKS) ..........................................................................4-21 ALIGN TO EXISTING COMPONENTS .........................................................................................4-22
iv AutoPLANT PIPING

12<5?6

?>D5>DC

ATTACH TO AN EXISTING COMPONENT..................................................................................4-23 AUTOMATICALLY ROUTE COMPONENTS ................................................................................4-23 AUTOMATICALLY PLACE CONNECTING PIPE (AUTOPIPE)....................................................4-23 CHANGE THE REFERENCE POINT............................................................................................4-24 DEFINE A TAP PORT FOR OLET PLACEMENT.........................................................................4-24 PLACE A COMPONENT IN SPACE .............................................................................................4-25 PLACE A KNOWN DISTANCE FROM AN EXISTING COMPONENT..........................................4-25 PLACE ON A SMART POLYLINE.................................................................................................4-26 COMPONENT MANIPULATION - HOW TO TOPICS...............................................................................4-27 EDIT COMPONENT INFORMATION............................................................................................4-27 UPDATE COMPONENT INFORMATION .....................................................................................4-27 COPY A COMPONENT ................................................................................................................4-28 ESTABLISH POST-COPY COMPONENT UPDATE PREFERENCES.........................................4-29 MOVE A COMPONENT................................................................................................................4-29 SET THE PREFIX AND/OR SUFFIX WHEN UPDATING COPIED COMPONENTS....................4-30

CHAPTER 5: PIPING TOOLS MENU

OVERVIEW .................................................................................................................................................5-2 CENTERLINE ROUTERS MENU................................................................................................................5-2 EDIT COMPONENT PREFERENCES............................................................................................5-2 FROM DIALOG .............................................................................................................................5-3 OPTIONS..................................................................................................................................5-3 INFO MODE DIALOG ...................................................................................................................5-11 FROM POLYLINE .......................................................................................................................5-12 FROM FILE .................................................................................................................................5-13 FILE STRUCTURE .................................................................................................................5-13 PRO-PIPE ROUTER ...................................................................................................................5-13 DESIGNER ROUTER .................................................................................................................5-14 FROM POINTS ...........................................................................................................................5-15 BACK ......................................................................................................................................5-15 REDRAW................................................................................................................................5-15 REF.........................................................................................................................................5-15 ABS.........................................................................................................................................5-16 NORTH ...................................................................................................................................5-16 SOUTH ...................................................................................................................................5-16 WEST .....................................................................................................................................5-16 EAST ......................................................................................................................................5-16 UP...........................................................................................................................................5-16 DOWN ....................................................................................................................................5-16 PICK NEXT POINT .................................................................................................................5-16 CENTERLINE ROUTER - HOW TO TOPICS ...............................................................................5-17 ROUTE A CENTERLINE FROM DIALOG ..............................................................................5-17 ROUTE A CENTERLINE FROM POINTS ..............................................................................5-17 ROUTE A CENTERLINE FROM POLYLINE ..........................................................................5-18 ROUTE A CENTERLINE - DESIGNER ROUTER ..................................................................5-18 ROUTE A CENTERLINE - PROPIPE ROUTER .....................................................................5-19 ROUTE A CENTERLINE FROM FILE ....................................................................................5-19 EDIT CENTERLINE PREFERENCES ....................................................................................5-19 REPRESENTATIONS ...............................................................................................................................5-20 OPERATION BUTTONS...............................................................................................................5-20 AUTOCAD ENTITIES....................................................................................................................5-21 ACIS .......................................................................................................................................5-21 2D VIEW .................................................................................................................................5-21 MESH .....................................................................................................................................5-21

Reference Manual

12<5?6

?>D5>DC

3D DISPLAY MODES................................................................................................................................5-22 WIREFRAME ..............................................................................................................................5-22 CENTERLINE .............................................................................................................................5-22 WIREFRAME W/CENTERLINE ..................................................................................................5-23 MESH ..........................................................................................................................................5-23 SET VIEWPORT DRAW MODE ...................................................................................................5-24 RESET ALL VIEWPORT DRAW MODES.....................................................................................5-24 SHADE ALL VIEWPORTS ............................................................................................................5-24 HIDE ALL VIEWPORTS................................................................................................................5-24 CONTROL 3D DISPLAY MODES.................................................................................................5-24 3D DISPLAY UTILITIES MENU ................................................................................................................5-25 SET OBJECT RIMS ON................................................................................................................5-25 SET OBJECT RIMS OFF..............................................................................................................5-25 SET CENTERLINE COLOR..........................................................................................................5-25 SET CENTERLINE TYPE .............................................................................................................5-26 SET CENTERLINE VISIBILITY.....................................................................................................5-26 SET TORUS CENTERLINE TYPE................................................................................................5-27 SET CLIPPED GRAPHICS TYPE.................................................................................................5-27 CONNECTIVITY CHECKER .....................................................................................................................5-27 CHECKER ...................................................................................................................................5-27 CHECK RUN ...............................................................................................................................5-29 RESUME CHECKER ..................................................................................................................5-29 CONNECTIVITY - HOW TO TOPICS ...........................................................................................5-29 CHECK SELECTED COMPONENTS FOR CONNECTIVITY.................................................5-29 CHECK ENTIRE RUN ............................................................................................................5-29 RESUME CHECKER ..............................................................................................................5-30 DIMENSION NODES.................................................................................................................................5-30 JOIN COMPONENTS................................................................................................................................5-31 STOP SIGNS ...........................................................................................................................................5-32 PLACE STOP SIGNS FOR ISO....................................................................................................5-32

CHAPTER 6: DATABASE TOOLS MENU

OVERVIEW .................................................................................................................................................6-2 EDIT COMPONENT ..................................................................................................................................6-2 EDIT COMPONENT - PAGE 2 ......................................................................................................6-4 UPDATE COMPONENT ............................................................................................................................6-5 CLEAN DATABASE ..................................................................................................................................6-6 VIEW DATABASE .....................................................................................................................................6-8 DATABASE INFORMATION .....................................................................................................................6-8 CLEAR CONNECTIONS.................................................................................................................6-9 VIEW TRANSACTIONS..................................................................................................................6-9 UPDATE FROM SPEC................................................................................................................................6-9 DATABASE - HOW TO TOPICS...............................................................................................................6-11 EDIT COMPONENT INFORMATION............................................................................................6-11 UPDATE COMPONENT INFORMATION .....................................................................................6-11 CLEAN THE DRAWING DATABASE TO REMOVE INVALID LINKS ...........................................6-12 VIEW THE DRAWING DATABASE...............................................................................................6-12 DRAWING DATABASE CUSTOMIZATION .............................................................................................6-13 DRAWING DATABASE FORMAT.................................................................................................6-13 DRAWING DATABASE TABLES ..................................................................................................6-14 HOW IT WORKS ....................................................................................................................6-15 DRAWING DATABASE TABLE SCHEMAS..................................................................................6-16
vi AutoPLANT PIPING

12<5?6

?>D5>DC

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

CHAPTER 7: 2D PIPING AND THE DRAFTING TOOLS MENU

2D PIPING APPLICATION OVERVIEW......................................................................................................7-2 PACKAGING THE 2D PIPING PRODUCT .....................................................................................7-2 HIDDEN LINE REMOVAL OUTPUT FOR CUSTOM ENTITIES .....................................................7-2 AUTOCAD R14 VS. AUTOCAD 2000 .............................................................................................7-2 MODIFICATIONS TO DRAWING PREFERENCES DIALOG .........................................................7-2 2D HIDDEN LINE OPTIONS...........................................................................................................7-3 SYMBOL MANAGER ......................................................................................................................7-4 RESTRICTIONS FROM THE STANDARD 3D PIPING PRODUCT................................................7-4 PIPING TOOLS ........................................................................................................................7-4 DRAW SCRIPTS.............................................................................................................................7-5 2D HLR OPTIONS ..........................................................................................................................7-5 DRAFTING TOOLS MENU .........................................................................................................................7-6 SYMBOL MANAGER..................................................................................................................................7-6 AUTOCAD 2000 USAGE ................................................................................................................7-6 AUTOCAD R14 USAGE..................................................................................................................7-7 PROCEDURES...............................................................................................................................7-7 SYMBOL LIBRARY DETAILS .........................................................................................................7-9 TITLE BLOCK.............................................................................................................................................7-9 2D SYMBOLS ...........................................................................................................................................7-10 CUSTOMIZATION ........................................................................................................................7-10 INSULATE PIPE........................................................................................................................................7-11 PIPE END SYMBOL..................................................................................................................................7-11 2D EDITING MENU ...................................................................................................................................7-11 BROKEN PIPE..............................................................................................................................7-12 BREAK ..........................................................................................................................................7-12 MEND............................................................................................................................................7-13 MEND ALL ....................................................................................................................................7-13

CHAPTER 8: ANNOTATION
OVERVIEW .................................................................................................................................................8-2 ANNOTATION PREFERENCES ...............................................................................................................8-2 ANNOTATION STYLE ....................................................................................................................8-2 PLACEMENT ..................................................................................................................................8-3 NORMAL MODE .............................................................................................................................8-3 TEXT MODE ...................................................................................................................................8-3 TEXT OPTIONS..............................................................................................................................8-4 BLOCK OPTIONS...........................................................................................................................8-4 CONTAINER OPTIONS..................................................................................................................8-4 LEADER OPTIONS.........................................................................................................................8-4
Reference Manual vii

12<5?6

?>D5>DC

EDIT ANNOTATION....................................................................................................................................8-5 FORMAT.........................................................................................................................................8-5 EDIT VERTEX.................................................................................................................................8-5 ROTATE..........................................................................................................................................8-5 MOVE..............................................................................................................................................8-5 ANNOTATION.................................................................................................................................8-5 EXIT ................................................................................................................................................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-9 EDIT ANNOTATION .......................................................................................................................8-9 PLACE A MATERIAL TAG..............................................................................................................8-9 PLACE AN INSTRUMENT BALLOON ..........................................................................................8-10 DATABASE FIELD ANNOTATION - HOW TO TOPICS ...............................................................8-11 PLACE "MAIN SIZE" ANNOTATION ......................................................................................8-11 PLACE "DESCRIPTION" ANNOTATION................................................................................8-11 PLACE "LONG DESCRIPTION" ANNOTATION ....................................................................8-12 PLACE "SPECIFICATION" ANNOTATION.............................................................................8-12 PLACE "PIPE CUT LENGTH" ANNOTATION ........................................................................8-13 PLACE "INSULATION" ANNOTATION...................................................................................8-13 LINE NUMBER ANNOTATION - HOW TO TOPICS.....................................................................8-14 PLACE SHORT LINE NUMBER ANNOTATION.....................................................................8-14 PLACE LONG LINE NUMBER ANNOTATION .......................................................................8-14 PLACE SHORT LINE NUMBER ANNOTATION WITH CENTERLINE SYMBOL...................8-15 PLACE LONG LINE NUMBER ANNOTATION WITH CENTERLINE SYMBOL .....................8-16 NOTE ANNOTATION - HOW TO TOPICS ...................................................................................8-16 INSERT A GENERAL NOTE ..................................................................................................8-16 INSERT ELEVATION INFORMATION..........................................................................................8-17 COORDINATE ANNOTATION - HOW TO TOPICS .....................................................................8-18 PLACE NE/ NS/ EW COORDINATE ANNOTATION ..............................................................8-18 PLACE GENERAL COORDINATE ANNOTATION.................................................................8-18

CHAPTER 9: REPORTS MENU

OVERVIEW .................................................................................................................................................9-2 BILL OF MATERIALS ...............................................................................................................................9-2 GENERAL PROCEDURE ...............................................................................................................9-3 REPORT NAME..............................................................................................................................9-3 REPORT FILE.................................................................................................................................9-4 UNITS/PRECISION.........................................................................................................................9-4 MISC. OPTIONS .............................................................................................................................9-4 MATERIAL TAG OPTIONS.............................................................................................................9-5 BILL OF MATERIALS CONFIGURATION ......................................................................................9-6 GENERAL TAB (BOM CONFIG) ..............................................................................................9-7 TITLE TAB (BOM CONFIG) .....................................................................................................9-9 HEADER TAB (BOM CONFIG) ..............................................................................................9-10 ROW TAB (BOM CONFIG).....................................................................................................9-11 COLUMN TAB (BOM CONFIG)..............................................................................................9-12

viii

AutoPLANT PIPING

12<5?6

?>D5>DC

BILL OF MATERIALS - HOW TO TOPICS ...................................................................................9-13 GENERATE A BILL OF MATERIALS .....................................................................................9-13 SELECT THE BOM FORMAT CONFIGURATION .................................................................9-14 ADD/MODIFY A BOM FORMAT CONFIGURATION..............................................................9-14 SET THE BOM PLACEMENT METHOD ................................................................................9-15 SET THE BOM BORDER PROPERTIES ...............................................................................9-15 SET THE BOM HEADER PROPERTIES................................................................................9-16 SET THE BOM TITLE PROPERTIES.....................................................................................9-16 SET THE BOM ROW PROPERTIES......................................................................................9-17 SET THE BOM COLUMN PROPERTIES...............................................................................9-17 BILL OF MATERIALS CUSTOMIZATION.....................................................................................9-18 HOW DOES IT WORK?..........................................................................................................9-18 REPORT FILES......................................................................................................................9-18 GENERATE REPORTS ...........................................................................................................................9-19 REPORT TYPE.............................................................................................................................9-20 REPORT NAME............................................................................................................................9-20 REPORT FILE...............................................................................................................................9-22 OPTIONS......................................................................................................................................9-22 UNITS/PRECISION.......................................................................................................................9-23 OUTPUT .......................................................................................................................................9-23 OK.................................................................................................................................................9-23 REPORTS - HOW TO TOPICS.....................................................................................................9-24 GENERATE REPORTS..........................................................................................................9-24 REPORT GENERATOR CUSTOMIZATION...........................................................................9-24 HOW DOES IT WORK?..........................................................................................................9-24 REPORT FILES......................................................................................................................9-25 REPORT TYPES ....................................................................................................................9-25 REPORT DEFINITION............................................................................................................9-25 REPORTS CUSTOMIZATION - HOW TO TOPICS......................................................................9-26 ADD/MODIFY A REPORT TYPE............................................................................................9-26 CREATE A NEW REPORT FILE ............................................................................................9-26 ADD A NEW REPORT DEFINITION ......................................................................................9-26 ADD 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-3 WORK AREA ................................................................................................................................10-4 REFERENCE DRAWINGS ...........................................................................................................10-4 INSERTION POINT.......................................................................................................................10-5 PICK..............................................................................................................................................10-5 ROTATION....................................................................................................................................10-5 MEMBERSHIP STATUS...............................................................................................................10-5 XREF ATTACHMENT TYPE.........................................................................................................10-5 NEW..............................................................................................................................................10-6 OPEN............................................................................................................................................10-6 SAVE.............................................................................................................................................10-6 SAVE AS.......................................................................................................................................10-6 CLOSE..........................................................................................................................................10-6 CANCEL........................................................................................................................................10-6 WORK AREA VIEWS ..............................................................................................................................10-7 CURRENT WORKING AREA .......................................................................................................10-7 ADD...............................................................................................................................................10-7 REMOVE.......................................................................................................................................10-7
Reference Manual ix

12<5?6

?>D5>DC

WINDOW ......................................................................................................................................10-7 EDIT..............................................................................................................................................10-7 COPY............................................................................................................................................10-8 INSERT/APPLY IN MODEL ..........................................................................................................10-8 PREVIEW......................................................................................................................................10-8 AUTO ZOOM ................................................................................................................................10-8 VIEW PROPERTIES.....................................................................................................................10-9 VIEW TITLE............................................................................................................................10-9 VIEW.......................................................................................................................................10-9 SCALE ....................................................................................................................................10-9 PROJECTION TILE ..............................................................................................................10-10 VIEW OPTIONS....................................................................................................................10-10 MATCH LINE OPTIONS.......................................................................................................10-10 3D VIEW ENVELOPE...........................................................................................................10-10 OK.........................................................................................................................................10-11 CANCEL ...............................................................................................................................10-11 EDIT SCALES.......................................................................................................................10-11 COORDINATE SYSTEM ......................................................................................................10-12 UPDATE WORK AREA .........................................................................................................................10-12

CHAPTER 11: 2D TO 3D MENU

OVERVIEW ...............................................................................................................................................11-2 PROCESS OVERVIEW .............................................................................................................................11-2 THE MAPPING PROCESS ...........................................................................................................11-2 MAPPING FILES...........................................................................................................................11-3 CLASSMAP.INI.......................................................................................................................11-3 PIDFLD.INI .............................................................................................................................11-3 2D3D.INI .................................................................................................................................11-4 PIDPREF.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-2 LOAD ............................................................................................................................................12-2 UNLOAD .......................................................................................................................................12-2 EXECUTE .....................................................................................................................................12-2 DEBUG .........................................................................................................................................12-2 SPECIFICATION SELECTION DIALOG...................................................................................................12-2 DRAWING NODES AND DRAWING BORDER CUSTOMIZATION.........................................................12-3 SPECIFICATION SELECTION ERROR....................................................................................................12-3 SPECIFICATION VALIDATION ................................................................................................................12-4 VALIDATION.................................................................................................................................12-4 SPEC REPAIR ..............................................................................................................................12-4 CATALOG REPAIR.......................................................................................................................12-4 NOTES/WARNINGS .....................................................................................................................12-5 DRAWING REPAIR.......................................................................................................................12-5 DRAWING SELECTION OPTIONS...........................................................................................................12-6 ALL................................................................................................................................................12-6 MANUAL .......................................................................................................................................12-6 ADVANCED - CURRENT DRAWING ...........................................................................................12-6
x AutoPLANT PIPING

12<5?6

?>D5>DC

DOMAIN .................................................................................................................................12-7 SELECT/ENTER.....................................................................................................................12-7 TYPE ......................................................................................................................................12-7 ATTRIBUTE FIELD.................................................................................................................12-7 CONSTRAINT ........................................................................................................................12-8 ATTRIBUTE VALUE ...............................................................................................................12-8 OPERATOR............................................................................................................................12-9 ACTIVE QUERIES..................................................................................................................12-9 WINDOW SELECTION...........................................................................................................12-9 INCLUDE XREFS ...................................................................................................................12-9 SAVE ......................................................................................................................................12-9 NEW .....................................................................................................................................12-10 DELETE................................................................................................................................12-10 ADVANCED - MULTIPLE DRAWING .........................................................................................12-11 DOMAIN ...............................................................................................................................12-11 SELECT/ENTER...................................................................................................................12-11 ADD DRAWINGS..................................................................................................................12-12 TYPE ....................................................................................................................................12-12 ATTRIBUTE FIELD...............................................................................................................12-12 CONSTRAINT ......................................................................................................................12-12 ATTRIBUTE VALUE .............................................................................................................12-12 OPERATOR..........................................................................................................................12-13 ACTIVE QUERIES................................................................................................................12-14 SAVE ....................................................................................................................................12-14 NEW .....................................................................................................................................12-14 DELETE................................................................................................................................12-14 DEFINING A SELECTION SET ..................................................................................................12-15 SELECT ALL THE COMPONENTS IN THE CURRENT DRAWING. ...................................12-15 MANUALLY SELECT COMPONENTS IN THE CURRENT DRAWING ...............................12-15 DEFINE MULTIPLE DRAWING QUERIES...........................................................................12-15 DEFINE A CURRENT DRAWING QUERY...........................................................................12-16 CREATE AND SAVE A QUERY ...........................................................................................12-16 MODIFY AN EXISTING QUERY ..........................................................................................12-17 DEFINE A COMPLEX QUERY (MULTIPLE CONSTRAINTS)..............................................12-17 DELETE A QUERY...............................................................................................................12-18

Reference Manual

xi

381@D5B

9>DB?4E3D9?>

This Reference Guide was generated in response to users requests to have the application online help formatted in a manner that could be referenced away from a setting in which the actual software was installed and running in front of them. It is provided in Adobe Acrobat Reader format to enable you to print as many copies of this information as desired.

ABOUT THIS MANUAL NEW FEATURES IN V1.5 HELP AND DOCUMENTATION SYSTEM REQUIREMENTS AUTHORIZATION DOCUMENTATION CONVENTIONS TECHNICAL SUPPORT AND TRAINING

1-2 1-3 1-7 1-10 1-11 1-12 1-13

>DB?4E3D9?>

2?EDD89C

1>E1<

12?EDD89C=1>E1<
This Reference Guide was generated in response to users requests to have the application on-line help formatted in a manner that could be referenced away from a setting in which the actual software was installed and running in front of them. Remember, this manual was generated from the on-line help, and therefore may have references to help topic links, which are not available as links in this format. The manual is provided in Adobe Acrobat Reader format to enable you to print as many copies of this information as desired. An option 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. The chapters are primarily organized by the layout of the main PIPING application menu, i.e., all of the commands 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, then provides 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 also provides 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 Production menu. 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, and utilities that are in general not executed explicitly from the Piping menu.

+ + + +

+ + +

+ +

1-2

AutoPLANT PIPING

9 > 6
5G

>DB?4E3D9?>

51DEB5C9>

F"

>5G651DEB5C9>F"
This area of the PIPING help system provides version-by-version links to new features added to the application. The following identifies the New Features and Modifications in Version 2.0 of the PIPING application.

F5BC9?>" >5G651DEB5C
The following provides a brief description of the new features and modifications in Version 2.0 of the PIPING application.

"4@Y`Y^W1``\YSQdY_^
A 2D version of the AutoPLANT PIPING application may now be purchased separately. Users that purchase an 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 functionality will be controlled by the Rebis Security system. The security system will control whether a user has access to the 2D or 3D PIPING environment and the associated commands and functions. When an Authorization request is made, the request will be specifically for the use of 2D or 3D PIPING. This will be controlled by the creation of either a 2D or 3D piping model, export to PCF etc. The primary control of the component drawing mode will be handled through the Drawing Preferences dialog.

7U^UbQ\

The AutoPLANT report writer has been upgraded to version 7.0 of Crystal Reports. Due to an anomaly in Crystal Reports, you should request the free correction release of version 7.0 from Seagate (version 7.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 may continue to do so with version 5.0. However, obviously the new report templates delivered can only be modified with version 7.0 or higher. >_dU Although version 8.0 has not been tested we expect this bug has been corrected in the standard version 8.0 release allowing version 5.0 reports to be saved in version 8.0. Under this version the report should be saved as a version 7.0 report unless you want to upgrade his own runtime to version 8.0.

Architectural Desktop support: This version will be supported when run with the version of AutoCAD that is delivered with Architectural Desktop. There is no interaction with any of the Desktop objects or any other added functionality associated with the Desktop product. DIN specs now have the nominal diameter prefixed with DN, such as DN100 for 100mm pipe. Various other 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 with ISOMETRICS 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.

Reference Manual

1-3

>DB?4E3D9?>

5BC9?>

" > 6
 5G

51DEB5C

4bQVdY^WD__\c=U^e>5G

The Drafting Tools menu has been added to the main Piping menu. It contains commands specifically designed for the placement and manipulation of 2D AutoCAD entities. A new Symbol Manager application is included, which provides a dockable interface (AutoCAD 2000 ONLY) that lists symbols in a tree view. A separate floating dialog interface is provided for AutoCAD R14 users. These symbols may 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 to the Drafting Tools menu. The 2D symbol placement options that were also in the Annotation menu have also been moved to this menu.

=YcSU\\Q^U_ec1ddQSX]U^dc

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

@Y`Y^WD__\c=U^e

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 at the command line to manually toggle this clipped graphics display of individual cylinders. Representations: The numerous individual menu commands that were provided to generate graphic representations of your components have been centralized in a single dialog control.

3_]`_^U^dc

Nozzles: A need has been established to create a nozzle component that will simply represent the nozzle as a symbolic representation and will typically be used when the user has already modeled the nozzle but needs a connection to an existing pipe line. This would allow complete Isos to be generated as well as a complete Bill Of Materials output and other requirements. To satisfy this requirement the existing nozzle component has been modified. High Purity elbow draw scripts have been improved to be more realistic. They now include a straight section 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 now draw 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 straight sections. The cut pipe symbol can now be optionally changed to the Japanese standard.

1-4

AutoPLANT PIPING

9 F
5BC9?>

>DB?4E3D9?>

" > 6
 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@5CE@@?BDDI@5C81F5255>14454

1. 2. 3. 4. 5. 6. 7. 8. 9.

Generic Guides/Anchor Boxes Vessel Pipe Guides Platform Pipe Guides Riser Clamp Base Anchor General Hanger Rod Spring Hanger Pipe Lug Attachment 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
Reference Manual 1-5

>DB?4E3D9?>

5BC9?>

" > 6
 5G

51DEB5C

449D9?>1<@9@9>73?=@?>5>DC81F5255>14454

1. 2. 3. 4. 5. 6. 7. 8. 9.

Trimmed 45 degree Elbow Reducing Lateral Long Weldneck Flange Control/Ball Valve Control/Globe Control/Check Control/Butterfly Control/Angle 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 =
9C31449D9?>1<3?=@?>5>DC

1. 2. 3. 4. 5. 6. 7. 8.

Reinforcing Pad Plain Lock Coupling # 90 Roto Chain Links Roto Chain Operator Injection Quill Venturi Flow meter Symbol Complex Flow meter Symbol Isogen Reference Dimensions General components have been added to the High Purity module. Ball valves have been added to the High Purity catalog and specs as well. The valve topworks have been improved for this module.

1-6

AutoPLANT PIPING

9 8
5<@1>4

>DB?4E3D9?>

?3E=5>D1D9?>

85<@1>44?3E=5>D1D9?>
The following table describes the help/tutorial documents provided with your software:
6 >
9<5 1=5

5C3B9@D9?>

1

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 and
function.

Access: Select Help/Contents from the Piping application menu, or select AutoPLANT 3D/Program Help Files/PIPING Help 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 available feature and function. Access: Select Help/Contents from the Import/Export application menu, or select AutoPLANT 3D/Program Help Files/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 your AutoPLANT applications (e.g., project customization, drawing database customization, module customization, report/BOM customization, etc.). Access: Select AutoPLANT 3D/Customization Tools and Help/AutoPLANT Program Customization Help from
your Windows Start menu.

BSCRIPT.CHM

Description: This help system provides information on AutoPLANT Basic Language Extensions provided to customize almost any 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 these language elements when using the Rebis Script Editor to customize/create basic scripts. Simply place the cursor within the element you need help on and pressing the function key. Access: Select AutoPLANT 3D/Customization Tools and Help/Basic Language Reference Help from your
Windows 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 intuitive graphical user interface to modify the information in the configuration files that define the PIPING/ISOMETRICS modules and the individual components available in each module. It also provides direct access to the method script files, port definition, and specification search criteria that are used by each component class. Access: Select Help/Contents from the Class Editor application menu, or select AutoPLANT 3D/Customization Tools and 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 was designed to remove the tedious effort that would have been required to manually edit the configuration files used to create and customize project configurations. Access: Select Help/Contents from the Configuration Editor application menu, or select AutoPLANT 3D/Customization Tools 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 user
interface 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 Tools and 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 to create/customize AutoPLANT Basic drawing scripts and functions. Context-sensitive help is provided to almost every standard Basic 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 Tools and Help/Script Editor Help from your Windows Start menu.

Reference Manual

1-7

>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 and
sets of models, which may be purchased separately. You can load multiple models varying from thousands to millions of triangles in size and interact with them at a guaranteed frame rate. It supports multiple formats via a plugin mechanism, as well as its own native file formats, AutoCADs *.dwg and *.dxf files and 3D Studios *.3ds files are supported. A range of navigating and viewing controls 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/Rebis Explorer 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 whose
primary 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/SpecGen Help 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 the
software.

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

>_dU

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

1449>7I?EB85<@
Rebis has developed a simple system to enable Dealers, Contractors, Users, etc. to provide links to their own custom HTML help system within each primary AutoPLANT applications help system.

8_g4_UcYdG_b[/
The topic Adding Your Help/Piping Customer Help that is compiled within the PIPING help file provides a link to a stand-alone HTML file named CUSTPIPE.HTM. This file may be modified to form the start point for your custom HTML help system. The path and name of this file is assigned in the >+HOS'RFV@ group of your ..\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,62KWP (43 1(7:25.B5227?6XSSRUW?&86(43KWP $,62 1(7:25.B5227?6XSSRUW?&867$,62KWP ;&+* 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 HTML editor (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, which may then be accessed directly from within the individual AutoPLANT application help systems. This system also enables you to download or upgrade your existing AutoPLANT help files, while maintaining the integrity of your internally generated HTML procedures. The following procedure explains how to modify CUSTPIPE.HTM to link your own internal procedures to a Rebis application HTML help system. This example explains how to create a new HTML file named MyProc1.HTM, then establish a link to this procedure by modifying the provided CUSTPIPE.HTM file using Microsoft 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. Enter some more text as desired to define a common procedure used by your organization.

1-8

AutoPLANT PIPING

9 8 $ % & ' ( )
5<@1>4

>DB?4E3D9?>

?3E=5>D1D9?>

Select File/Save As, then set the Save As Type selection to HTML Document. Type the file name as MYPROC1.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 the link. !! Save the file and exit. Thats all there is to it. !" To test your link, run the PIPING application help file. Display the Adding Your Help/PIPING Customer Help topic, then press the Click here to display your CUSTPIPE.HTM button. Your link now appears in the CUSTPIPE.htm help topic in a separate HTML help window. Click on the My Procedure 1 link to display your custom help procedure. >_dU There is a wealth of additional information available on HTML help via the Internet.

@9@9>73ecd_]Ub8U\`
The Add Your Help topic above explains how you can add a link to your own HTML based help system from within PIPINGs help. The main HTML page of your help system must be named CUSTPIPE.HTM and must reside in the same directory as the PIPING help file AT_PIPE.CHM. Once you have created your help system, you can click the Display your Custom HTML Help button in the PIPING Customer Help topic to access it. An example CUSTPIPE.HTM has been created for you and may be modified.

D9@C?>EC9>7B529C85<@
Rebis Help has been designed to provide you access to a variety of different types of help. The suggestions below 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 your help window. As you click on links within a topic, the topic that you jump to is automatically highlighted in the left pane to enable you to more easily view where you are within the overall help system. An extensive index of help topics has been provided to enable you to quickly locate information on a 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 find an entry in the index that you want to view, press the Display button. 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 List Topics. All of the topics within the help system that contain the entered keyword or phrase will appear in the selection list. Select the topic that you want to display, then press the Display button to view the topic. The Command Reference folder in the help system has been organized to replicate the layout of the application menu system as closely as possible. Where deemed necessary, a set of How To procedures are provided in a separate How To folder below the actual commands folder.

Index

Search

Relationship between Command Reference and How To topics

Reference Manual

1-9

>DB?4E3D9?>

ICD5=

5AE9B5=5>DC

Printing

The new organization of Rebis help systems makes printing easier than ever. To print the current topic, simply select it in the Table of Contents, then press the Print button. Enable the Print the selected topic radio button in the dialog displayed, then press OK. If you want to print all of the topics that reside in a particular folder and all of its sub-folders, simply select the folder and press Print, then enable the Print the selected heading and all subtopics radio button, then press OK. All topics in and below the selected folder will be printed in the order in which they are defined in the folder. Rebis has devised a system to enable you to add a link to your own custom set of internal procedures, etc. from within each Rebis application help system. This information can be found under the folder Adding Your Help that appears at the bottom of the Table of Contents for each help system.

Adding Your Own Help

CICD5=B5AE9B5=5>DC 7B1@893C5>F9B?>=5>D
AutoCAD Release 14/2000 installed and fully operational.

CICD5= 1ED?@<1>D1@@<931D9?>C
Operating System CAD Environment Processor Pentium-Pro 200mHz RAM 64 MB (128 MB recommended) Disk Space 650 MB (1 GB recommended)

Windows 95, 98, AutoCAD r14, 2000, NT, or 2000 or 2000i

CDBE3DEB1<1@@<931D9?>C
Operating System Windows 98, NT, or 2000 CAD Environment AutoCAD 2000 Processor Pentium-Pro 200mHz RAM 64 MB (128 MB recommended) Disk Space 650 MB (1 GB recommended)

CE@@<5=5>D1<?D85B1@@<931D9?>C
Supplemental applications are designed to work in the same operating environment as the primary application with which it is associated. These programs usually require significantly less resources in terms of storage and memory than do the application types listed above.

9>CD1<<1D9?>
To learn how to install the software and configure your system, refer to the Software Installation and Configuration insert that was shipped with your CD.

1CCE=@D9?>C
Certain assumptions are made about your knowledge of AutoCAD and your knowledge of drafting and design techniques.

1-10

AutoPLANT PIPING

>DB?4E3D9?>

ED8?B9J1D9?>

;>?G<5475?61ED?314
Rebis assumes that you already know AutoCAD Release 14/2000 in the Windows 95/NT environment. No attempt is made to educate you in the ways of AutoCAD. Therefore, you should refer to the documentation provided with your AutoCAD software for answers to any questions you may have about that environment and command set.

;>?G<5475?64B16D9>71>445C97>D538>9AE5C
AutoPLANT is intended to make the professional drafter or designer more efficient. The documentation assumes 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.

1ED8?B9J1D9?>
All software authorization for new Rebis products is handled by the new Rebis Security Manager. This application is installed when you install your AutoPLANT software. This application may be launched by selecting Rebis Security/Rebis Security Configuration Manager from your Windows Start menu. This will enable you to authorize, or request an authorization code for all of your AutoPLANT applications in one easy to use interface. When you start an application that has not been authorized, a dialog will display prompting you to authorization the application as an Evaluation copy for a limited number of days, or to start the application in Demo mode. The application can only be fully authorized using the Rebis Security Configuration Manager.

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

5hYcdY^W8QbTgQbU<_S[c
The old hardware locks were implemented using Alladins Hasp Locks. Hasp locks were attached to the printer port and require hasp drivers to be detected by the application. All hardware locks are initially set to expire within a month (an authorization code is required to remove the expiration date). Upon implementation of the Rebis Security Manager, no existing hardware locks will be authorized for use with applications. This means the old hardware locks will not work with the new applications. Clients should keep their old hardware locks to allow product support for older versions. The read-only properties of the existing hardware lock can only be viewed within the Configuration View, not authorized. >_dU The Rebis Security Configuration Manager provides a help file with detailed instructions for authorizing your software. Start the application by selecting Rebis Security/Rebis Security Configuration Manager from your Windows Start menu, then select Help/Contents to view this information.

Reference Manual

1-11

>DB?4E3D9?>

?3E=5>D1D9?>3?>F5>D9?>C

4?3E=5>D1D9?>3?>F5>D9?>C
A number of conventions are maintained throughout all AutoPLANT documentation to make identifying and understanding the information presented both quick and easy.
3
?>F5>D9?>

5C3B9@D9?>

>?D5* 89>D* G1B>9>7* FILENAMES

3URJUDP&RGH

Precedes information of general importance. Precedes optional time-saving information. Precedes information about actions that should not be performed under normal operating conditions. Directory paths and file names are italicized. Example: \PIPING directory, AUTOEXEC.BAT file. Excerpts from text or basic script files and script variables and statements appear in the font shown. Commands or information that must be manually entered is bolded in the font shown. Example: After selecting Setup/Drawing Preferences from the Piping menu, press the OK button in the dialog. Dialog and database table names are italicized. Example: The Preferences dialog. Indicates that the command must be executed from a menu or dialog. Indicates an item (component or point) that may be picked on a drawing. Throughout this manual, the menu command sequence required to execute a command will be explicitly defined in the text, along with the associated toolbar.

INPUT

Dialogs Field_Name Select Pick

1-12

AutoPLANT PIPING

9 D
538>931<

>DB?4E3D9?>

E@@?BD1>4 B19>9>7

D538>931<CE@@?BD1>4DB19>9>7
Rebis trained personnel are available to provide quality support to customers on all current product lines. To inquire 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 view this 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 best method for receiving personalized, quality technical support.

DI@5C?6D538>931<CE@@?BD
+

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 to resolve your problem immediately. >_dU If you would like more information on how to purchase an MES contract, please call our North American MES Sales Manager at (925) 933-2525, ext. 251.

Fax Support: Fax traditional inquiries to (504) 893-5293; 24hrs, 7days/week. Our Automated FaxBack Service (925) 933-2525; 24hrs, 7days/week contains answers to some of the most commonly asked questions. After calling the service, use the phones keypad to select the type of product, and to step through a selection of topics. If the subject about which you are inquiring is listed, simply input your fax number and you will receive an immediate fax response to your question. Internet Support: Send electronic support inquiries to support@rebis.com. Our staff frequently checks the support e-mail for inquiries, and responds to them promptly. Choosing this method of support allows you to bypass our telephone lines when they are busy. The e-mail method will also enable you to attach drawings or files needed to help troubleshoot and solve your problem. Rebis also maintains a Web page which contains several areas of interest to users of our software, including a customer service area, a file download area, tips and tricks, etc. Rebis URL is www.rebis.com.

Reference Manual

1-13

381@D5B

75DD9>7CD1BD54

"

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

PROJECT CONFIGURATION SOFTWARE CONFIGURATION INTERFACE CONNECTION TECHNIQUES DRAWING PRODUCTION OVERVIEW SPECIFICATION OVERVIEW

2-2 2-3 2-7 2-16 2-41 2-43

"

7 @

5DD9>7

D1BD54

B?:53D

?>697EB1D9?>

@B?:53D3?>697EB1D9?>
AutoPLANT provides tools to support a project configuration implementation. This design supports multiple project configurations and enables you to assign application drawing/model defaults and settings on a projectwide 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, which basically mirrors the shipping directory structure. You can then create custom versions of almost any of the provided files and store them within the project directory structure without undermining the integrity of the default 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 for annotation styles. To support these clients, you would create two configurations. In each configurations directory structure, you would place the annotation script files that have been customized to conform with each clients annotation style standards. When you start a new drawing for either client you would select the configuration that you want to apply for that drawing. By selecting the appropriate configuration you will be instructing AutoPLANT to search that custom directory structure for any files before searching for the file in the standard search path. AutoPLANT will find the customized annotation script files for the selected configuration 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 of these files reside in a centralized location within the project configurations directory structure. Working in this manner will enable you to upgrade AutoPLANT software without being concerned about losing customized versions of specific files. You should NEVER directly modify any of the files in the shipping version of the software. In fact, if you use AutoPLANT's Configuration Editor and Class Editor applications to 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 as templates when you create your own custom configurations. A number of custom application tools are provided to simplify the procedure to create and modify project configurations.

@B?:53D3ECD?=9J1D9?>D??<C
AutoPLANT provides two tools to simplify the customization process. Each of these tools may be launched from the ..\AutoPLANT 3D\Customization Tools group in your Windows Start menu, or from the Rebis main menu when you start AutoPLANT Plant Design or Isometrics. Each tool provides its own context-sensitive help 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 of these tools for more information.

1ed_@<1>D3_^VYWebQdY_^5TYd_b
The AutoPLANT Configuration Editor application may be used to create/modify projects. It enables you to select a shipping configuration (imperial, metric, mixed metric) as a template to create your new project configuration directory structure and associated files. It also removes the tedious effort that would have been required to manually edit the numerous application configuration files by providing a highly-intuitive graphical user interface with tabbed dialogs to modify the configuration settings assigned to each project.

2-2

AutoPLANT PIPING

7 C

5DD9>7

D1BD54

?6DG1B5

?>697EB1D9?>

1ed_@<1>D3\Qcc5TYd_b
The Class Editor (CE) works hand-in-hand with the AutoPLANT Configuration Editor application. The shipping version of the AutoPLANT software provides three default configuration, Imperial, Metric, and Mixed Metric, which should not be modified. The intent of the system design is for you to use the Configuration 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 custom configuration. All modified files are stored in your custom project configuration directory; therefore, maintaining the integrity of the shipping version of all of these files.

C?6DG1B53?>697EB1D9?>
This section describes the relevant files created by the installation program that initially configure your AutoPLANT software.

C?6DG1B53?>697EB1D9?>69<5C
When an AutoPLANT application is installed, the configuration files AT.INI and APLANT.INI are created on your local drive. APLANT.INI is the primary AutoPLANT control file, which is created in your Windows directory. The install program creates a >0(5*('@ group in your APLANT.INI. In this group, the $7B&)* keyword is assigned 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$/@ group that contains key assignments that apply across all AutoPLANT applications. Each group contains keywords that 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 keywords that assign the network, local, and custom root directories that are used to locate these specific file types when running 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

>Udg_b[fc<_SQ\G_b[cdQdY_^9^cdQ\\QdY_^c
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 local workstation. When a user performs a local workstation installation, the user will be prompted to first specify the local root installation directory (e.g., C:\REBIS), then to specify the root directory where the network application files were installed (e.g., N:\REBIS). The install will then install the local workstation files and create AT.INI in their /2&$/B5227?&)* local workstation directory, where /2&$/B5227 is the local root directory specified during the install with the USER subdirectory appended. In this example, AT.INI would be installed in the users C:\REBIS\USER\CFG directory. In order for the application to find the core set of files that were installed on the network and local workstation drives, the installation program assigns the 1(7:25.B5227 keyword in AT.INI to the network root directory and the local root directory to the /2&$/B5227 keyword. The 1(7:25.B5227 and /2&$/B5227 keywords would also have
Reference Manual 2-3

"

7 C

5DD9>7

C 3

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 the 1(7:25.B5227 keyword in each users local AT.INI file to the new network path.

1D9>9;5IG?B4C
AT.INI contains a configuration group for each installed AutoPLANT application, and a >*(1(5$/@ group that contains key assignments that apply across all AutoPLANT applications. Each group contains keywords that define the paths, files, and functions required to start the application. >_dU The keywords in the >$/,$6@ group were discussed in the previous topic. This group contains keywords that were assigned the 1(7:25.B5227 and /2&$/B5227 paths based on whether your organization works from stand-alone or network installations.

The following table lists the keywords assigned in each AutoPLANT applications group in AT.INI.
PROGRAMDIR LOCALDIR STARTUP_FILE STARTUP_FUNC UNLOAD_FUNC DESCRIPTION REGAPP MENU_SELECTABLE HELP_FILE SYS_PREF_INI_FILE COMP_PREF_INI_FILE USER_PREF_INI_FILE
Example: PROGRAMDIR=%NETWORK_ROOT%\PIPING Example: LOCALDIR=%LOCAL_ROOT%\PIPING Example: STARTUP_FILE=at_pipe.lsp Example: STARTUP_FUNC=at_pipe_startup Example: UNLOAD_FUNC=at_pipe_unload Example: DESCRIPTION=AutoPlant Piping Example: REGAPP=at_pipe Example: MENU_SELECTABLE=1 Example: HELP_FILE=%NETWORK_ROOT%\SUPPORT\AT_PIPE.CHM Example: SYS_PREF_INI_FILE=SYSPref Example: COMP_PREF_INI_FILE=COMPPref Example: USER_PREF_INI_FILE=UserPref

D5=@?B1BI69<5C
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 and may be modified. The files in this directory may be deleted periodically. Simply open the directory assigned to this keyword in Windows Explorer and delete all of the files and directories contained therein.

G9>4?GCB579CDBI5>DB95C
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. This information has been provided because of numerous user requests.

2-4

AutoPLANT PIPING

7 C

5DD9>7

D1BD54

?6DG1B5

?>697EB1D9?>

C?6DG1B53?>697EB1D9?>8?GD?D?@93C
This section provides a set of procedures that explain how to customize your Software Configuration.

CUde`=e\dY`\U3_^VYWebQdY_^c
AutoPLANT is designed to enable a user to setup multiple system configurations. >_dU Project configurations that contains default settings and search paths are defined using the AutoPLANT Configuration Editor application.

When the software is installed, APLANT.INI is created in the \WINDOWS directory. The >*(1(5$/@ group in this file assigns the $7B&)* keyword to the directory that contains the AT.INI file that defines the system setup for each application. For example, the default definition of AT_CFG in APLANT.INI points to the LOCAL_ROOT\CFG directory on the users workstation.

> D C
?

5DE@1>4

E 1
C5

>?D85B

?>697EB1D9?>

! " #

Create an alternate AT.INI in a different directory that defines a separate system configuration for the applications. Assign the $7B&)* keyword in APLANT.INI to the directory where the alternate configuration AT.INI file resides. Re-Start the system.

CUddXU>Udg_b[@QdX
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 users local workstation. When each user installs the local 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 installation program assigns the 1(7:25.B5227 keyword to the network root installation directory in AT.INI.

> D C
?

5DD85

>

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. >_dU If the system cannot find the core program files, ensure that 1(7:25.B5227 keyword is properly assigned, and that the network mapping to this directory is connected on the local workstation.

Reference Manual

2-5

"

7 C

5DD9>7

C 3

D1BD54

?6DG1B5

?>697EB1D9?>

CUddXU<_SQ\G_b[cdQdY_^@QdX
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 users local workstation. When each user installs the local 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 local workstation files, the installation program assigns the 1(7:25.B5227 keyword to the network root directory and the local root directory to the /2&$/B5227 keyword. If only a local installation is performed, these keywords will be assigned to the same local root directory.

> D C
?

5DD85 ?31<

<

?B;CD1D9?>

1D8

! "

Open /2&$/B5227\CFG\AT.INI in a text editor. Assign the 1(7:25.B5227 keyword to the desired network path. >_dU If the system cannot find the local program files, ensure that /2&$/B5227 keyword is properly assigned.

CUd=_TYViQ^1``\YSQdY_^3_^VYWebQdY_^
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 installed application.

> D C =
? 5D

?496I1>

@@<931D9?>

?>697EB1D9?>

! "

Open /2&$/B5227\CFG\AT.INI in a text editor. Find the name of the group for the application configuration to modify. Each application group contains a set of keywords that define the general configuration for that application.

CUddXUDU]`_bQbi6Y\Uc4YbUSd_bi
When AutoPLANT software is installed, the configuration file AT.INI is created in the LOCAL_ROOT\CFG local workstation directory. AutoPLANT software requires a temporary directory to store temporary files created during normal program execution. The $3703 keyword in the >*(1(5$/@ group in AT.INI configuration file is assigned to this directory.

> D C
?

5DD85

5=@?B1BI

9B53D?BI

! "

Open /2&$/B5227\CFG\AT.INI in a text editor. Assign the $3703 keyword to the desired drive and path. >_dU The directories and files in the directory specified here should be deleted periodically when you are not running an AutoPLANT application.

2-6

AutoPLANT PIPING

5DD9>7

C 9

D1BD54

>D5B6135

9>D5B6135
PIPING has been designed with the professional piper and designer in mind. The interface closely follows AutoCADs design, with additional toolbars and menus inserted.

=5>EC
When you first load the AutoPLANT 3D software, the Rebis menu is inserted into AutoCADs menu structure. From this menu, AutoPLANT applications and utilities can be launched. Only those applications which 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
Reference Manual 2-7

"

7 9

5DD9>7

D1BD54

>D5B6135

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

D??<21BC
Several toolbars are available to select components and execute PIPING commands.

2-8

AutoPLANT PIPING

5DD9>7

C 9

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 a cascading 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.

Reference Manual

2-9

"

7 9

5DD9>7

D1BD54

>D5B6135

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

>_dU

To close a toolbar, press the kill button in the upper left corner (if the toolbar is docked, you will need to 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 the toolbars, place the cursor over any toolbar button, then right-click with the mouse. AutoCADs Toolbar dialog is displayed. Toggle the Large Buttons check box as appropriate, then press Close to exit the dialog.

>_dU

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

2-10

AutoPLANT PIPING

5DD9>7

C 9

D1BD54

>D5B6135

4B1G9>71B51
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.

Reference Manual

2-11

"

7 9

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 AutoCAD 2000s Layouts. This enables you to place annotation and dimension text and symbols on a virtual sheet of paper, without cluttering the actual model.

2-12

AutoPLANT PIPING

5DD9>7

C 9

D1BD54

>D5B6135

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

3?==1>4@B?=@DC
Many commands are presented on the command line, just below the drawing area.

Reference Manual

2-13

"

7 9

5DD9>7

D1BD54

>D5B6135

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

2-14

AutoPLANT PIPING

5DD9>7

C 9

D1BD54

>D5B6135

491<?7C
PIPING provides many dialogs in which user input is requested. The dialogs allow a great deal of information to 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 function is displayed.

Reference Manual

2-15

"

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

3?>>53D9?>D538>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 >_dU The items listed above provide an overview of connection techniques.

2-16

AutoPLANT PIPING

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

75>5B1<3?=@?>5>D@<135=5>D
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, PIPING assumes you will want to connect to the end of the previous component. You can accept the default and press Enter to automatically connect two components. You can also designate a new point, or specify a placement 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 asymmetrical components, you can toggle the point on the component which will be placed at the insertion point. Some components also have alignment ports. Specify the orientation: For bends, branching and asymmetrical components, you need to specify how the component is oriented.

#

$

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

@<13513?=@?>5>D9>C@135
PIPING components may be placed in space; that is, not connected to any other component or placed without respect to a known point on an existing component. This section demonstrates how to place a piece of pipe and an elbow in space.

Reference Manual

2-17

"

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

@<1351@9535?6@9@59>C@135

2-18

AutoPLANT PIPING

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

Reference Manual

2-19

"

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

2-20

AutoPLANT PIPING

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

@<1351>5<2?G9>C@135

Reference Manual

2-21

"

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

2-22

AutoPLANT PIPING

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

Reference Manual

2-23

"

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

1DD138D?1>5H9CD9>73?=@?>5>D

2-24

AutoPLANT PIPING

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

Reference Manual

2-25

"

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

@<1351;>?G>49CD1>356B?=1>5H9CD9>73?=@?>5>D

2-26

AutoPLANT PIPING

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

Reference Manual

2-27

"

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

2-28

AutoPLANT PIPING

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

1<97>D?5H9CD9>73?=@?>5>DC

Reference Manual

2-29

"

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

2-30

AutoPLANT PIPING

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

Reference Manual

2-31

"

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

2-32

AutoPLANT PIPING

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

Reference Manual

2-33

"

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

1ED?=1D931<<I@<1353?>>53D9>7@9@51ED?@9@5

2-34

AutoPLANT PIPING

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

Reference Manual

2-35

"

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

381>75D85B565B5>35@?9>D

2-36

AutoPLANT PIPING

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

1ED?=1D931<<IB?ED53?=@?>5>DC

Reference Manual

2-37

"

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

2-38

AutoPLANT PIPING

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

@<135?>1C=1BD@?<I<9>5

Reference Manual

2-39

"

7 3

5DD9>7

D1BD54

?>>53D9?> 538>9AE5C

2-40

AutoPLANT PIPING

7 4
B1G9>7

5DD9>7

D1BD54

B?4E3D9?>

F5BF95G

4B1G9>7@B?4E3D9?>?F5BF95G
PIPINGs drawing production tools use the concept of defined Work Areas. A Work Area is a user-specified set of drawings that overlay each other. This Work Area concept was developed to provide a convenient method for sharing plant information between multiple drawings. For example, models from multiple disciplines (equipment, pipe, steel) can grouped together. Three dimensional Work Area Views can then be associated 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 been saved on a shared network drive. This technique allows multiple users to view a defined area of the plant, and to 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 with annotated 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 to section, dimension and annotate defined areas from within the plant ensures consistency in drawing production. After placing these views as viewports in Paper Space, Rebis encourages you to remain in Paper Space to place dimensions and annotation. Two dialogs are associated with Work Areas: Work Area Setup and Work Area View. The first dialog establishes the set of referenced drawings, while the View dialog defines the view coordinates and placement options. 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-dimensional clipping areas. Various options are available from this location, and you can either input coordinates directly or choose them manually by picking points in the current drawing.

Reference Manual

2-41

"

7 4

5DD9>7

D1BD54

B1G9>7

B?4E3D9?>

F5BF95G

After the views are created, you can place them as tiled viewports in Paper Space for plotting. To dimension the items in the viewport, remain in Paper Space and utilitize AutoCADs dimensioning tools. A set of separate Piping/Annotation commands have been provided that operate from Paper Space as well. By remaining in Paper Space to place dimensions and annotation, you can easily return to a clean model without 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 >_dU For a practical example of how to create a viewport and use the dimensioning and annotation tools, refer to the PIPING tutorial.

2-42

AutoPLANT PIPING

7 C

5DD9>7

D1BD54

@5396931D9?>

F5BF95G

C@5396931D9?>?F5BF95G
AutoPLANT applications are configured to use Microsoft Access formatted specification databases by default. 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 find information regarding specification creation/modification. The Spec Generator applcation is shipped with its own context-sensitive help file, which provides detailed explanations on how to use that application to create/modify specs and catalogs.

C@5341D121C5D12<56?B=1D
The format for the external specification database tables is also configured in DBCONFIG.INI. The default format is defined to use a single Microsoft Access database that contains the individual tables for each specification. This was changed from the individual specification table default in AutoPLANT version 1.02 to take advantage of the new Specification Generator v6.0 application. The default record in DBCONFIG.INI appears as follows:
>6SHF@ 'HVFULSWLRQ 6SHFGDWDEDVHV '$7$B6285&( 06$FFHVVIRU$XWR3/$17 '$7$B7<3( '%4 '$7$B6285&( )R[3URIRU$XWR3/$17 '$7$B7<3( 'HIDXOW'LU '$7$B6285&( G%DVH)LOHVIRU$XWR3/$17 '$7$B7<3( 'HIDXOW'LU

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

@B?F9454C@53C1>431D1<?7C
The following catalogs are available:
+ + + + + + + + + + + + + +

Carbon Steel Cable Tray Conduit Swagelok Stainless Steel Ductile Victalic Triclove Rsf Armstrong Itt Spirax BPE Din for metric

Reference Manual

2-43

"

7 C

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

2-44

AutoPLANT PIPING

381@D5B

C5DE@=5>E

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 DRAWING PREFERENCES MODULE SETUP COMPONENT PREFERENCES COMPONENT COPY PREFERENCES COMPONENT UPDATE PREFERENCES

3-2 4-3 4-8 4-17 4-18 4-23

#
?F5BF95G

5DE@

5>E

F5BF95G

The Setup menu provides options to define initial drawing preferences, and other settings used during the placement and manipulation of components. The Setup toolbar is available as a flyout toolbar from the main Piping Functions toolbar, or may be displayed 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

4-2

AutoPLANT PIPING

C 4

5DE@

5>E

B1G9>7

B565B5>35C

4B1G9>7@B565B5>35C
The Drawing Preferences dialog shown below displays by selecting Setup/Drawing Preferences from the Piping 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 start a drawing. Any specification directory that resides below this path will appear in the Specification drop-down list in this dialog. The Specification Path assigned in a configuration can be modified using the AutoPLANT Class Editor, which can be launched from the Rebis main menu or toolbar. Specification Nominal Size Lists the specification directories that reside below the Specification Path defined in the configuration. Select a spec name from this list to make it active. Lists the available main nominal pipe sizes from the current specification, based on the Drawing Units set in the selected configuration. The selected size is used when you place components to locate the appropriate component record in the specification. The spec record contains descriptive and parametric information used to draw the component. Enter the Line Number in this field. Line numbers can be identified using any alphanumeric combination of characters. Subsequent components placed in the drawing will be assigned the Line 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 components line number after it has been placed, use the Edit Component command. To revise a line number (change the line number of a selected group of components), 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 external drawing database record of subsequent components will be assigned these field values until they are changed.

Line Number

Reference Manual

4-3

5DE@

5>E

B1G9>7

B565B5>35C

Drawing Mode/ Representation

The Drawing Mode area of the dialog has been re-organized into Drawing Mode and Representation areas to support the implementation of the new flat 2D PIPING application available 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 authorized for 2D only, will have their 3D Drawing Mode and associated Representations disabled. Users authorized for 3D will have all draw modes and options available. The following describes the Drawing Mode/Representations now available in terms of the selection mode in the Drawing Mode and Representation areas of the dialog (e.g., 3D-Double Line will 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 drawing of 3D components in 3D space using Rebis custom component objects. 3D-Single Line: this configuration enables drawing of Single Line component representations in 3D space using AutoCAD entities. In general, only Pipe Components, Bends and Returns, and Branching 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 the vertical 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 Line representations of components using AutoCAD entities. As noted above, the 2D - Double Line mode will automatically generate and draw flat 2D entities from using their 3D custom components counterparts. This is a radical change from the previous method. Previously, the Double Line mode in the 3D system used a complex set of draw methods to determine which view the component was being placed in and then determined how this component should be drawn. This method will be replaced by automatically converting, during placement, the 3D component into 2D native CAD objects, which have been generated via the new Hidden Line Removal (HLR) interface. Additional Options: Surface Resolution: When you enable the 3D Drawing Mode radio button, a Surface Resolution setting will be activated. This value assigns AutoCADs SURFTAB1 and SURFTAB2 environment variables that control the mesh display of component graphics. A number between 2 and 32766 is required, while a setting of 12 or 16 is recommended. Changing this value does not change the Surface Resolution setting assigned to previously placed components. You can display the inherent mesh representation of 3D components with the Piping Tools/3D Display Modes/Mesh command. 2D HL Options: When you enable the 2D Drawing Mode radio button, the Surface Resolution option will be replaced by a 2D HL Options button. Pressing this button displays the HLR Options dialog, which enables you to define how hidden line removal is handled for the 2D-Double Line representations. Hidden line removal is handled on a per component basis with respect to the settings defined in this dialog. Once these options are set, all subsequent components will be drawn in that mode until it is changed. You can also generate existing component representations using the new settings. A more detailed explanation of this feature is covered after this table.

4-4

AutoPLANT PIPING

C 4

5DE@

5>E

B1G9>7

B565B5>35C

Component Preferences

The Color and Layer options shown below determine how PIPING assigns component layers and colors. The actual color used for a particular value for each option, except for By Paint, is defined in 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 the component 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 Line Number from the [ByLineNo] group in COLOR.INI. ByPaint: Component color is determined by reading the color assigned in the Paint field of the components 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 any component connected to it. This option overrides settings in the Drawing Preferences dialog in order 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 elbow from the Base Carbon Steel module to one end of this pipe. First, you should know that pipe is a variable end component. This means that the end of the pipe is not necessarily defined until you connect a component to it. The valid ends for Victaulic pipe are IGM; BW; SCM; SWM as defined in the PORTS.INI for the Victaulic components. Therefore, load the Victaulic module and place a pipe segment from the Victaulic Spec by selecting it from the Victalic components menu. To connect a base Carbon Steel elbow to one end of this pipe you must first set the Data Mode, either in the Component or Drawing Preferences dialogs to From Settings (not component). Then change the spec to CS150 and select connect the standard base elbow to one end of the pipe. When the From Component data mode is used the connecting component will try and resolve as much information as possible from the connecting component, including the spec. Therefore, if From Component is set and you are connecting to a Victaulic component, the system will be forced to use the Victaulic Spec. In the example above, you used the From Settings data mode to override the component attributes to enable you to connect the Carbon Steel elbow which is from a different spec.

Auto Router Mode

Enable this switch to automatically connect a selected component to the run end of the previous component. This is the fastest method of placing a series of connected components. If the selected component contains a branch or a bend, you will still need to specify the orientation. 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 Preferences dialog). If you modify the insulation thickness of an existing component using the Database Tools/Edit Component command, the component will be redrawn and display the indicated insulation graphically. This switch should only be enabled if you are customizing or creating new PIPING component placement 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 each statement in the script to locate possible errors. Reference Manual 4-5

Show Insulation

Debug Mode

5DE@

5>E

B1G9>7

B565B5>35C

Default Spec Choice

When a component is selected for placement, PIPING searches the specification for the requested component. If more than one match is found, the Rebis Specification Selection dialog displays to enable you to select between components of the same size and type, but which have different end conditions, schedules, ratings, etc. When the Default Spec Choice switch is enabled, PIPING will place components marked as defaults in the specification automatically, without displaying the Rebis Specification Selection dialog. A component may be marked as the default selection by placing a 1 in the Option Code field of the default components specification record using Rebis Spec Generator v.5.0 application. You were given the option to install the Spec Generator when you installed PIPING. This application has its own help file.

Weld gaps

Welded joints determine the fastener used to connect welded components based on this setting. If the check box is enabled, a weld gap will be inserted using the fastener basic script at_weldedjoint_fasteners to insert AT_WELDGAP. If this check box is disabled, then a weld gap will not be inserted, but a buttweld fastener will be inserted using this script to insert AT_BUTTWELD. PIPING stores component entity handle information in the drawing by default. This check box enables you to also save this information in the external drawing database. Enable this option to save joint, port, and fastener data in the external drawing database. This information is saved in the drawing by default.

Save CAD Links Save Port Data

"48YTTU^<Y^U?`dY_^c
As mentioned in the table above, when the 2D Drawing Mode is enabled, a 2D HL Options button will replace the 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 each component. Enabling this check box will activate the Output Properties grid in this dialog. The grid options define the manner in which hidden line output is displayed as described below:
Visibility Color Linetype Lineweight If the "Light bulb" is ON (yellow), then visibility is turned ON and hidden lines will be visible. Assigns the color of the visible hidden lines. Selects the line type to be used for the hidden line. Only loaded line types can be used from this selection and there will be no interface to load line types. The standard CAD interface should be used for this purpose. Determines the weight of the visible hidden lines. When you click within this grid field, a browse button will appear. Press this button to display the following dialog.

4-6

AutoPLANT PIPING

5DE@

5>E

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

Reference Manual

4-7

#
=?4E<5C5DE@

5DE@

= C

5>E

?4E<5

5DE@

A module is a set of component draw routines, command prompts, menu, and specifications that extend the component set available in the PIPING and/or ISOMETRICS applications. By loading a module, you can draw components other than the default Carbon Steel set. After a new module is loaded, you will need to return to the Drawing Preferences dialog to specify the specification, size, and other drawing settings appropriate 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 without closing the dialog. More than one module may be loaded in the same session, but only one specification is active at a time. Each module has an associated menu and toolbar. Before selecting a component from a modules menu or toolbar, you should ensure that the specification that contains the components for that module is properly set in the Drawing Preferences dialog. The provided modules and their associated specifications are shown below:
=?4E<5C Ductile Iron Victaulic High Purity Lined Pipe Tubing Cable Tray HVAC Conduit C@53C DUCTILE (imperial), MDUCT (metric), MMDUCT (mixed metric) VICTALIC (imperial), MVICT (metric), MMVICT (mixed metric) TRICLOVE (imperial), MTRIC (metric), MMTRIC (mixed metric) RSF (imperial), MRSF (metric), MMRSF (mixed metric) SWAGELOK (imperial), MSWGLOK (metric), MMSWGLOK (mixed metric) (PIPING ONLY) CABLET (imperial), MCABLET (metric), MMCABLET (mixed metric) (PIPING ONLY) HVAC (imperial), MHVAC (metric), MMHVAC (mixed metric) (PIPING ONLY) CONDUIT (imperial), MCOND (metric), MMCOND (mixed metric)

1F19<12<5=?4E<5C
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 the dialog. Press Apply or OK to execute the action.

4-8

AutoPLANT PIPING

5DE@

= C

5>E

?4E<5

5DE@

<?141<<
Enable this radio button, then press Apply to load all modules in the Available List group. When the dialog is closed, the modules menu will be loaded. After loading a module you must return to the Drawing Preferences dialog to set the Spec to the specification that contains the modules component records before you will be able to place components available in the modules menu.

<?14=?4E<5
Enable this radio button, then press Apply or OK to load the modules selected in the Available List area of the dialog. The selected module menus be accessible. After loading a module you must return to the Drawing Preferences dialog to set the Spec to the specification that contains the modules component records before you will be able to place components available in the modules menu.

E><?14=?4E<5
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 modules menus.

E><?141<<=?4E<5C
Enable this radio button, then press Apply or OK to unload all of the modules listed in the Available List group if they were previously loaded. This will remove any loaded module menus and toolbars from the application. >_dU Remember to reset the active specification for the component set that you will be placing.

F95G=?4E<545D19<C
Select a module from the Available List group, then enable the View Module Details radio button and press Apply to display the dialog shown. This dialog displays the module definition record as defined in the file MODULES.INI. This information can be modified using the AutoPLANT Class Editor, which may be launched from the Rebis main menu or toolbar.

1@@<I
Executes the action selected in the Module Actions area of the dialog without closing this dialog. Use this button to load/unload/view several modules individually, then press OK or Cancel when you are finished to close the dialog. The following sections provide a brief description of each available module.

Reference Manual

4-9

5DE@

= C

5>E

?4E<5

5DE@

312<5DB1I=?4E<5@9@9>7=?4E<5?><I
The Cable Tray module provides a standard set of cable tray components used in most industries. This module comes with a standard set of component placement options, as well as sample specifications that may be used to place these components.

<_QT
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 Preferences commands.

C`USc3QdQ\_Wc
The Cable Tray module provides sample specifications in Imperial, Metric, and Mixed Metric units as noted below. (PIPING ONLY) CABLET (imperial), MCABLET (metric), MMCABLET (mixed metric) These sample specifications were created from the full Imperial, Metric, and Mixed Metric catalogs provided and should be modified using the Spec Generator application to contain the components that you will use on your projects. >_dU A description of the fields in these specifications is available in the Spec Generator help.

3_]`_^U^dc
The Cable Tray module provides a standard set of Straight Sections, Bends, Branches, Reducers, and Box Connector component placement options, which may be executed via the Cable Tray menu or toolbars.

4bQgY^W@bUVUbU^SUc
The Cable Tray/Setup/Drawing Preferences command displays a dialog with two toggle switches. Enable the Draw 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 of the trays.

3?>4E9D=?4E<5@9@9>7=?4E<5?><I
The Conduit module provides a set of thin wall tubing components, which typically contains electrical wires and are used by most industries. This module comes with a standard set of component placement options, as well as sample specifications that may be used to place these components.

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

4-10

AutoPLANT PIPING

5DE@

= C

5>E

?4E<5

5DE@

C`USc3QdQ\_Wc
The Conduit module provides sample specifications in Imperial, Metric, and Mixed Metric units as noted below. (PIPING ONLY) CONDUIT (imperial), MCOND (metric), MMCOND (mixed metric) These sample specifications were created from the full Imperial, Metric, and Mixed Metric catalogs provided and should be modified using the Spec Generator application to contain the components that you will use on your projects. >_dU A description of the fields in these specifications is available in the Spec Generator help.

3_]`_^U^dc
The Conduit module provides a standard set of Conduit, Elbows, Condulet Outlet Bodies, a Junction Box and other Miscellaneous Fitting component placement options, which may be executed via the Conduit menu or toolbars.

4E3D9<59B?>=?4E<5
The Ductile Iron Pipe module provides a set of components, which are typically used for water/wasterwater applications. This module comes with a standard set of component placement options, as well as sample specifications that may be used to place these components.

<_QT
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. This may be accomplished via the Piping/Setup/Drawing Preferences, or Piping/Setup/Component Preferences commands.

C`USc3QdQ\_Wc
The Ductile Iron module provides sample specifications in Imperial, Metric, and Mixed Metric units as noted below. DUCTILE (imperial), MDUCT (metric), MMDUCT (mixed metric) These sample specifications were created from the full Imperial, Metric, and Mixed Metric catalogs provided and should be modified using the Spec Generator application to contain the components that you will use on your projects. >_dU A description of the fields in these specifications is available in the Spec Generator help.

3_]`_^U^dc
The Ductile Iron module provides a standard set of ductile iron flanged and mechanical joint component placement options, which may be executed via the Ductile menu or toolbars.

Reference Manual

4-11

5DE@

= C

5>E

?4E<5

5DE@

8978@EB9DI=?4E<5
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 placement options, as well as sample specifications that may be used to place these components.

<_QT
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 Preferences commands.

C`USc3QdQ\_Wc
The High Purity module provides sample specifications in Imperial, Metric, and Mixed Metric units as noted below. TRICLOVE (imperial), MTRIC (metric), MMTRIC (mixed metric) These sample specifications were created from the full Imperial, Metric, and Mixed Metric catalogs provided and should be modified using the Spec Generator application to contain the components that you will use on your projects. >_dU A description of the fields in these specifications is available in the Spec Generator help.

3_]`_^U^dc
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 be executed via the High Purity menu or toolbars.

8F13=?4E<5@9@9>7=?4E<5?><I
The HVAC module provides a set of components for Heating/Ventilating/Air Conditioning. Typically, this Ductwork 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 placement options, as well as sample specifications that may be used to place these components.

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

C`USc3QdQ\_Wc
The HVAC module provides sample specifications in Imperial, Metric, and Mixed Metric units as noted below. (PIPING ONLY) HVAC (imperial), MHVAC (metric), MMHVAC (mixed metric) These sample specifications were created from the full Imperial, Metric, and Mixed Metric catalogs provided and should be modified using the Spec Generator application to contain the components that you will use on your projects.

4-12

AutoPLANT PIPING

5DE@

= C

5>E

= >_dU A description of the fields in these specifications is available in the Spec Generator help.

?4E<5

5DE@

3_]`_^U^dc
The HVAC module provides a standard set of Tubes, Bends, Branches, Reducers, Valves, General Components, and other Miscellaneous Fitting component placement options, which may be executed via the HVAC menu or toolbars.

<9>54@9@5=?4E<5
The Lined Pipe module provides a set of components. This module comes with a standard set of component placement options, as well as sample specifications that may be used to place these components.

<_QT
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 Preferences commands.

C`USc3QdQ\_Wc
The Lined Pipe module provides sample specifications in Imperial, Metric, and Mixed Metric units as noted below. RSF (imperial), MRSF (metric), MMRSF (mixed metric) These sample specifications were created from the full Imperial, Metric, and Mixed Metric catalogs provided and should be modified using the Spec Generator application to contain the components that you will use on your projects. >_dU A description of the fields in these specifications is available in the Spec Generator help.

3_]`_^U^dc
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 the Victaulic menu or toolbars.

DE29>7=?4E<5
The Tubing module provides a set of components, including small bore tubing used for instrumentation lines in many industries These components are typically used in the pharmaceutical industry, and also in mechanical design applications (pump manufacturers, etc). This module comes with a standard set of component placement options, as well as sample specifications that may be used to place these components.

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

C`USc3QdQ\_Wc
The Tubing module provides sample specifications in Imperial, Metric, and Mixed Metric units as noted
Reference Manual 4-13

5DE@

= C

5>E

?4E<5

5DE@

below. SWAGELOK (imperial), MSWGLOK (metric), MMSWGLOK (mixed metric) These sample specifications were created from the full Imperial, Metric, and Mixed Metric catalogs provided and should be modified using the Spec Generator application to contain the components that you will use on your projects. >_dU A description of the fields in these specifications is available in the Spec Generator help.

3_]`_^U^dc
The Tubing module provides a standard set of Pipe, Elbows, Tees, Flanges, Valves, Reducers, and other Miscellaneous Fitting component placement options, which may be executed via the Tubing menu or toolbars.

F93D1E<93=?4E<5
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 that may be used to place these components.

<_QT
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. This may be accomplished via the Piping/Setup/Drawing Preferences, or Piping/Setup/Component Preferences commands.

C`USc3QdQ\_Wc
The Victaulic module provides sample specifications in Imperial, Metric, and Mixed Metric units as noted below. VICTALIC (imperial), MVICT (metric), MMVICT (mixed metric) These sample specifications were created from the full Imperial, Metric, and Mixed Metric catalogs provided and should be modified using the Spec Generator application to contain the components that you will use on your projects. >_dU A description of the fields in these specifications is available in the Spec Generator help.

3_]`_^U^dc
The Victaulic module provides a standard set of IPS, AWWA, PressFit, Copper Tubing, Fire Protection and Transition component placement options, which may be executed via the Victaulic menu or toolbars.

4-14

AutoPLANT PIPING

5DE@

= C

5>E

?4E<5

5DE@

=?4E<53ECD?=9J1D9?>
The shipping version of the module configurations are defined in the file MODULES.INI, that resides in the NETWORK_ROOT\MODULES directory. The Ductile Iron module configuration group in MODULES.INI is shown below.
>$7B3'8&@ 'LUHFWRU\1DPH 'XFWLOH %DVHB0RGXOH %DVH 'HVFULSWLRQ 'XFWLOH,URQ0RGXOH 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?RULHQWVSHFNH\&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 module name enclosed in brackets, >@, followed by seven keywords. These keywords specify the initial set of path and file information required to load the module. Module configurations may edited/modified using the AutoPLANT Class Editor application. That application provides 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 AutoPLANT Configuration Editor application, then selected the configuration in the Class Editor. This process will create a copy of MODULES.INI in your project directory, which may be modified. This system was devised to protect the integrity of the shipping version of the modules configuration file. When you create a new PIPING/ISO drawing and select your custom project configuration, any changes made to that projects module configuration 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. The MODULES.EBS method is used by the Setup/Module Setup command to manage modules loaded in the system. It defines the Module Setup dialog instance and reads the module definition file, MODULES.INI from the current project configuration directory to determine which modules have been installed on the system and are displayed in the Module Setup dialog list. The configuration information defined in MODULES.INI may be displayed for the selected module in the Module Setup dialog by executing the View Module Details option. This information should only be modified using the AutoPLANT Class Editor application, which can be executed from the Rebis main menu or toolbar.

=?4E<5C5DE@3ECD?=9J1D9?>8?GD?D?@93C
This section provides a set of procedures that explain how to add a new module to a custom project

4UVY^UQ>Ug=_Te\U7b_e`3_^VYWebQdY_^
Module configurations are defined in the file MODULES.INI. A separate group must be defined for each module that assigns the module directory name and the search paths required to find the method, dialog, and picture files used by the module.

> D 1
?

441

>

5G

?4E<5

B?E@

?>697EB1D9?>

! "

You must first create a custom project using the AutoPLANT Configuration Editor application. Refer to that application's help file for instructions. Start the AutoPLANT Class Editor and select your custom project from the Configurations drop-down list.
Reference Manual 4-15

5DE@

= C

5>E

?4E<5

5DE@

# $ % &

In the navigation tree, select the Base Piping Module, then select Insert/Module to display the Create Module dialog. Enter the name for you new module (e.g., MY_MODULE) in the Name field. Enter a brief description of the 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 the desired 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 configuration information will display in a dialog for modification. This process created the ..\MODULES subdirectory below your ..\CUSTOM\Project_Name directory, copied the system MODULES.INI file into that directory, then added a module group record containing the information you see in this dialog to that file.

4UVY^UQ>Ug=_Te\U4YbUSd_biCdbeSdebU
The next step required to add a new module to the system is to construct the modules directory structure. The standard module directory structure should be created below your custom project's ..\MODULES directory as shown 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 named MY_PROJECT, you should create the same directory structure shown in the figure below the ..\BASE directory 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 for more information on this process.

=_TYVidXU=_Te\UCUde`4YQ\_W
The Module Setup dialog instance and function are defined in the MODULES.EBS method in the NETWORK_ROOT\MODULES\module_dir\DIALOGS directory. This method controls the process of loading and unloading modules in the piping system and should NOT be modified.

4-16

AutoPLANT PIPING

C 3

5DE@

5>E

?=@?>5>D

B565B5>35C

3?=@?>5>D@B565B5>35C
The Component Preferences command is available in both PIPING and ISOMETRICS. It displays the floating dialog shown below. This dialog may be left open at all times, and provides a quick and easy method to change and view the current Specification, Size, Line Number, and Data Mode settings that may also be defined 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 close to the Drawing Preferences dialog to change these settings.

C@5396931D9?>
A specification is defined as a directory in which all of the component database tables for that specification reside. This drop-down contains a list of the specification directories that reside below the root specification directory The root specification directory is defined as part of the configuration that you select when you start a drawing and appears in the Drawing Preferences dialog in the Specification Path setting. Select a Spec name from the drop-down list to make it active. All subsequent component placements will use the parametric and descriptive information from the selected specification until it is changed.

>?=9>1<C9J5
Lists the available main nominal pipe sizes from the current specification, based on the Drawing Units set in the selected configuration. The selected size is used when you place components to locate the appropriate component record in the specification. The spec record contains descriptive and parametric information used to draw the component. Select a Size from the drop-down list to make it active

<9>5>E=25B
Enter the Line Number in this field. Line numbers can be identified using any alphanumeric combination of characters. Subsequent components placed in the drawing will be assigned the Line 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 components line number after it has been placed, use the Edit Component command. To revise a line number (change the line number of a selected group of components), use the Update Component command.

41D1=?45
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 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.

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

Reference Manual

4-17

C 3

5DE@

5>E

?=@?>5>D

?@I

B565B5>35C

3?=@?>5>D3?@I@B565B5>35C
Components may be copied in PIPING and ISOMETRICS using AutoCADs COPY command. The Setup/Component Copy Preferences option enables you to establish rules that define how copied components are updated. When using AutoCADs COPY command, key fields, such as Line Number, may need to be updated depending on where the component is copied and the intended use at the new location. The Component Copy Preferences dialog controls whether updates are performed manually or automatically, and enables 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 component copy preferences. The configured preferences will be defined for every drawing that is created using the configuration in which they were defined. For example, if you create a new drawing and select the Imperial configuration in the initial Model Setup dialog, then define your copy preferences, every drawing created by that user using the Imperial configuration will display the last defined set of copy preferences for that configuration.

>_dU

When copying components, do NOT use the COPYCLIP command on AutoCADs toolbar or the Edit/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 the Component Update Preferences. The former specifies the fields that are updated (either manually or automatically) after a component or group of components is copied using AutoCADs COPY function. The latter is associated with updating component drawing database information with the Database Tools/Update Component command. These two functions are separate commands.

>_dU

@?CD3?@IE@41D51ED?=1D9?>
This area of the dialog enables you to define the method used to update copied components. The options are described below (only one may be selected):

@b_]`dV_b>Ug3_]`_^U^dFQ\eU
If this option is enabled, the Update Component Data Fields dialog will automatically display after you perform a COPY to enable you to modify the values of the configured component data fields. From this
4-18 AutoPLANT PIPING

C 3
?=@?>5>D

5DE@

5>E

?@I

B565B5>35C

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

CicdU]4UVQe\dE`TQdY^W
If this option is enabled, the copied components data fields will be updated automatically using the system defaults established in the Component Fields and Prefix and Suffix areas of the Component Copy Preferences dialog. When this option is selected, copied components are updated automatically without displaying a dialog for user input.

1ed_]QdYSCSbY`d2QcUTE`TQdY^W
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 and command 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 Update method area of the Component Copy Preferences dialog.

3?=@?>5>D695<4C
The Component Field Selection dialog shown below is a common drawing database field selection dialog that is used by several AutoPLANT functions. It displays all of the fields in the current external drawing databases PIPING table to enable you to select the desired fields as they apply to the currently executed function. 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. >_dU TIP: You can use the Ctrl and/or Shift keys to select multiple fields, then Add> them to the dialog simultaneously. 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 explanation below the particular function heading for more information.

3_]`_^U^d3_`i@bUVUbU^SUcTYQ\_W
The Fields To area of the dialog specifies the fields that will be updated when you copy components. Press the Select button to display the dialog shown above. Select a field then press the Add> button to add it to the list of fields that will be available when updating components. >_dU Only drawing database fields that have been defined in the PIPING table scheme as updatable will appear 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
Reference Manual 4-19

C 3

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 copied components. If the Prompt for New Component Value option is selected from the Post-Copy Update Automation area of the dialog, these fields will display for modification in the Update Component Data Fields dialog when you perform a copy. If the System Default Updating option was selected, these fields will be updated automatically based on the established Prefix and Suffix definitions.

@B569H1>4CE669H
This area of the Component Copy Preferences dialog enables you to establish default prefix and suffix values that 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/or suffix in the field next to the check box. You must then press the Apply to Fields button to select the component 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 to select the fields to apply the defined prefix/suffix values. The fields that appear for selection in the Available Fields list were previously selected from the Component Fields area of the Component Copy Preferences dialog. To apply the defined prefix/suffix defaults to a field, select Prefix or Suffix from the drop-down list, then select the desired field(s) and press the Add> button. Note that the prefix and suffix assignments must be defined separately by making the appropriate selection from the Select Fields For selection list. Using this technique, a prefix can be assigned to one field type, while the suffix applied to another, or a prefix and a suffix may be applied to the same field.

If you no longer want to apply a prefix or suffix to a copied components data fields, simply disable the check boxes in the Component Copy Preferences dialog. If later, you would like to apply these same values, simply enable 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 will display listing the fields that you selected above with the default prefix/suffix values appended to the source components initial field value. These values may be accepted or modified. If the Automatic Updating radio button is enabled when you perform a copy, the prefix/suffix values will be applied to the selected fields automatically without further interaction.

4-20

AutoPLANT PIPING

C 3
?=@?>5>D

5DE@

5>E

?@I

B565B5>35C

21C93C3B9@DE@41D5=5D8?4
For more advanced users, the Component Copy Preferences function enables you to create custom Basic Script functions that control how copied component drawing database field values are updated. For these options 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 the name of the Basic Script Method (function) in this file that you want to be executed immediately after the copy is performed.

5CD12<9C8@?CD3?@I3?=@?>5>DE@41D5@B565B5>35C
The following procedure explains how to establish rules that the system will use when a user attempts to copy component(s).

> D
! "

?4569>5@?CD 3?@I3?=@?>5>DE@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 copied components as follows:
+ + +

Prompt: After the component(s) is copied, a dialog will be displayed in which you can review and edit the field values before updating System Default: After the component(s) is copied, field values will be updated automatically based on the definitions established in this dialog Script: Copied components are updated automatically as determined by a Basic Script file. If you select this option, skip to Step 5.

#

Press the Select button from the Component Fields area of the dialog. When the Component Field Selection dialog appears, select the desired fields from the Available list, then press Add>. After selecting the 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 is optional as you can edit the field as desired after the component is copied. If you are using the System Default option, you must input a Prefix, Suffix, or both in these fields (if neither is specified and System Default 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. Subsequent component COPY commands will update components based on the definitions established in this dialog.

$

% & ' (

C5DD85@B569H1>4?BCE669HG85>E@41D9>73?@9543?=@?>5>DC > D C
? 5DD85

B569H1>4

?B

E669HG85>E@41D9>73?@9543?=@?>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 Default Field Value Pref field. (If a Prefix is not defined, skip to Step 3.) Input the prefix that will be appended to the front of the affected field. Separators are allowed (for example, a value of NEW is acceptable).
Reference Manual 4-21

C 3

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 Use Program 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). >_dU Both a Prefix and a Suffix can be added to the same field. Simply enable both options and input values 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 Fields list has been populated based on the selections made from the Component Fields area of the Component Copy 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 Prefix input 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.

% & ' (

3?@I13?=@?>5>D
PIPING/ISO components can be copied like any other object using the Copy command. AutoPLANT provides the Setup/Component Copy Preferences command to customize the copy procedure.

> D 3
?

?@I1

?=@?>5>D

! "

Type COPY at the command line (do NOT use the COPY icon on the AutoCAD toolbar, which is equivalent 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 AutoCAD OSNAP commands if necessary. $ The prompt
Second point of displacement:

displays. Pick or input the point where the copied component(s) should be placed. Use AutoCAD OSNAP commands if necessary. % The Update Component Data Fields dialog displays. Select the field in the left column that requires updating, then type the new value in the Edit Field field. Repeat this process for other fields if available. Press OK when done. >_dU You can customize the fields presented for post-copy updating using the Setup/Component Copy Preferences command. Click below for more information.

4-22

AutoPLANT PIPING

C 3
?=@?>5>D

5DE@

5>E

@41D5

B565B5>35C

3?=@?>5>DE@41D5@B565B5>35C
It is sometimes necessary to update component drawing database field values after components have been placed in a drawing. For example, a piping line may be moved or copied, which would require you to update the 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 of components. During component updates a dialog displays to enable you to select the drawing database field(s) that you want to update, then enter the new value for the selected field(s). The fields that are available in this dialog are assigned using the Setup/Component Update Preferences command. This enables a project manager to limit 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 the Fields to Include list, select the field and press <Remove. Multiple fields may be selected in either list by pressing and holding down the Ctrl key, then selecting the fields. A block of fields may be selected in either list by selecting the first field in the block, then pressing and holding down the Shift key and selecting the last field in the block. >_dU Only drawing database fields that have been defined in the PIPING table scheme as updatable will appear 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 modifying 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 component update preferences. The configured preferences will be defined for every drawing that is created using the configuration in which they were defined. For example, if you create a new drawing and select the Imperial configuration in the initial Model Setup dialog, then define your Update Preferences, every drawing created by that user using the Imperial configuration will display the last defined set of update preferences when the Database Tools/Update Components command is executed.

1F19<12<5695<4C
Lists the fields in the external drawing databases PIPING table that may be added to the list of fields displayed in the Update Component Data Fields dialog when you execute the Database Tools/Update Component 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 block of fields may be selected by pressing and holding down the Shift key, then selecting the first field in the block and then the last field in the block.

Reference Manual

4-23

C 3

5DE@

5>E

?=@?>5>D

@41D5

B565B5>35C

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

B5=?F5
Moves the selected fields from the Fields to Include list back into the Available Fields list.

695<4CD?9>3<E45
Lists the fields in the drawing database that display in the Update Component Data Fields dialog when you command. To remove a field from the Fields to Include execute the Database Tools/Update Component list, select the field and press <Remove. Multiple fields may be selected by pressing and holding down the Ctrl key, then selecting the fields. A block of fields may be selected by selecting the first field, then pressing and holding down the Shift key and selecting the last field in the block.

4-24

AutoPLANT PIPING

381@D5B

3?=@?>5>D=5>EC

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 components under various circumstances.

PIPE COMPONENTS BENDS AND RETURNS BRANCHING COMPONENTS TAP PORT VALVES FLANGES REDUCERS AND SWAGES MISCELLANEOUS FITTINGS SUPPORTS MISCELLANEOUS ATTACHMENTS COMPONENT PLACEMENT - HOW TO TOPICS COMPONENT MANIPULATION - HOW TO TOPICS

4-2 4-4 4-5 4-6 4-8 4-12 4-12 4-13 4-16 4-18 4-21 4-27

$
@9@53?=@?>5>DC

?=@?>5>D

5>EC

@ 3
9@5

?=@?>5>DC

The Pipe Components menu provides the following options to place components of this type. The associated Pipe Components toolbar button, menu command name, graphic depiction of each component, and a description 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, or may 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 to indicate the pipes length. You may also use this command to stub-in pipe using the create taP prompt option that displays when you attempt to connect pipe to an existing pipe segment. Simply execute the command, select the existing pipe segment, 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 and Collar Length. The Pad Thickness value defines the width of the pad itself, while the Collar Length value defined the 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 pipe bends 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 from the selection list (3R, 5R, or 6R). The R following the value instructs the system to multiply the value times the nominal size as specified in the Drawing Preferences dialog to determine the actual bend radius. You can also enter a value in this field, or enter a value with an R suffix to instruct the system to multiple this value times the nominal 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 you enter 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 the piping path. After the path is defined, the following Pipe Bend Data dialog displays to allow for the definition of the pipe bends.You can either enter the desired Bend Radius in the field provided, or select one of the pre-defined values from the selection list (3R, 5R, or 6R). The R following the value instructs the system to multiply the value times the nominal size as specified in the Drawing Preferences dialog to determine the actual bend radius. You can also enter a value in this field, or enter a value with an R suffix to instruct the system to multiple this value times the nominal size.

4-2

AutoPLANT PIPING

?=@?>5>D

5>EC

@ 3
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 Radius for remaining bends check box option. This enables you to repeat the bend radius from the first bend to all subsequent 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 symbolic representation and will typically be used when the user has already modeled the nozzle but needs a connection to an existing pipe line. This would allow complete Isos to be generated as well as a complete Bill Of Materials output and other requirements. To satisfy this requirement the existing nozzle component will be modified to allow a consistent interface for the user. To insert the nozzle select the menu option Pipe Components\Nozzle. The usual spec spec selection dialog will be displayed enabling you to select a particular nozzle from a multiple selection. Should only one nozzle be available 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 displaying additional data retrieved from the spec:

The Vessel Name should specify the equipment tag connected to this nozzle. Enter a Nozzle Number in the field indicated. The Nozzle Service is for information only for output to reports etc. The Nozzle Size, Rating (or schedule for butt welded nozzles) and Nozzle Length are displayed for information only. If you attempt to place a nozzle that has a zero (0.0) COMP_LEN spec database table field value, the Nozzle length field will be enabled as shown above. Enter the Nozzle length in the field provided. The nozzle will be drawn using the length parameter specified. Two basic nozzle types are provided. You may either insert a nozzle Symbol using the parameters assigned for Drawing Mode/Representation in the Drawing Preferences dialog, or insert a nozzle Indicator. If the nozzle has already 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 line number for this component.

Reference Manual

4-3

3 2

?=@?>5>D

5>EC

5>4C1>4

5DEB>C

Nipple

Pipe Nipples require two picks: a placement point and a direction vector. If you attempt to place a nipple that has a 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 length parameter specified. AutoPipe AutoPipe enables you to place connecting pipe between existing components and fittings. When the command is executed, the Drawing Selection Options dialog displays to enable you to select or define the selection set of components. The component selection set may include multiple components and directional/orientation changes in a single line. After the selection set is created, connecting pipe is automatically placed between the selected fittings. If in-line reducers or branches are detected, changes in pipe size and direction are made automatically.

25>4C1>4B5DEB>C
The Bends and Returns menu provides options to place components of this type. A description of each of these 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, or may be displayed separately by selecting Toolbars/Component Toolbars/Bends and Returns.

90-degree LR Elbow 90-degree SR Elbow 90-degree 3R Elbow 90-degree Reducing Elbow

Requires three placement points: insertion, direction, and orientation. Requires three placement points: insertion, direction, and orientation. Requires three placement points: insertion, direction, and orientation. Requires three placement points: insertion, direction, and orientation. The Specification Selection dialog displays before placement to enable you to select the desired reducing size. Requires three placement points: insertion, direction, and orientation. The Specification Selection dialog is displayed before placement to allow you to choose the reducing size. This component is defined in the HDPE specification. Requires three placement points: insertion, direction, and orientation. Requires three placement points: insertion, direction, and orientation. Requires three placement points: insertion, direction, and orientation. Requires three placement points: insertion, direction, and orientation. The Specification Selection dialog is displayed before placement to allow you to choose the reducing size. This component is defined in the HDPE specification. Requires three placement points: insertion, direction, and orientation. The Specification Selection dialog is displayed before placement to allow you to choose the reducing size. This component is defined in the HDPE specification.

60-degree LR Elbow

90-degree Street Elbow 45-degree LR Elbow 45-degree 3R Elbow 30-degree LR Elbow

22.5-degree LR Elbow

4-4

AutoPLANT PIPING

3 2

?=@?>5>D

5>EC

B1>389>7

?=@?>5>DC

Trimmed Elbow

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

Bend Elbow

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

180-degree Return

Requires three placement points: insertion, direction, and orientation.

2B1>389>73?=@?>5>DC
The Branching Components menu provides options to place components of this type. A description of each of 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 be displayed 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 the port of an existing component is selected. The next step is to specify the distance from that port where the olet will 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. The creation of the tap port for this type of olet differs from the other tap port definition procedures in that elbolets are always placed tangential to the bend, and therefore do not require the specification of a distance from the port to the olet insertion location. The orientation of the elbolet is tangential to the selected port on the bend. Requires placement on a component with a previously defined Tap Port. Requires placement on a component with a previously defined Tap Port. Requires placement on a component with a previously defined Tap Port. Requires placement on a component with a previously defined Tap Port. Requires placement on a component with a previously defined Tap Port.

Threadolet Sockolet Weldolet 45 Degree Pipet Straight Pipet

Elbow-Flanged Pipet Requires placement on a component with a previously defined Tap Port. Thermowell Latrolet Requires placement on a component with a previously defined Tap Port. Requires placement on a component with a previously defined Tap Port. Reference Manual 4-5

?=@?>5>D

5>EC

D @
1@

?BD

Nipolet Coupolet Saddle Sweepolet Weldolet Insert Straight Tee Reducing Tee Cross Reducing Cross Lateral True Wye

Requires placement on a component with a previously defined Tap Port. Requires placement on a component with a previously defined Tap Port. Requires placement on a component with a previously defined Tap Port. Spec record available in spec database DN40.MDB. Requires placement on a component with a previously defined Tap Port. Requires placement on a component with a previously defined Tap Port. Requires placement, direction, and orientation points. The orientation determines the branch direction. Requires placement, direction, and orientation points. The orientation determines the direction of the reducing branch. Requires placement, direction, and orientation points. Requires placement, direction, and orientation points. The orientation determines the direction of the reducing branch. Requires placement, direction, and orientation points. The orientation determines the direction of the lateral. Requires placement, direction, and orientation points. The orientation determines the direction of the lateral.

D1@@?BD
The Tap Port command must be executed prior to placing an olet. This command adds a port to the selected component on which the olet will be placed. All components in PIPING have associated ports. These ports are important reference points on the component. The number of ports on any one component depends on the component 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 which indicate 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 the base point from which the distance you specify in the next prompt will be measured to define the location of the tap.
Select the base port Toggle/<Enter to select currently highlighted port>: 4-6 AutoPLANT PIPING

?=@?>5>D

5>EC

D @
1@

?BD

Use the Toggle option (or type T and press Enter) to toggle through the components ports until the desired 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 be inserted 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 on the 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 the placement point, select the component where the tap was defined. PIPING will recognize the previously defined Tap point as a port and define the olets insertion points at that location.

Reference Manual

4-7

$
F1<F5C

3 F

?=@?>5>D

5>EC

1<F5C

The Valves menu provides options to place components of this type. A description of each of these options and 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 be displayed separately by selecting Toolbars/Component Toolbars/Valves.

.
Ball Gate Globe Plug Needle Butterfly Check Control Angle Relief Requires placement and direction points. Three types of gate valves are available for placement: Gate, Extended Gate, and Valv-O-Let Gate. Each requires placement and direction points. Two types of globe valves are available for placement: Globe, and Y-Body Globe. Each requires placement and direction points. Requires placement and direction points. Requires placement and direction points. Requires placement and direction points. Four types of check valves are available for placement: Check, Stop Check, Angle Stop Check and YBody Check. Each requires placement and direction points. Requires placement and direction points. Requires placement, direction, and orientation points. Requires placement, direction, and orientation points. The Specification Selection dialog is displayed prior to placement to allow you to select the size of the relief end of the valve. After making this selection, the orientation point specifies the location of the relief end. Requires placement, direction, and orientation points. Requires placement, direction, and orientation points. Two types of Diaphragms are available for placement: Diaphragm and Angle Diaphragm. Each requires placement, direction, and orientation points.

Three Way Four Way Diaphragm

D?@G?B;C
1ed_]QdYS9^cUbdY_^
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 is placed. Simply select the desired topwork from the dialog and press OK to display its placement dialog. Enter the desired parameters, then press OK to associate the topwork to the valve.

=Q^eQ\9^cUbdY_^
Topworks can be manually added to existing valves by selecting Valves/Topworks. You will be prompted to select a valve, then the dialog shown below displays.

4-8

AutoPLANT PIPING

?=@?>5>D

5>EC

1<F5C

Select the desired topworks from the dialog, then press OK. Each topwork option displays a dialog to enable you to enter the parameters required to draw the topwork. Each dialog contains a bitmap that illustrates each of the required parameters. Simply enter the parameter values and press OK to connect the topwork to the valve.

D_`g_b[c@\QSU]U^d3ecd_]YjQdY_^
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 valves class record.

4YQ\_WCU\USdY_^
The default valve topworks placement option reads the file TOPWORKS.INI that resides in the current module directory (e.g., the TOPWORKS.INI file for the Base carbon steel modules resides in your NETWORK_ROOT\MODULES\BASE directory). The list of available topworks that display in the dialog are defined in this file. The format of a topwork definition in this file is as follows:
>&RQH@ &ODVV1DPH $7B723:25.6B&21( 'HVFULSWLRQ &RQH2SHUDWRU

When you pick an option from the dialog list and press OK, the system will display the parameter dialog for the selected topwork. If the specification record for the valve that you are placing assigns values for the topwork parameters, then those values will display as the defaults in the topworks placement dialog. If the parameters are not defined in the specification, then they will be read from a separate TOPWORKS.INI file that resides in the current configuration directory. For example, the topworks parameters for the provided Imperial configuration are defined in the file TOPWORKS.INI that resides in your NETWORK_ROOT\CONFIG\IMPERIAL directory. The configurations TOPWORKS.INI consists of a series of multi-line records that define each topwork. For example, the record for the cone operator appears as shown below.
>$7B723:25.6B&21(@ +HLJKW  GLDPHWHU  /21*B'(6&5 &RQH2SHUDWRU

Reference Manual

4-9

3 F

?=@?>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 the topworks class name. The statements that follow enable you to assign default parameters that will appear in the actual topworks placement dialog. As mentioned above, if the specification record for the valve that you are placing assigns values for these same fields, then those values will display as the defaults in the topworks placement dialog.

C`USCU\USdY_^
If you want a particular topworks type always placed with a specific valve type, you can define the topworks type in the Operator field of the valves specification record. For example, if you always want the cone topwork placed with a ball valve, you can assign AT_TOPWORKS_CONE to the Operator field in all of your valve spec records. In this instance, when you place a valve with the Operator field defined, the system will not display the topworks selection dialog, but will still display the cone operators parameter dialog to enable you 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.

3\QccCU\USdY_^
If you want a particular topworks type always placed with a specific valve type, you can define the topworks type by assigning the topworks class to the 723:25.6B&/$66 keyword in the valves class record in CLASS.INI. For example, if you always want the handwheel topwork placed with a ball valve, you can assign AT_TOPWORKS_HANDWHEEL to the 723:25.6B&/$66 keyword to the desired valve class records in CLASS.INI. In this instance, when you place a valve with the 723:25.6B&/$66 keyword defined, the system will not display the topworks selection dialog, but will still display the defined topworks parameter dialog to enable you 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.

Deb^?VVD_`g_b[c@\QSU]U^d
The reason that all of this works is because the ,1387B0(7+2' for the valves that generally require topworks specifies that topworks placement is required. The input method for each valve type is defined in that valves methods record in METHODS.INI. All valves 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 check valves, is defined in the >%$6(B9$/9(6B0(7+2'@ group in METHODS.INI as follows:
,1387B0(7+2' &RPPRQ?YOYLQSXWDWB9DOYHBLQSXW

This indicates that the function DWBYDOYHBLQSXW in the file ..\COMMON\VLVINPUT.EBS will be run for each valve insertion. All valves use the methods defined in the %$6(B9$/9(6B0(7+2' group, unless they explicitly define 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?YOYLQSXWDWB9DOYHBLQSXW'XPP\

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

4-10

AutoPLANT PIPING

?=@?>5>D

5>EC

1<F5C

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

1TTY^WQ3ecd_]3_]`_^U^d
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 your NETWORK_ROOT\MODULES\BASE directory). A sample record has been provided in this file that executes the 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 ([DPSOHRIDXVHUFRPSRQHQWVDPHDVWKH*DWHYDOYH

The first item enclosed in brackets is the user valve group name, which must be unique and exactly match the valve class name as defined in the modules CLASS.INI file. Each module has its own CLASS.INI file. In order to add a new user valve class, you must first use the Configuration Editor application to create a custom configuration, then use the Class Editor application to add the new user valve class to the custom configurations CLASS.INI file. Each of these applications provide their own help file with instruction on how to perform these tasks.

Reference Manual

4-11

$
6<1>75C

3 6

?=@?>5>D

5>EC

<1>75C

The Flanges menu provides options to place components of this type. A description of each of these options and 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 be displayed separately by selecting Toolbars/Component Toolbars/Flanges.

Weldneck Threaded Socketweld Blind Expander Slip-On Lap-Joint Stub End Orifice Reducing Flange Pick from Spec

Requires placement and direction points. Requires placement and direction points. Requires placement and direction points. Requires placement and direction points. Requires placement and direction points. Requires placement and direction points. Requires placement and direction points. Requires placement and direction points. Threaded and Slip-On selections are available. Requires placement and direction points. This command enables you to select the flange directly from the specification. The Specification Selection dialog displays a list of flanges matching the requested size. Select from the list.

B54E35BC1>4CG175C
The Reducers and Swages menu provides options to place components of this type. A description of each of these 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 allow you to select the reduced size. The orientation point determines the location of the flat end of the reducer. Requires placement and direction points. A dialog is displayed for the selection of a reduced size. Requires placement, direction, and orientation points. The Specification Selection dialog opens to allow you to select the reduced size. The orientation point determines the location of the flat end of the swage.

Concentric Swage Eccentric Swage

4-12

AutoPLANT PIPING

3 =

?=@?>5>D

= 6

5>EC

9C35<<1>5?EC

9DD9>7C

=9C35<<1>5?EC69DD9>7C
The Miscellaneous Fittings menu provides options to place components of this type. A description of each of these 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 Return Bend Offset Branch Lateral Wye Cross End Blinds Menu Paddle Spacer Bleed Ring Spectacle Open Spectacle Closed Orifice Plate Requires placement, direction, and orientation points. The orientation determines the flat side of the paddle blind. Requires placement, direction, and orientation points. The orientation determines the flat side of the spacer blind. Requires placement and direction points. Requires placement, direction, and orientation points. The orientation determines the flat side of the open spectacle blind. Requires placement, direction, and orientation points. The orientation determines the flat side of the closed spectacle blind. When you attempt to place an Orifice Plate, you are first prompted to pick the insertion point, then select the desired record from the Specification Selection dialog. When you select a record and press OK, a dialog displays to accept/modify a few of the components drawing database field values. The default dialog field values are initially retrieved from the spec (if it exists). The input dialog enables you to change these values before the actual creation of the component. A bitmap graphic illustrating the parametric fields that may be modified is also provided in these dialogs. Requires placement and direction picks. Requires placement, direction, and orientation picks. Requires placement, direction, and orientation picks. Requires placement, direction, and orientation picks. Requires placement, direction, and orientation picks. Requires placement, direction, and orientation picks. Requires placement and direction picks. Requires placement, direction, and orientation picks. Requires placement and direction picks.

Restriction Plate When you attempt to place a Restirction Plate, you are first prompted to pick the insertion point, then select the desired record from the Specification Selection dialog. When you select a record and press OK, a dialog displays to accept/modify a few of the components drawing database field values. The default dialog field values are initially retrieved from the spec (if it exists). The input dialog enables you to change these values before the actual creation of the component. A bitmap graphic illustrating the parametric fields that may be modified is also provided in these dialogs. Strainers Menu Startup Requires placement and direction picks. Reference Manual 4-13

?=@?>5>D

= 6

5>EC

9C35<<1>5?EC

9DD9>7C

Basket Angle Wye 2-Port Wye

Requires placement, direction, and orientation picks. Requires placement, direction, and orientation picks (spec records in spec database DN40.MDB). Requires placement, direction, and orientation picks. Requires placement, direction, and orientation picks.

Steam Traps Menu Straight Tee Wye Requires placement and direction picks. Requires placement and direction picks. Requires placement and direction picks.

Wye w/Swivel Requires placement, direction, and orientation picks. Connector Return In-Line Union Menu Union Union Elbow Union Tee Requires placement, direction, and orientation picks. Requires placement, direction, and orientation picks. Requires placement, direction, and orientation picks. Requires placement, direction, and orientation picks.

Requires placement, direction, and orientation picks.

Other Miscellaneous Fittings Menu Coupling Requires placement and direction points.

Half Coupling Requires placement and direction points. Boss Pipe Cap Plug Expansion Joint Bushing Reducer Insert Requires placement and direction points. Requires placement and direction points. Requires placement and direction points. Requires placement, direction, and orientation picks.

Requires placement and direction picks. Requires placement and direction points.

Requires placement, direction, and orientation picks. Ejector/Eductor Venturi Flow Meter When you attempt to place a Ventrui Flow Meter, you are first prompted to pick the insertion point, then select the desired record from the Specification Selection dialog. When you select a record and press OK, a dialog displays to accept/modify a few of the components drawing database field values. The default dialog field values are initially retrieved from the spec (if it exists). The input dialog enables you to change these values before the actual creation of the component. A bitmap graphic illustrating the parametric fields that may be modified is also provided in these dialogs.

4-14

AutoPLANT PIPING

3 =

?=@?>5>D

= 6

5>EC

9C35<<1>5?EC

9DD9>7C

Complex Flow Meter

When you attempt to place a Complex Flow Meter, you are first prompted to pick the insertion point, then select the desired record from the Specification Selection dialog. When you select a record and press OK, a dialog displays to accept/modify a few of the components drawing database field values. The default dialog field values are initially retrieved from the spec (if it exists). The input dialog enables you to change these values before the actual creation of the component. A bitmap graphic illustrating the parametric fields that may be modified is also provided in these dialogs. Requires placement, direction, and orientation picks.

Injection Quill

EC5B69DD9>7C
The User Fittings command displays the AutoPLANT Selections dialog shown below.

Select the desired user fitting placement option from the dialog, then press OK.

1TTY^WQ3ecd_]3_]`_^U^d
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 your NETWORK_ROOT\MODULES\BASE directory). A sample record has been provided in this file that executes the 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 8VHUGHILQHGILWWLQJVDPHDVDGHJUHHHOERZ

The first item enclosed in brackets is the user fitting group name, which must be unique and exactly match the fitting class name as defined in the modules CLASS.INI file. Each module has its own CLASS.INI file. In order to add a new user fitting class, you must first use the Configuration Editor application to create a custom configuration, then use the Class Editor application to add the new user fitting class to the custom configurations CLASS.INI file. Each of these applications provide their own help file with instruction on how to perform these tasks.

Reference Manual

4-15

$
CE@@?BDC

3 C

?=@?>5>D

5>EC

E@@?BDC

The Supports menu in PIPING and ISOMETRICS provides options to place supports. Selecting any of these options will display an AutoPLANT Selections dialog listing the available support placement types for the selected menu option.

Select the desired component from the dialog, then press OK. Each support option displays a dialog to enable you to enter the parameters required to draw the support. Each dialog contains a bitmap that illustrates each of the required parameters. Simply enter the parameter values and press OK to draw the support. >_dU The selection dialog instance is defined in the SELECT.EBS file in your NETWORK_ROOT\MODULES\BASE\DIALOGS directory.

1449>713ECD?=3?=@?>5>D
Each of the support menu placement options reads an INI file to determine the list of supports for that type displayed in the selections dialog. For example, the supports displayed by the Supports/Anchors and Guides command are defined in the file ANCHORS.INI that resides in the current module directory (e.g., the ANCHORS.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 Support menu commands are listed below:
Supports/Hangers HANGERS.INI

Supports/Supports on Supports COMPSUPP.INI Supports/Misc. Supports Supports/Shoes Supports/User Supports MISCSUPP.INI SHOES.INI SUPPORTS.INI

The format of a support definition in these files is as follows:

>8%ROW@ &ODVV1DPH $7B6833257B8%2/7 'HVFULSWLRQ 8%ROW6XSSRUW

The first item enclosed in brackets is the support group name, which must be unique and exactly match the support class name as defined in the modules CLASS.INI file. Each module has its own CLASS.INI file. In order to add a new support class, you must first use the Configuration Editor application to create a custom configuration, then use the Class Editor application to add the new support class to the custom configurations CLASS.INI file. Each of these applications provide their own help file with instruction on how to perform these tasks.
4-16 AutoPLANT PIPING

?=@?>5>D

5>EC

E@@?BDC

The User Supports menu option and associated SUPPORTS.INI file is provided to enable you to add your own supports to the system.

@<1351CE@@?BD > D @
? <1351

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 may accept this port, or type T and press Enter to toggle to a different port on the selected component. When the desired port is highlighted, press Enter. % The prompt
Toggle base port/Align/change Ref point/<Enter Distance>:

displays. Enter the first letter of the desired option, or input a distance to specify the distance from the selected port where the support will be placed. & ' Another dialog will display to define the parameters required to place the selected support. Enter the parameters 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.

Reference Manual

4-17

?=@?>5>D

= 1

5>EC

9C35<<1>5?EC

DD138=5>DC

=9C35<<1>5?EC1DD138=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.

@9@9>7
In PIPING, the following Misc. Attachments enable you to insert a detail item that can be exported to AutoISO 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 a dimension be placed from a point on a component to a disconnected item on an ISOGEN isometric generated using AutoPLANT Import/Export. Click the Reference Dimension link for more information on this attachment type.

9C?=5DB93C
The same options indicated above are available in ISOMETRICS to allow for the manual insertion of these detail items in an isometric drawing. The following options are also provided in ISOMETRICS to allow for the insertion of additional items that are not component attachments, but add detail to the drawing and can be dimensioned to using the Reference Dimension option. These items are:
+ + +

Equipment Vessel I-Beam Ground

4-18

AutoPLANT PIPING

3 =
+

?=@?>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 the Reference Dimension option.)

1449>713ECD?=3?=@?>5>D
The default attachment placement option reads the file MISCATT.INI that resides in the current module directory (e.g., the MISCATT.INI file for the Base carbon steel modules resides in your NETWORK_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 match attachment class name as defined in the modules CLASS.INI file. Each module has its own CLASS.INI file. In order to add a new user attachment class, you must first use the Configuration Editor application to create a custom configuration, then use the Class Editor application to add the new attachment class to the custom configurations CLASS.INI file. Each of these applications provide their own help file with instruction on how to perform these tasks.

B565B5>3549=5>C9?>1DD138=5>D
The Reference Dimension attachment is available for placement by executing the Miscellaneous Attachments option from the Piping/Iso menu, then selecting the Reference Dimension option an pressing OK. This attachment is provided to enable you to dimension from a point on a component to a disconnected item in an ISOGEN isometric drawing generated from a PIPING model or ISOMETRICS drawing using AutoPLANT Import/Export. This capability was added to enable you to identify the component and the item to which it references. Selecting the Reference Dimension option from the Miscellanous Attachments dialog and pressing OK prompts you to select the parent, or reference, component.
Select the component

The next step is to define the define the desired component reference location, which is the coordinates on the component from which the reference dimension will be placed. When the component was selected above, one of its ports was highlighted. The following prompt enables you to toggle the selected port to one of the other component 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>: Toggle base port/Align/change Ref point/<Enter Distance>:

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.

Reference Manual

4-19

?=@?>5>D

= 1

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 attachments drawing database record. You may optionally append the reference item location to the Long Description value by enabling the Append reference location to the description check box. This value will be written to the external drawing database record and displayed as annotation in the generated ISOGEN isometric. B
565B5>35

5>D5B<9>5

The Reference Centerline list defines the line type of the item used for this reference object. The following line type selections are currently available.
Isogen Default (normal) Dashed/Existing Centerline Phantom Hidden/Dotted Short Centerline
default for the type of reference item selected __ __ __ __ __ __ __ __ __ _ _ ___ _ ____ _ ____ _ __ _ _ __ _ _ __ _ _ __ _ _ _______________ __ _ __ _ __ _ __ _ __ _ __

1D57?BI

The Category list enables you to select the type of item being referenced. Describes the category for the type of component that the referenced item belongs to, the following options are currently available and will be displayed as part of the resulting reference dimension: Building Equipment Item Floor Level Grid Line Horizontal Steel Equipment Pipeline Vertical Steel Equipment Wall Miscellaneous

4-20

AutoPLANT PIPING

3 3 1 3
?=@?>5>D

?=@?>5>D

5>EC

<135=5>D 

8

?G ? ?@93C

D D

>>?D1D9?>

?>D19>5B

The tag annotation can optionally be enclosed by one of the following container types: round, square, or pointed by selecting the desired option from the Annotation Container drop-down list. B
565B5>35

2:53D

B95>D1D9?>

This option indicates the orientation of the referenced object. Your may either select an orthogonal projection, North, South, East, West, Up or Down. Alternately, if you select Angled, on completion of the input to this dialog you will be prompted to specify the direction of the referenced item by selecting two points in space. 4
9=5>C9?>?> C?

This option will allow a location dimension to be generated for the selected pipeline component, not the reference. C
;5G54

9=5>C9?>

Determines if the dimension to the reference item should be in the form of skewed movements between a point on the pipeline and the centerline of the item to be referenced. If this item is left disabled then the movements of the dimension lines will follow the primary planes. One, two or three movements may be necessary depending n the location of the referenced item.

3ecd_]YjQdY_^3_^cYTUbQdY_^c
In order to implement this functionality, we had to add a script to output reference dimensions to PCF for ISOGEN, and add the ability to create reference dimension attachments in ISOMETRICS. This required modification of the PIPING/ISOMETRICS scripts and INI files to handle an AT_ATTACH_REFDIM class and by adding a PCF script for output.

3?=@?>5>D@<135=5>D8?GD?D?@93C
This area provides step-by-step instructions that walk you through several component placement techniques.

144?@5B1D?BCD?F1<F5CD?@G?B;C
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 the Valves/Topworks command.

> D 1 D
? 44

?@G?B;C

?

@5B1D?BCD?

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 contains parameter fields that must be defined in order to draw the operator. Each dialog also contains a bitmap graphic that illustrates the parameters required. Define the parameters for the operator in the dialog, then press OK. The prompt
Enter Topworks Direction:

$ %

Reference Manual

4-21

3 3

?=@?>5>D

5>EC

?=@?>5>D

<135=5>D 

8

?G ? ?@93C

D D

displays, and the starting point is anchored to the center of the selected valve. Pick a point to orient the operator.

1<97>D?5H9CD9>73?=@?>5>DC
A component can be placed so that its centerlines are aligned with existing components in the model. This is useful for placing bends and branching components, which are connecting existing components at different elevations and in different planes of the model.

> D 1
?

<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 youll want to accept the default to place the new components 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 prompt

the port alignment, then press Enter.

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 on the Responses toolbar.

4-22

AutoPLANT PIPING

3 3
?=@?>5>D

?=@?>5>D

5>EC

<135=5>D 

8

?G ? ?@93C

D D

1DD138D?1>5H9CD9>73?=@?>5>D
When routing components, the most common method of connection is Fitting to Fitting. In Auto Router mode, this type of connection is made automatically. In manual routing mode, follow the procedure below.

> D 1
?

DD138D?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 the run 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 Responses toolbar to orient along a particular axis. >_dU If you are not connecting to the last component placed in the drawing, you will need to specify a new reference point before attaching. To do this, simply select the component you want to attach to in Step 3, then continue the procedure normally.

1ED?=1D931<<IB?ED53?=@?>5>DC
The Auto Router mode is the fastest method of connecting a series of components together. This option should not be used if special placement procedures are required.

> D 1
?

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

1ED?=1D931<<I@<1353?>>53D9>7@9@51ED?@9@5
The AutoPipe command will automatically place connecting pipe between existing fittings. Main Size is determined by the connecting components, and the command will recognize in-line reducers and change the nominal size accordingly.

> D 1
?

ED?=1D931<<I

<135

?>>53D9>7

9@5

1

ED?

@ 
9@5

! " #

Select Pipe Components/Auto Pipe

The Drawing Selection Options dialog displays. Select the components between which connecting pipe should be placed using the tools in this dialog. After the selection set is created, the connecting pipe is placed.

Reference Manual

4-23

3 3

?=@?>5>D

5>EC

?=@?>5>D

<135=5>D 

8

?G ? ?@93C

D D

381>75D85B565B5>35@?9>D
When routing in PIPING, a reference point is always indicated in your drawing. This symbol indicates the current point from which all commands will be executed. If you are connecting two components using the fitting to fitting method, the new component will be connected to the reference point. In some cases, you may want to change the reference point so that, for example, you can place a component a specified distance from the center point of an elbow instead of its endpoint.

> D 3
?

81>75D85

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 other available locations on the current component. If youd like, you can pick a valid point on another component in the model. " Input a distance or select the Align to option to continue with the placement procedure.

4569>51D1@@?BD6?B?<5D@<135=5>D
Before an olet can be attached to an existing pipe, you must define a new port at the desired location on the existing pipe. Once the port is defined, the olet can be attached to it.

> D 4
?

569>51

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 to designate the port at the opposite end of the pipe. default port, or Toggle $ The prompt
Toggle base port/Align/change Ref point/<Enter Distance>:

displays. Enter a distance from the reference point at the command line, or pick a point in the model. (If the 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 be inserted 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 or keys on the Responses toolbar. the ' The new port is defined at the specified location and orientation. You can now place an olet directly on this port by selecting and olet placement command, then picking the component on which you defined

4-24

AutoPLANT PIPING

3 3
?=@?>5>D

?=@?>5>D

5>EC

<135=5>D 

8

?G ? ?@93C

D D

the tap. PIPING will automatically locate the tap port on the selected component and make it the default insertion point for the olet.

@<13513?=@?>5>D9>C@135
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 specific location or coordinate with no respect to other component locations.

> D @
?

<1351

?=@?>5>D9>

@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 AutoCAD techniques. $ 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, there may be anywhere from two to four possible insertion points. After the desired point is specified, press Enter. % 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 the buttons on the Resonses toolbar, then press Enter.

@<1351;>?G>49CD1>356B?=1>5H9CD9>73?=@?>5>D
Component may be placed a relative distance from an existing point on a reference component. You may, for example, place a bend 10 from the center point of a tee that is already placed in the model.

> D @
?

<1351

>?G>

9CD1>356B?=1>

H9CD9>7

?=@?>5>D

! "

Select the component. 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 youd like to place relative to the center of the component, change the reference point. $ Input a distance at the command line, then press Enter (you may also indicate the distance by picking a new point in the drawing).
Reference Manual 4-25

3 3

?=@?>5>D

5>EC

?=@?>5>D

<135=5>D 

8

?G ? ?@93C

D D

% &

An outline of the component is placed in the drawing. To place it, press Enter. If youd like to change the until the component appears as desired, then press Enter. insertion point, use the Toggle option (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 commands from 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 alignment of the component. Press Enter when done.

to change the

@<135?>1C=1BD@?<I<9>5
Components may be placed on smart polylines which are placed into a model to define one or more piping paths. This method ensures the proper alignment of several objects and allows vector data and other settings to be extracted directly from the intelligence of the smart polyline.

> D @
?

<1351

?=@?>5>D?>1

=1BD

?<I<9>5

! "

Select the component. The prompt

Relative/Toggle/<Pick point (Component, Routing Line, Space, or Enter for fit to fit)>:

displays. Select a point on the polyline. Use AutoCADs OSNAP commands to select a specific endpoint, intersection point, or XYZ distance from a specific reference point (refer to AutoCAD documentation/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 to place the component. If the Connect from Existing option is specified as the Data Mode, the component will automatically be assigned the lines settings (size, insulation, etc.). Otherwise, the values established in the Drawing Preferences dialog will be applied.

4-26

AutoPLANT PIPING

3 3
?=@?>5>D

?=@?>5>D

5>EC

1>9@E<1D9?> 

8

?G ? ?@93C

D D

3?=@?>5>D=1>9@E<1D9?>8?GD?D?@93C
This area provides procedures that walk you step-by-step through common component manipulation tasks.

549D3?=@?>5>D9>6?B=1D9?>
After a component is placed in a model, many of its attributes can be modified directly by editing the external drawing database record associated with the component. As a general rule, dimensional and position data may not be modified.

> D 5 3
? 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 this dialog contains the most common component drawing database record information. Most of the information is provided for information purposes only. The field data that may be modified is presented in white editable text boxes. Simply move the cursor into the desired text box and modify the information as desired. Changes made in this dialog will update the respective field information in the components drawing database record. Press Next Page to display the second page of the dialog. The second page contains component position and port information. It also provides a complete list of all of the components drawing database record field values. Press OK to close the dialog.

#

$

E@41D53?=@?>5>D9>6?B=1D9?>
The Database Tools/Update Component command may be used to globally update the value of specific external drawing database fields for a selection set of components in the current or from multiple drawings.

> D
! " # $ %

?E@41D53?=@?>5>D9>6?B=1D9?>

Select Database Tools/Update Component

The Drawing Selection Options dialog displays. Select the components to update using the tools available 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 Edit Field 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. >_dU You can customize the list of fields that appear in the Update Component Data Fields dialog using the Setup/Component Update Preferences command.

Reference Manual

4-27

3 3

?=@?>5>D

5>EC

?=@?>5>D

1>9@E<1D9?> 

8

?G ? ?@93C

D D

3?@I13?=@?>5>D
PIPING/ISO components can be copied like any other object using the Copy command. AutoPLANT provides the Setup/Component Copy Preferences command to customize the copy procedure.

> D 3
?

?@I1

?=@?>5>D

! "

Type COPY at the command line (do NOT use the COPY icon on the AutoCAD toolbar, which is equivalent 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 AutoCAD OSNAP commands if necessary. $ The prompt
Second point of displacement:

displays. Pick or input the point where the copied component(s) should be placed. Use AutoCAD OSNAP commands if necessary. % The Update Component Data Fields dialog displays. Select the field in the left column that requires updating, then type the new value in the Edit Field field. Repeat this process for other fields if available. Press OK when done. >_dU You can customize the fields presented for post-copy updating using the Setup/Component Copy Preferences command. Click below for more information.

4-28

AutoPLANT PIPING

3 3
?=@?>5>D

?=@?>5>D

5>EC

1>9@E<1D9?> 

8

?G ? ?@93C

D D

5CD12<9C8@?CD3?@I3?=@?>5>DE@41D5@B565B5>35C
The following procedure explains how to establish rules that the system will use when a user attempts to copy component(s).

> D
! "

?4569>5@?CD 3?@I3?=@?>5>DE@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 copied components as follows:
+ + +

Prompt: After the component(s) is copied, a dialog will be displayed in which you can review and edit the field values before updating System Default: After the component(s) is copied, field values will be updated automatically based on the definitions established in this dialog Script: Copied components are updated automatically as determined by a Basic Script file. If you select this option, skip to Step 5.

#

Press the Select button from the Component Fields area of the dialog. When the Component Field Selection dialog appears, select the desired fields from the Available list, then press Add>. After selecting the 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 is optional as you can edit the field as desired after the component is copied. If you are using the System Default option, you must input a Prefix, Suffix, or both in these fields (if neither is specified and System Default 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. Subsequent component COPY commands will update components based on the definitions established in this dialog.

$

% & ' (

=?F513?=@?>5>D
PIPING/ISO components can be moved like any other AutoCAD entity.

> D =
?

?F51

?=@?>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 AutoCAD OSNAP commands if necessary. Press Enter. $ The prompt
Second point of displacement:

displays. Select the point where the component should be moved. Use AutoCAD OSNAP commands if
Reference Manual 4-29

3 3

?=@?>5>D

5>EC

?=@?>5>D

1>9@E<1D9?> 

8

?G ? ?@93C

D D

necessary. Press Enter. >_dU If you intend to move a set of components and connect the open end of this set to an existing component, you should use the Piping Tools/Join Components command to connect the two coincident welded components together. For example, if you move/copy a pipeline connected to one buttweld component to the end of another buttweld component, you can use this command to properly connect the second buttweld component with the copied pipeline. Flanges and other components that are not coincident cannot be connected with this function.

C5DD85@B569H1>4?BCE669HG85>E@41D9>73?@9543?=@?>5>DC > D C
? 5DD85

B569H1>4

?B

E669HG85>E@41D9>73?@9543?=@?>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 Default Field Value Pref field. (If a Prefix is not defined, skip to Step 3.) Input the prefix that will be appended to the front of the affected field. Separators are allowed (for example, a value of NEW is acceptable). If a suffix is to be attached to the end of the updated field values, enable the check box in the Use Program 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). >_dU Both a Prefix and a Suffix can be added to the same field. Simply enable both options and input values 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 Fields list has been populated based on the selections made from the Component Fields area of the Component Copy 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 Prefix input 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.

% & ' (

4-30

AutoPLANT PIPING

381@D5B

@9@9>7D??<C=5>E

This chapter covers the Piping Tools menu, which provides numerous tools to increase the efficiency and accuracy of component placement.

OVERVIEW CENTERLINE ROUTERS MENU REPRESENTATIONS 3D DISPLAY MODES 3D DISPLAY UTILITIES MENU CONNECTIVITY CHECKER DIMENSION NODES JOIN COMPONENTS STOP SIGNS

5-2 5-2 5-20 5-22 5-25 5-27 5-30 5-31 5-32

%
?F5BF95G

@ ?

9@9>7

??<C

5>E

F5BF95G

The Piping Tools menu provides numerous tools to enable you to increase the efficiency and accuracy of component placement. These commands may also be executed via the Piping Tools toolbar. This toolbar is available as a flyout toolbar from the main Piping Functions toolbar, or may be displayed separately by selecting Toolbars/Function Toolbars/Piping Tools. This toolbar contains flyouts that display additional commands for each Piping Tools category.

35>D5B<9>5B?ED5BC=5>E
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 single step. It is also the best method for drawing rolls and defining slopes on the piping path, eliminating the need to 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 our users. Review the choices offered in the menu, then select a method, which best meets the needs of your project.

549D3?=@?>5>D@B565B5>35C
Many AutoPLANT commands display the following dialog to enable you define the settings that will apply for that function. This is a reduced version of the Drawing Preferences dialog, which only displays the component attributes that may be defined for the command executed. For example, the Draw Intelligent Centerline command in ISOMETRICS and the Piping Tools/Centerline Routers/From Dialog command in PIPING 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, then press OK.

5-2

AutoPLANT PIPING

@ 3

9@9>7

??<C

5>E

5>D5B<9>5

?ED5BC

5>E

6B?=491<?7
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 centerline should be drawn using a smart info line. If this switch is ON, an additional dialog is displayed for the setting of 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
([LW2SWLRQV!3LFN3RLQW

is displayed. Pick the starting point in the drawing to begin routing the centerline. If you select the endpoint of 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 all of the options in this dialog is provided after this figure. Click on an area of the dialog to quickly jump to the help on a specific option.

The dialog provides tools for defining the next point on the current centerline. After the point is defined, the dialog will close to allow you to specify in-plane points using standard AutoCAD techniques. To re-open the dialog at any time, simply press Enter or the right mouse button.

?`dY_^c
The following options aid in adding a point to the centerline. In many cases, these options are used in conjunction with the Distance/Angle fields. >
?>5

No point creation commands or options selected. You can set this option to clear the current settings. D
?G1B4C

1

G1I

@

?<1B

The Towards (+Z) and Away (-Z) options will activate the Distance field. Specify the distance from the previous point. The Polar option will activate the Distance and the X-Y Angle fields. Input the distance and angle at which the next point should be placed. For example, to place the next point 45-degrees from the current point, 6 feet
Reference Manual 5-3

@ 3

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. C
<?@9>7

Activates the Z Angle field. The Sloping command enables you to input the angle the pipe line runs towards or away from the current point. After pressing OK from the Routing dialog, the dialog shown below is displayed. Specify whether or not the pipe line is sloping towards or away from the viewer (looking down on the drawing in the plan view).

You will be prompted to select the (XY) location of the next point. The router will automatically calculate the proper Z value based on the requested slope angle. J4
9CD1>35

Activates the Distance, Z-Distance and X-Y Angle fields. The Z-Distance command enables you to input a polar 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 ZDistance value specifies the new centerline point as 48 units above Point A.

5-4

AutoPLANT PIPING

@ 3 B B
9C5

9@9>7

??<C

5>E

5>D5B<9>5

?ED5BC

5>E

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 specified distance, and calculates a Z Angle value for information purposes (press Enter or move the cursor to a new field to calculate the angle). Input the Rise and Run values in the appropriate fields, then press OK. The new point is placed in the model. E 4
@ ?G>

>

?BD8

C

?ED8

5

1CD

G

5CD

Activates the Distance field. Select the appropriate command to indicate the general direction the pipe line is turning, then input the length the line proceeds along that direction before the next point is reached. B
5<1D9F5

Disables the Distance/Angles fields. The Relative commands will determine the intersection between the previous centerline point and a point that already exists in the model (such as the endpoint of a component or a point on another centerline). This can be very useful when routing a centerline to connect two components that lie in different planes and at different elevations. For example, refer to the Figure below.

Reference Manual

5-5

@ 3

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 known distance from the nozzle, you now need to calculate the point that will align with the centerline of the tee where an elbow will be placed. Select Relative from the Routing dialog, then press OK. The dialog closes and the prompt 3LFN'LUHFWLRQ is displayed. Indicate the direction in which the next point will be located. You are next prompted to3LFN5HODWLYH(QG3RLQW. Use the AutoCAD ENDP OSNAP to select the centerline of the tee. The line is routed from the previous point to the selected end point, with a 90 bend in the line. B
565B5>35

The Reference command enables you to select a reference point that already exists in the model, then specify a distance from that point. A line from the new point is then drawn back to the centerlines 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 a known distance away from the previous elbow. You also want the two elbows placed on the same plane so they can be supported at the same elevation. Select the Reference command, then select the intersection point of the elbow to use as reference. Next, specify a distance away from that point. The centerline continues to the newly defined point. You can then continue routing. The result is shown in red in the Figure. 5
<5F1D9?>

Activates the Distance and Pipe O.D. fields. Input the elevation at which you want the next point placed in the Distance field. Input the nominal pipe diameter in the Pipe O.D. field to ensure that the centerline will be placed at the proper location. D?@3?@2?@5
<5F1D9?>

Activates the Distance and Pipe O.D. fields. First ensure that the Pipe OD field correctly describes the nominal 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 the pipe is at the requested elevation. If Bottom Elev is selected, the router will place the centerline so that the
5-6 AutoPLANT PIPING

@ 3

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 is automatically placed at the centerline elevation with no adjustments. 2
?H

?ED5B

93;

If you are connecting two points that lie in different planes at different elevations, you can use the Box Router Pick 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. Select Box Router Pick from the Router dialog, then use the ENDP OSNAP to pick the endpoint of the tee. A threedimensional box is drawn between the two points as shown in the Figure. The following prompt is presented:
([LW&RQQHFW5HGUDZ%R[3RLQWV6ORSH,QFUHPHQW$XWR.HHS1H[W!

Note that a yellow line is extends from the starting point to one of the corners on the box. Type A and press Enter at the command line to go into Auto Mode. The yellow line indicates a possible path to the opposite end of the box. Accept the routing by pressing K to Keep it, or press Enter or the right mouse button to toggle through 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 not connected. 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 the display 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 Auto mode. Slope: Allows you to define an anchor point for the slope, then specify a corner on the box where the line should 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
Reference Manual 5-7

@ 3

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 box disappears 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 with choices 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 the Distance, Z Distance, and X-Y Angle fields (instead of picking an existing point). Input values in the fields to draw the box, then route as described in the Box Router section of this help file. E
>4?

Deletes the last point defined on the centerline. 4

9CD1>35

The distance from the previous point in current drawing units (negative values are accepted). J4
9CD1>35

The Distance in the Z plane from the previous point. This value may be used in combination with others to define elevation and polar points. HI1
>7<5

The X-Y Angle from the previous point. This value is used in combination with Distance and Z-Distance values to specify polar coordinates on the centerline. J1
>7<5

The Angle from the previous point measured in the vertical (or Z) plane. This value is used in combination with other values to specify polar coordinates on the centerline. @
9@5

?4

Inset the Pipe Outside Diameter in this field when specifying elevation points. The Pipe OD is needed in order to determine where the centerline should be placed when the user requests pipe to be placed at a certain elevation 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. J
??=

Opens the following dialog, which presents methods for transparently zooming and panning during the definition of a centerline path.

5-8

AutoPLANT PIPING

@ 3 J

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/HIW3UHYLRXV9PD[:LQGRZ6FDOH;;3!

After changing the zoom factor, you are immediately returned to the centerline routing session where you left it. BDJ
??=

Provides access to the standard AutoCAD RTZOOM command, which enables you to interactively zoom in and 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 left it. @
1>

Provides access to the standard AutoCAD PAN command, which enables you to select a point in the drawing and then pick a displacement distance. After panning the drawing, you are immediately returned to the centerline routing session where you left it. BD@
1>

Provides access to the standard AutoCAD RTPAN command, which enables you to interactively Pan the drawing by picking a point and then dragging it to the desired location. After panning the drawing, you are immediately returned to the centerline routing session where you left it. F
@?9>D

Accesses the AutoCAD VPOINT command, which enables you to interactively select the viewpoint of the model. 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.

Reference Manual

5-9

@ 3

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 specified fields of the Router dialog.

Compute the value using the keys provided (mouse or keyboard input accepted), then press a button in the Pass To area of the calculator to paste the value in the register into the desired field. F
95G

@D9?>C

E

>9DC

Select from the view options to input values in different formats. The System selection uses the units currently defined for the drawing. If one of the other options is selected (i.e., Architectural) you can specify the units in a different format. When the value from the register is passed to the Route dialog, the result will be automatically converted to system units. 5
H9D

Closes the Router dialog and discontinues centerline routing. 3

EBB5>D

<5F1D9?>

Displays the current system elevation (the elevation of the last point defined on the centerline) for informational purposes. 9
>6?

?45

Indicates whether Info Mode is ON or OFF. To change the Info Mode setting, you must exit the routing session and re-start it. When the Info Mode dialog appears, make the appropriate selection.

5-10

AutoPLANT PIPING

@ 3

9@9>7

??<C

5>E

5>D5B<9>5

?ED5BC

5>E

9>6?=?45491<?7
When you place a centerline in PIPING, the dialog shown below displays. This dialog enables you to specify whether or not you want to associate intelligence (Spec, Size, Line Number, and Insulation Thickness) to the line.

If you enable the Info Mode On option and press OK, the Component Preferences dialog displays as shown below.

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. These values will be extracted from the centerline and applied to any components placed on it.

Reference Manual

5-11

@ 3

9@9>7

??<C

5>E

5>D5B<9>5

?ED5BC

5>E

6B?=@?<I<9>5
The From Polyline command enables you to convert an existing AutoCAD polyline into an intelligent centerline on which components can be placed. AutoCADs PLINE command may be used to route a centerline, then the From Polyline command may be executed on the polyline to convert it to an intelligent PIPING centerline. This command does not actually convert the existing polyline, but only creates a new AutoPLANT intelligent centerline on top of the existing polyline. If you want the existing polyline deleted after the new intelligent centerline is created you can set the CL_DEL_PLINE_FLAG AutoPLANT system variable prior to executing this command. The variable is initially set to zero (0), which will not erase the existing polyline. If you want the polyline erased after the conversion, type the following at the AutoCAD command prompt:
DWBSLSLQJV\VWHPBVHWYDULDEOHFOBGHOBSOLQHBIODJ

When the From Polyline command is executed, the Component Preferences dialog displays as shown below to enable 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.

5-12

AutoPLANT PIPING

@ 3

9@9>7

??<C

5>E

5>D5B<9>5

?ED5BC

5>E

6B?=69<5
The points required to define a polylines geometry can be specified in an external text file. The file can then be read to draw the line and associate intelligence with it. When the From File command is executed, the Select Centerline Input File dialog displays. Highlight the desired file, then press OK. The parameters will be read from the selected file to draw the centerline.

6Y\UCdbeSdebU

/,1(180%(5 3 63(& PPFV 120,1$/  ,167+,&.  376 ? ?  /,1(180%(5 3 120,1$/  63(& PPFV ,167+,&.  376 ? ? 

LINENUMBER SPEC NOMINAL INSTHICK PTS

Specifies the pipe line number Specifies the specification Specifies the nominal pipe size (decimal values only) Specifies the insulation thickness (decimal values only) Specifies the points that define the pipe route. Multiple lines with the same data could be specified by having multiple PTS variables in the same section . Each PTS definition constitutes a continuous centerline.

@B?@9@5B?ED5B
PRO-PIPE's 3D-Polyline Router function has been incorporated into PIPING. It provides several options to define a piping path with a 3D polyline. You can change elevation, move toward or away, specify polar coordinates, use previously placed components as a reference, slope down a specified angle and distance, or specify an exact XYZ offset. Components may then be placed on the line using the geometry of the line to determine 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^FXUUHQWHOHYDWLRQ` 3LFNVWDUWSRLQWRUSUHVV&DUULDJH5HWXUQWRFKDQJHHOHYDWLRQ

Pick the starting point or press Enter to change the system elevation. To change the elevation, press Enter then input 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 of Pipe, (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RZDUGV3RODU2IIVHW6ORSLQJ5HIHUHQFH1RGH8QGRH;LW!

The options are as follows:

Option (E)lev (A)way (T)owards Description Picks the next polyline end point straight up or straight down to the elevation value entered. Picks the next polyline end point in the negative vertical direction away from you in the current UCS view at the exact distance specified, and resets the system elevation to the elevation of the point picked. Picks the next polyline end point in the positive vertical direction towards you in the current UCS view at the exact distance that you specify and resets the system elevation to the elevation of the point picked. Reference Manual 5-13

@ 3

9@9>7

??<C

5>E

5>D5B<9>5

?ED5BC

5>E

(P)olar (O)ffset (S)loping

Prompts you to enter an angle and a distance from the current point. Allows you to specify an exact offset in the X,Y, and Z directions, or enables you to enter the desired elevation and pick the offset distance and the direction point. 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 angle specified. Prompts you to pick any object as a reference to reset the system elevation for the next prompt picked. Prompts you to pick a previously placed node marker as a reference to reset the system elevation for the next point picked. Removes the last end point picked from the polyline and continues the command from the previous point. Ends the PRO-PIPE router command.

(R)eference (N)ode (U)ndo e(X)it

45C97>5BB?ED5B
AutoPLANTs DESIGNER router has been included in PIPING to enable users familiar with this technique of routing to use the same methods to route centerlines in the new system. When the command is first executed, the prompt:
&HQWHUOLQHIURP

displays. Select the starting point in the drawing, then respond to the
%DVH(OHYDWLRQ  5HIHUHQFHSRLQW(OHYDWLRQRIFHQWHUOLQH!

by inputting a starting elevation value at the command line. To extract the elevation from the Z value of an existing point, type R and press Enter, then pick the reference point. After the starting point and the elevation have been specified, the prompt
9HUWLFDO1H[WFHQWHUOLQHSRLQW!RUUHWXUQZKHQGRQH

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
5HIHUHQFHSRLQW(OHYDWLRQRIFHQWHUOLQH!

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, input an elevation value. To exit the line routing command, press Enter or the right mouse button at the
9HUWLFDO1H[WFHQWHUOLQHSRLQW!RUUHWXUQZKHQGRQH

prompt.

5-14

AutoPLANT PIPING

@ 3

9@9>7

??<C

5>E

5>D5B<9>5

?ED5BC

5>E

6B?=@?9>DC
The From Points centerline router presents a command line interface for routing a points. After the command is executed, the prompt
(QWHUVWDUWLQJHOHYDWLRQ!

displays. Input the starting elevation. Next, the following prompt is presented:
3LFNVWDUWLQJSRLQW

Specify the starting point of the centerline. You can now begin routing the line. In addition to standard AutoCAD controls, the From Points command provides the following options, which are available at the command line at all times during the routing session. A description of each of these options is provided below.

2QS[
Removes the previously defined point, and enables you to continue routing.

B5TbQg
Performs a regeneration of the current view without leaving the routing session.

BUV
The Ref command enables you to select a reference point that already exists in the model, then specify a distance from that point. A line from the new point is then drawn back to the centerlines previous point. (use the REdraw afterwards to remove the reference line). Refer to the Figure below

Reference Manual

5-15

@ 3

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 a known distance away from the previous elbow. You also want the two elbows placed on the same plane so they can be supported at the same elevation. Select the Reference command, then select the intersection point of the elbow to use as reference. Next, specify a distance away from that point. The centerline continues to the newly defined point. You can then continue routing. The result is shown in red ink.

1Rc
If one of the direction vectors is chosen (North, South, East, West, Up, Down), you can then input an absolute coordinate where the next point will be placed.

>_bdX
Select this option to place the next point North of the previous point. You are then prompted to input a distance or an absolute coordinate.

C_edX
Select this option to place the next point South of the previous point. You are then prompted to input a distance or an absolute coordinate.

GUcd
Select this option to place the next point West of the previous point. You are then prompted to input a distance or an absolute coordinate.

5Qcd
Indicates that the next point should be East of the current point. You are then prompted to input a distance or an absolute coordinate.

E`
Indicates that the next point should be above (+Z direction) the current point. You are then prompted to input a distance or an absolute coordinate.

4_g^
Indicates that the next point should be below (-Z direction) the current point. You are then prompted to input a distance or an absolute coordinate.

@YS[>Uhd@_Y^d
Pick (graphically select) the next point on the centerline.

5-16

AutoPLANT PIPING

@ 3

9@9>7

??<C

5>E

5>D5B<9>5

?ED5BC

5>E

35>D5B<9>5B?ED5B8?GD?D?@93C
This are provides a set of procedures that explain how to perform many common centerline router tasks.

B_edUQ3U^dUb\Y^UVb_]4YQ\_W
Centerline routing from a dialog allows access to a variety of routing tools to define the centerline of a piping path.

> D B
?

?ED51

5>D5B<9>5

C9>71

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, skip to Step 4. The Component Preferences dialog displays. You can select the Specification, Nominal Size, Line Number, and Insulation Thickness values from this dialog, and then assign these attributes to the line itself. Components placed on this line will use these component preferences when placing the components. The prompt
Exit/<Options>/Start Point:

$

displays. Select the starting point for the centerline, or press Enter to open the Routing dialog. If you select an existing component, the elevation will automatically be set based on the elevation of the existing components centerline (use AutoCAD OSNAP commands to ensure you have selected it properly). 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 the Distance/Angle area of the dialog. Afterwards, press OK to route that point. The dialog closes and the polyline is routed to the new point. To re-open the dialog, press Enter then route additional point(s). You may also route points using the standard (AutoCAD) line routing techniques. From the command prompt, type E and press Enter to exit the polyline command.

&

B_edUQ3U^dUb\Y^U6b_]@_Y^dc
Centerline routing from points displays a number of routing options to define a centerline of a piping path.

> D B
?

?ED51

5>D5B<9>52I

569>9>7

?9>DC

! "

Select Piping Tools/Centerline Routers/From Points

The Component Preferences dialog displays. You can select the Specification, Nominal Size, Line Number, and Insulation Thickness values from this dialog, and then assign these attributes to the line itself. Components placed on this line will use these component preferences when placing the components. The prompt
Set elevation/ <Pick starting point or component>

#

Input a starting elevation, then press Enter (selecting the endpoint of an existing components centerline will NOT reset the system elevation using this command; if you need to set the elevation based on an existing 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
Reference Manual 5-17

@ 3

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.

B_edUQ3U^dUb\Y^U6b_]@_\i\Y^U
Centerline routing from a polyline enables the user to draw a polyline using standard AutoCAD PLINE commands, then to define the line as a smart polyline on which components can be placed. The current settings in the Drawing Preferences dialog are applied to the line.

> D B
?

?ED51

5>D5B<9>52I

5<53D9>71>

H9CD9>7

?<I<9>5

! " #

Draw a polyline using the AutoCAD PLINE command. The line should accurately describe the piping path, 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.

B_edUQ3U^dUb\Y^U4UcYW^UbB_edUb
The AutoPLANT DESIGNER router, has been included in PIPING for AutoPLANT users familiar with that centerline routing function. The functionality is the same.

> D B
?

?ED51

5>D5B<9>5

C9>7D85

45C97>5BB

?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 additional options.

5-18

AutoPLANT PIPING

@ 3

9@9>7

??<C

5>E

5>D5B<9>5

?ED5BC

5>E

B_edUQ3U^dUb\Y^U@b_@Y`UB_edUb
The PRO-PIPE polyline router has been included in PIPING for PRO-SERIES users familiar with that centerline 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.

> D B
?

?ED51

5>D5B<9>5

C9>7D85

@B?@9@5B

?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 existing component, the system elevation will be reset to that value automatically. To manually input the elevation, 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 the command 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.

B_edUQ3U^dUb\Y^U6b_]6Y\U
Centerlines can also be routed automatically based on values read from an external file. The file contains the descriptions of the coordinate locations and other factors such as layer, line number, and size variables.

> D B
?

?ED51

5>D5B<9>56B?=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 the file.

#

5TYd3U^dUb\Y^U@bUVUbU^SUc
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 you to select an existing centerline and modify the settings defined when it was placed.

> D 5 3
? 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.

Reference Manual

5-19

%
B5@B5C5>D1D9?>C

@ B

9@9>7

??<C

5>E

5@B5C5>D1D9?>C

The Piping Tools/Representations command displays the following dialog, which enables you to generate various representations of your PIPING components.

Enable the desired Drawing Mode radio button, and then its associated Representation radio button that you want to work with. The following describes the Drawing Mode/Representation optoins now available in terms of the selection made in the Drawing Mode and Representation areas of the dialog (e.g., 3D-Double Line will 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 drawing of 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 space using AutoCAD entities. In general, only Pipe Components, Bends and Returns, and Branching 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 the vertical 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 Line representations of components using AutoCAD entities. The following operations may then be executed for the selected Drawing Mode/Representation:

?@5B1D9?>2EDD?>C
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 the selected representation for the component if one does not already exist. Hides existing representations of the selected Drawing Mode/Representation. Re-displays the selected Drawing Mode/Representation that has already been generated (but are currently turned OFF, or which have been hidden due to the generation of other representations). Deletes (removes) existing representations from the model for the currently selected Drawing Mode/Representation. Before deleting these representations, ensure that at least a single line or 2D rep exists for the selected components.

OFF Redraw Delete

After selecting the desired operation, the Drawing Selection Options dialog displays to enable you to define the selection set of components that will be included in the representation. If you generate or redraw 3D
5-20 AutoPLANT PIPING

9@9>7

??<C

5>E

5@B5C5>D1D9?>C

representations, any active representation is automatically turned OFF. Note that polyline visibility is controlled by the current 3D Display Mode setting.

1ED?3145>D9D95C
The AutoCAD Entities area of the dialog provides three options, which enable you to generate the denoted AutoCAD entity representation of your PIPING components. Each of these options is described below.

139C
The ACIS button creates an AutoCAD 3D ACIS representation of the current view of the selected component graphics on the current layer. The 3D representation is not associated with the existing component graphic in any manner. It is created from standard ACIS 3D entities. These entities can be treated as any standard ACIS entity. Before you generate a 3D representation, you should use the AutoCAD LAYER command to set the layer on which the representation will be generated.

"TFYUg
The 2d View button creates a 2D representation of the current view of the selected component graphics on the current layer. The 2D representation is not associated with the existing component graphic in any manner. It is 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 use the AutoCAD LAYER command to set the layer on which the representation will be generated.

=UcX
The Mesh button creates an AutoCAD 3D representation of the current view of the selected component graphics on the current layer. The 3D representation is not associated with the existing component graphic in any manner. It is created from standard AutoCAD 3D entities. These entities can be treated as any standard AutoCAD entity. Before you generate a 3D representation, you should use the AutoCAD LAYER command to set the layer on which the representation will be generated.

Reference Manual

5-21

9@9>7

??<C

5>E

#4 4


9C@<1I

?45C

#449C@<1I=?45C
The Piping Tools/3D Display Modes menu provides options that enable you to toggle the display of PIPING components. 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 3D representations from single line graphics.

G9B56B1=5

35>D5B<9>5

5-22

AutoPLANT PIPING

9@9>7

??<C

= =

5>E

#4 4


9C@<1I

?45C

G9B56B1=5G35>D5B<9>5

Note the difference between this mode and standard Wireframe. A close examination of the elbow shows a natural centerline that follows the curve of the elbow. This is to be distinguished from the smart polyline that describes the piping path. If the component is drawn without the polyline, you can still distinguish the natural centerline with the Wireframe w/Centerline option.

=5C8

Displays 3D components as a 3D wireframe mesh. The AutoCAD SURFTAB1 and SURFTAB2 environment variables that define the mesh resolution may be defined in the Surface Resolution in the Drawing Preferences 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 Surface Resolution is set to 16 and a number of components are drawn, then when the Mesh Display Mode is selected, the components mesh representation will reflect the Surface Resolution setting when it was placed.

Reference Manual

5-23

9@9>7

??<C

5>E

#4 4


9C@<1I

?45C

C5DF95G@?BD4B1G=?45
The Set Viewport Draw Mode option in the Piping Tools/3D Display Modes menu enables you to set the 3D Display Mode for individual viewports. The first four commands in the 3D Display Modes menu set the active System display mode. All viewports that do not have a display mode set using the Set Viewport Draw Mode command display using the active System display mode. The command displays the following prompt:
6HOHFWGUDZPRGHIRUFXUUHQWYLHZSRUW 6\VWHP&HQWHUOLQH&HQWHU:LUHIUDPH:LUHIUDPH0HVK!

A description of each of these options is provided below.

System Centerline sets the active viewport display mode to the current System display mode setting. sets the active viewport display mode to Centerline.

Wireframe w/Centerline sets the active viewport display mode to Wireframe w/Centerline. Wireframe Mesh sets the active viewport display mode to Wireframe. sets the active viewport display mode to Mesh.

To select an option, type the capitalized letter in the option name and press Enter.

B5C5D1<<F95G@?BD4B1G=?45C
The Reset All Viewport Draw Modes option in the Piping Tools/3D Display Modes menu resets all of your individual viewport display modes to System. The System display mode is set by executing one of the first four options in the 3D Display Modes menu.

C81451<<F95G@?BDC
In the same manner as AutoCADs REGENALL command may be executed to regen all open viewports, the Shade All Viewports command in the Piping Tools/3D Display Modes menu may be executed to perform a SHADE on all viewports.

89451<<F95G@?BDC
In the same manner as AutoCADs REGENALL command may be executed to regen all open viewports, the Hide All Viewports command in the Piping Tools/3D Display Modes menu may be executed to perform a HIDE on all viewports.

3?>DB?<#449C@<1I=?45C
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.

5-24

AutoPLANT PIPING

@


9@9>7

??<C

5>E

#4 4

9C@<1I

D9<9D95C

5>E

#449C@<1IED9<9D95C=5>E
The 3D Display Utilities menu provides options that enable you to manipulate the display of 3D PIPING component graphics. A description of each of these options is provided below.

C5D?2:53DB9=C?>
The end of all components are displayed as open by default. The Set Object Rims On option in the Piping Tools/3D Display Utilities menu enables you to change the display property of these ends to appear as if they were 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 the components to execute the operation. >_dU This command will only work on components whose ends are drawn using Rebis DWBF\OLQGHU, DWBWRUXV, and DWBFRQH custom objects.

C5D?2:53DB9=C?66
The end of all components are displayed as open by default. The Set Object Rims Off option in the Piping Tools/3D Display Utilities menu enables you to change the display property of these ends to appear as if they were open, if they were previously closed using the Set Objects Rims On option. 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 opened. Simply enter the desired option number, then press Enter. You will then be prompted to select the components to execute the operation. >_dU This command will only work on components whose ends are drawn using Rebis DWBF\OLQGHU, DWBWRUXV, and DWBFRQH custom objects.

C5D35>D5B<9>53?<?B
The Set Centerline Color option in the 3D Display Utilities menu displays a color palette to enable you to select the centerline color for all components. Simply select the desired centerline color from the dialog and press OK. BYLAYER is the default centerline color setting. You will need to REGEN for the change to appear on your display.

Reference Manual

5-25

9@9>7

??<C

5>E

#4 4


9C@<1I

D9<9D95C

5>E

>_dU

Centerlines only appear when the Centerline or Wireframe w/Centerline 3D Display Mode is active.

C5D35>D5B<9>5DI@5
The Set Centerline Type option in the 3D Display Utilities menu displays a dialog to enable you to select the centerline type for all components. Simply select the desired centerline type from the dialog and press OK. BYLAYER is the default centerline type setting. You will need to REGEN for the change to appear on your display. >_dU This command only works on At_Cylinder and At_Torus entities. Centerlines only appear when the Centerline or Wireframe w/Centerline 3D Display Mode is active.

C5D35>D5B<9>5F9C929<9DI
The Set Centerline Visibility option in the 3D Display Utilities menu enables you to control the visibility of centerlines for individual components when a HIDE is performed. This setting only takes affect when the 3D Display Mode is set to Wireframe w/Centerlines. When executed, the following prompt displays:
'R\RXZDQWWRVKRZFHQWHUOLQHVGXULQJDKLGH<HV1R!

This prompt enables you to specify whether or not the centerlines for the components you will select will be shown or hidden when a HIDE is executed. Type Y or N and press Enter, then select the components to perform the operation. >_dU This command only works on At_Cylinder and At_Torus entities.

5-26

AutoPLANT PIPING

9@9>7

??<C

5>E

?>>53D9F9DI

853;5B

C5DD?BEC35>D5B<9>5DI@5
The Set Torus Centerline Type option in the 3D Display Utilities menu prompts you to select the desired mode for displaying torus centerlines for components that are drawn using the torus object. >_dU Centerlines only appear when the Centerline or Wireframe w/Centerline 3D Display Mode is active.

C5D3<9@@547B1@893CDI@5
Enables you to toggle the display of clipped cylinder (pipe) graphics to either Baseballs or Quadrant display as shown below. You may also enter SETCLIPPEDGRAPHICS at the command line to manually toggle this clipped graphics display of individual cylinders.

3?>>53D9F9DI3853;5B
The Piping Tools/Connectivity Checker menu provides options that enable you to confirm proper connectivity along piping runs. It should be noted that PIPING checks for connectivity during normal routing activities. 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 command prompts you to select a set of components on a run, then specify the starting component. The command then highlights each component in the run individually, progressing down the line until an improper connection is detected. The command then exits to allow you to correct the problem at that location. The third command allows you to resume a connectivity check on a group of components that may have been previously suspended.

3853;5B
The Checker command enables you to check a selected group of components for proper connectivity. When the command is executed, the Drawing Selection Options dialog displays to enable you to define the selection set of components that you want to test (e.g., you may only want to check consistency for a specific line number). Once the component selection set has been defined, the first disconnect (if one is found) and the Connectivity Check dialog display as shown below.

Reference Manual

5-27

@ 3

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 displayed disconnect. 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 the disconnect. 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 more detailed explanation of the disconnect.

A description of the options in this dialog is provided below:

First, Prev, Next, and Last Press these buttons to scroll through the disconnects. Information about the disconnect at the selected port is displayed in the bottom pane of the dialog, while the display zooms into that area of the drawing for closer examination. Zoom In/Out Repair Press these buttons to zoom into or away from from the currently displayed disconnect. Press this button to attempt to repair the connection between two coincident welded components. For example, if you copy a pipeline connected to one buttweld component to the end of another buttweld component, you can use this command to properly connect the second buttweld component with the copied pipeline. Flanges and other components that are not coincident cannot be connected with this function. Press this button to temporarily suspend the Checker command. This process can be continued at any time using the Resume Checker command. Displays the Brief version of this dialog as shown previously.

Suspend Brief

When finished viewing connection information, press the Done button to close the dialog.

5-28

AutoPLANT PIPING

9@9>7

??<C

5>E

?>>53D9F9DI

853;5B

3853;BE>
The Check Run command prompts you to select a set of components in a run, then to designate a starting component. Each component connection is then checked. The component is highlighted and you are prompted 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.

B5CE=53853;5B
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 shown when the Checker command was suspended.

3?>>53D9F9DI8?GD?D?@93C
The following procedures explain how to perform common connectivity tasks.

3XUS[CU\USdUT3_]`_^U^dcV_b3_^^USdYfYdi

> D 3
?

853;

5<53D54

?=@?>5>DC6?B

?>>53D9F9DI

! " #

From PIPING select Piping Tools/Connectivity Checker/Checker Tools/Connectivity Checker/Checker .

, or from ISOMETRICS select ISO

The Drawing Selection dialog appears. Choose All to select all of the components in the drawing, or choose 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 AutoCADs WINDOW and CROSSING qualifiers. When selecting objects, be sure to include fasteners, welds, and other 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 the bottom 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.

3XUS[5^dYbUBe^

> D 3
?

853;1>

>D9B5

B 3
E> C

?>>53D9F9DI

! " #

From PIPING select Piping Tools/Connectivity Checker/Check Run Tools/Connectivity Checker/Check Run .

, or from ISOMETRICS select ISO

The Drawing Selection dialog is displayed. Choose All to select all of the components in the drawing, or choose 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
Reference Manual 5-29

@ 4

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.

BUce]U3XUS[Ub

> D B
?

5CE=5D85

853;5B

?==1>4

! " #

From PIPING select Piping Tools/Connectivity Checker/Resume Checker select ISO Tools/Connectivity Checker/Resume Checker . Select Piping Tools/Connectivity Checker/Resume Checker.

, or from ISOMETRICS

The Connectivity Check dialog displays beginning with the disconnect that was shown when the Checker command was suspended. If a previous execution of the Checker command was not executed, the Checker command will be executed by this option. Continue viewing disconnects in turn, making any necessary repairs, then press Done to close the dialog.

$

49=5>C9?>>?45C
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 place dimensions while in Paper Space. This is not required unless the component that you want to dimension from does not have already have a node at the desired location.
Insert Show Hide Edit Clear Reinserts dimension nodes for all selected components. Turn on dimension nodes for selected components. Turn off dimension nodes for selected components. Edit (add/delete) dimension nodes for selected components. Deletes "added" dimension nodes for selected components.

5-30

AutoPLANT PIPING

9@9>7

??<C

5>E

?9>

?=@?>5>DC

:?9>3?=@?>5>DC
The Join Components command is provided to enable you to properly connect two coincident components together. For example, if you copy a pipeline connected to one buttweld component to the end of another buttweld component, you can use this command to properly connect the second buttweld component with the copied 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 the first component and every port on the second component. If multiple join types are found, a dialog similar to the 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 following message:
Components joined together successfully.

to indicate that the join has been made successfully. If no joint is completed, then a dialog similar to the following will display, which describes the attempts made and the problem with each attempt. The same functions that are called to validate and create joints during component insertion in fitting-to-fitting mode are called for each attempted connection, and therefore the same connection rules apply during the join command as during component insertion.

>_dU

The joint gap tolerance is defined by the configuration that you selected when you created the drawing. You can view/modify this setting using the AutoPLANT Configuration Editor application. This application may be launched from the AutoPLANT 3D/Customization Tools and Help group in your Windows Start menu. Open the configuration to view/modify, then select Edit/Piping Configuration Group or Edit/Iso-Auto-Iso Configuration Group. In either dialog, select the Preferences tab. The gap is assigned in the Maximum Joint Gap field.

Reference Manual

5-31

%
CD?@C97>C

@ C

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 should break 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 stop should 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 to ISOMETRICS on-line Help for more information.

@<135CD?@C97>C6?B9C? > D
! "
?@<1351

D?@

97>9>1

@9@9>7

=?45<

Select Piping Tools/Stop Signs The prompt

Select the component:

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 the reference point represents the location where the stop sign should be placed, press Enter; otherwise, type T or use the Toggle button on the Responses toolbar until the reference point appears at the desired location. Press Enter after the desired port is highlighted. $ The Stop sign in placed at the selected port.

5-32

AutoPLANT PIPING

381@D5B

41D121C5D??<C=5>E

&

This chapter covers the Database Tools menu, which provides a number of options to view/manipulate information in the external drawing database.

OVERVIEW EDIT COMPONENT UPDATE COMPONENT CLEAN DATABASE VIEW DATABASE DATABASE INFORMATION UPDATE FROM SPEC DATABASE - HOW TO TOPICS DRAWING DATABASE CUSTOMIZATION

6-2 6-2 6-5 6-6 6-8 6-8 6-9 6-11 6-13

&
?F5BF95G

4 ?

1D121C5

??<C

5>E

F5BF95G

The Database Tools menu provides a number of options to view/manipulate information in the external drawing database. These commands may also be executed via the Database Toolbar toolbar. This toolbar is available as a flyout toolbar from the main Piping Functions toolbar, or may be displayed separately by selecting Toolbars/Function Toolbars/Database Tools.

549D3?=@?>5>D
The PIPING and ISOMETRICS applications use a common set of dialogs to view/modify component external drawing database records with the Edit Component command. When the command is executed, the prompt
Select the component:

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, and Valves. These dialog instances are defined in the individual component scripts in the NETWORK_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 be modified is presented in white editable text boxes. Simply move the cursor into the desired text box and modify the information as desired. Changes made in this dialog will update the respective field information in the components drawing database record. A description of the fields in this dialog are provided below:
6-2 AutoPLANT PIPING

1D121C5

??<C

5>E

5 3
49D

?=@?>5>D

Component Type

The general Component Type (i.e., PIP, 90L, TEE, etc.), which was read from the GTYPE field in the specification database table when the component was placed. This value is stored in the GTYPE in the drawing databases PIPING table.

Component Sub Type The Component Sub-Type (i.e., LR, STR), which was read from STYPE field in the specification database table when the component was placed. This value is stored in the STYPE field in the drawing databases PIPING table. Specification Spec Table The Specification from which the component was drawn. This value is stored in the SPEC table in the drawing databases PIPING table. The Specification Table in the specification that contains the database record that was used to draw the component. This value is stored in the components XDATA in the drawing. The component Line Number, which was read from the Drawing Preferences dialog when the component was placed. This value is stored in the components LINENUMBER field in the drawing databases PIPING table. Displays the user-defined Tag associated with the component. You may define the tag value by entering a value in the space provided. This value will be stored in the TAGNUMBER field in the drawing databases PIPING table. Enable this check box to label the component as Existing. Components marked in this manner may be excluded from a generated Bill of Materials, and are used to distinguish between components that already exist in the field and those being added to the design. If this check box is enabled, the value 1 will be written in the EXISTING field in the components drawing database record. If you are modifying existing designs and wish to designate a large group of components as Existing, add the field Existing to the list of fields to be updated using the Setup/Component Update Preferences command. The nominal Main Size of the component, which was read from the MAIN_SIZE field in the specification database table when the component was placed. This value is stored in the components MAIN_SIZE field in the drawing databases PIPING table. Displays a graphical representation of the component and illustrates where its ports are located. The Short Description of the component, which was read from the SHORT_DESC field in the specification database table when the component was placed. This value is stored in the components SHORT_DESC field in the drawing databases PIPING table. The Specification Tag of the component, which was read from the TAG field in the specification database table when the component was placed. This value is stored in the components TAG field in the drawing databases PIPING table. The Piece Mark of the component, which was read from the PIECE_MARK field in the specification database table when the component was placed. This value is stored in the components PIECE_MARK field in the drawing databases PIPING table. 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 when the component was placed. This value is stored in the components SORT_CODE field in the drawing databases PIPING table. The full Long Description of the component, which was read from the LONG_DESCR field in the specification database table when the component was placed. This value is stored in the components LONG_DESCR field in the drawing databases PIPING table. The specification containing the insulation description; the insulation spec can be specified by editing the component with the Update Component command. The Insulation Thickness which was read from the Drawing Preferences dialog when the component was placed. This value is stored in the components INSTHICK field in the drawing databases PIPING table.

Line Number

Tag

Existing component

Main Size

Component Tile Window Short Description

Spec Tag

Piece Mark

Sort Code

Description

Insulation Spec Insulation Thick

Reference Manual

6-3

&

1D121C5

??<C

5>E

5 3
49D

?=@?>5>D

Rating/Schedule

The Rating/Schedule of the component, which was read from the RATING and SCHEDULE fields in the specification database table when the component was placed. These value are stored in the components RATING and SCHEDULE fields in the drawing databases PIPING table.

Field Fit Excess (Pipe The Field Fit Excess field accepts any value, including negative parameters. components ONLY) Shop/Field Indicates whether the component is a Shop or Field component. The AutoPLANT Report Generator provides the BOMCADSFCutLengths report to enable you to generate a BOM on the drawing that separates components into Shop or Field groups. If the field is enabled (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 table when the component was placed. This value is stored in the components SHOP_FLD field in the drawing databases PIPING table.

Press Next Page to display the second page of the dialog. The second page contains component position and port information. It also provides a complete list of all of the components drawing database record field values. The second dialog instance is common to all components and is defined in the NETWORK_ROOT\MODULES\BASE\COMMON\COMPUTIL.EBS file.

549D3?=@?>5>D@175"
The second page of the Edit Component option contains two windows of information. The top window displays positional and vector information related to the component ports and the direction factors specified during placement. This information is especially useful to users creating custom draw routines to verify how the port information on a component is being assigned.

The second window contains a complete listing of the database fields associated with that component in the drawing database record. Scroll through the listing to find a particular value. You can click on a field in the bottom pane of the dialog to edit its value. If a field that you select is READ-ONLY, a message dialog will display indicating that this field cannot be edited.

6-4

AutoPLANT PIPING

1D121C5

??<C

5>E

@41D5

?=@?>5>D

E@41D53?=@?>5>D
The Database Tools/Update Component option is provided in PIPING and ISOMETRICS to enable you to change component drawing database field values in the current drawing and/or attached xreferenced drawings. For example, a design change may require you to change the Line Number of a select group of components from L100 to L200. This command may be used to select the components to modify, then update the Line Number value in the drawing database. When the Database Tools/Update Component command is executed, the Drawing Selection Options dialog displays to enable you to define the selection set of components. After the selection set has been defined, the Update Component Data Fields dialog displays as shown below. Select each database field and enter its new value in the Edit Field and then press OK to perform the update.

>_dU

Only drawing database fields that have been previously assigned in the Component Update Preferences dialog can be modified. Modify the list of fields using the Setup/Component Update Preferences option. D 2 E
? 5 @41D54

<

9CD?6

95<4C

Lists the fields in the current external drawing databases PIPING table that may be updated. This list is populated with the field names assigned using the Setup/Component Update Preferences command. Select a field name in this list to display to the associated values in the Field Values portion of the dialog. 6
95<4

1<E5C

Lists all the unique field values for the selected group of components. Select a field to edit its value. 5
49D

95<4

When you select a field, its current value displays in this text box. Define a new value by overwriting the existing value. Press OK to apply the changes, or select another field from the list to edit its value.

Reference Manual

6-5

&
3<51>41D121C5

4 3

1D121C5

??<C

5>E

<51>

1D121C5

A record is written to the external drawing database each time a component is placed. If you delete these components later in the drawing process, the records still exist in the database until they are permanently deleted using this command. The Clean Database function reconciles the components in the model with the records in the external drawing database. It removes records from the database that do not have matches in the drawing. When you execute the command, the following dialog displays to enable you to specify the clean parameters that 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 the current drawing. Any database record that exists without a corresponding graphic component is removed. Clean Fasteners Enable this check box to remove both the CAD and external database entries for those fasteners that are no longer joining two components together. For example if a weld is connecting a pipe and an elbow and the elbow is removed, the weld is left, unless also manually removed. This operation will clean up such fasteners. On rare occasions a graphic component is created without a corresponding database record. This implies there is no intelligence for this component. Enable this check box to move those graphical components that exist without an associated database record to the piping_orphan layer. This enables you to "quietly" clean the database, current cleaning statistics are still reported to the command line but the total information dialog will not be reported if this option is left unchecked. This enables an operator to request the clean operation and allow the entire process to be executed without interaction.

Clean Graphics Data

Display Status Dialogs

A problem may result when more than one user is connected to the database, the Clean command will not allow the cleanup of any tables that are not being used. These are typically temporary tables that are used during a session named AT_XXXX. However, if you crash out or the system goes down, the connection you have cannot clean up automatically, therefore, the system believes a user is still logged on. If you are certain that you are the only one that has a connection to the database, execute the Database Tools/Database Information command to clear up lost connections. On the Database Information dialog and press the Clear Connections button (this will be active if more than one connection exists).
Database
6-6 AutoPLANT PIPING

1D121C5

??<C

5>E

<51>

1D121C5

This will warn of the potential dangers of doing this, if you press OK the number of connections 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 table of the first, which resulted in lost data. >_dU The Bill of Materials and Generate Report functions automatically clean the drawing database upon execution.

Clean Database command will clean: 1. 2. 3. Database entries that have no graphics equivalent. Database fasteners that have no graphics equivalent. 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 component is erased. Cleaning the database will have the effect of reducing the size of the database and making the database consistent with the graphics data. This operation is very efficient and will only take a few seconds to complete, depending on the size of the database. The second option is much more expensive to use, but will clean out any unwanted fasteners from the drawing 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 than the first. If this option reports that components exist in the drawing but do not exist in the database, then they are moved to the "PIPING_ORPHANS" layer so that a user can determine which components have no associated database entries. If any components are moved to this layer, this problem could be the result of a more 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 if the 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 are components that only have the hidden intelligent piping block (named AT_MASTER_PIPING) left for this component 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 known to be created when operations are not fully executed or the user decides to Escape from a command while only mid way through its execution. The existence of these lonely masters in the drawing has the singular impact of consuming unnecessary space. Finally, when a drawing is opened a temporary copy of the external database is made using a temporary filename 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. If there is only a single connection to this database and the user has the "Clean Graphics Data" option set for a drawing that contains no "Lonely Masters" or graphic components that do not have a database entry, obsolete temporary 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.

Reference Manual

6-7

&
F95G41D121C5

4 F

1D121C5

??<C

5>E

95G

1D121C5

The View Database command enables you to view current drawing component records in its external drawing databases PIPING table. When the command is first executed, the Drawing Selection Options dialog displays to enable you to filter the selection set of component records that will display. After creating your selection 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 To button. 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 external drawing database in a dialog in the exact same manner as if you had selected the Database Tools/Edit Component, then selected the component.

41D121C59>6?B=1D9?>
The Database Information option displays the dialog shown below, which provides a brief view of the current drawing database status. This dialog notes the number of component records currently saved in each of the external database tables, as well as the actual number of components in the drawing. For example, if you have saved the drawing, then drawn additional components, this will reflect a difference in these two values. For the Database Information option to function, you must have the Piping system loaded.

6-8

AutoPLANT PIPING

1D121C5

??<C

5>E

@41D56B?=

@53

3<51B3?>>53D9?>C
The Clear Connections button is provided to free latent database connections. The external database must know how many users are attached to it to remain in sync, especially when a clean is performed. If a user opens a drawing to modify it and another opens the drawing simply to view it, then you don not want the second 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 connections currently associated with the database. This is fine, except for the instance where the application abnormally terminates. In this instance, the lock, or connection, is never removed. The Clear Connections button may be pressed to manually remove, or clean up, these latent locks on the external database.

F95GDB1>C13D9?>C
The View Transactions button displays the dialog shown below, which denotes the transactions currently stored in the database. The Purge button on this dialog will delete all transactions currently recorded. This does not delete any component records, but simply deletes all of the transaction records themselves. It enables you to track all transactions recorded from the last time a purge was executed.

E@41D56B?=C@53
The Database Tools/Update from Spec command is provided to synchronize component data in the drawing database with component information that was modified in your specifications. This command overwrites the existing drawing database information for the selection set of components with any data that was modified in the spec. >_dU Warning: If you have manually edited component information in the drawing database using the Database Tools/Edit Component command or by some other method, then this data will also be overwritten if it is defined in the specification.

When the command is executed, the standard selection dialog displays to enable you to define the selection set of components to be updated. Note that drawings other than the current drawing can be selected for update. In this instance, you cannot undo the change. If the current drawing is selected, you can always quit without 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 to update the data from the spec.

Reference Manual

6-9

&

4 E

1D121C5

??<C

5>E

@41D56B?=

@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. Each components data is read in the usual way and stored in the components data structure, the equivalent spec record 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 is executed for a component the method can read any of the current spec data from the scriptbuffer functions and overwrite the current component data using the external database function at_DbExt_put, hence updating the component. >_dU As noted in this dialog, only descriptive information will be modified. Changes will not modify the graphic representation of components.

To add to the list of methods available, you can manually edit your copy of the file MODULES\BASE\COMMON\SPECUPD.EBS. To add a new method you will first need to change the dialog selection method, this is the dialog that the user selects which method to update from the available list. This dialog can be found in ..\MODULES\BASE\DIALOGS\SELSPCUP.EBS. From this dialog the user should add a 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.

6-10

AutoPLANT PIPING

1D121C5

??<C

5>E

1D121C5 

8

?G ? ?@93C

D D

41D121C58?GD?D?@93C
This area contains that explain how to use the options in the Database Tools menu.

549D3?=@?>5>D9>6?B=1D9?>
After a component is placed in a model, many of its attributes can be modified directly by editing the external drawing database record associated with the component. As a general rule, dimensional and position data may not be modified.

> D 5 3
? 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 this dialog contains the most common component drawing database record information. Most of the information is provided for information purposes only. The field data that may be modified is presented in white editable text boxes. Simply move the cursor into the desired text box and modify the information as desired. Changes made in this dialog will update the respective field information in the components drawing database record. Press Next Page to display the second page of the dialog. The second page contains component position and port information. It also provides a complete list of all of the components drawing database record field values. Press OK to close the dialog.

#

$

E@41D53?=@?>5>D9>6?B=1D9?>
The Database Tools/Update Component command may be used to globally update the value of specific external drawing database fields for a selection set of components in the current or from multiple drawings.

> D
! " # $ %

?E@41D53?=@?>5>D9>6?B=1D9?>

Select Database Tools/Update Component

The Drawing Selection Options dialog displays. Select the components to update using the tools available 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 Edit Field 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. >_dU You can customize the list of fields that appear in the Update Component Data Fields dialog using the Setup/Component Update Preferences command.

Reference Manual

6-11

&

4 4

1D121C5

??<C

5>E

1D121C5 

8

?G ? ?@93C

D D

3<51>D854B1G9>741D121C5D?B5=?F59>F1<94<9>;C
The Database Tools/Clean Database command reconciles the external drawing database by removing records from the drawing database for which a component graphic no longer exists (i.e., the component has been deleted).

> D 3
?

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

F95GD854B1G9>741D121C5
The Database Tools/View Database command enables you to view all of the component records in the external drawing databases PIPING table while running an AutoPLANT application.

> D F
?

95GD85

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. >_dU You should execute Database Tools/Clean Database prior to performing this function if you have deleted components from the drawing. These component records will not be removed from the external drawing database and will appear in the View Database listing until the database has been cleaned.

6-12

AutoPLANT PIPING

4 4
B1G9>7

1D121C5

??<C

5>E

1D121C5

ECD?=9J1D9?>

4B1G9>741D121C53ECD?=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 are defined 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 you may elect to configure the system for other database formats, they have not been tested and are not supported at this time.

4B1G9>741D121C56?B=1D
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 at the start of a project and used throughout. Models that contain components from both the EQUIPMENT and PIPING applications share a common external drawing database, while drawings created with ISOMETRICS will have their own external drawing database. The drawing database configuration is defined in the >3/$17@ group in the file DBCONFIG.INI as shown below. This file is located in your NETWORK_ROOT\DATABASE sub-directory.
>3ODQW@ 'HVFULSWLRQ $OO3ODQWGDWDEDVHV '$7$B6285&( 06$FFHVVIRU$XWR3/$17 '$7$B7<3( '%4 &RQWURO'E 06$&&(660'% 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 is installed, 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/edit these data sources by launching the 32-bit ODBC Administrator from the AutoPLANT/Odbc group in your Windows Start menu, then clicking on the System DSN tab. DATA_TYPE ControlDb The ODBC data type for the data source being defined. This keyword assigns the template database used for the MS Access database format. ODBC has no way of creating an Access database, therefore, the template is copied to create the MS Access drawing database. This also controls which version of the Access driver used. If the Access database was built with version 8.0 of Access, 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 other name (e.g. Rebis\Database\MSACCESS.80) and rename the template database Rebis\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 to NO then transactions will not be logged. If set to YES (default) they will be logged.

Reference Manual

6-13

&

4 4

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 is saved. 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 backup tables 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 is compressed to save space and to keep the database a manageable size. To improve the performance and reliability of the database the method of compression has changed. On previous releases the database was always directly compressed into the same file. The database is now compressed into a local file under the directory %local_root%\databasebackup. Once compressed this backup is then copied to the original source of the 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 with extension .MDB). You can modify this extension in DBCONFIG.INI to change of the extension of this temporary database to some other (e.g., .XXX) by setting the &RPSDFW([Wkey. ;CompactExt = MDX Note that this is commented out in the production version as the default is .MDX internally. To change the extension 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 compression should this value be set, even if it is set to .MDX. Therefore, making this setting will have the added effect of retaining 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 be created for each drawing. If a dBASE database is configured, a separate file will be created for each of the drawing database tables, with a unique extension as configured in DBCONFIG.INI.

4B1G9>741D121C5D12<5C
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 as illustrated below.
7DEOHB1DPHV 3LSLQJ(TXLS1R]]OH&RQWURO7UDQVDFW3RUW-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 corresponding INI 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'DWDGEI6\VWHP 3LSLQJ 3LSLQJ'DWDGE$SSOLFDWLRQ3LSLQJB%DFNXS (TXLS (TXLSPHQW'DWDGE$SSOLFDWLRQ(TXLSB%DFNXS 1R]]OH 1R]]OH'DWDGE$SSOLFDWLRQ1R]]OHB%DFNXS 7UDQVDFW 7UDQVDFWLRQ'DWDGE6\VWHP 3RUW 3RUW'DWDGE6\VWHP -RLQW -RLQW,QIRUPDWLRQGE6\VWHP )DVWHQHU )DVWHQHU'DWDGE6\VWHP &$'/LQN &$'GUDZLQJ/LQNVGE6\VWHP &113RUW &RQQHFWLYLW\3RUW'DWDGE6\VWHP &11-RLQW &RQQHFWLYLW\-RLQW,QIRUPDWLRQGED6\VWHP &11)DVW &RQQHFWLYLW\)DVWHQHU'DWDGEE6\VWHP &QQ$WFK $WWDFKPHQWVGEF6\VWHP

6-14

AutoPLANT PIPING

4 4 Each table assignment is described by the following properties:

Table INI File Name
B1G9>7

1D121C5

??<C

5>E

1D121C5

ECD?=9J1D9?>

The structure, or schema, of each table is defined in an INI file in the same directory as DBCONFIG.INI. The INI file name 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). Extension Name Used for those drivers that create a file per table (xBase driver). For example, if the system is configured to create dBASE drawing databases, and you create a drawing named MYPIPE.DWG, then individual tables will be created named MYPIPE.DBF, MYPIPE.DB1, MYPIPE.DB2, MYPIPE.DB3, etc.

Mandatory Number of mandatory fields used with the table. These fields are fixed and up to three are allowed. Irrespective of how fields the user defined a table these fields will always be included. 0 - No mandatory fields included in the table 1 - Include the COMP_ID field 2 - Include COMP_ID and MODULE fields 3 - 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 because they are consisdered mandatory and should not be modified by the user. They are created automatically by the system, before the other columns are created. For example, if this value is set to 3 then the columns: COMP_ID text size 20 Module Text size 20 ClassName 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 Backup Table Name of the backup table, if any. Only available with non-file based database tables (i.e., not available for xBase databases).

8_gYdG_b[c
If the system is configured to create MS Access drawing databases, and the name of the drawing is PIPE01.DWG, then a single MS Access drawing database file named PIPE01.MDB will be created that contains the individual tables. If the system is configured to create dBASE drawing databases, then individual tables will be created named PIPE01.DBF, PIPE01.DB1, PIPE01.DB2, PIPE01.DB3, etc., which will store the 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 is first 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 start with a EQUIPMENT drawing instead of a PIPING drawing, the EQUIP, NOZZLE, and CONTROL tables are created 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, and CADLINK tables and data are created and stored in the external drawing database. The data in these tables is automatically stored in the drawings XDATA, but a mechanism is provided to enable you to also store this data 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 box in the Drawing Preferences dialog. To add the JOINT, PORT, and FASTENER tables and write their data to the drawing database enable the Save Port Data check box. The default value of these settings may be set in each of your project configurations.

Reference Manual

6-15

&

4 4

1D121C5

??<C

5>E

B1G9>7

1D121C5

ECD?=9J1D9?>

4B1G9>741D121C5D12<5C385=1C
The structure, or schema, of each table in the drawing database is configured in a separate INI file, which resides in the same directory as DBCONIFG.INI. For example, the structure of the PIPING drawing database table is defined in the file PIPING.INI, while the structure of the EQUIP drawing database table is defined in EQUIP.INI. The following table lists each of the drawing database table schema INI files and provides a description of each.
CONTROL.INI The CONTROL data table stores general drawing information in the external drawing database (e.g., drawing name, user who last modified the drawing, etc.). CONTROL.INI defines the structure, or schema, of the control information stored in the CONTROL table. The PIPING data table stores all data for components placed in a PIPING or ISOMETRICS drawing. PIPING.INI defines the structure, or schema, of the component information stored in the PIPING table. 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. The NOZZLE data table stores all data for nozzles placed using the EQUIPMENT application. NOZZLE.INI defines the structure, or schema, of the nozzle information stored in the NOZZLE table. The PORT data table stores all component port data in a model. Port data is stored in the drawing, but may also optionally be stored in the external drawing database by enabling the Save CADLinks check box in the Drawing Preferences dialog. PORT.INI defines the structure, or schema, of the link information stored in the PORT table.

PIPING.INI EQUIP.INI NOZZLE.INI PORT.INI

TRANSACT.INI The TRANSACT table contains a record of significant transactions that have taken place and can by viewed executing Database Tools/Database Information, then pressing the View Transactions button. These transactions 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 the property 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 ISOMETRICS drawing. These joints are checked whenever you attempt to connect components. Joint data is stored in the drawing, but may also optionally be stored in the external drawing database by enabling the Save Port Data check box in the Drawing Preferences dialog. JOINT.INI defines the structure, or schema, of the joint information stored in the JOINT table.

FASTENER.INI The FASTENER table stores fastener component data for fasteners placed between components in a PIPING or (optional) ISOMETRICS drawing. Fastener data is stored in the drawing, but may also optionally be stored in the external drawing database by enabling the Save Port Data check box in the Drawing Preferences dialog. FASTENER.INI defines 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., entity handle). Link data is stored in the drawing, but may also optionally be stored in the external drawing database by enabling the Save CADLinks check box in the Drawing Preferences dialog. CADLINK.INI defines the structure, or schema, 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 store drawing port, joint, fastener, and attachment data used during the operation of the program. These table names start with the CNN prefix and should not be removed from the database format configuration.

CSXU]Q4UVY^YdY_^
The >'HIDXOW'%@ group in each of the table schema INI files defines the fields that will be included in that table 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'(18 6+23B)/' 6+23B)/'18 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,=(&

6-16

AutoPLANT PIPING

4 4
%5$1B6,=( %5$1B6,=(& )$&,1*B )$&,1*B&8 6&+('8/( 6&+('8/(& 3,3(B2'B0 3,3(B2'B01 5$7,1* 5$7,1*&   
B1G9>7

1D121C5

??<C

5>E

1D121C5

ECD?=9J1D9?>

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 Width Precision Updatable The field data type (C=Character; N=Numeric). The field width. The field precision (if numeric). (Optional): Placing a U in this position indicates that the field is updateable. This setting should not be altered unless you are absolutely certain that the field is descriptive ONLY. Enabling the update of fields that contain dimensional information will have adverse affects to the model.

A separate group may be defined for each component Class in each tables INI file, which contains the table structure for that component Class. The >'()$8/7'%@ table structure will be used for all component classes whose table structure is not explicitly defined. For example, the PIPING table provides two additional schema groups: >$7B%877:(/'@, >$7B7+5($'@, and >$7B62&.(7:(/'@ for fasteners of these types.

@9@9>79C?=5DB93C3?=@?>5>D41D1
When a component is placed from PIPING or ISOMETRICS all data defined in its spec record will be written 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 the NETWORK_ROOT\MODULES\BASE\COMMON directory. PIPEDATA.EBS is a common utility method that contains functions that define additional data written to a components drawing database record. The data method and function that is executed for a specific component placement is defined by the '$7$B0(7+2' keyword in the modules METHODS.INI file. PIPEDATA.EBS is the shipping version of the softwares 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 piping components. 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 valve topworks. at_HeaderWeld_Data: Default function to write the additional external drawing database data for components that stub-in to another pipe and produce a weld (e.g., if you stub-in a weldolet then the header weld is created, which is usually different than a regular weld and therefore billed as a different item).

+ + +

If a field is added to the PIPING table, you may add this field to the Drawing Preferences dialog, then add the appropriate commands to the PIPEDATA.EBS functions to write this new field data to the drawing database when a component is placed. You could also add this field to the Edit Component dialog to enable the user to edit the field after a component has been placed with the Database Tools/Edit Database function.
Reference Manual 6-17

&

4 4

1D121C5

??<C

5>E

B1G9>7

1D121C5

ECD?=9J1D9?>

PIPINGs Drawing Preferences dialog is defined in the PREFRENC.EBS file, while ISOMETRICS is defined in the ISOPREF.EBS file. These files reside in your ..\MODULES\BASE\DIALOGS directory. In addition to these files, separate basic script dialogs are defined for each component type in component scripts in the NETWORK_ROOT\MODULES\BASE\COMMON sub-directory. These may be modified to enable the user to edit the field using the DatabaseTools/Edit Database command. The second page of this dialog is common for all components and is defined in the COMPUTIL.EBS file in the same directory.

5AE9@=5>D3?=@?>5>D41D1
When an equipment or primitive component is placed in a model, a record is written to the drawings EQUIP database table. The DWBHTS'E(TXLS function in the NETWORK_ROOT\EQUIP\METHODS\UTIL\COMPDB.EBS file defines the data written to the drawing database for equipment components (equipment number and insulation thickness). When a nozzle component is placed in a model, a record will be written to the drawings NOZZLE drawing database table. The DWBHTS'E1R]]OH function in COMPDB.EBS defines the data written to the drawing database for nozzles (projection, tag, spec, line number, iso name, size, O.D., long description, and short description, etc.). Either of these functions may be modified to include additional data in the components drawing database record. Separate forms are provided to modify the drawing database information for equipment/primitives and nozzles. The Database Tools/Edit Database function displays the appropriate dialog when executed. These forms are defined in the NETWORK_ROOT\EQUIP\METHODS\UTIL\EDITDB.EBS file and may be modified to include additional drawing database field data in the same manner as described for the PIPING/ISO component dialogs.

4B1G9>741D121C53ECD?=9J1D9?>8?GD?D?@93C
This section provides a set of procedures that explain how to perform common drawing database customization tasks.

CUddXU4bQgY^W4QdQRQcU6_b]QdQc=C1SSUcc_bT21C5
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 is configured (default), a single file that contains multiple tables will be created for each drawing. If a dBASE database is configured, a separate file will be created for each of the drawing database tables, with a unique extension as configured in DBCONFIG.INI. The drawing database format should be configured at the start of a project and used throughout. >_dU At this time, the project implementation structure does not support multiple DBCONFIG.INI files or individual table schemas within a project. Therefore, you must modify the shipping version of these files located in your NETWORK_ROOT\DATABASE directory. Please backup these files before modfiication.

6-18

AutoPLANT PIPING

4 4
B1G9>7

1D121C5

??<C

5>E

1D121C5

ECD?=9J1D9?>

> D C
?

5DD85

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.

CUddXU5hdU^cY_^cV_bT21C54bQgY^W4QdQRQcUDQR\Uc
The drawing database format may be configured as MS Access or dBASE format in DBCONFIG.INI. If a dBASE drawing database is configured in the >3/$17@ group in DBCONFIG.INI, a separate file will be created for each of the drawing database tables, with a unique extension. The procedure to define the extension for each of these tables is covered below.

> D C
?

5DD85

HD5>C9?>6?B4

21C5 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, separated by semi-colons. Directly after this keyword, the individual table definitions are defined. For example, the table 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 second parameter is the table description; the third parameter is the table extension; the fourth parameter is the required fields (which cannot be modified); the fifth parameter is the database table type (application or system); 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 these tables using the drawing name with the extensions defined in each table definition. These extensions will only be used if your external drawing database table type is xBASE. If MS Access is configured, all of these tables will be created in a single external drawing database. The extension parameter must be unique for each table and may be modified here. In this example, the PIPING table for a drawing named SAMPLE.DWG would be SAMPLE.DB1. if using an xbase type external drawing database.

1TTQDQR\Ud_dXU4bQgY^W4QdQRQcU
The drawing database is currently opened before the configuration is determined, therefore, the database is considered 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 7DEOHB1DPHV keyword 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.
Reference Manual 6-19

&

4 4

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 is opened. When the drawing is saved, this table copy is flushed to the permanent table, very much like the PIPING 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.

%

1TT=_TYVidXU4bQgY^W4QdQRQcUDQR\UCdbeSdebUVYU\Tc
The external drawing database is configured in the DBCONFIG.INI file. The structure of each table in the drawing database is defined in a separate INI file. For example, the structure of the PIPING drawing database table is defined in the file PIPING.INI, while the structure of the EQUIP table is defined in EQUIP.INI. In each tables INI file, a separate group may be defined for each component class, which defines the table structure applied to that component Class. A special Class, >'()$8/7'%@, defines the table structure for all component classes whose table structure is not defined explicitly in each of these INI files. The procedure to add an example COMMODITY field to the PIPING tables default component class is covered below.

> D 1
?

441

95<4D?D85

@9@9>74

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 the right side of the assignment is the name of the field to be mapped to component field. The second parameter defines the type of data (C=Character,N=Numeric). The third parameter defines the field width and the fourth defines its precision. The fourth optional parameter indicates whether or not the field 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 drawing databases PIPING table.

$ %

4UVY^UdXU4QdQ@edY^d_dXU4bQgY^W4QdQRQcU
The data output to a components drawing database record during placement is defined in the Basic Script file PIPEDATA.EBS. That resides in the NETWORK_ROOT\MODULES\BASE\COMMON directory. By default, all fields in the components 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 appropriate PIPEDATA.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 that you want written to the drawing database when a component is placed. The procedure to specify that the data for a new field named COMMODITY that was added to the PIPING table schema in PIPING.INI and was added to the Drawing Preferences dialog is covered below.

6-20

AutoPLANT PIPING

4 4
B1G9>7

1D121C5

??<C

5>E

1D121C5

ECD?=9J1D9?>

> D G
?

B9D5D85

95<4D?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 the Drawing 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 variable value into the components drawing database record COMMODITY field.
status = at_DbExt_put (Commodity, AT_DB_TABLE_PIPE, AT_CURRENT_DOCUMENT, compID, "COMMODITY")

$

Save PIPEDATA.EBS and exit.

1TTQ4bQgY^W4QdQRQcU6YU\Td_dXU4bQgY^W@bUVUbU^SUc4YQ\_W
PIPINGs Drawing Preferences dialog is defined in the file PREFRENC.EBS, while ISOMETRICSs Drawing Preferences dialog is defined in the file ISOPREF.EBS. Both of these files reside in the NETWORK_ROOT\MODULES\BASE\DIALOGS directory. This procedure explains the steps required to add an existing drawing database field to this dialog, then lists links to the procedures required to write the new field information to the drawing database each time a component is placed. This example explains how to add an example COMMODITY field to the dialog.

> C
! " # $ %

D5@

!*1

441

95<4D?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'LDORJ and (QG'LDORJ statements define the dialog instance. To edit the dialog, select all of the statements from %HJLQ'LDORJ to (QG'LDORJ, including those statements, 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. You may need to move the existing preferences to open an area for the new setting. Double-click on the control 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, initialize the new Text Box control by entering the following statement:
Call At_SetControl(AT_TB, AT_COMP_PREF,"Commodity","COMMODITY","Commodity")

& ' (

)

Save and exit.

Reference Manual

6-21

&

4 4

1D121C5

??<C

5>E

B1G9>7

1D121C5

ECD?=9J1D9?>

> C

D5@

"*1

44D85

95<4D?D85

@9@9>74

B1G9>7

1D121C5

12<5

The PIPING drawing database table is defined in the file PIPING.INI. The procedure to add the example COMMODITY 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 in length:
COMMODITY = COMMODITY C 10 0

#

Save PIPING.INI and exit.

D5@

> C

#*G

B9D5D85

95<4D?D85

B1G9>7

1D121C5

The function that writes the drawing database record for a component is defined in the PIPEDATA.EBS method. 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 all components, except for fasteners and supports. The first step is to declare the String variable that will store the value of the Commodity field that you will get from the Drawing Preferences dialog. Add the following 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 this function to get the value of the Commodity field from the Drawing Preferences settings and store it in the commodity variable that you declared above. It must be placed after this statement because the function required the components 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 the COMMODITY 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@

> C

$*9

>9D91<9J5D85

5DD9>79>D85

?>697EB1D9?>

The final required step is to initialize the Commodity setting in each of the configurations that you will be using. This can be accomplished using the AutoPLANT Configuration Editor. ! The >6\VWHP&RPS3UHI@ group in CONFIG.INI initializes and sets the defaults for component preferences defined in the Drawing Preferences dialog. In this example, you will manually add the Commodity default to this group for the Imperial configuration. You can repeat this process for any other configurations 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 to initialize 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 the Commodity field, then press OK. Draw a component. Select Database Tools/Edit Component, then select

6-22

AutoPLANT PIPING

4 4
B1G9>7

1D121C5

??<C

5>E

1D121C5

ECD?=9J1D9?>

the component. Press Next Page, then scroll down the list of fields and you will notice that the value you entered was written to the Commodity field in the external drawing database.

1TT=_TYVidXU6YU\TcY^dXU5TYd3_]`_^U^d4YQ\_Wc
The Database Tools/Edit Component command displays the selected components drawing database information in two dialogs. The first dialog displays the most common component drawing database record information. Each component type has its own version of this dialog defined in its Edit Component drawing script. 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 the components drawing database record field values. This dialog instance is defined in the file COMPUTIL.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 piping components Edit Component dialog. This example will add a COMMODITY field to the dialog. This procedure assumes that you have already added this field to the PIPING table schema in PIPING.INI as described in the previous procedure.

> D 1
?

441

95<4D?D85

?=@?>5>D >6?B=1D9?>

91<?7

! " #

Start the Rebis Script Editor and open the file NETWORK_ROOT\MODULES\BASE\COMMON\PIPE.EBS. Select Edit/Find, then enter Begin Dialog and press Find Next. The statements between the %HJLQ'LDORJ and (QG'LDORJ statements define the dialog instance. To edit the dialog, select all of the statements from %HJLQ'LDORJ to (QG'LDORJ, including those statements, then select Edit/Edit Dialog. The Script Editor will launch the Dialog Editor and display the dialog 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 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. You can re-size or 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 series of $WB&RPSRQHQW'LDORJB6HW7%&RQWURO function calls that initialize the Text Box controls on the first page of the Edit Component dialog. To initialize the new Text Box control added above, add the function call:
Call at_ComponentDialog_setTBControl ("Commodity", "COMMODITY")
+ + +

$

%

& '

DWB&RPSRQHQW'LDORJBVHW7%&RQWURO: is the function to initialize Text Box controls.

Commodity: is the name entered in the Text Box controls 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 the Database Tools/Edit Component command and pick the pipe.

Reference Manual

6-23

381@D5B

"4@9@9>71>4D854B16D9>7D??<C=5>E

'

This chapter covers the commands in the new Drafting Tools menu.

2D PIPING APPLICATION OVERVIEW DRAFTING TOOLS MENU SYMBOL MANAGER TITLE BLOCK 2D SYMBOLS INSULATE PIPE PIPE END SYMBOL 2D EDITING MENU BROKEN PIPE

7-2 7-6 7-6 7-9 7-10 7-11 7-11 7-11 7-12

'

"4 @9@9>7


1>4D85

B16D9>7

??<C

5>E

"4 @


9@9>7

@@<931D9?>

F5BF95G

"4@9@9>71@@<931D9?>?F5BF95G
The 2D Piping product is an application required to provide a user the ability to design and draw a plant layout in a 2D "flat" mode. The aim is to provide this functionality as a subset of the existing 3D product. To this end the following changes to the existing 3D product have been implemented.

@13;179>7D85"4@9@9>7@B?4E3D
The 2D PIPING product will be installed in the same manner as the 3D PIPING product. The functionality will be controlled by the Rebis Security system. The security system will control whether a user has access to the 2D or 3D PIPING environment and the associated commands and functions. When an Authorization request is made, the request will be specifically for the use of 2D or 3D PIPING. This will be controlled by the creation of either a 2D or 3D piping model, export to PCF etc.

89445><9>5B5=?F1<?ED@ED6?B3ECD?=5>D9D95C
The current 3D system uses a method of draw scripts to define and draw the resulting 3D entities for AutoPLANT. In 3D, when a component is created, the draw method utilizes a series of interface functions to create custom entities in true 3D. The 2D PIPING product will continue to use this technique, however the default 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 3D insertion. Internally the 3D custom entities will be converted through the new HLR interface into CAD entities and lines, resulting in a flat 2D output.

1ED?314B!$FC1ED?314"
This new method of dynamically producing HLR 2D output is only available under the AutoCAD 2000 product. To this end the 2D product will use a less sophisticated method of generating the 2D output in R14 by simply replacing the custom entities with AutoCAD primitives, lines, arcs, etc. Due to the constraints in this release of AutoCAD, two serious limitations will exist. 1. 2. The CAD primitives generated will not be generated through an HLR scheme, hence overlapping entities will exist within a single component. Lines may be generated where arcs are expected e.g. at the edge of elbows and this will remain for the R14 release.

=?496931D9?>CD?4B1G9>7@B565B5>35C491<?7
The following describes the Drawing Mode/Representations now available in terms of the selection mode in the Drawing Mode and Representation areas of the dialog (e.g., 3D-Double Line will 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 drawing of 3D components in 3D space using Rebis custom component objects. 3D-Single Line: this configuration enables drawing of Single Line component representations in 3D space using AutoCAD entities. In general, only Pipe Components, Bends and Returns, and Branching 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 the vertical plane) Double Line representations of components using AutoCAD entities.

7-2

AutoPLANT PIPING

"4 @9@9>7


1>4D85

B16D9>7

??<C

5>E

"4 @


9@9>7

@@<931D9?>

F5BF95G

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

As noted above, the 2D - Double Line mode will automatically generate flat 2D entities from existing 3D custom components. This is a radical change from the previous method. Previously, the Double Line mode in the 3D system used a complex set of draw methods to determine which view the component was being placed in and then determined how this component should be drawn. This method will be replaced by automatically converting, during placement, the 3D component into 2D native CAD objects, which have been generated via the 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 draw modes available will be controlled by the Rebis Security System. If the user is only authorized for 2D PIPING then the system will set the default draw mode to Double Line/2D, otherwise the default will remain Double Line/3D. Users authorized for 2D only, will have their 3D - Double Line draw mode disabled. Users authorized for 3D will have all draw modes and options available.

"489445><9>5?@D9?>C
When the 2D Drawing Mode is enabled, a 2D HL Options button will replace the 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 each component. Enabling this check box will activate the Output Properties grid in this dialog. The grid options define the manner in which hidden line output is displayed as described below:
Visibility Color Linetype Lineweight If the "Light bulb" is ON (yellow), then visibility is turned ON and hidden lines will be visible. Assigns the color of the visible hidden lines. Selects the line type to be used for the hidden line. Only loaded line types can be used from this selection and there will be no interface to load line types. The standard CAD interface should be used for this purpose. Determines the weight of the visible hidden lines. When you click within this grid field, a browse button 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 2D representations. Reference Manual 7-3

'

"4 @9@9>7


1>4D85

B16D9>7

??<C

5>E

"4 @


9@9>7

@@<931D9?>

F5BF95G

CI=2?<=1>175B
Once of the most important aspects of the 2D PIPING product is the ability to place simple shapes instead of complete 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 this document and will be presented as a separate design or prototype.

B5CDB93D9?>C6B?=D85CD1>41B4#4@9@9>7@B?4E3D
The 2D PIPING product does not allow the following commands/options, which can only be used while designing in the 3D mode. 1. 2. 3. 4. 5. PXF Import/Export Export to PCF will not be available from a 2D PIPING drawing. ISOGEN output will not be available as a consequence of the previous limitation. AutoISO will not be allowed from a 2D PIPING drawing. ISOMETRICS: this product must be licensed in its current form as a separate product. There will be no ability to export to a 2D PIPING drawing from and ISOMETRICS drawing as is available in the full 3D product. The REDRAW command will be not available on 2D PIPING drawings. Bill of Materials will be available. All existing modules will be available in 2D. A 3D drawing cannot be generated from a 2D PIPING drawing.

6. 7. 8. 9.

The user can only work in a 2D-drawing environment. Under these constraints any custom Rebis objects that are drawn will be shown as flat entities in any view. The following features, which were derived from the 3D Piping User Interface, will not be available.

@Y`Y^WD__\c
1. Centerline Routers a) From Dialog b) From File c) Pro-Pipe Router d) Designer Router 2. Representations a) 3D Reps b) AutoCAD Entities 3. 4. 5. 6. 7. 3D Display Modes 3D Display Utilities Connectivity Checker Isometric Stop Signs Drawing Production Options

7-4

AutoPLANT PIPING

"4 @9@9>7


1>4D85

B16D9>7

??<C

5>E

"4 @


9@9>7

@@<931D9?>

F5BF95G

4B1GC3B9@DC
The current 3D draw scripts will remain intact. However the current use of draw scripts for flat, double line mode will be removed and replaced using the preferred internal method of drawing components in a flat 3D mode. This will greatly enhance the layout of scripts, which were formerly overly complex because of the inclusion of having to determine which view the user was currently in before deciding how to draw a component in the current 2D mode. Instead, the scripts will still support 3D, Double and Single mode, but for the most part 3D and 2D will use the same code from the draw script. Internally, the system will recognize 2D mode and automatically transform the current 3D component into its flat AutoCAD counterpart. The end result 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 to draw a different representation of a component in 2D than its 3D counterpart. For example some valves may use a symbolic representation instead of flattening the current 3D representation.

"48<B?@D9?>C
In the Draing Preferences dialog, when you enable the 2D Draiwng Mode radio button, the Surface Resolution option will be replaced by a 2D HL Options button. Pressing this button displays an HLR Options dialog, which enables you to define how hidden line removal is handled for the 2D-Double Line representations. Hidden line removal is handled on a per component basis with respect to the settings defined in this dialog.

The Output Hidden Geometry check box determines if hidden line output should be displayed for each component. Enabling this check box will activate the Output Properties grid in this dialog. The grid options define the manner in which hidden line output is displayed as described below:
Visibility Color Linetype If the "Light bulb" is ON (yellow), then visibility is turned ON and hidden lines will be visible. Assigns the color of the visible hidden lines. Selects the line type to be used for the hidden line. Only loaded line types can be used from this selection and there 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 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 2D representations. Reference Manual 7-5

'

"4 @9@9>7


1>4D85

B16D9>7

??<C

5>E

B16D9>7 ??<C

5>E

4B16D9>7D??<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

CI=2?<=1>175B
The operation of the Symbol Manager varies depending on your version of AutoCAD. If running in AutoCAD 2000, the Drafting Tools/Symbol Manager command displays a dockable dialog as shown at left below. 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

1ED?314"

EC175

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 standard block 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 existing symbol. To use drag and drop, draw the symbol in AutoCAD, select it and then drag it into the required folder. A dialog box pops up to fill in the symbol name, scale factors, rotation, etc. If you fill these in, it will use 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 which symbol to use. You can also create new folders using the right mouse click menu and move symbols between folders using drag and drop.

7-6

AutoPLANT PIPING

"4 @9@9>7


1>4D85

B16D9>7

??<C

5>E

I=2?<

1>175B

1ED?314B!$EC175
Select the desired symbol folder from the Folders drop-down list. A list of symbols assigned to that folder will 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 Symbol Manager by manually editing the SYMBOL.INI file. This procedure is explained later in this topic.

@B?354EB5C
The following exercises provide an example of how to place and add a symbol. The operation of the Symbol Manager varies depending on your version of AutoCAD. These differences are noted in the following procedures.

> @
1. 2.

<139>71

E=@

I=2?<

Select Piping/Drafting Tools/SymbolManager&ldots; to display the Symbol Manager. AutoCAD 2000: Double click on the User Root folder to expand it, then click on the [+] symbol next to the Equipment 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 mouse pointer over the symbol, hold down the right button while you move the mouse cursor to a point over the AutoCAD 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. This procedure varies depending on your version of AutoCAD. Separate procedures are provided below to add a symbol if using AutoCAD 2000 and AutoCAD R14. Complete the procedure for your version of AutoCAD.

>
1. 2. 3. 4.

449>71

I=2?<D?D85

I=2?<

1>175B

1314"

Draw a rectangle by typing Rectangle at the command prompt, or by selecting Draw/Rectangle from the AutoCAD pull-down menu. Pick oposite corners to create a rectangle approximately 3 x 6. Highlight the rectangle by picking it in the AutoCAD window. 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 the mouse button. The following dialog appears.

5.

Reference Manual

7-7

'

"4 @9@9>7


1>4D85

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. >_dU If you always want the scale or rotation to be a static value, you can assign the desired values in the dialog fields provided. If you do not enter values, the user will be prompted for these parameters when placing your symbol.

7. 8. 9.

Notice that your new symbol has been added to the Symbol Manager dialog. You can now place this symbol in the same manner as you placed the pump in the previous exercise. 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. You can delete the rectangle from your drawing as it will not be used in this Tutorial.
449>71

> 1
1. 2. 3. 4.

>

5G

E=@

I=2?<

1ED?314 B!$


Draw a rectangle by typing Rectangle at the command prompt, or by selecting Draw/Rectangle from the AutoCAD pull-down menu. Pick oposite corners to create a rectangle approximately 3 x 6. Use the WBLOCK command to Write Block the symbol. The file should be placed in REBIS\USER\CONFIG\IMPERIAL\SYMBOLS\ directory. Using a text editor, add a new entry to the REBIS\USER\CONFIG\IMPERIAL\SYMBOLS\SYMBOL.INI similar to example that follows:
>3XPS@ )LOHQDPH 3803 7\SH 6\PERO 3DUHQW 1HZ)ROGHU7KLVPXVWEHWKHIROGHU\RXZDQWLWWRUHVLGHLQ &RORU RSWLRQDOH[DPSOHZRXOGSODFHEORFNUHG /D\HU P\OD\HURSWLRQDOOGRWVH[DPSOHZRXOGSODFHEORFNRQQHZOD\HUQDPHGE\OD\HU ;VFDOH RSWLRQDO <VFDOH RSWLRQDO 5RWDWLRQ RSWLRQDO

5.

The symbol will now be available in the Symbol Manager the next time it is executed. You can delete the rectangle from your drawing if desired.

7-8

AutoPLANT PIPING

"4 @9@9>7


1>4D85

B16D9>7

??<C

= 2

5>E

9D<5

<?3;

CI=2?<<92B1BI45D19<C
The program has been designed to use a system, custom, and user directory for storing symbols. Only the User 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 Symbols directory under the current configuration directory. If it cant find it, it will create it. The list of symbols that is displayed 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. Each entry (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 is what the user sees. The symbols just display the name of the section. The names of the folders are randomly generated. A future enhancement might be to use a global unique ID to generate initial values for the folders.
>8VHU5RRW@ 7\SH 5RRW 'LVSOD\QDPH 8VHU5RRW >1HZ)ROGHU@ 'LVSOD\QDPH (TXLSPHQW W\SH 1RGH 3DUHQW 8VHU5RRW >3XPS@ )LOHQDPH 3803 7\SH 6\PERO 3DUHQW 1HZ)ROGHU

D9D<52<?3;
The Drafting Tools/Title Block command displays a dialog similar to the one shown below, which lists title block 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 Factor and the Insertion Point to place the title block.

Reference Manual

7-9

'
"4CI=2?<C

"4 @9@9>7


1>4D85

B16D9>7

??<C

5>E

"4 C


I=2?<C

The Drafting Tools menu provides a number of 2D piping symbol placement options, which place generic AutoCAD blocks. Some of these blocks contain attributes, which you are given the option to assign during placement. These components are not "AutoPLANT intelligent," and therefore will not appear in generated BOMs 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

3ECD?=9J1D9?>
The blocks are defined in the AutoCAD drawing file SYMLIB.DWG, which resides in your NETWORK_ROOT\SUPPORT directory. The insertion routines themselves are defined in the BLKINSRT.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 the existing functions in BLKINSRT.EBS and change the function name and the block definitions assigned in the function. You can then execute the following command, or program it in your menu file to execute your script. Replace My_Block with the name of your new block insertion function in BLKINSRT.EBS.
DWB%DVLFBH[HFXWH6FULSWVWUFDWDWB6\VBJHW1HW'LU 0RGXOHV??EDVH??FRPPRQ??EONLQVUWHEV0\B%ORFN

7-10

AutoPLANT PIPING

"4 @9@9>7


1>4D85

B16D9>7

??<C

5>E

>CE<1D5

9@5

9>CE<1D5@9@5
The Drafting Tools/Insulate Pipe command prompts you to select an existing pipe segment, then displays the dialog shown below.

Enter the desired Insulation Thickness and Insulation Spec in the fields provided, then press OK. You will then be prompted to pick the desired start and end points for the insulation on the pipe segment selected previously.

@9@55>4CI=2?<
The Drafting Tools/Pipe End Symbol command prompts you to select the existing pipe segment on which you want to place a pipe end symbol. The system will place the end symbol on the end of the pipe closest to the point along the pipe segment that you pick.

"4549D9>7=5>E
The Drafting Tools/2D Editing menu provides the following options:
Trim Ungroup Regroup Works in the same manner as AutoCADs TRIM command on 2D AutoPLANT components. You will first be prompted to pick the cutting edges, then the objects to trim. 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. Prompts you to select an entitiy that is part of an AutoPLANT 2D component, then automatically regroups all of the entities 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 components group, then will delete that entity from the drawing.

Remove from Prompts you to select any entity that is part of an AutoPLANT 2D components group, then will remove this entity from that group.

Reference Manual

7-11

'
2B?;5>@9@5

"4 @9@9>7


1>4D85

B16D9>7

??<C

5>E

B?;5>

9@5

The commands in the Drafting Tools/Broken Pipe menu enable you to break pipe for annotating pipe at different elevations in paper space. The Mend and Mend All commands restore broken pipe to its original state.

2B51;
Allows you to select a pipe to break. The user is prompted to select the pipe to break, then indicate the starting and ending points of the break. A pipe break symbol is inserted at both ends of the break, and the centerline 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 a pipe is broken, it can be mended with either the Mend or Mend All commands.

> D 2
?

B51;

9@5

1. 2.

Select Drafting Tools/Broken Pipe/Break 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 that will 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 define where the break will end. The pipe is broken between the selected points, and pipe break symbols are placed on the open ends of the pipe. You can mend pipe with the Mend Pipe and Mend All Pipe commands.

7-12

AutoPLANT PIPING

"4 @9@9>7


1>4D85

B16D9>7

??<C

5>E

B?;5>

9@5

=5>4
Repairs a selected piece of pipe that has been broken with the Break Pipe command.

> D =
?

5>4

9@5

1. 2.

Select Drafting Tools/Broken Pipe/Mend 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.

=5>41<<
Repairs all pipe in a drawing (or viewport) that has been broken with the Break Pipe command. The Mend All command will repair a selected group of pipe segments on which a Break Pipe command was executed.

> D =
?

5>4

5<53D54

9@5

57=5>DC

1. 2.

Select Drafting Tools/Broken Pipe/Mend All

All broken cylinders in the current viewport are mended.

Reference Manual

7-13

381@D5B

1>>?D1D9?>=5>E

This chapter covers the Annotation menu, which provides a number of options to enable you to annotate your PIPING components.

OVERVIEW ANNOTATION PREFERENCES EDIT ANNOTATION DATABASE FIELD ANNOTATION LINE NUMBER ANNOTATION NOTES ANNOTATION ELEVATION ANNOTATION COORDINATE ANNOTATION TAGS INSTRUMENT BALLOONS ANNOTATION - HOW TO TOPICS

8-2 8-2 8-5 8-6 8-6 8-7 8-7 8-7 8-7 8-8 8-9

(
?F5BF95G

1 ?

>>?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 flyout toolbar from the main Piping Functions toolbar, or may be displayed separately by selecting Toolbars/Function Toolbars/Annotation. This toolbar contains flyouts that display additional commands for each annotation category.

The style and format of annotation may be defined using the Annotation/Annotation Preferences option. A number of options display on the command line when you place annotation. These options are also available by executing the Edit Annotation command, then selecting an existing annotation element.

1>>?D1D9?>@B565B5>35C
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 with the drawing or saved as a new set of default preferences. A description of each dialog option is provided below:

1>>?D1D9?>CDI<5
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 the individual annotation types. The Default Settings functions as a template. Define the general characteristics of all the annotation that will be placed in the drawing, then select an individual style to specify preferences that are unique to that annotation type. If a setting is specified for an individual style, it overrides the default settings. For example, the default annotation settings might specify that containers are to be disabled, but you can edit the GenNote style so general notes are placed with a container box around it. The annotation styles include the following choices:
Default Settings General Note Coordinate Main Size Description Long Description Spec Cut Length Insulation Tag Line Number Default settings applied to all the styles listed below. These settings are applied unless modifications are made to a specific annotation style Inserts general information notes into a drawing Annotates the absolute coordinates of a point. The main size of the selected component. Annotates the short description of the selected component. Annotates the long description of the selected component. Annotates the specification from which the component was drawn. Annotates the cut length of the selected pipe. Annotates the insulation value associated with the selected component. Annotates the tag assigned to the selected component. Annotates the line number on which the selected component is placed.

8-2

AutoPLANT PIPING

1 1

>>?D1D9?>

5>E

>>?D1D9?>

B565B5>35C

Line Number Long

Annotates an expanded version of the line number information that includes commodity and insulation values along with the line number.

Line Number with Centerline Line number annotation preceded by the centerline symbol. Line Number Long with Centerline Instrument Bubbles Mark Top of Pipe Elevation Center of Pipe Elevation Bottom of Pipe Elevation Northeast Coordinate Northsouth Coordinate EastWest Coordinate Long line number annotation preceded by the centerline symbol. (various types can be defined individually) Allows you to place section and elevation marks in your drawing. Annotates the elevation of the selected component with respect to the top of pipe location. Annotates the elevation of the selected component with respect to the center of pipe location. Annotates the elevation of the selected component with respect to the bottom of pipe location. Annotates the selected points North/East coordinate. Annotates the selected point's North/South coordinate. Annotates the selected point's East/West coordinate.

@<135=5>D
The Placement options control how annotation gets placed in a drawing. You can have access to extra placement options, edit text before it is placed, exit the command automatically or continue selecting components for annotation, and other options as explained below.

>?B=1<=?45
The Normal mode is the standard method for placing annotation. It involves the four general steps outlined below: ! " # $ Select the component to annotate. If the annotation style has an associated leader line, the selected point also becomes the leader lines 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 option from those presented. Select a new component/element for annotation, or press Enter to exit the command.

D5HD=?45
The Text mode enables you to edit the annotation text before it is placed. The general steps are outlined below. ! " # $ % Select the component to annotate. If the annotation style has an associated leader line, the selected point also becomes the leader lines 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 option from those presented. Edit the text. AutoCADs Mtext dialog is displayed. You may edit the text or the properties of the text before it is placed in the drawing. Select a new component/element for annotation, or press Enter to exit the command.

Reference Manual

8-3

>>?D1D9?>

5>E

D5HD?@D9?>C
The options in the Text group box determine how text gets placed in the drawing. These are the equivalents of AutoCADs MTEXT commands/options of the same name.

2<?3;?@D9?>C
The Block option enables you to associate an AutoCAD block with a selected annotation style. Input a block name in the field provided, then specify rotation and scaling factors as desired. In order for PIPING to locate the 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.

3?>D19>5B?@D9?>C
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 Ratio determines the spacing between bounding lines of the container and the text placed inside it.

<5145B?@D9?>C
The Leader group box contains options and settings associated with leader lines. Leader lines are anchored at the 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, the annotation is placed without a leader line. Splined Hookline Arrowhead Dim Style Dim Style Template Color Splines the leader line so that angles or directional changes in the leader line are drawn as smooth curves. Enable this option to automatically draw the leader line as hooked if the angle of the leader line is greater that 15 degrees from horizontal or vertical. Enable this option to draw the open end of the leader line as an arrow head which points to the component (or object) selected for annotation. Allows you to apply an existing dimension style to the current annotation style. The dimension style must have been previously defined in the current drawing for it to be valid input in this field. This field is reserved for future functionality. Allows you to specify the color applied to the annotation. Valid input includes BYLAYER, an AutoCAD color number, or an AutoCAD color string (text description, i.e., Blue)

8-4

AutoPLANT PIPING

>>?D1D9?>

5>E

5 1
49D

>>?D1D9?>

549D1>>?D1D9?>
The annotation command prompt shown below enables you to edit existing annotation elements. The command prompt is displayed automatically during annotation placement (unless one of the exit placement options was specified). It is also displayed when the Annotation/Edit Annotation command is executed.
Format/Edit vertex/Rotate/Move/Annotation/eXit:

>_dU

If you want to edit annotation text ONLY, the easiest method is to use AutoCADs DDEDIT command.\

A description of each of these options is provided below:

6?B=1D
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.

549DF5BD5H
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.

B?D1D5
Rotates the text and the associated leader line a user-specified angle.

=?F5
Enables you to select a new point to change the start point of the leader line.

1>>?D1D9?>
This command displays the command prompt shown below.
Attachpoint/Edit/Info/eXit: Reference Manual 8-5

1 4

>>?D1D9?>

= 1

5>E

1D121C5

95<4

>>?D1D9?>

These options control the annotation text as follows:

5H9D

Attachpoint: Controls how the text is positioned in relation to the leader line. The Attachpoint option is the same as the Attachment field in the Annotation Preferences dialog. Edit: Displays AutoCADs Mtext dialog which enables you to edit the selected annotation text and text properties.

Exits the annotation command prompt.

41D121C5695<41>>?D1D9?>
These commands annotate the field value stored in a components database record. The annotation procedure is the same for all the database annotation commands: select the command then the component whose database 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.

<9>5>E=25B1>>?D1D9?>
These commands annotate the line number stored in a components database record. Line numbers are assigned during component placement, and can either be read from the value specified in the Drawing Preferences dialog, or from the connecting component. The annotation procedure is the same for all the Line Number annotation commands: select the command then the component whose Line Number value you want to extract and place as annotation.
Line No. Short Line No. Long Annotates the line number-specification-main size. 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.

8-6

AutoPLANT PIPING

>>?D1D9?>

5>E

>

?D5C

>>?D1D9?>

>?D5C1>>?D1D9?>
These commands allow you to place general note annotation in your drawings. The procedure is to select the command then indicate the placement options. AutoCADs Mtext dialog is displayed to allow you to input the text and control formatting and placement options.
General Note Allows for the annotation of general notes in your drawing.

5<5F1D9?>1>>?D1D9?>
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, then select the location in the drawing where the leader line will be placed.
TOP Elevation COP Elevation BOP Elevation Top of Pipe Elevation Center of Pipe Elevation Bottom of Pipe Elevation

3??B49>1D51>>?D1D9?>
NE Coordinate NS Coordinate Annotates the North, East coordinate location of the selected point 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 North coordinates. NS Coordinate annotation is placed as horizontal text only. 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), West coordinates are reported. EW Coordinate annotation is placed as vertical text only. Annotates the (x,y,z) coordinate location of the selected point.

EW Coordinate

Coordinate

D17C
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 the selected components MAT_MARK field, then it will display as the default in the dialog displayed. Once you have 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 components TAGNUMBER field, then it will display as the default in the dialog displayed. Once you have defined the tag, press OK to place the annotation.

Reference Manual

8-7

1 9

>>?D1D9?>

5>E

>CDBE=5>D

1<<??>C

9>CDBE=5>D21<<??>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 then prompted to select the anchor point and the placement point. Afterwards, the Enter Attributes dialog is displayed. Enter the T-tag attributes in the fields provided, then press OK. The instrument bubble is placed in the drawing at the points specified, and with the attributes entered in the dialog.

8-8

AutoPLANT PIPING

1 1

>>?D1D9?>

5>E

>>?D1D9?> 

8

?G ? ?@93C

D D

1>>?D1D9?>8?GD?D?@93C
This area provides procedures that explain how to perform common annotation tasks.

549D1>>?D1D9?> > D
! "
?549D5H9CD9>71>>?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 this command prompt.

@<1351=1D5B91<D17
The Annotation/Tags/Material Tag command enables you annotate components with Bill of Materials markers whose values directly correspond to the BOM material tags generated during the last execution of the BOM command.

> D @
?

<1351

1D5B91<

17

! "

Select Piping/Annotation/Tags/Material Tags The prompt:

Select the component

is displayed. Select the component that you want to annotate. It is important to note that the point you specify becomes the anchor to the annotations leader line, so select the point where you want the leader line 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:
Format/Edit vertex/Rotate/Move/Annotation/eXit <X>:

is displayed. This prompt enables you to edit the existing annotation elements. If the BOM mark requires no changes, press X to exit the editing mode. % The prompt:
Select the component

is re-displayed. Select another anchor point to place and define a new BOM mark, or press Enter to exit the command.

Reference Manual

8-9

1 1

>>?D1D9?>

5>E

>>?D1D9?> 

8

?G ? ?@93C

D D

@<1351>9>CDBE=5>D21<<??>
PIPING contains balloons for labeling and identifying instrumentation placed in a piping drawing.

> D @
?

<1351> >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 as follows. Complete the fields necessary to adequately define the instrument. FUNCTION: Abbreviated functional description of the instrument; default is T1 INST_ID: Unique instrument 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 to close the dialog. The editing prompt:
Format/Edit vertex/Rotate/Move/Annotation/eXit <X>:

'

is displayed. This prompt enables you to edit the existing annotation elements. If the BOM mark requires no changes, press X to exit the editing mode. ( The prompt
Select the anchor point of annotation:

is re-displayed. Select another anchor point to place and define a new instrument bubble, or press Enter to exit the command.

8-10

AutoPLANT PIPING

1 1

>>?D1D9?>

5>E

>>?D1D9?> 

8

?G ? ?@93C

D D

41D121C5695<41>>?D1D9?>8?GD?D?@93C
This area provides procedures that explain how to perform common database field annotation tasks.

@\QSU=QY^CYjU1^^_dQdY_^

> D 1
?

>>?D1D51

?=@?>5>D C

19>

9J5

! "

Select Annotation/Database Fields/Main Size The prompt

Select the component:

displays. Pick a point on a component. The point becomes the anchor of the annotation leader line. # The prompt
Annotation location:

displays. Pick a point to place the annotation. $ The editing prompt:

Format/Edit vertex/Rotate/Move/Annotation/eXit <X>:

is displayed. This prompt enables you to edit the existing annotation elements. If the BOM mark requires no changes, press X to exit the editing mode. % The prompt
Select the component

is re-displayed. Select another component to annotate, or press Enter to exit the command.

@\QSU4UcSbY`dY_^1^^_dQdY_^

> D 1
?

>>?D1D51

?=@?>5>D C

C

8?BD

4

5C3B9@D9?>

! "

Select Annotation/Database Fields/Description The prompt

Select the component:

displays. Pick a point on a component. The point becomes the anchor of the annotation leader line. # The prompt
Annotation location:

displays. Pick a point to place the annotation. $ The editing prompt:

Format/Edit vertex/Rotate/Move/Annotation/eXit <X>:

is displayed. This prompt enables you to edit the existing annotation elements. If the BOM mark requires no changes, press X to exit the editing mode. % The prompt
Select the component

is re-displayed. Select another component to annotate, or press Enter to exit the command.

Reference Manual

8-11

1 1

>>?D1D9?>

5>E

>>?D1D9?> 

8

?G ? ?@93C

D D

@\QSU<_^W4UcSbY`dY_^1^^_dQdY_^

> D 1
?

>>?D1D51

?=@?>5>D C ?>7

<

5C3B9@D9?>

! "

Select Annotation/Database Fields/Long Desc The prompt

Select the component:

displays. Pick a point on a component. The point becomes the anchor of the annotation leader line. # The prompt
Annotation location:

displays. Pick a point to place the annotation. $ The editing prompt:

Format/Edit vertex/Rotate/Move/Annotation/eXit <X>:

is displayed. This prompt enables you to edit the existing annotation elements. If the BOM mark requires no changes, press X to exit the editing mode. % The prompt
Select the component

is re-displayed. Select another component to annotate, or press Enter to exit the command.

@\QSUC`USYVYSQdY_^1^^_dQdY_^

> D 1
?

>>?D1D51

?=@?>5>D C

@5396931D9?>

! "

Select Annotation/Database Fields/Spec The prompt

Select the component:

displays. Pick a point on a component. The point becomes the anchor of the annotation leader line. # The prompt
Annotation location:

displays. Pick a point to place the annotation. $ The editing prompt:

Format/Edit vertex/Rotate/Move/Annotation/eXit <X>:

is displayed. This prompt enables you to edit the existing annotation elements. If the BOM mark requires no changes, press X to exit the editing mode. % The prompt
Select the component

is re-displayed. Select another component to annotate, or press Enter to exit the command.

8-12

AutoPLANT PIPING

1 1

>>?D1D9?>

5>E

>>?D1D9?> 

8

?G ? ?@93C

D D

@\QSU@Y`U3ed<U^WdX1^^_dQdY_^

> D 1
?

>>?D1D51

@ 3 <
9@5 C

ED 5>7D8

! "

Select Annotation/Database Fields/Pipe Cut Length The prompt

Select the component:

displays. Pick a point on a piece of pipe. The point becomes the anchor of the annotation leader line. # The prompt
Annotation location:

displays. Pick a point to place the annotation. $ The editing prompt:

Format/Edit vertex/Rotate/Move/Annotation/eXit <X>:

is displayed. This prompt enables you to edit the existing annotation elementsIf the BOM mark requires no changes, press X to exit the editing mode. % The prompt
Select the component

is re-displayed. Select another length of pipe to annotate, or press Enter to exit the command.

@\QSU9^ce\QdY_^1^^_dQdY_^

> D 1
?

>>?D1D51

?=@?>5>D C >CE<1D9?>

! "

Select Annotation/Database Fields/Insulation The prompt

Select the component:

displays. Pick a point on a component. The point becomes the anchor of the annotation leader line. # The prompt
Annotation location:

displays. Pick a point to place the annotation. $ The editing prompt:

Format/Edit vertex/Rotate/Move/Annotation/eXit <X>:

is displayed. This prompt enables you to edit the existing annotation elements. If the BOM mark requires no changes, press X to exit the editing mode. % The prompt
Select the component

is re-displayed. Select another component to annotate, or press Enter to exit the command.

Reference Manual

8-13

1 1

>>?D1D9?>

5>E

>>?D1D9?> 

8

?G ? ?@93C

D D

<9>5>E=25B1>>?D1D9?>8?GD?D?@93C
This area provides procedures that explain how to perform common line number annotation tasks.

@\QSUCX_bd<Y^U>e]RUb1^^_dQdY_^
This selection will place a short line number description in the form:
/LQH1XPEHU6SHFLILFDWLRQ0DLQ6L]H

> D @
?

<135

8?BD 9>5

<

>

E=25B

>>?D1D9?>

! "

Select Annotation/Line Number/Line No. Short The prompt

Select the component:

displays. Select the component whose line number you wish to annotate. It is important to note that the point you specify becomes the anchor to the annotations leader line, so select the point where you want the leader line to connect to the component, then press Enter. # The prompt
Annotation location:

displays. Pick the location where the annotation text will be placed. Annotation styles and placement options are established in the Annotation Preferences dialog. $ The editing prompt:
Format/Edit vertex/Rotate/Move/Annotation/eXit <X>:

is displayed. This prompt enables you to edit the existing annotation elements. If the BOM mark requires no changes, press X to exit the editing mode. % The prompt
Select the component:

is re-displayed. Pick another component to continue placing line number annotation, or press Enter without picking a point to exit the command.

@\QSU<_^W<Y^U>e]RUb1^^_dQdY_^
This selection will place a long line number description in the form:
/LQH1XPEHU6SHFLILFDWLRQ0DLQ6L]H&RPPRGLW\LIVSHFLILHG,QVXODWLRQLIVSHFLILHG

> D @
?

<135 ?>7 9>5

<

<

>

E=25B

>>?D1D9?>

! "

Select Annotation/Line Number/Line No. Long The prompt

Select the component:

displays. Select the component whose line number you wish to annotate. It is important to note that the point you specify becomes the anchor to the annotations leader line, so select the point where you want the leader line to connect to the component, then press Enter.

8-14

AutoPLANT PIPING

1 1 #

>>?D1D9?>

5>E

>>?D1D9?> 

8

?G ? ?@93C

D D

The prompt
Annotation location:

displays. Pick the location where the annotation text will be placed. Annotation styles and placement options are established in the Annotation Preferences dialog. $ The editing prompt:
Format/Edit vertex/Rotate/Move/Annotation/eXit <X>:

is displayed. This prompt enables you to edit the existing annotation elements. If the BOM mark requires no changes, press X to exit the editing mode. % The prompt
Select the component:

is re-displayed. Pick another component to continue placing line number annotation, or press Enter without picking a point to exit the command.

@\QSUCX_bd<Y^U>e]RUb1^^_dQdY_^gYdX3U^dUb\Y^UCi]R_\
This selection will place a short line number description with a centerline symbol in the form:
&HQWHUOLQH6\PERO/LQH1XPEHU6SHFLILFDWLRQ0DLQ6L]H

> D @
?

<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

Select the component:

displays. Select the component whose line number you wish to annotate. It is important to note that the point you specify becomes the anchor to the annotations leader line, so select the point where you want the leader line to connect to the component, then press Enter. # The prompt
Annotation location:

displays. Pick the location where the annotation text will be placed. Annotation styles and placement methods are established in the Annotation Preferences dialog. $ The editing prompt:
Format/Edit vertex/Rotate/Move/Annotation/eXit <X>:

is displayed. This prompt enables you to edit the existing annotation elements. If the BOM mark requires no changes, press X to exit the editing mode. % The prompt
Select the component:

is re-displayed. Pick another component to continue placing line number annotation, or press Enter without picking a point to exit the command.

Reference Manual

8-15

1 1

>>?D1D9?>

5>E

>>?D1D9?> 

8

?G ? ?@93C

D D

@\QSU<_^W<Y^U>e]RUb1^^_dQdY_^gYdX3U^dUb\Y^UCi]R_\
This selection will place a long line number description with a centerline symbol in the form:
&HQWHUOLQH6\PERO/LQH1XPEHU6SHFLILFDWLRQ0DLQ6L]H&RPPRGLW\LIVSHFLILHG,QVXODWLRQ LIVSHFLILHG

> D @
?

<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

Select the component:

displays. Select the component whose line number you wish to annotate. It is important to note that the point you specify becomes the anchor to the annotations leader line, so select the point where you want the leader line to connect to the component, then press Enter. # The prompt
Annotation location:

displays. Pick the location where the annotation text will be placed. Annotation styles and preferences are established in the Annotation Preferences dialog. $ The editing prompt:
Format/Edit vertex/Rotate/Move/Annotation/eXit <X>:

is displayed. This prompt enables you to edit the existing annotation elements. If the BOM mark requires no changes, press X to exit the editing mode. % The prompt
Select the component:

is re-displayed. Pick another component to continue placing line number annotation, or press Enter without picking a point to exit the command.

>?D51>>?D1D9?>8?GD?D?@93C
This area provides procedures that explain how to perform common note annotation tasks.

9^cUbdQ7U^UbQ\>_dU

> D 9
! "

? >C5BD1

5>5B1<

>

?D5

Select Annotation/Notes/Gen Note The prompt

Select the anchor point of annotation:

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 additional notes below this header, using the formatting controls available in this dialog if desired. Press OK when done to close the dialog. The text is top-left justified at the specified point.

8-16

AutoPLANT PIPING

1 1

>>?D1D9?>

5>E

>>?D1D9?> 

8

?G ? ?@93C

D D

9>C5BD5<5F1D9?>9>6?B=1D9?>
Three commands are available for annotating elevation values in a model. Elevation values can reflect the Top of Pipe (TOP), Center of Pipe (COP) or the Bottom of Pipe. The placement procedure for these types of annotation differs only in the initial command selection.

> D 9
!

? >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
Select the component:

displays. Pick the point on the component whose elevation is to be annotated. The point you pick becomes the anchor of the annotations leader line. # The prompt
Annotation location:

displays. Select the point where the annotation will be placed. $ The editing prompt
Format/Edit vertex/Rotate/Move/Annotation/eXit <X>:

is displayed. This prompt enables you to edit the existing annotation elements. If the BOM mark requires no changes, press X to exit the editing mode. % The prompt:
Select the component

is re-displayed. Select another anchor point to place and define a new elevation or press Enter to exit the command.

Reference Manual

8-17

1 1

>>?D1D9?>

5>E

>>?D1D9?> 

8

?G ? ?@93C

D D

3??B49>1D51>>?D1D9?>8?GD?D?@93C
This area provides procedures that explain how to perform common coordinate annotation tasks.

@\QSU>5>C5G3__bTY^QdU1^^_dQdY_^

> D 1
?

>>?D1D51

>5>C5G3

??B49>1D5

!

Select one of the following commands: Annotation/Coordinates/NE Coordinate Annotation/Coordinates/NS Coordinate Annotation/Coordinates/EW Coordinate .

"

The prompt
Select the anchor point of annotation:

displays. # The prompt

Annotation location:

displays. Pick the point in the drawing where the North and East coordinate location information will be placed. The selected point becomes the anchor point of the leader line. $ The editing prompt:
Format/Edit vertex/Rotate/Move/Annotation/eXit <X>:

is displayed. This prompt enables you to edit the existing annotation elements. If the coordinate requires no changes, press X to exit the editing mode. % The prompt:
Select the anchor point of annotation:

is re-displayed. Select another anchor point to place and define a new coordinate or press Enter to exit the command.

@\QSU7U^UbQ\3__bTY^QdU1^^_dQdY_^

> D 1
?

>>?D1D51

5>5B1<

??B49>1D5

! "

Select Annotation/Coordinates/ Coordinate The prompt

Select the anchor point of annotation:

displays. Pick the exact coordinate that you want to annotate. # The prompt
Annotation location:

displays. Select a second point to place the annotation in the drawing. The coordinate annotation expresses the X,Y,Z values of the coordinate.

8-18

AutoPLANT PIPING

381@D5B

B5@?BDC=5>E

There are two types of reports available in this menu. The Bill of Materials option generates a BOM for placement in the current drawing. The Generate Reports option enables you to direct output to a file or a viewing window, and to customize the type of report and the information contained in it.

OVERVIEW BILL OF MATERIALS GENERATE REPORTS

9-2 9-2 9-19

)
?F5BF95G

B ?

5@?BDC

5>E

F5BF95G

There are two types of reports available in this menu. The Bill of Materials option generates a BOM for placement in the current drawing. The Generate Reports option enables you to direct output to a file or a viewing 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 toolbar from the main Piping Functions toolbar, or may be displayed separately by selecting Toolbars/Function Toolbars/Reports.

29<<?6=1D5B91<C
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 current drawing. It extracts data from component information in the current, or from multiple drawings external drawing database(s). AUTO-ISO provides a Bill of Materials Configuration command to enable you to configure the format of the BOM output that will be placed on generated isometric drawings. AUTO-ISO will use the last BOM configuration defined to format the generated BOM. In order to automatically place a BOM on an iso, you must also enable the Auto Bill of Materials check box in the Control Settings dialog.

9-2

AutoPLANT PIPING

B 2

5@?BDC

5>E

9<<?6

1D5B91<C

75>5B1<@B?354EB5
1. 2. The content of the BOM is controlled by the Report selected. Select the desired Report, and set the other options as desired. If you want to customize the format (font, line type, column, etc.) press the Options button. A tabbed dialog will display to enable you to customize the format of the BOM. >_dU When you have finished defining the BOM options, press OK. The Drawing Selection Options dialog will display to enable you to define the selection set of components that you want to appear in your BOM. When you have finished defining the selection set, the BOM will be placed on the drawing using the method that you defined in the General tab of the Bill of Materials Configuration dialog.

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

B5@?BD>1=5
The Report drop-down list enables you to select the report file that will be used to process the component data that will be presented in the generated BOM. The following BOM reports are provided with the software:

BOMCADCutLengths: uses the BOMCUTLN.RPT Report File to generate a BOM that lists cut-lengths of pipe 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 cut lengths 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 and all 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 the nearest foot or meter and then all other components grouped by size.

Reference Manual

9-3

B 2

5@?BDC

5>E

9<<?6

1D5B91<C

B5@?BD69<5
This read-only field displays the path to the currently selected report name. The report files can be customized directly with the Crystal Reports application.

E>9DC@B539C9?>
Units Precision Bore Precision 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. Select the level of precision reported for pipe lengths. 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 AutoCADs DIMZIN environment variable. Only the imperial (architectural) settings are currently honored. Refer to your AutoCAD documentation for more information.

=9C3?@D9?>C
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). This value controls which components will be omitted from B.O.M. processing. Components whose sort order code is greater than this value are omitted from the BOM. If an invalid omit code is entered (i.e., <=0 or a blank space or a non-numeric value), this will effectively turn off the OMIT CODES option, allowing the report to generate all records into the output. Components can be marked as Existing to distinguish between components that already exist in the field, and those which are part of new design configurations. This enables you generate a Bill of Materials that reflects only components that are new to the design. Enable the Ignore Existing Components check box to omit components marked as Existing from the BOM. In PIPING and ISOMETRICS, you can use the Database Tools/Update Components command to define a selection set of components to mark as existing, or set this value for individual components using the Database Tools/Edit Component command. Clean Database Fasteners Append Pipe End Preparations This option removes those fasteners that are no longer used for connecting components. For example if a pipe is welded to an elbow and the elbow is removed but the weld is left, this action will remove the weld from the pipe. 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 are generated. This method is stored in ..\BASE\COMMON\BOMDESCR.EBS. Any component that does not have this method will inherit the default from the %$6(B&20321(176B&/$66. During BOM generation if the flags for appending topworks descriptions and pipe end code preparations are set in the user interface a temporary piping system variable is set and read by the script. The script will act on this variable as shown below for the pipe 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, for Imperial for example look in the file ..\CONFIG\IMPERIAL\PIPEENDS.INI. Append Topwork Descriptions Ascending Sort_Code Order Adds topworks description to the end of a valve's description in a report. A method similar to that explained for the Pipe End Preparation is used for the topwork's descriptions being appended to the valve descriptions. When enabled, this option will list the components in the BOM in a ascending order using the SORT_CODE values. For example, the default pipe SORT_CODE=17, and the Weldneck Flange SORT_CODE=1. In the BOM, the Weldneck Flange will be listed first and pipe second because of the SORT_CODE values. If this option is not enabled, then the components will be listed in a descending order using the SORT_CODE values.

Ignore Existing Components

9-4

AutoPLANT PIPING

B 2

5@?BDC

5>E

9<<?6

1D5B91<C

=1D5B91<D17?@D9?>C
When the BOM executes in PIPING it will update the necessary material tag fields according to the selection made. However, material tag balloon annotation will only be placed in ISOMETRICS/AUTO-ISO. When tagging attempts to create balloons for the tags in a PIPING drawing a warning message is issued, indicating that the material database tags have been updated only (no graphics will be generated). If you want to place material balloon tags in a PIPING drawing after a BOM has been generated, you may do so using the new Annotation/Tags/Material Tags command.
Tag Format Starting Tag Number No Material Tags The option enables you to specify how you want the balloon material tags formatted. Two options are available. The text box enables you to explicitly define the starting number for material tagging of components. Enable this option to disable the placement of material tags on each component. Enabling this radio button will automatically disable the associated Show Material Tags, Fastener Tags, and Support Tags options. Enable this option to update the MAT_MARK field with the new material tag for component records in the external drawing database.

Update Material Tags

Reinsert Material Tags Enable this option to automatically update existing material balloon tags that may have been placed from a previous BOM run. Do Not Update Existing Enable this option to leave the existing tags and use them in the BOM, then only generate and place Material Tags material 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. If enabled, the system will attach a material balloon tag to each component in the report selection set. This technique makes it easy to pair components in the drawing with records in the report. If the Show Material Tags check box is enabled, the Show Fastener Tags and Show Support Tags options will also be made available to enable you to optionally display tags for supports and fasteners.

>_dU

Refer to the Bill of Materials folder in the AutoPLANT Program Customization help file for customization information. This help file may be displayed by selecting AutoPLANT 3D/Customization Tools and Help/AutoPLANT Program Customization from your Windows Start menu.

Reference Manual

9-5

B 2

5@?BDC

5>E

9<<?6

1D5B91<C

29<<?6=1D5B91<C3?>697EB1D9?>
The Options button on the Bill of Materials dialog displays another dialog that enables you to customize the format of your BOM. This includes the line type and thickness, title, and the data columns that will actually be 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 determine how the BOM output is formatted on the drawing. This includes the line type and thickness, title, and the data columns that will actually be presented in the BOM output. The Bill of Materials Configuration dialog shown below displays by pressing the Options button on the main BOM dialog. It enables you to select the format configuration that you want to use to generate your BOMs. New configurations may be created and existing configurations may be modified in this dialog. AUTO-ISO provides a Bill of Materials Configuration command to enable you to configure the format of the BOM output that will be placed on generated isometric drawings. AUTO-ISO will use the last BOM configuration defined to format the generated BOM. In order to automatically place a BOM on an iso, you must 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 in the General tab to make it active. The selected configuration will be used when you generate a BOM. When you select a configuration from the drop-down list, the settings currently defined for that configuration display in each tab of the dialog. Also note that the active configuration name always displays in the dialogs title bar for reference. You can modify any of the active configurations settings in the dialog tabs. BOM format configuration settings are saved locally, which means that each user may have his own set of BOM format configurations.

>_dU

If you are running AUTO-ISO and have enabled the Bill of Materials check box in the Annotation Options/Component Data dialog, AUTO-ISO will use the last known BOM configuration to place the automatic BOM on your isometrics. You can run the Annotation Options/Bill of Materials command to set these options for AUTO-ISO.

9-6

AutoPLANT PIPING

B 2

5@?BDC

5>E

9<<?6

1D5B91<C

7U^UbQ\DQR2?=3_^VYW
The General Tab in the Bill of Materials Configuration dialog enables you to create/modify BOM format settings. When you select a format from the drop-down list, all settings previously defined for that format will appear in this tab and all of the other tabs of this dialog to enable you to view/modify these settings. You can also create new format configurations on this tab.

A description of each of the settings in the General tab is provided below: B

5@?BD

?B=1D

?>697EB1D9?>

The Format drop-down lists all of the available BOM format configurations. The configuration that you select is used to generate your BOM. When you select a configuration from the drop-down list, the settings defined for that configuration display in all of the options in the dialog tabs. The active configuration name always displays in the dialogs title bar. If you modify a value on any of the tabs it will be saved locally with the 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, and QUANT. 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. BOM configurations are stored locally, therefore, each user may have a set of BOM format configurations.

Reference Manual

9-7

B 2

5@?BDC

5>E

9<<?6

1D5B91<C

<135=5>D

5D8?4

There are three placement methods available: Node, Origin and By Pick. These options determine how the Bill 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 the node listed in this field, from the corner defined in the Placement Corner area of this dialog. This option is primarily used by AUTO-ISO to enable you to insert a node at the location that you want automatic BOMs placed on the drawing. This will enable you to run AUTO-ISO in batch mode to generate several isometrics in one run without being prompted to pick the location of the BOM on each drawing. A BOM node 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 and nodelocation 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 at this 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, then to specify the Placement Corner from which the BOM will be drawn. 3
?B>5B

<135=5>D

The BOM placement method is defined in the Placement group in the General tab. The Placement Corner options 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. 2

?B45B

B?@5BD95C

The Border Properties define the properties of the Bill of Materials border. This is the line that surrounds all of 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 not exist in the drawing, it will be created automatically before placing the Bill of Materials. If this field is left 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 AutoCAD documentation for the list of linetypes and their corresponding names. If you do not want lines at all, set this 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.

9-8

AutoPLANT PIPING

B 2 D ?

5@?BDC

5>E

9<<?6

1D5B91<C

5HD

66C5D

The distance the text is offset from the vertical borders and column lines as measured in current drawing units. >
5G

Press this button to add a new BOM format configuration. The following dialog displays to enable you to enter the new format configuration name. Enter the configuration name and press OK. The new configuration will 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.

DYd\UDQR2?=3_^VYW
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 Height Spacing Style Line Type The text that appears in the title of a Bill of Materials report. The default value is Bill of Materials. The height of the text. The spacing applied above and below the text in the BOM. The name of an AutoCAD font style that will be used to format the text. 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 AutoCAD documentation for the list of linetypes and their corresponding names. If you do not want lines at all, set this field value to none (must be all lowercase letters). The thickness of the line in current units. The relative length of dash-dot line types per drawing unit.

Line Weight LTScale

Reference Manual

9-9

B 2

5@?BDC

5>E

9<<?6

1D5B91<C

8UQTUbDQR2?=3_^VYW
These settings define how Bill of Materials Headers are formatted. Headers separate groups of objects in the report, such as Shop and Field.

A description of the fields in this tab is provided below:

Height Spacing Style Line Type The height of the text. The spacing applied above and below the text in the BOM. The name of an AutoCAD font style that will be used to format the text. 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 AutoCAD documentation for the list of linetypes and their corresponding names. If you do not want lines at all, set this field value to none (must be all lowercase letters). The thickness of the line in current units. The relative length of dash-dot line types per drawing unit.

Line Weight LTScale

9-10

AutoPLANT PIPING

B 2

5@?BDC

5>E

9<<?6

1D5B91<C

B_gDQR2?=3_^VYW
These settings define how the Bill of Materials rows in individual sections are formatted.

A description of the fields in this tab is provided below:

Height Spacing Style Line Type The height of the text. The spacing applied above and below the text in the BOM. The name of an AutoCAD font style that will be used to format the text. 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 AutoCAD documentation for the list of linetypes and their corresponding names. If you do not want lines at all, set this field value to none (must be all lowercase letters). The thickness of the line in current units. The relative length of dash-dot line types per drawing unit.

Line Weight LTScale

Reference Manual

9-11

B 2

5@?BDC

5>E

9<<?6

1D5B91<C

3_\e]^DQR2?=3_^VYW
These settings define the properties of the Bill of Materials lines and columns.

A description of the fields in this tab is provided below: 4

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 AutoCAD documentation 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 generated BOM. Press Organize to display a dialog to select the fields that you want to appear as columns in the BOM output. To add a field, simply select if from the left list, then press Add. To remove a field, select it from the right list and press Remove. Columns will appear in the BOM output in the order that they appear in the Current list. You can change the order of a field by selecting the field in the Current list and pressing the Up or Down Arrows to move the field to the desired position. When you are finished selecting and arranging the column fields, press OK. The column Name drop-down contains a list of all of the selected column fields.

9-12

AutoPLANT PIPING

B 2

5@?BDC

5>E

9<<?6

1D5B91<C

The settings that appear in the remaining Properties group options apply to the currently selected column Name only. This enables you to select each column in the Name drop-down list, then define individual properties for that column. When you select a column name from the list the settings defined for that column will display.
Column Header This field enables you to define the text that appears at the top of a column. Select a column 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 the column cell. Select a column Name from the drop-down list, then select the desired Justification from the drop-down list (options include L (Left), C (Center), and R (Right)). Repeat this process for each column Name. 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 AutoCAD documentation for the list of linetypes and their corresponding names. If you do not want lines at all, set this field value to none (must be all lowercase letters). The thickness of the line in current units. The relative length of dash-dot line types per drawing unit. The width of the column in current units.

Line Type

Line Weight LTScale Width

>_dU

The system is delivered with an option to omit certain components from a report. If a component has a 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.

29<<?6=1D5B91<C8?GD?D?@93C
This area of the help provides procedures specific to the generation of a Bill of Materials on your CAD drawing using the Reports/Bill of Materials command.

7U^UbQdUQ2Y\\_V=QdUbYQ\c
The Reports/Bill of Materials command in PIPING in ISOMETRICS generates a report for placement on a drawing. AUTO-ISO provides a BOM Configuration option to enable you to set the format of BOMs automatically placed on generated isometric drawings. The procedure to generate a BOM from PIPING/ISOMETRICS is provided below.

> D 7
?

5>5B1D51

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 by enabling/disabling the options as desired. If you want to create/modify the format of the BOM (linetype, font, column, title, etc.), press the Options button. 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 to appear on the BOM using the tools presented in this dialog. >_dU If the Material Tags option was enabled, these tags are placed now.

Reference Manual

9-13

B 2

5@?BDC

5>E

9<<?6

1D5B91<C

&

The placement of the BOM is determined by the Placement option selected in the General tap of the Bill of Materials Configuration dialog. The default is placement by pick point to define the upper left corner of the BOM. The following prompt displays:
Select upper left point:

'

Pick a point in the model (or in Paper Space) to place the BOM. >_dU The Bill of Materials will place a formatted report in the current drawing. To generate reports which are output to a viewing window or a file, use the Reports/Generate Reports option.

CU\USddXU2?=6_b]Qd3_^VYWebQdY_^

> D
! " #

?3ECD?=9J5D85

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. When you select a format configuration from this tab, all of the settings defined for that configuration will display 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.

$ %

1TT=_TYViQ2?=6_b]Qd3_^VYWebQdY_^
The format of the border, lines, text, column, etc. of a BOM that is placed on a drawing is stored in a BOM format configuration. The shipping version of the software provides several sample format configuration to choose from. These formats may be modified, or new ones created. The following procedure explains how to create a new BOM format configuration.

> D 3
?

B51D51

>

5G

2?=6

?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 that will be used when you generate a BOM may be selected from the Configuration drop-down list on the General tab in this dialog. When you select a configuration, all of the settings that are defined for that configuration will display in the fields of each tab on the dialog. The current active configuration always displays in the Title bar of the dialog for reference. To modify a configuration, simply select it from the list in the General tab, then modify the desired parameters. The configuration will be saved locally, so that each user may modify and have his own set of configurations on their local drive. To add a new configuration, press New. A dialog displays to enable you to enter the name of the new configuration. Enter the new name and press OK. The new configuration will become the selected configuration in the drop-down list. Define the parameters for the configuration in each of the tabs. The new configuration and its settings will be saved locally. When you are finished adding/modifying configurations, select the configuration that you want to apply to the next generated BOM in the General tab, then press OK to close the dialog.

#

$

%

&

9-14

AutoPLANT PIPING

B 2

5@?BDC

5>E

9<<?6

1D5B91<C

CUddXU2?=@\QSU]U^d=UdX_T
The format of the border, lines, text, column, etc. of a BOM that is placed on a drawing is stored in a BOM format configuration. The shipping version of the software provides several sample format configuration to choose from. These formats may be modified, or new ones created by pressing the Options button in the Bill of Materials dialog. The following procedure explains how to modify the method used to place a BOM on your drawing.

> D C
?

5DD85

2?=@

<135=5>D

5D8?4

! " # $

Select Reports/Bill of Materials to display the Bill of Materials dialog. Press Options to display the Bill of Materials 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 place the BOM. Select By Node and then enter the BOM node name if you have previously defined and placed a node on the drawing to define the BOM insertion point. A BOM node may be placed by manually entering the command
(at_border_addnode nodename nodelocation)

where: QRGHQDPH is the name of your node and QRGHORFDWLRQ is the XY coordinate that defines the node location with respect to the plant origin. Select Origin to place the BOM at the origin. By default, the origin is defined as (0,0), but you can enter new origin XY coordinates in the fields provided. Select By Pick 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 accomplished by 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 to have their own set of BOM format configurations.

CUddXU2?=2_bTUb@b_`UbdYUc
The format of the border, lines, text, column, etc. of a BOM that is placed on a drawing is stored in a BOM format configuration. The shipping version of the software provides several sample format configuration to choose from. These formats may be modified, or new ones created by pressing the Options button in the Bill of Materials dialog. The following procedure explains how to modify the properties of the border that will be drawn around the BOM placed on your drawing.

> D C
?

5DD85

2?=@

<135=5>D

5D8?4

! " # $ %

Select Reports/Bill of Materials to display the Bill of Materials dialog. Press Options to display the Bill of Materials Configuration dialog. Select the BOM format Configuration that you want to use/modify in the General tab. The properties of the border that surrounds the BOM are defined in the Border Properties area of the General tab. Enter the name of the layer where you want the BOM drawn in the Layer field. If this layer does not exist it 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 predefined 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 their corresponding names. Enter the desired thickness of the border lines in the Line Weight field in current units.
Reference Manual 9-15

&

B 2

5@?BDC

5>E

9<<?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 to have their own set of BOM format configurations.

CUddXU2?=8UQTUb@b_`UbdYUc
The format of the border, lines, text, column, etc. of a BOM that is placed on a drawing is stored in a BOM format configuration. The shipping version of the software provides several sample format configuration to choose from. These formats may be modified, or new ones created by pressing the Options button in the Bill of Materials dialog. The following procedure explains how to modify the properties of the Header text used to place a BOM on your drawing. Headers separate groups of objects in the report, such as Shop and Field.

> D C
?

5DD85

2?=@

<135=5>D

5D8?4

! " # $ %

Select Reports/Bill of Materials to display the Bill of Materials dialog. Press Options to display the Bill of Materials Configuration dialog. Select the BOM format Configuration that you want to use/modify in the General tab. 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 use to format the Header text in the Height, Spacing, and Style fields. Enter the desired line type in the Line Type field. This must be an AutoCAD name for a line with predefined 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 their corresponding names. Enter the desired thickness of the border lines in the Line Weight field in current units. 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 to have their own set of BOM format configurations.

& ' (

CUddXU2?=DYd\U@b_`UbdYUc
The format of the border, lines, text, column, etc. of a BOM that is placed on a drawing is stored in a BOM format configuration. The shipping version of the software provides several sample format configuration to choose from. These formats may be modified, or new ones created by pressing the Options button in the Bill of Materials dialog. The following procedure explains how to modify the Title that will be placed at the top of the BOM on your drawing.

> D C
?

5DD85

2?=@

<135=5>D

5D8?4

! " # $ % &

Select Reports/Bill of Materials to display the Bill of Materials dialog. Press Options to display the Bill of Materials Configuration dialog. Select the BOM format Configuration that you want to use/modify in the General tab. 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 use to format the Title text in the Height, Spacing, and Style fields. Enter the desired line type in the Line Type field. This must be an AutoCAD name for a line with predefined 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 their corresponding names.

9-16

AutoPLANT PIPING

B 2 ' ( )

5@?BDC

5>E

9<<?6

1D5B91<C

Enter the desired thickness of the border lines in the Line Weight field in current units. 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 to have their own set of BOM format configurations.

CUddXU2?=B_g@b_`UbdYUc
The format of the border, lines, text, column, etc. of a BOM that is placed on a drawing is stored in a BOM format configuration. The shipping version of the software provides several sample format configuration to choose from. These formats may be modified, or new ones created by pressing the Options button in the Bill of Materials dialog. The following procedure explains how to modify the properties of the text in the row of the BOM placed on your drawing.

> D C
?

5DD85

2?=@

<135=5>D

5D8?4

! " # $ %

Select Reports/Bill of Materials to display the Bill of Materials dialog. Press Options to display the Bill of Materials Configuration dialog. Select the BOM format Configuration that you want to use/modify in the General tab. 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 use to format the Row text in the Height, Spacing, and Style fields. Enter the desired line type in the Line Type field. This must be an AutoCAD name for a line with predefined 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 their corresponding names. Enter the desired thickness of the border lines in the Line Weight field in current units. 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 to have their own set of BOM format configurations.

& ' (

CUddXU2?=3_\e]^@b_`UbdYUc
The format of the border, lines, text, column, etc. of a BOM that is placed on a drawing is stored in a BOM format configuration. The shipping version of the software provides several sample format configuration to choose from. These formats may be modified, or new ones created by pressing the Options button in the Bill of Materials dialog. The following procedure explains how to modify the columns used to place a BOM on your drawing.

> D C
?

5DD85

2?=@

<135=5>D

5D8?4

! " # $

Select Reports/Bill of Materials to display the Bill of Materials dialog. Press Options to display the Bill of Materials Configuration dialog. Select the BOM format Configuration that you want to use/modify in the General tab. Click on the Column tab to display the properties used to format and select the columns that will appear in your BOM. In the Default Column Line group, 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 their corresponding names. Enter the desired thickness of the border lines in the Line Weight field in current units. Enter the relative length of dash-dot line types per drawing unit in the LT
Reference Manual 9-17

B 2

5@?BDC

5>E

9<<?6

1D5B91<C

Scale field. % The Name drop-down list includes the columns that will appear in your BOM. Press Organize to add or remove columns from the BOM. The fields shown in this dialog are defined configured in each configurations CONFIG.INI file in the [Reports] group. This list much match what is actually reported in 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 properties for each column in the BOM output. To configure a columns properties, select the column from the Name 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 you want the header text justified within the column header box from the Justification drop-down list. 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 their corresponding names. Enter the desired thickness of the border lines in the Line Weight field in current units. Enter the relative length of dash-dot line types per drawing unit in the LT Scale field. Enter the width of the column in the Width field. Press OK to save the format configuration settings. These settings are saved locally to enable each user to have their own set of BOM format configurations.

&

'

(

29<<?6=1D5B91<C3ECD?=9J1D9?>
8_g4_UcYdG_b[/
The following provides a brief overview of the process that the Bill of Materials function executes to generate and place a BOM on a drawing. The BOM function uses Seagate Softwares Crystal Reports run-time engine to process the component data that will appear in the report output. When you generate a BOM, the Drawing Selection Options dialog displays to enable you to define the selection set of components in the current drawing, or across multiple drawings (including xrefs). The BOM function extracts the component drawing database records defined in the selection set from the drawing databases into a temporary database. It then cleans this database, removing records 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 Crystal Reports) 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 actual fields that will appear in the BOM and how they will be presented (e.g., show pipe cut lengths as a total, or show individually). The report writer takes this data, along with the formatting options configured in the Bill of Materials configuration dialog, and generates a text file. This text file is formatted in a special way that is required by a LISP pre-processor that then actually draws the BOM on the drawing.

BU`_bd6Y\Uc
The Reports that are available for selection in the Bill of Materials dialog are configured to use a specific Crystal Reports (*.RPT) file to process the component data. You must purchase this software in order to generate 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 available for BOM output are defined in the >5HSRUWV@ group of each configurations CONFIG.INI file. This group controls 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 the field to the &ROXPQV variable assignment in that group.
9-18 AutoPLANT PIPING

B 7

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 the new RPT file to make it available in the Bill of Materials dialog.

75>5B1D5B5@?BDC
The Generate Reports option displays a dialog to enable you to generate a report that can be sent to the printer, a file, or pre-viewed in a separate window on-screen. You can select between default report types, or create unique reports that can be generated on the current drawing or on a project-wide basis. Options are provided to enable you to define the units, precision, and whether or not existing components are presented in the report output.

A description of the settings in each area of this dialog is provided below:

Reference Manual

9-19

B 7

5@?BDC

5>E

5>5B1D5

5@?BDC

B5@?BDDI@5
Four Report Types are available: BOM, EQUIPMENT LIST, NOZZLE TAKEOFF, and USER1. After selecting 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 Reports option will allow you to generate a Bill of Materials for more that one drawing if the Build Selection option is enabled. EQUIPMENT LIST: Generates a list of the equipment in the model (or the selection set). Can only be used to report on equipment that was generated using AutoPLANT EQUIPMENT. NOZZLE TAKEOFF: Generates a standard nozzle-takeoff schedule. Can only be used to report on nozzles that were placed using AutoPLANT EQUIPMENT.

Report Types may be added/modified in the following dialog that displays by pressing the Configure button next 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. Report Types are saved in RPTTYPE.INI in the format shown below.
>%20@ 'HVFULSWLRQ 5HSRUWVIRU%LOORI0DWHULDOV 7DEOH7\SH 3LSLQJ '%7\SH 3ODQW

This file contains a group record for each report type, which indicates the report type, a description that will appear in the Report Type drop-downlist, the table in the external drawing database that will be used, and the database type. Rebis provides pre-defined report types to generate reports based on data in the PIPING, EQUIP, and NOZZLE tables.

B5@?BD>1=5
The Report drop-down list enables you to select the report file that will be used to process the component data that will be presented in the generated BOM. The following BOM reports are provided with the software:
+

BOMCADCutLengths: uses the BOMCUTLN.RPT Report File to generate a BOM that lists cut-lengths of pipe 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 cut lengths individually, and sorts the remaining components in the report into shop and field components.

+ +

9-20

AutoPLANT PIPING

B 7
+

5@?BDC

5>E

5>5B1D5

5@?BDC

BOMCADMaintenance: uses the BOMMAINT.RPT file to generate a BOM that lists pipe cut lengths and all 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 the nearest 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 may be 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 to display the dialog shown below.

This dialog enables you to add Reports available for selection in the Report Generator dialog are defined in REPORTS.INI. This file contains a group record for each report type, which indicates the report type, the report 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. The options in the Report Name drop-down list is filtered based on the selected Report Type. The table below lists the default Report Names associated with each of the Report Types provided with the software. These represent the default set of reports only. You can easily create a new report name, and associate it with one of the Report Types, or create a new Report Type with an entirely new set of reports.
BOM BOMBRIEF BOMCUSTOM BOMCUTLENGTHS BOMDESIGNER BOMSFCUTLENGTHS BOMSTANDARD EQUIPMENT LIST EQUIPSTANDARD NOZZLE TAKEOFF NOZZSTANDARD

Reference Manual

9-21

B 7

5@?BDC

5>E

5>5B1D5

5@?BDC

B5@?BD69<5
This read-only field displays the path to the currently selected report name. The report files can be customized directly with the Crystal Reports application.

?@D9?>C
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). This value controls which components will be omitted from B.O.M. processing. Components whose sort order code is greater than this value are omitted from the BOM. 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.

Ignore Existing Components

Clean Database This option removes those fasteners that are no longer used for connecting components. For example if a pipe Fasteners is welded to an elbow and the elbow is removed but the weld is left, this action will remove the weld from the pipe. Previous Selection Material Tag Options Select this option to use the same selection set defined in your previous report-building session. This option is useful when applying the previous filter to a new drawing database or set of databases. The Material Tag Options button displays the dialog shown below to place material tags on the drawing whose group 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. When tagging attempts to create balloons for the tags in a PIPING drawing a warning message is issued, indicating that the material database tags have been updated only (no graphics will be generated). If you want to place material balloon tags in a PIPING drawing after a report has been generated, you may do so using the new Annotation/BOM Mark command. Material Tags The Tag Format option enables you to specify how you want the balloon material tags formatted. Two options are available. The Starting Tag Number text box enables you to explicitly define the starting number for material tagging of components. The Show Material Tags check box is only available when generating a report with AutoPLANT ISOMETRICS or AUTO-ISO. If enabled, the system will attach a material balloon tag to each component in the report selection set. 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 for component records in the external drawing database.

9-22

AutoPLANT PIPING

B 7

5@?BDC

5>E

5>5B1D5

5@?BDC

Reinsert Material Tags: Enable this option to automatically update existing material balloon tags that may have been 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. Append Topworks Description Append Pipe End Preparations Adds topworks description to the end of a valves description in a report.

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 are generated. This method is stored in ..\BASE\COMMON\BOMDESCR.EBS. Any component that does not have this method will inherit the default from the %$6(B&20321(176B&/$66. During BOM generation if the flags for appending topworks descriptions and pipe end code preparations are set in the user interface a temporary piping system variable is set and read by the script. The script will act on this variable as shown below for the pipe 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, for Imperial for example look in the file ..\CONFIG\IMPERIAL\PIPEENDS.INI.

Ascending When enabled, this option will list the components in the BOM in a ascending order using the SORT_CODE Sort_Code Order values. For example, the default pipe SORT_CODE=17, and the Weldneck Flange SORT_CODE=1. In the BOM, the Weldneck Flange will be listed first and pipe second because of the SORT_CODE values. If this option is not enabled, then the components will be listed in a descending order using the SORT_CODE values.

E>9DC@B539C9?>
Units Supress 0 Feet/Inches Precision Bore Precision 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. These options are read-only, and display the settings as set for by AutoCADs DIMZIN environment variable. Only the imperial (architectural) settings are currently honored. Refer to your AutoCAD documentation for more information. Select the level of precision to be used in the report. Allows you to select a different bore precision for mixed metric units ONLY.

?ED@ED
Select a radio button to define how the results of the report should be output. You can direct the report to appear in an on-screen viewing window (from which you can optionally print the report), to be sent directly to an 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 to define the selection set of components from the current drawing, or across multiple drawings, which will display in the report output. The user must then define the databases to be included in the report and to apply any filters as desired. >_dU Refer to the Generate Reports folder in the AutoPLANT Program Customization help file for customization information. This help file may be displayed by selecting AutoPLANT/Customization Tools and Help/AutoPLANT Program Customization from your Windows Start menu.

Reference Manual

9-23

B 7

5@?BDC

5>E

5>5B1D5

5@?BDC

B5@?BDC8?GD?D?@93C
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.

7U^UbQdUBU`_bdc
AutoPLANT includes an application called the Rebis Report Writer, which provides a powerful interface for generating and modifying reports.

> D 7
?

5>5B1D51

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 BOM report 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 in the 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 Build Selection option is enabled, the Drawing Selection dialog will display when Apply is pressed. This will enable you to create a query that filters the components in the current drawing (or across multiple drawings). If the Current Drawing option is selected (the default), a report will be generated based on all the objects in the current drawing. Select the desired Output. Preview will open a viewing window containing the report. From this window you can print the report if desired. Printer will send the report directly to the printer, while Export to File will permit you to create a file of user-specified type. After selecting the report type and name, determining the output type, and specifying the selection options, press Apply to begin generating the report. If the Build Selection option was enabled, the Drawing Selection dialog displays. If the Output was set to Preview, a window is opened which contains the selected report.

&

'

B5@?BD75>5B1D?B3ECD?=9J1D9?>
The Report Generator is a common AutoPLANT application that may be launched from any AutoPLANT applications Reports menu. It enables you to generate a report that may be output to a printer, file, or displayed on screen in preview mode.

8_g4_UcYdG_b[/
The following provides a brief overview of the process that the AutoPLANT Report Generator function executes to generate a report. The Report Generator function uses Seagate Softwares Crystal Reports run-time engine to process the component data that will appear in the report output. When you generate a report, the Drawing Selection Options dialog displays to enable you to define the selection set of components in the current drawing, or across multiple drawings (including xrefs). The Report Generator function extracts the component drawing database records defined in the selection set from the drawing databases into a temporary database. It then cleans this database, removing records for which components 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 Crystal Reports) which extracts the data from the temporary databases, and processes it using the selected Report file.

9-24

AutoPLANT PIPING

B 7

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 actual fields that will appear and how they will be presented and formatted in the report.

BU`_bd6Y\Uc
The Reports that are available for selection in the Report Generator dialog are configured to use a specific Crystal Reports (*.RPT) file to process the component data. You must purchase this software in order to generate 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.

BU`_bdDi`Uc
The Report Generator function enables you to setup report types, which enable you to group your reports by type. For example, you may have a set of reports that you use for a particular client. You could setup a new report type for that client. Then define a set of reports of that type. When you execute the Report Generator option, and select the new clients Report Type, only those reports that are defined of the clients Report Type will 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 any reports defined in REPORTS.INI that have their TYPE keyword set to BOM will generate the report based on data in the Piping table of the Plant (drawing) database.
>%20@ 'HVFULSWLRQ 5HSRUWVIRU%LOORI0DWHULDOV 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.

BU`_bd4UVY^YdY_^
This is an example of a report definition group configuration in REPORTS.INI. Each configuration has its own REPORTS.INI file, which resides in the root configuration directory. The 7\SH keyword indicates that the report type is defined in the >%20@ group in RPTTYPE.INI. The 6FKHPD keyword indicates that BOMSTAND.RPT is the Crystal Reports report definition file. The 6FKHPD1DPH and 'HVFULSWLRQ keywords indicate that Standard BOM Report is the report description. The 'UDZLQJ2XSXW keyword indicates that this report is available only for generating an external report and may not be placed on a CAD drawing.
>%206WDQGDUG@ 7\SH %20 6FKHPD 1HWZRUNB5RRW?5HSRUWV?ERPVWDQGUSW 6FKHPD1DPH 6WDQGDUG%205HSRUW 'HVFULSWLRQ 6WDQGDUG%20UHSRUWZLWKDFFXPXODWHGSLSHOHQJWKVIRUYLHZLQJSULQWLQJRUH[SRUWLQJWR DILOH 'UDZLQJ2XWSXW 1R

Reference Manual

9-25

B 7

5@?BDC

5>E

5>5B1D5

5@?BDC

B5@?BDC3ECD?=9J1D9?>8?GD?D?@93C
This area of the help system provides links to procedures to customize the AutoPLANT Report Generator.

1TT=_TYViQBU`_bdDi`U
A reports type is defined by the 7<3( keyword in the report definition group in REPORTS.INI. This keyword defines a group in RPTTYPE.INI that defines the table and database type from which the report data will be extracted. 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 Control table in the Plant database.

> D 1 =
? 44

?496I1

5@?BD

I@5

! " #

Select Reports/Generate Reports. Press Configure to display the Report Definitions dialog. The Report Type field in this dialog indicates the 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 Type drop-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 Type field. Type Report for Control Data in the Description field. Select All Plant Databases from the Database Type 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 from the Type field to view/modify the new report type record. This report type will now be available for selection from the Report Definitions dialogs Type drop-down list.
>&21752/537@ 'HVFULSWLRQ 5HSRUWVIRU&RQWURO'DWD 7DEOH7\SH &RQWURO 'E7\SH 3ODQW

$

%

3bUQdUQ>UgBU`_bd6Y\U
The Report Generator function uses Seagate Softwares Crystal Reports run-time engine to process the component data that will appear in the report output. You must purchase this software in order to generate a new 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, you should must create a new Report Definition and configure it to use the new RPT file to make it available in the AutoPLANT Report Generator dialog.

1TTQ>UgBU`_bd4UVY^YdY_^
Reports available for selection in the Report Generator dialog are defined in REPORTS.INI. This file contains a group record for each report type that indicates the report type, the report format file, and whether or not the report can be placed on a drawing or output as an external report. Rebis provides pre-defined reports to generate an external BOM, nozzle schedule, and equipment list. The following procedure explains how to add a new report type to report on the data in the Control Plant (drawing) databases table. >_dU This procedure assumes that you have previously created the CONTROLRPT type and the CTRLSTD.RPT report definition file as outlined in the previous two How To customization procedures.

9-26

AutoPLANT PIPING

B 7

5@?BDC

5>E

5>5B1D5

5@?BDC

> D 1 =
? 44

?496I1

5@?BD

569>9D9?>

! "

Select Reports/Generate Reports. Press Configure next to the Report Name field to display the Report Definitions dialog. The Report dropdown lists all report definitions that are currently defined for the type of report selected in the Type dropdown list. To modify a report definition, select the type of report from the Type drop-down list, then select the report definition from the Report drop-down list. Modify the Description and Report Definition File as desired. To add a new report definition to report on the Control Plant database table, select CONTROLRPT from the Type drop-down list. The Reports drop-down list is empty to indicate that no reports have been defined 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 for generation.

#

$ % & '

1TTQ=U^e3_]]Q^Td_7U^UbQdUQC`USYVYS5hdUb^Q\BU`_bd
In many instances, your organization may setup a standard set of reports that must be generated for each drawing. The DWBUSW function may be used to define menu commands to execute a specific reports of a specific types. The format of this function is as follows:
DWB5HSRUWBORDGDWB5SW5HSRUW1DPH

where 5HSRUW1DPH 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. The Reports/Equipment List command configures the Report Generator to generate the provided EquipmentList report. If you want to add a command to the menu to configure the Report Generator to generate this report, you would use the function as follows:
DWB5HSRUWBORDGDWB5SW(TXLSPHQW/LVW

Reference Manual

9-27

381@D5B

4B1G9>7@B?4E3D9?>=5>E

This chapter covers the Drawing Production menu options that enable you to create and save Work Areas and define and assign Views to these Work Areas, which may be applied in Paper Space to quickly generate section view drawings of the latest state of the Work Area drawings

OVERVIEW DRAWING SETUP WORK AREA SETUP WORK AREA VIEWS UPDATE WORK AREA

10-2 10-2 10-3 10-7 10-12

!
?F5BF95G

4 ?

B1G9>7

B?4E3D9?>

5>E

F5BF95G

The Drawing Production menu provides access to options that enable you to create and save Work Areas. A Work Area is simply a set of one or more xreferenced drawings. You may also define and assign Views to these Work Areas, which may be applied in Paper Space to quickly generate section view drawings of the latest state of the Work Area drawings The Drawing Production toolbar is available as a flyout toolbar from the main Piping Function toolbar, or may be displayed separately by selecting Toolbars/Function Toolbars/Drawing Production.

4B1G9>7C5DE@
The Drawing Setup function is a modified version of AutoCADs MVSETUP command. It enables you to move into Paper Space, select one of the pre-defined borders available for the current configuration, and place a title block on the user-configured sheet. To create and place viewports, we encourage you to utilize the Drawing Production/Work Area Views command. A general description of the operation of the Drawing Setup command is provided below.

> D C
?

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 a Layout tab). The Paper Space icon replaces the standard Model Space UCS icon to indicate that you are now 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 the default Imperial configuration below.

10-2

AutoPLANT PIPING

B1G9>7

B?4E3D9?>

= C

5>E

?B;

B51

5DE@

The title block drawings shown in this dialog are defined in the current configuration. In the configuration you can define the directory used to display the available border drawings. Select the desired 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 the current layout. Select File/Page Setup to display the Page Setup dialog. Click on the Plot Device tab and select your plotter. If you dont have a plotter installed, select one of the DWF plotter drivers supplied with AutoCAD. These plotter drivers provide a full set of imperial and metric sheet sizes. Click on the Layout 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 Views command. >_dU For more information on the use of Paper Space, refer to your AutoCAD documentation.

(

G?B;1B51C5DE@
The Work Area Setup command enables you to create and save Work Areas. A Work Area is simply a set of one or more xreferenced drawings. The dialog provides options to create new or open existing work areas and to select the drawings that will included in the work area. When the dialog is closed, the work area drawings will be xreferenced into the current drawing as you specify.

Reference Manual

10-3

B1G9>7

@ C

B?4E3D9?>

5>E

?B;

B51

5DE@

A description of the settings and buttons in this dialog are provided below.

G?B;1B51
To create a new work area, you must first press the New button and define the work area file. Next, enter a description of the new work area in the title field. Enter a description in this field when defining a new work area.

B565B5>354B1G9>7C
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. >_dU This utility now supports the specification of explicit network (UNC) paths for your referenced drawings. In general, most organization define drive letters for their network paths. This enables them to move an entire set of files from one network server to another network server without losing the pathing information as long as the same drive letter is defined on both servers. Other organizations may 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 named TEST.DWG, to add this drawing to the Work Area using a UNC path, simply select Network Neighborhood and then browse to the \\REBIS\MYDWGS directory and select the drawing. The path in 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 letter Z 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 paths are preferred when mapped drive letters are not consistent across work stations. Drive letter-based paths are preferred when standardized drive letters map to the same locations across work groups that will share work areas. The decision to use UNC paths vs. drive letter-based paths is based on your organizations preference.

If the current drawing has xreferenced drawings attached using either the Drawing Production utilities, or using AutoCADs 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 a drawing that is currently attached as an xref to the current drawing. This feature is provided to enable you to quickly add drawings that are attached as xrefs in the current drawing to the Work Area. If you select the Xref Drawing option, a dialog will display listing all xrefs currently attached to the current drawing. This dialog indicates the xref drawings file name, the attachment type, the path to the drawing, the insertion point used to attach the drawing, and the insertion angle specified. Simply select a drawing from the dialog and press OK to add 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 list of 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 would specify 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. You can attach directly to components or nozzles on xreferenced drawings and begin your routing from these shared points.

10-4

AutoPLANT PIPING

B1G9>7

B?4E3D9?>

= C

5>E

G >_dU

?B;

B51

5DE@

Drawings are referenced using AutoCADs XREF/Overlay command (as distinguished from the XREF/Attach command. Refer to your AutoCAD documentation for more information on these commands.

9>C5BD9?>@?9>D
The Insertion Point indicates where one drawing is placed in relation to the others. To define the insertion point for an xreferenced drawing, you must select the drawing in the Reference Drawings list, then enter the desired East, North, and Elevation coordinates in the fields provided. If an insertion point is not specified, the global origin (0,0,0) is assumed. To manually specify this point, press the Pick button. >_dU The insertion point is always relative to the current models Plant Orgin.

@93;
You can manually pick the insertion point for the drawing selected in the Reference Drawings area of the dialog. Select a drawing name in the Referenced Drawings list, then press Pick. The dialog temporarily closes to enable you to pick a point in the current drawing.

B?D1D9?>
The Rotation enables you to specify the angle at which the drawing will be inserted into the Work Area with respect to the Insertion Point. The Pick button may be pressed to manually define the desired rotation angle.

=5=25BC89@CD1DEC
The Membership Status determines the relationship between the current drawing and the referenced drawings as 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 referenced drawings, 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 Work Area is saved on a network directory where it can be shared, the current drawing becomes available to other users who select the same work area. Non-Member: When this option is selected, the referenced drawings are not visible inside the current drawing. Use this option to recall saved views or to place view ports in Paper Space using the Work Area View coordinates.

HB561DD138=5>DDI@5
If the current drawing has xreferenced drawings attached, using either the Drawing Production utilities, or using AutoCADs 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 a drawing that is currently attached as an xref to the current drawing. This feature is provided to enable you to quickly add drawings that are attached as xrefs in the current drawing to the Work Area. If you select the Xref Drawing option, a dialog will display listing all xrefs currently attached to the current drawing. This dialog indicates the xref drawings file name, the attachment type, the path to the drawing, the insertion point used to attach the drawing, and the insertion angle specified. Simply select a drawing from the dialog and press OK to add it to the Work Area. If the drawing already exists in the Work Area nothing will be done here.

Reference Manual

10-5

B1G9>7

@ C

B?4E3D9?>

5>E

?B;

B51

5DE@

>5G
Press New to create and name a new Work Space file. A file selection dialog is displayed. Name the file, and save 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 be shared in a network environment. To allow other users to add drawing to (or remove them from) the Work Area, the file must be stored on a shared network drive.

?@5>
Press Open to load saved settings from an existing *.RWA (Rebis Work Area) file.

C1F5
Press this button to save changes made to existing *.RWA files. The directory path where this file is saved will be saved with your drawing. In the same manner that you can use explicit (UNC) network paths to add drawings to the work area, you can specify explicit network paths to define the location for this file.

C1F51C
Press Save As to save the current Work Area file under a new name or in a new location. You must retain the RWA file extension.

3<?C5
Closes the Work Area Setup dialog. Prompts you if there are any unsaved changes.

31>35<
Closes the Work Area Setup dialog without saving changes.

10-6

AutoPLANT PIPING

B1G9>7

B?4E3D9?>

= F

5>E

?B;

B51

95GC

G?B;1B51F95GC
The Work Area Views dialog lists the views associated with a Work Area, and enables you to edit and create new views.

A description of the options available in this dialog is provided below:

3EBB5>DG?B;9>71B51
Lists the current Work Area. Initially, the dialog opens with the last active Work Area. To select a different Work Area, press the Browse button.

144
Opens the View Properties dialog for the definition of a new Work Area View.

B5=?F5
Removes the currently highlighted Work Area View from the list of those associated with the Work Area.

G9>4?G
Lists the drawings which have been added to the current Work Area.

549D
Opens the View Properties dialog with the properties of the currently highlighted Work Area View.

Reference Manual

10-7

B1G9>7

@ F

B?4E3D9?>

5>E

?B;

B51

95GC

3?@I
Creates a copy of the selected View. A dialog is displayed in which to input a new name. You can then Edit the copied view to create a new one.

9>C5BD1@@<I9>=?45<
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 the model using the defined View Properties . This allows several drawings to share a Work Area view. If a drawing is joined to the Work Area as a Guest or Member, xreferenced drawings are displayed in the view. If joined as a Non-member, the viewing planes defined in the Work View are used, but the referenced drawings are not visible.
7LOHPRGH 3DSHU6SDFHZLWKRUZLWKRXWIORDWLQJYLHZSRUWV

When Tilemode=0, the button reads Insert in Drawing. Press the Insert button to place a scaled, tiled viewport into the drawing. The viewport is inserted at the scale specified from the View Properties dialog.

@B5F95G
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 an isometric 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 in Drawing is pressed may be from a Plan or an Elevation perspective (according to the setting in the View field of the View Properties dialog. >_dU When Tilemode=0, the Preview option is grayed-out (disabled).

1ED?J??=
When Tilemode=1, the Auto Zoom option becomes available. Enable Auto Zoom to automatically zoom out to create enough space to place a new viewport in Paper Space. For example, suppose you are zoomed in to a tight area of Paper Space and are placing a viewport which would normally extend beyond the boundaries of the current zoom factor. If this option is enabled, AutoPLANT will automatically zoom out to create enough space for you to place the new tile. >_dU The Auto Zoom option is not available in Model Space.

10-8

AutoPLANT PIPING

B1G9>7

B?4E3D9?>

= F

5>E

?B;

B51

95GC

F95G@B?@5BD95C
The properties of Work Area Views are defined in the dialog shown below. Fields are provided to define the coordinates of a three-dimensional box. A side of the box is selected for projection in the view. Objects that lie outside the boundaries of the box may be clipped from the view. Settings are also available for determining 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.

>_dU

When specifying the properties of a view, you must be in Model Space. Additionally, if you will be manually picking points in the model to define coordinate locations, you must be in Plan view.

FYUgDYd\U
The name of the view being defined/edited. This name will appear in the view list in the Work Area Views dialog.

FYUg
This setting determines the orthogonal projection (the side of the box) which is associated with the saved view. The selected view is highlighted in red in the tile to the left. The coordinates of the box itself are defined in the 3D Envelope section of this dialog.

CSQ\U
The Scale of the view port. The selection list displayed is based on your current drawing units settings (i.e., if your drawing units is set to Architectural, then Architectural scales will appear in the selection list.
Reference Manual 10-9

B1G9>7

@ F

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 of available scales, or select By Window to manually create an UNSCALED viewport in Paper Space. If you select 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.

@b_ZUSdY_^DY\U
The graphic shown in the window illustrates the orthogonal projection plane indicated by the selected View.

FYUg?`dY_^c
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 both this option and the Viewport Visibility option is enabled, there will be two bounding boxes around the viewport when it is placed in Paper Space. Coordinates: Controls whether plant coordinates are displayed around the viewport. These coordinates are relative to the current viewport, and specify the coordinates from which the view was cut. The coordinate 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 AutoCAD viewports (global). Note that if both this option and the Match Line option are enabled, there will be two bounding boxes around the viewport when it is placed in Paper Space.

+ + +

=QdSX<Y^U?`dY_^c
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 press OK. >_dU These settings do not effect Work Area Views applied in Model Space.

#4FYUg5^fU\_`U
The coordinates specified in this area of the dialog define the clipping planes of a three dimensional box. The box defines the objects that are included in the view. The View selection determines the orthogonal projection from which the view is created. The Coordinate System setting is provided to enable you to specify views based on the Plant coordinate system that you defined when you created this drawing, or based on some user-define UCS. The coordinate system that you want to use in defining a view is displayed to the right of the Coordinate System button. The default coordinate system is the World coordinate system. Press the Coordinate System button to display a dialog to change the coordinate system. The First Point and Second Point fields determine the opposite corners of a single clipping window. You can manually 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
10-10 AutoPLANT PIPING

B1G9>7

B?4E3D9?>

= F

5>E

?B;

B51

95GC

the East and North coordinates in both the First Point and Second Point fields. The command works by allowing for the selection of opposite corners of a window. When manually picking points, you MUST BE IN PLAN VIEW. The Elevation fields determine the top and bottom clipping planes. These values are ALWAYS world Z coordinates. 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 of elevation Views (Front, Back, Left, Right).

?;
Press OK to apply an editing changes you have made to the saved view (the View Title).

3Q^SU\
Press Cancel to discard any changes you have made to the saved view (the View Title).

5TYdCSQ\Uc
This dialog displays when you press the Edit button next to the Scale field in the View Properties dialog. This dialog is provided to enable you to add/modify the available scales for each AutoCAD units setting. The scales displayed in the view properties dialog are filtered based on the current drawing AutoCAD Units setting.

To display a list of scales defined for a particular drawing unit, simply click the the units.

symbol to the left of

To modify a scale, select it from the list, then modify its Scale Text and Scale Value settings. The Scale Text is the label that will appear to select the scale in the View Properties dialog, while the Scale Value is the desired scale. To add a new scale, first select the units type that you want to add a scale for, then press Add. Enter the label 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.

Reference Manual 10-11

4 E

B1G9>7

B?4E3D9?>

5>E

@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 to another. For example, if you want to copy all of the scales defined in the DECIMAL group to the ENGINEERING group, simply select the ENGINEERING group in the left pane, then enable the Copy From Scale radio button, then select DECIMAL from the drop-down list. This will replace the existing ENGINEERING scales by copying all of the scales defined in the DECIMAL group, which may then be modified.

3__bTY^QdUCicdU]
This setting is provided to enable you to specify views based on the Plant coordinate system that you defined when you created this drawing, or based on some user-define UCS. The coordinate system that you want to use in defining a view is displayed to the right of the Coordinate System button. The default coordinate system is the World coordinate system. Press the Coordinate System button to display the following dialog to change the coordinate system.

If you want to define a view based on the Plant coordinate system that you assigned when you created the drawing, press the Plant button. The Origin and X/Y Axis points for this coordinate system will display in the dialog and may be modified. If you want to define a view based on a UCS, you should first set the UCS, then execute the Drawing Production command and access this dialog to change the desired coordinate system to UCS. You may modify 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 points previously defined for the view will be modified to reflect the selected coordinate system.

E@41D5G?B;1B51
This function applies any changes made to your current work area (if a work area has been defined for the drawing), bypassing the work area definition dialog.

10-12

AutoPLANT PIPING

381@D5B

"4D?#4=5>E

!!

This chapter covers the 2D to 3D component mapping functionality between Rebis AutoPLANT P&ID drawings and AutoPLANT PIPING

OVERVIEW PROCESS OVERVIEW SET PROJECT BROWSE/INSERT COMPONENTS PREFERENCES

11-2 11-2 11-5 11-6 11-7

!!
?F5BF95G

"4 ?

D?

#4 =


5>E

F5BF95G

2D to 3D component mapping functionality is provided between Rebis AutoPLANT P&ID drawings and AutoPLANT PIPING. PIPING and/or EQUIPMENT provide the following options. Click on an option to display its help.

@B?35CC?F5BF95G
In order for the 2D to 3D functionality to operate you must have access to an AutoPLANT 2D project. The 2D to 3D functionality provided in PIPING and EQUIPMENT is basically accomplished via a series of mappings defined in external text files. These mappings enable the system to accurately map an AutoPLANT P&ID component to its AutoPLANT PIPING equivalent. If you are familiar with the customization of the P&ID system, you will understand that what this functionality actually accomplishes, on the most general level, is a mapping of a P&ID components key to a PIPING component class. >_dU 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 for translation 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 provided on a class category basis. Configuration dependent (e.g. Imperial vs. Metric) field value mappings on either a field name only basis or a class 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) >_dU Value mapping is configuration dependent primarily because of different units settings per configuration. 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 PIPING drawing via the 2D to 3D insert function.

D85=1@@9>7@B?35CC
The following briefly describes the order in which the INI files are referenced to implement the mapping of a 2D 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 dialog based on the selected option. The user selects a 2D item from the dialogs navigation tree, then presses OK. This returns the selected items 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 by referencing 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 referenced to 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.

=1@@9>769<5C
To implement this process, four (4) external text files are used. A brief description of each of these is provided below:
11-2 AutoPLANT PIPING

"4 @

D?

#4 =


5>E

B?35CC

F5BF95G

3<1CC=1@9>9
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:
>'FODVVFDWHJRU\!@ 'FODVVQDPH! 'FODVVQDPH!

Where valid values for 'FODVVFDWHJRU\! include: InLine, Process, Instruments, Equipment, and Nozzles >_dU Examples:
>,Q/LQH@ %$// $7B9$/9(B%$// &%$// $7B9$/9(B%$// >,QVWUXPHQWV@ &9$/9( $7B9$/9(B&17/ 025,) $7B25,) >1R]]OHV@ $7B12==/(

Including the wildcard character, "*", for <2D class name> indicates that all classes of the given category map to the indicated 3D class name.

@946<49>9
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 a 2D field to a 3D field, if a field value is not present for a given 3D field in the 2D database and another 2D field exists that maps to the same 3D field, the second (and subsequent) fields are examined until a value is found. Therefore, 3D field names should be listed in order of precedence. For example, in the InLine sample below, 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 field names that are present in the 2d3d.ini file (see below) will have their values mapped from 2D to 3D according to the values in the 2d3d.ini mapping file. All other field values are copied verbatim. Nozzles must be scoped to either Piping or Equipment because these systems have different implementations of nozzles. This is accomplished by suffixing the "Nozzles" INI group name with either ".Piping" or ".Equipment". Format:
>'FRPSRQHQWW\SH!@ 'ILHOGQDPH! 'ILHOGQDPH!

Where valid values for 'FRPSRQHQWW\SH! include: InLine, Process, Instruments, Equipment, and Nozzles

Reference Manual

11-3

!!

"4 @

D?

#4 =


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]]OHV3LSLQJ@ 7$*B12 7$*180%(5

"4#49>9
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 or procedurally. Only fields listed here will be mapped. Fields not listed here will be copied verbatim from 2D to 3D. For procedural mapping, the name of the conversion script and function must be specified. The script conversion function retrieves the string parameter which represents the 2D value to be mapped/converted by calling DWB6FULSW%XIIHUBJHW6WULQJYDOXH7R0DS0$33('B9$/8(. The converted 3D value is set in the script conversion function by calling DWB6FULSW%XIIHUBSXW6WULQJPDSSHG9DOXH0$33('B9$/8(. Format 1 - Explicit field value mapping:
>'ILHOGQDPH!@ 'ILHOGYDOXH! 'ILHOGYDOXH!

Format 2 - Procedural field value mapping:

>'ILHOGQDPH!@ &RQY0HWKRG %$6,&VFULSWFRQYHUVLRQILOH!%$6,&VFULSWFRQYHUVLRQIXQFWLRQ!

Examples:
,PSHULDOFRQILJXUDWLRQLQ1(7:25.B5227?FRQILJ?,PSHULDO?GGLQL >120,1$/@       >7(03(5$785(@ &RQY0HWKRG &RQYHUWHEV&RQYHUW'HJUHHV 0HWULFFRQILJXUDWLRQLQ1(7:25.B5227?FRQILJ?0HWULF?GGLQL >120,1$/@  PP  PP  PP >7(03(5$785(@ &RQY0HWKRG &RQYHUWHEV&RQYHUW&HOVLXV

11-4

AutoPLANT PIPING

"4

D?

#4 =

5D

5>E

C @

B?:53D

@94@B569>9
File name: %NETWORK_ROOT%\xchg\pid\pidpref.ini Description: Used to specify 2D component specific drawing preference 3D field names. 3D field names listed in this file are grouped by 2D component type. at_2dTo3d_setPrefs and at_2dTo3d_setPref reference these field names for a given 2D component type to set the piping system variables if no fields are explicitly passed to these functions. Format:
>'FRPSRQHQWW\SH!@ 'GUDZLQJSUHIHUHQFHSLSLQJV\VWHPILHOGQDPH!

Where valid values for 'FRPSRQHQWW\SH! include: InLine, Process, Instruments, Equipment, and Nozzles >_dU Examples:
>3URFHVV@ /,1(180%(5 120,1$/ 63(&

An equal sign = must proceed the field name.

C5D@B?:53D
The 2D to 3D/Set Project option displays the dialog shown below. The function initially will try to locate your 2D projects automatically and display them for selection. If these projects cannot be found, a Browse button is provided to enable you to navigate to and select the desired 2D project.

>_dU

In general, the system will locate 2D projects if they exist on the same workstation as the 3D system running 2D to 3D.

To enable a project, select it from the list and then press OK, or press Browse to navigate to and select the desired 2D project.

Reference Manual

11-5

!!

"4 2

D?

#4 =


5>E

B?GC5

9

>C5BD

?=@?>5>DC

2B?GC59>C5BD3?=@?>5>DC
The ../Browse and ../Insert submenus under the 2D to 3D menu in PIPING and EQUIPMENT provide a set of options that enable you to filter the active 2D project component information available to view/insert from the dialogs navigation tree as illustrated below. You must initialize a 2D project using the Setup Project/2D to 3D command before this command will operate.

The primary difference between the Browse and Insert dialogs is the functionality of the OK button. If this dialog is displayed from a Browse menu selection, the OK button will simply close the dialog. If displayed from an Insert menu selection, the OK button will prompt you to insert the currently selected item in the dialogs navigation tree. The Browse option on the dialog expands the dialog to display two tabs, which provide specific information about the item selected in the navigation tree. The View tab uses AutoDESK Volo View Express to display the current drawing. An option to install this application separately is provided on your CD.

11-6

AutoPLANT PIPING

"4

D?

#4 =


5>E

B565B5>35C

@B565B5>35C
The 2D to 3D/Preferences option is available in the PIPING application ONLY. This option displays the dialog 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 2D button. You will be prompted to select a 2D component from the navigation tree to apply the setting. The settings from the selected component will appear in the dialog after selected. Press Done when you are finished to begin placing PIPING components using these settings.

Reference Manual

11-7

381@D5B

?D85B3?==1>4C6E>3D9?>C

!"

This chapter covers other PIPING commands and/or functions that may or may not be available for execution from the menu or toolbars.

SCRIPTING TOOLS MENU SPECIFICATION SELECTION DIALOG DRAWING NODES AND DRAWING BORDER CUSTOMIZATION SPECIFICATION SELECTION ERROR SPECIFICATION VALIDATION DRAWING SELECTION OPTIONS

12-2 12-2 12-3 12-3 12-4 12-6

!"

? C

D85B

?==1>4C

6

E>3D9?>C

3B9@D9>7 ??<C

5>E

C3B9@D9>7D??<C=5>E
The Scripting Tools menu provides a number of options to simplify the customization of the AutoPLANT Basic commands and functions. A description of each of these options is provided below:

<?14
Displays a file selection dialog. Select an existing script (*.EBS), then press OK to load it. Any functions defined in the script can then be executed with the Basic Scripts/Execute command.

E><?14
Unloads a script that has already been loaded. The command line will prompt for the name of the script. Type the filename, then press Enter.

5H53ED5
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.

452E7
Turns on a debugging mode for detecting errors in a user-defined function contained in a Basic Script.

C@5396931D9?>C5<53D9?>491<?7
When you attempt to place a component in which there are more than one specification records that matches the search critera, a Specification Selection dialog as shown below will display. This dialog lists all records that match the current search criteria to enable you to select the specification record that you want to use to draw the component.

Select the desired record, then press OK to place the component.

12-2

AutoPLANT PIPING

? 4
B1G9>7

D85B

?==1>4C

6

E>3D9?>C

>

?45C1>4

B1G9>7

?B45B

ECD?=9J1D9?>

4B1G9>7>?45C1>44B1G9>72?B45B3ECD?=9J1D9?>
Border nodes are special points associated with the border, such as the location of the north arrow in an Isometrics drawing. These nodes are used by the AutoPLANT application for default placement of information with respect to the border. The border editor provides a user interface allowing the user to manipulate border nodes. To execute the border editor feature enter the following command at the AutoCAD command line:
DWB%RUGHUBHGLW1RGHV

A dialog displays that enables you to display, add, move, rename and delete border nodes existing in the currently opened border drawing. This feature can only be executed with the AutoPLANT module loaded and when a border drawing has been inserted into the drawing. This feature can also be run inside Piping or Isometrics once a border is inserted into the Piping or Isometric drawing. Once the user has edited the border nodes, he should save the border drawing. The default set of AutoPLANT borders each contain four border nodes:
AT_NORTH_ARROW BOM-PT AISOLL AISOUR for placement of the north arrow in an Isometric drawing for placment of the bill of materials Lower left corner of the Auto Isometrics boundary Upper right corner of the Auto Isometrics boundary

C@5396931D9?>C5<53D9?>5BB?B
A dialog similar to the one shown below will appear when you attempt to place a component that does not have a record in the selected specification that matches the defined search criteria. It is provided to enable you to determine the reason a particular component record was not available. You can either add a record to the 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 CS150 does 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 was used as the search criteria to find the component record.

Reference Manual

12-3

!"

? C

D85B

?==1>4C

6

E>3D9?>C

@5396931D9?>

1<941D9?>

C@5396931D9?>F1<941D9?> F1<941D9?>
In AutoPLANT, a components SYS_ID field value is used when the system needs to re-read data from the specification or component data that is neither stored in the model or the external drawing database. If a specification record has been manually deleted, or has been copied using some other third party application instead 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 was copied from the catalogs into the specs, using the Spec Generator application. This process generates a unique SYS_ID field value for each spec record. If a third party application such as Microsoft Access is used to copy spec records, then the SYS_ID field in the spec records will be duplicated and basically rendered useless. In addition, if an existing component was placed using a specification record that has since been deleted, 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 place dimensions some of the data that is currently only stored in the spec is required. If the spec item cannot be found an undetermined dimension will result, possibly zero. You may turn OFF automatic Spec validation in your configuration by disabling the Spec Validation check box on the System dialog, either by using the Configuration Editor or editing the appropriate configuration file, 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 to reflect these changes.

C@53B5@19B
The following procedure explains how to repair your specifications. 1. 2. 3. Start the Spec Generator application from the AutoPLANT/SpecGen program group in your Windows Start menu. Select Tools/Repair SYS_ID. 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 you enable the Include subdirectories radio button. This function scans the selected specs and repairs duplicate IDs by providing replacement SYS_IDs.

31D1<?7B5@19B
The following procedure explains how to repair your catalogs. This procedure should be run on catalogs generated using third party applications (e.g., Microsoft Access). 1. 2. 3. Start the Spec Generator application from the AutoPLANT program group in the Windows Start menu. Select Tools/Repair SYS_ID. Enable the Catalogs radio button from the dialog displayed, then use the Browse button to select the catalog(s) that need to be repaired. This application can scan multiple catalogs from the root directory selected if you enable the Include subdirectories radio button. This function scans the selected catalogs and repairs duplicate IDs by providing replacement SYS_IDs. It also generates and propagates the SYS_ID, COMP_IDX, PIECEMARK fields if your catalog was generated using a third party application.

12-4

AutoPLANT PIPING

D85B

?==1>4C

6

E>3D9?>C

@5396931D9?>

1<941D9?>

>?D5CG1B>9>7C
If the Spec radio button is enabled, and a catalog is selected, then only the SYS_IDs entries in the catalog will be repaired. If the Catalog radio button is enabled, and a spec is selected, then the application will abort.

4B1G9>7B5@19B
Once your specs have been repaired, you can repair affected drawings by opening each drawing. When the drawing is opened for the first time, AutoPLANT will ask if you want to attempt to repair the references to the drawing spec data. Press Yes if you want this function executed automatically, or press No if you want to execute this command later. If you pressed Yes the system will process all of the components in the current drawing to determine if any need to be repaired. If components are found that need to be repaired, the following 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 the AutoCAD command line to process the components and display the dialog shown above. Once the drawing has 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 spec records SYS_ID, but using the WHERE CLAUSE, it found a single instance that should be the correct spec record. You should check this entry in your spec to ensure that the new record that will replace the original record is the spec record that you expected. Selectable SysID using Where Clause: This indicates that the system could not find the original spec records SYS_ID, but using the WHERE CLAUSE, it found multiple records that could be the correct spec record. 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 this component could no longer be found using the same WHERE CLAUSE. You should add the spec record for this component (i.e., it may either have been deleted accidently, or modified to no longer match the WHERE CLAUSE).

If you want to view an affected component, select it in the dialog list, then press Go To. To repair a component, 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 AutoCAD command line. Before you can execute this function, you must have scanned the drawing by either pressing Yes from the initial dialog that displayed when you opened the drawing, or by manually running the AT_SPEC_SCAN function. You must Save the drawing after performing updates if you want these changes to take effect.

Reference Manual

12-5

!"

? 4

D85B

?==1>4C

6

E>3D9?>C

B1G9>7

5<53D9?>

@D9?>C

If a drawing has been scanned and saved, the automatic detection will be disabled. For example, if you repair a drawing, then add a number of components, then come back to the drawing later and want to ensure that it is synchronized with the spec, you should manually run the AT_SPEC_SCAN function to check the consistency of the entire drawing again.

4B1G9>7C5<53D9?>?@D9?>C
AutoPLANT applications use a common tool to enable you to define a selection set of components based on a user-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 this dialog, you can define the selection set of components that will be processed by the command. You can select All the components in the current drawing, Manually pick individual components, or use the Advanced option to filter one or more drawings for components that contain user-specified attributes.

>_dU

In AUTO-ISO, the Run Auto-Iso command will display this dialog only if you have opened a PIPING drawing prior to executing the command. If you do not have a PIPING drawing open, the command will jump to the dialog that displays when you enable the Advanced and Multiple Drawing Selection options in this dialog.

A more detailed explanation of each of these options is provided below:

1<<
Selects all components in the current drawing.

=1>E1<
Closes the dialog and enables you to manually select components in the model. You can select components individually, or use AutoCADs Window, Fence, Crossing, etc. qualifiers to build a selection set.

14F1>3543EBB5>D4B1G9>7
When you select the Advanced option and do NOT enable the Multiple Drawing check box in the Drawing Selection Options dialog, the Component Update Selection dialog displays as shown below. This method is used to define a selection set of components in the current drawing based on its component's drawing database field values, or AutoCAD color/layer attributes.

12-6

AutoPLANT PIPING

D85B

?==1>4C

6

E>3D9?>C

B1G9>7

5<53D9?>

@D9?>C

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

4_]QY^
Two domains are available: User and Project. The User option displays a list of queries that have been saved on the users local drive, while the Project domain displays a list of queries that have been saved on the network drive, and are therefore available to all members of a project. These definitions are saved in separate QUERIES.INI files.

CU\USd5^dUb
Saved query definitions can be selected from this list. Once a named query is selected, the remaining areas of the 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 to simply 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 new query without saving.

Di`U
Select the type of database being queried from this selection list. The default, Piping Data, will populate the Attribute Field selection list (below) with the fields of the drawing database. The other option, Drawing, will enable you to select objects which share an AutoCAD color or layer name.

1ddbYRedU6YU\T
This selection list is populated with attributes, which may be queried on for the current selection set. If the Type field (above) is set to Piping Data, then the selection list contains attributes from the drawing database. If set to Drawing, the attributes will include COLOR and LAYER.

3_^cdbQY^d
Reference Manual 12-7

!"

? 4

D85B

?==1>4C

6

E>3D9?>C

B1G9>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:
= LIKE The attribute value must be EQUAL TO the user-specified query value. 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 SQL documentation 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.

< <= > >= !=

1ddbYRedUFQ\eU
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. The system will search the selected drawing(s) for all unique values of the current Attribute Field to propagate this dialog list.

Ths dialog lists unique records for the current Attribute Field. For example, if the Attribute Field is set to LINENUMBER 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 the Shift key and then select the first and then last entry to select a group of entries. If multiple entries are selected, 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. For example, if you have a large drawing that has hundreds of line number and only want to select from line numbers that begin with the characters L2, you can filter the display of line number entries in this dialog by entering L2% in the Filter List Content field, then pressing Reselect. The "%" implies a wild card of any number of characters. You may also use the underscore character "_" to imply a wild card of any single character.
12-8 AutoPLANT PIPING

D85B

?==1>4C

6

E>3D9?>C

B1G9>7

5<53D9?>

@D9?>C

?`UbQd_b
The operator is associated exclusively with defining a complex query. For example, after defining the first query, press Add-> from the Active Query group box. Next, highlight the CONSTRAINT= line in the Active Queries window. You can now define an additional query, select an Operator, then press Add to build a complex 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 Exclusive constraint. OR Components which meet at least ONE of the conditions are included in the selection set; this is known as an Inclusive constraint.

1SdYfUAeUbYUc
This area of the dialog lists the queries that have been defined. Queries can be added to this list by defining them in the Define Query area of the dialog, then pressing the Add-> button. For each query, the following information is displayed:
+ +

Type: Piping Data or Drawing Constraint: The expression which defines the search. >_dU Because the drawing name is not associated with this type of query, you can save it and use it again with any other drawing.

GY^T_gCU\USdY_^
Enable this dialog to further restrict the query by manually selecting components in the current drawing. For example, you can specify a filter, enable this option, then press OK. AutoPLANT then asks you to select components in the drawing. Only those objects which match the criteria of the query AND exist within the manual selection set will be returned. >_dU This option is available ONLY for the current drawing. You cannot window-select objects in an XREFed drawing.

9^S\eTUHB56c
Enable this option to include XREFed drawings in the current query.

CQfU
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
Reference Manual 12-9

!"

? 4

D85B

?==1>4C

6

E>3D9?>C

B1G9>7

5<53D9?>

@D9?>C

future use. A dialog will display asking you to confirm that you would like to overwrite the existing definition. >_dU To create a new query, press New from the Select Components dialog.

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

4U\UdU
Press this button to delete the current query.

12-10

AutoPLANT PIPING

D85B

?==1>4C

6

E>3D9?>C

B1G9>7

5<53D9?>

@D9?>C

14F1>354=E<D9@<54B1G9>7
When you select the Advanced option and enable the Multiple Drawing check box in the Drawing Selection Options dialog, the Component Update Selection dialog displays as shown below. This method may be used to define a selection set of components across multiple drawings based on their drawing database field values, or their AutoCAD color/layer attributes.

>_dU

In AUTO-ISO, the Run Auto-Iso command will instantly display this dialog only if you have NOT opened 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 you want to define your selection set for the current/multiple drawings.

A description of the options in this dialog is provided below:

4_]QY^
Two domains are available: User and Project. The User option displays a list of queries that have been saved on the users local drive, while the Project domain displays a list of queries that have been saved on the network drive, and are therefore available to all members of a project. These definitions are saved in separate QUERIES.INI files.

CU\USd5^dUb
Saved query definitions can be selected from this list. Once a named query is selected, the remaining portions of 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 to simply 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 without saving.
Reference Manual 12-11

!"

? 4

D85B

?==1>4C

6

E>3D9?>C

B1G9>7

5<53D9?>

@D9?>C

1TT4bQgY^Wc
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 areas of the dialog described below.

Di`U
Select the type of database being queried from this selection list. The default, Piping Data, populates the Attribute 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.

1ddbYRedU6YU\T
This selection list is populated with attributes, which may be queried on for the current selection set. If the Type field (above) is set to Piping Data, then the selection list contains attributes from the drawing database. If set to Drawing, the attributes will include COLOR and LAYER.

3_^cdbQY^d
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 SQL documentation 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.

1ddbYRedUFQ\eU
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 the Select Attribute Value dialog shown below. to select one or more from

12-12

AutoPLANT PIPING

D85B

?==1>4C

6

E>3D9?>C

B1G9>7

5<53D9?>

@D9?>C

Ths dialog lists unique records for the current Attribute Field. For example, if the Attribute Field is set to LINENUMBER 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 the Shift key and then select the first and then last entry to select a group of entries. If multiple entries are selected, 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. For example, if you have a large drawing that has hundreds of line number and only want to select from line numbers that begin with the characters L2, you can filter the display of line number entries in this dialog by entering L2% in the Filter List Content field, then pressing Reselect. The "%" implies a wild card of any number of characters. You may also use the underscore character "_" to imply a wild card of any single character.

?`UbQd_b
The operator is associated exclusively with defining a complex query. For example, after defining the first query, press Add-> from the Active Query group box. Next, highlight the CONSTRAINT= line in the Active Queries window. You can now define an additional query, select an Operator, then press Add to build a complex 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 Exclusive constraint. OR Components which meet at least ONE of the conditions are included in the selection set; this is known as an Inclusive constraint.

Reference Manual 12-13

!"

? 4

D85B

?==1>4C

6

E>3D9?>C

B1G9>7

5<53D9?>

@D9?>C

1SdYfUAeUbYUc
This area of the dialog lists the queries that have been defined. Queries can be added to this list by defining them in the Define Query area of the dialog, then pressing the Add-> button. For each query, the following information is displayed:
+

Document: Each query condition is associated with a specific drawings that you added in the Add Drawings area of this dialog. The Active Queries window displays the full path to the drawing associated with each query. Type: Piping Data or Drawing Constraint: The expression which defines the search. >_dU To define the same query for multiple drawings, highlight the desired drawings in the Add Drawings area of the dialog, define the query, then press Add. Multiple entries will be written into the Active Queries window.

+ +

CQfU
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 for future use. A dialog will be displayed asking you to confirm that youd like to overwrite the existing definition. >_dU To create a new query, press New from the Select Components dialog.

>Ug
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 the Query field.

4U\UdU
Press this button to delete the current query.
12-14 AutoPLANT PIPING

D85B

?==1>4C

6

E>3D9?>C

B1G9>7

5<53D9?>

@D9?>C

4569>9>71C5<53D9?>C5D
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 a selection set based on desired component attributes. This area provides procedures that explain how to perform common drawing selection tasks.

CU\USd1\\dXUS_]`_^U^dcY^dXUSebbU^dTbQgY^W

> D
! " #

?C5<53D1<<3?=@?>5>DC9>D853EBB5>D4B1G9>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.

=Q^eQ\\icU\USdS_]`_^U^dcY^dXUSebbU^dTbQgY^W

> D
! " # $

?=1>E1<<IC5<53D3?=@?>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 AutoCADs Window, Fence, Crossing, etc. qualifiers to group-select objects. Press Enter when finished to build the selection set. The command is executed on the selected components.

4UVY^U]e\dY`\UTbQgY^WaeUbYUc

> D
! " # $ % &

?3B51D5169<D5B21C54?>=E<D9@<54B1G9>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 Drawing Selection check box, then press OK. The Advanced Selection dialog displays (the title on this dialog is determined by the command selected in Step 1). From the Select/Enter field, select the pre-defined query definition that most closely matches the type of query 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 of drawings available to the query. >_dU If the drawings exist in the same directory, you can use Ctrl and Shift selection techniques to select and 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 the query, then press Add. If you examine the Active Queries window, you will find that a query expression has 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
Reference Manual 12-15

(

!"

? 4

D85B

?==1>4C

6

E>3D9?>C

B1G9>7

5<53D9?>

@D9?>C

to the command specified in Step 1.

4UVY^UQSebbU^dTbQgY^WaeUbi

> D
! " # $

?4569>51C9=@<5AE5BI?>D853EBB5>D4B1G9>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 in Step 1). From the Select/Enter field, select the pre-defined query definition that most closely matches the type of query you would like to perform. (Certain queries, such as Select by line number, have already been defined, 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 select attributes from the drawing database, while Drawing permits you to select objects that share an AutoCAD color or layer. Select the Attribute Field from the selection list. If Piping Data was selected in Step 5, this list is populated 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 the input box, or press the Browse button. When browse is pressed, AutoPLANT will compile a list of all unique 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 passed to the command specified in Step 1.

3bUQdUQ^TCQfUQAeUbi

> D
! " # $ % & '

?3B51D51>4C1F51AE5BI

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 being defined for multiple drawing selection, enable the Multiple Drawing Selection option. Press OK. The Advanced Selection dialog displays (the title on this dialog is determined by the command selected in Step 1). From the Select/Enter field, select the pre-defined query definition which most closely matches the type of 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 to all members of the current project

12-16

AutoPLANT PIPING

D85B

?==1>4C

6

E>3D9?>C

4 ( )

B1G9>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 of the 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.

=_TYViQ^UhYcdY^WaeUbi

> D
! " # $ % & '

?=?496I1>5H9CD9>7AE5BI

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. If this query is being defined for multiple drawing selection, enable the Multiple Drawing Selection option. Press OK. The Advanced Selection dialog displays (the title on this dialog is determined by the command selected in Step 1). 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, or edit 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, a confirmation dialog displays.

4UVY^UQS_]`\UhaeUbi]e\dY`\US_^cdbQY^dc

> D
! " # $ % & ' (

?4569>513?=@<5HAE5BI

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. If this query is being defined for multiple drawing selection, enable the Multiple Drawing Selection check box. Press OK. The Advanced Selection dialog displays (the title on this dialog is determined by the command selected in Step 1). Define one or more queries. In the Active Queries window, select the CONSTRAINT = expression to which an additional constraint will 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 passed to the command specified in Step 1. >_dU If there are multiple active queries, be aware that complex constraints can only be associated with one query at a time. You must highlight the appropriate CONSTRAINT= line in the Active Queries window, then define each individually.

Reference Manual 12-17

!"

? 4

D85B

?==1>4C

6

E>3D9?>C

B1G9>7

5<53D9?>

@D9?>C

4U\UdUQaeUbi

> D
! " # $ % &

?45<5D51AE5BI

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. If this query is being defined for multiple drawing selection, enable the Multiple Drawing Selection option. Press OK. The Advanced Selection dialog displays (the title on this dialog is determined by the command selected in Step 1). 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.

12-18

AutoPLANT PIPING