Professional Documents
Culture Documents
At Pipe
At Pipe
At Pipe
FUbcY_^"
1 ED? @<1>D@9@9>7
#4@9@9>7=?45<9>7
1 ED? @<1>D @9@9>7
#4@9@9>7=?45<9>7
FUbcY_^ "
REBIS
1600 RIVIERA AVENUE., SUITE 300
WALNUT CREEK, CALIFORNIA 94596 USA
D ED?B91<
3?@IB978D 9>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®, PRO-SERIES®, OMNI-SERIES®, and PlantLIFE®, are registered trademarks of
Rebis Inc.
AutoCAD® is a registered trademark in the U.S. Patent and Trademark Office by AutoDESK, Inc.
Windows®, MS-DOS®, Excel®, FoxPro®, Microsoft®, and all other names and trademarks are the
property of their respective owners.
QA - AP020001
D12<5?63?>D5>DC
Tutorial iii
D12<5 ?6 3?>D5>DC
Tutorial v
381@D5B
9>DB?4E3D9?>
Welcome to AutoPLANT® PIPING, a 3D integrated piping application which makes it
easier than ever to produce and maintain intelligent, three-dimensional piping
models. PIPING combines speed and power into an intuitive, graphical interface that
makes the process of creating models easier than ever. PIPING has been designed
to make your job easier by reducing drawing time and automating traditionally time-
intensive tasks. Project Managers will also appreciate the efficiency with which
project data is handled, and how easy it is to share data between the entire suite of
AutoPLANT products. This tutorial introduces some of the main features of PIPING,
and walks you through the creation of a simple piping model. For information related
to the use of a specific command or function refer to the on-line help.
FEATURES 1-7
G81D 9C @9@9>7/
AutoPLANT PIPING utilizes the latest AutoCAD ARX technology. The program architecture
takes advantage of 32-bit processing, will run in AutoCAD 2000 or AutoCAD Release 14, and
enables you to produce intelligent, three-dimensional production models under demanding
deadline constraints.
If you are a new user of a Rebis piping application, you will soon discover that PIPING provides a
true three-dimensional work environment. Objects can be viewed from any perspective, and users
can toggle between various display modes almost instantaneously, without creating duplicate
objects in the drawing or experiencing a “lag” in redraw time. What’s more, the underlying data is
more powerful than ever. Component and drawing control data is dynamically linked to an external
drawing database. The database information can be used to generate reports, or to globally
manipulate and revise the descriptive component data.
>_dU PIPING is a powerful addition to AutoDesk’s popular AutoCAD drafting package, and is
fully compatible with AutoCAD 2000 and AutoCAD Release 14 working in the Windows
95, 98, or NT environments, ONLY!
>_dU At this time, PIPING does not support AutoCAD 2000’s multiple document interface
(MDI).
Each PIPING package is licensed for use on only one computer, or for a limited number of
workstations in a network environment.
The Rebis Security Configuration Manager application has been implemented to authorize your
software. The procedure to authorize AutoPLANT V2.0 is provided in the help file for this
application, which may be launched via your Window Start menu by selecting
Rebis Security/Rebis Security Configuration Manager, then Help Contents. The Authorization
Procedures area of this help provides graphical walkthrough procedures of each phase of the
authorization process.
When you start an AutoPLANT application that has not been authorized, a dialog will display that
prompts you to specify whether you want to run the software in Demo mode, or authorize the
software as an Evaluation copy for a limited number of days. The software can only be fully
authorized using the Rebis Security Configuration Manager application described above.
>_dU No existing hardware locks will be authorized for use with applications using the new
software security. This means the old hardware locks will not work with the new
applications. Users should keep their hardware locks in a safe place to allow project
support for previous versions of the software. You will also need this lock to authorize
upgrades to the software. Again, refer to the Rebis Security Configuration Manager help
file for details on authorizing your software.
>_dU In response to user requests to have the application on-line help formatted in a manner
that can be referenced away from a setting in which the actual software is installed we
will now provide the help in an Adobe® Acrobat® Reader PDF formatted manual after
each major release. These will be provided in PDF format to enable users to print as
many copies of this information as desired. These files will be generated after each
release from the on-line help and made available for download from the
http://www.rebis.com/support/docs web page.
Tutorial 1-3
9>DB?4E3D9?>
85<@ 1>4 4?3E=5>D1D9?>
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 press the b
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.
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, AutoCAD’s *.dwg and *.dxf files and
3D Studio’s *.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. The "X" in the file name
indicates the version number.
Access: This document resides in your ..\SUPPORT directory.
85<@4?3E=5>D E@41D5C
The Contents page of AutoPLANT help files contains an Update Now button. If you have a
connection established with an Internet provider, press this button to access the Rebis Help/Doc
Update web page for the help file that you are viewing. View the main help/docs web page at
KWWSZZZUHELVFRPVXSSRUWGRFV for a complete list of applications. You can then click on a
specific AutoPLANT application to display a list of its available help/doc downloads.
Help and Tutorial builds are tracked by the build date that displays in the Title bar of each
help/tutorial window. Check the build date on your existing file, then from the download area of
the Rebis web site view the currently available help for your AutoPLANT application. Compare
the date that displays on that version with the date of your current help file to determine if a newer
version is available.
Downloads will be provided in the form of self-extracting zip files. When you download an update,
simply save the file to the directory where the old files resides, then run the downloaded
executable. For example, if you download an update for the AutoPLANT PIPING V2.0 help file
Tutorial 1-5
9>DB?4E3D9?>
85<@ 1>4 4?3E=5>D1D9?>
AT_PIPE.CHM, the downloaded file will be named PIPEV2_0.EXE. Save the file to
your..\SUPPORT directory where the existing AT_PIPE.CHM help file resides, then run the
PIPEV2_0.EXE to overwrite your existing help file.
@9@9>785<@ ?B71>9J1D9?>
PIPING’s on-line Help is the source for answers to any questions you might have about program
features and functionality. All PIPING command dialogs provide a help button to quickly display
context-sensitive help on that option. PIPING Help includes the following main topic areas:
New Features: Provides links to new and modified features by version number.
Getting Started: Provides an introduction to the interface, covers general placement techniques
and tools, explains the recommended method of annotating drawings, and provides a
description on how to get the most use out of the help system.
Command Reference: This folder is organized to closely match the structure of the Piping main
menu. This should enable you to quickly locate help on a specific menu option. In general, the
help for each command resides in a separate folder under the menu name folder where it exists
in the menu. Most command folders also contain a How To sub folder, which includes a set
of procedure topics that describe how to use that command.
2D Piping Application Notes: The new 2D PIPING application is provided with this release.
The options provided in this application are automatically included with your application if
you have purchased the full 3D PIPING application. If you have only purchased a 2D PIPING
authorization, please read the topics in this area for important information.
Technical Support: Contains information on how and when to contact our Technical Support
staff. This section includes telephone and fax numbers, as well as a live web link to the Rebis
web site for the latest support information.
Adding Your Help: Rebis has developed a simple system to enable Dealers, Contractors, Users,
etc. to provide links to their own custom HTML help system within each AutoPLANT
application's help system. This area of the help explains how to connect your own HTML help
to each AutoPLANT application’s help system.
the selected folder will be printed in the order that they are defined in the folder. PDF files may be
printed by selecting File/Print, then selecting the range of pages to print.
651DEB5C
PIPING runs on top of AutoCAD R14 or 2000 ONLY in the Windows 95, 98, or NT environment
as shown in the following Figure (AutoCAD 2000 screens are used throughout this tutorial). Note
that the toolbars enable quick placement of piping components and the execution of commands.
The standard set of AutoCAD commands and menus is also available. The interface is designed to
streamline user input and to set up the CAD environment for the development of 3D piping
models.
>_dU Chapter 3 introduces the PIPING interface and offers suggestions for customizing the
interface to suit your working style.
The following sub-sections briefly describe new features in this release as well as existing features
of the software.
Tutorial 1-7
9>DB?4E3D9?>
651DEB5C
>5G=?496954 651DEB5C
This section briefly describes the new and modified features provided in v2.0.
7U^UbQ\
2D Piping Application: A 2D version of the AutoPLANT PIPING application may now be
purchased separately. Users that purchase the full 3D AutoPLANT PIPING application will
get the 2D functionality free of charge.
A new option, 2D-Piping, is available during the install that enables you to install this product
which will provide different options from the 3D installation. Under this product there will be
no provision to install Import/Export or ISOGEN. Only PIPING and EQUIPMENT will be
available as valid selections. Currently both of these applications will be provided as part of
the 2D Piping solution. The functionality will be controlled by the Rebis Security system. The
primary control of the component drawing mode will be handled through the Drawing
Preferences dialog.
Drafting Tools Menu: 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
that lists symbols in a tree view. These symbols may be dragged from the Symbol Manager
directly into your drawing, or new symbols added by simply dragging them from AutoCAD
into the interface.
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.
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 customizing 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.
=YcSU\\Q^U_ec 1ddQSX]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.
Representations: The numerous individual menu commands that were previously provided to
generate graphic representations of components have been centralized in a single dialog
control.
3_]`_^U^dc
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)
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.
Tutorial 1-9
9>DB?4E3D9?>
651DEB5C
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.
Rectangular and Round HVAC components in imperial, metric, and mixed metric units have
been added. The McGill catalog was used.
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.
Tutorial 1-11
9>DB?4E3D9?>
651DEB5C
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
@B?4E3D9F9DI
PIPING’s emphasis is on producing finished 3D models. Drawing production tools are provided to
set up work areas and views. These enable you to manage multiple drawings developed for a
particular project and generate production drawings from them. Production drawings can be
output, reports generated, and drawings created with other AutoPLANT applications, such as
EQUIPMENT or STRUCTURAL can be xreferenced in to complete the model.
A variety of features are available to automate most repetitive drafting tasks. Extensive use of
PIPING's utilities automate processes such as conversion between drawing modes, generation of
Bill of Materials, routing centerline paths, automatic placement of pipe, etc. Our goal is to
automate the processes that formerly required intensive user interaction, thereby saving you time
while ensuring accurate, clean models. Managers responsible for meeting tight production
deadlines will appreciate this important design philosophy.
DBE5 #445C97>
When our developers began work on PIPING, much of the emphasis was placed on creating clean
three-dimensional models. It was also a requirement that the file size be minimized, and that views
be available to support a variety of display modes without the added baggage of creating duplicate
copies of components. The result of our efforts is a true three-dimensional work environment that
does not sacrifice speed or drawing size to achieve its goal. Gone are the days of being forced to
visualize 3D objects in 2D space. Of course, the model can always be displayed in 2D mode and
optimized for plotting, but we are sure that you will find connecting components and routing pipe
lines much easier using the 3D methodology.
PIPING components are constructed from a group of Rebis Custom Objects. For example, a piece
of piping is created from a cylinder, while a flanged ball valve is created from two cylinders for the
flanges, two cones, and a sphere. These custom objects have four inherent display modes, which
enable you to almost instantaneously switch between display modes.
In addition, the PIPING application provides a set of representation commands that enable you to
generate and display single line, double-line, and 3D representations of specific components in a
piping line, or complete lines in the same model.
>_dU The Basic Language Reference help file may be launched via the
AutoPLANT 3D/Customization Tools and Help group in your Windows Start menu. It
provides help on the AutoPLANT Basic Language Extensions provided to customize the
system, as well as standard Basic Language element help.
Tutorial 1-13
9>DB?4E3D9?>
651DEB5C
9>D5<<975>D C5<53D9?>
PIPING models are not merely drawings. As the model is created, a drawing database is also
maintained, which contains a record for each component placed in the model. A component’s data
can be edited at any time during a drawing session.
Many PIPING functions enable you to apply the function to a selection set of components. This
selection set may be defined by querying the external drawing database to select components that
have the same database field value (e.g., Line Number, Spec, Tag), or drawing attributes (e.g.,
color, layer). After a selection set of components is created, you can globally revise values, change
line numbers, enter unique descriptions, etc. This is particularly useful when updating drawings
due to design changes.
Selection sets of
components can be
created across multiple
drawings
Complex expressions
can be created to find a
specific set of objects
41D121C5 3ECD?=9J1D9?>
AutoPLANT stores component and drawing information in an external ODBC-compliant database.
When you installed the application(s), ODBC drivers were installed on your system to enable you
to define the database format that you want to use on your projects. Currently, AutoPLANT
supports Microsoft Access and dBASE database configurations. You may elect to configure other
database formats, but they are not supported at this time. The external database may be configured
as a single Microsoft Access database with multiple tables, or multiple dBASE-formatted database
tables. The drawing database format should be configured at the start of a project and used
throughout.
>_dU By default, the drawing database is configured as a Microsoft Access database. For
information on configuring the drawing database for use with other formats, refer to
AutoPLANT Program Customization help, which is available via the
AutoPLANT/Customization Tools and Help group in your Windows Start menu.
C@5396931D9?>4B9F5>
PIPING provides sample database catalogs of tens of thousands of components from which
manufacturer-specific specifications may be produced. The Spec Generator program enables you
to build and customize the database specifications used with particular projects or clients. Each
specification is a subset of a catalog and is stored in its own directory. Specifications can also be
edited or modified to suit unique requirements, and any number of specifications can be created.
The ability to select and apply one or more specifications consistently throughout one or more
drawings or projects is why we call PIPING a specification-driven application. Because PIPING
components are placed according to defined specifications, they are not merely drawing blocks.
Instead, the components are built parametrically, and therefore have a high degree of intelligence.
To expedite the drawing process, sample specifications are included. These specifications are
available in Imperial, Metric, and/or Mixed-Metric versions. A brief description of some of the
sample specs provided is given below:
Carbon Steel: A sample carbon steel specification, based on 150-pound ANSI pressure
classification (Imperial: CS150, Metric: MCS150, and Mixed Metric: MMCS150).
Stainless Steel: A sample stainless steel specification (Imperial: SS150, Metric: MSS150,
and Mixed Metric: MMSS150).
Ductile Iron: The Ductile Iron Pipe module provides a set of components, which are
typically used for water/wasterwater applications. A sample ductile iron specification
(Imperial: Ductile, Metric: MDUCT, and Mixed Metric: MMDUCT).
Victaulic: The Victaulic module provides a set of components, which are typically used
in commercial building piping. A sample Victaulic specification (Imperial: Victalic,
Metric: MVICT, and Mixed Metric: MMVICT).
Tutorial 1-15
9>DB?4E3D9?>
651DEB5C
High Purity: The High Purity module provides a set of components, which are typically
used in HiPurity, Food/Bev, Pharmaceutical, Dairy, Breweries, etc. A sample High
Purity specification (Imperial: TriClove, Metric: MTRIC, Mixed Metric: MMTric).
Lined Pipe: A sample Resistoflex (RSF) specification (Imperial: RSF, Metric: MRSF,
Mixed Metric: MMRSF).
Cable Tray: The Cable Tray module provides a standard set of cable tray components
used in most industries. A sample Cable Tray specification (Imperial: CableT, Metric:
MCableT, and Mixed Metric: MMCableT).
Conduit: The Conduit module provides a set of thin wall tubing components, which
typically contains electrical wires and are used by most industries. A sample Conduit
specification (Imperial:Conduit, Metric: MCond, Mixed Metric: MMCond).
HVAC: 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. A sample
HVAC specification (Imperial: HVAC, Metric: MHVAC, Mixed Metric: MMHVAC).
Tubing: 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). A sample Tubing specification (Imperial: Swagelok, Metric:
MSwglok, Mixed Metric: MMSwglok).
PIPING’s specification-related features include a default component switch, which enables you to
force the system to utilize the spec record that you have defined as the default for a specific
component size.
>_dU Refer to the Spec Generator’s on-line help system for more information on specification-
related features and functions.
PIPING uses the Microsoft ACCESS (*.MDB) versions of the specs as the default. This is
configured in your network ..\DATABASE\DBCONFIG.INI file and may be modified.
The new Report Writer module provides a means to generate a wide range of reports on the data
contained in the current drawing, or across a range of drawings. AutoPLANT makes extensive use
of the Crystal Reports™ run-time engine to process data in the external drawing databases. In
addition to standard Bill of Materials generation, a number of external report options are also
provided. Additionally, you can customize any of these reports or create your own. For instance, it
is now a simple task to filter the selection set of components that will be included in a report based
on one or more criteria across one or more drawings.
The AutoPLANT Report Generator function is also provided to generate fully customizable
external reports, which will not be placed on a drawing sheet. The dialog that appears when you
execute the Report function is shown below.
Tutorial 1-17
9>DB?4E3D9?>
651DEB5C
35>D5B<9>5 B?ED5BC
The Piping Tools/Centerline Routers menu provides commands to construct the geometry of a piping
line. Elevation and coordinate parameters are stored on the line and are applied to components
placed on them. You can also associate intelligence, including: size, spec, line number, insulation
thickness, etc. with the line so that these settings are assigned to any component placed on the line.
The Centerline Routing tools are often the easiest method of defining an entire pipe run, or all runs
in a given model.
The PIPING architecture was designed with your customization needs in mind. In addition to the
standard BasicScript function and command set, Rebis has developed a set of BasicScript API
Extensions to facilitate the creation of component drawing scripts and manipulation functions.
These extensions consist of a set of Basic data types, commands, and functions specifically
designed for the creation of AutoPLANT components. These functions, combined with the
standard BasicScript macro language, provide a full-featured environment for script development
and customization of the PIPING application.
All PIPING components, and most dialogs, are defined in open Basic files for easy modification.
The system architecture enables a user with a solid foundation in the Visual Basic for Applications
programming language to modify almost any aspect of the component placement process, or to
create new components or add new functions to the system.
>_dU The Basic Language Reference and AutoPLANT Program Customization help files may
be launched via the AutoPLANT 3D/Customization Tools and Help program group in your
Windows Start menu.
Tutorial 1-19
9>DB?4E3D9?>
12?ED D89C DED?B91<
This tutorial also emphasizes the use of PIPING’s Drawing Production utilities to place annotation,
dimensions, Bill of Materials, and Sections in Paper Space.
>_dU If you want more information on the range of connection and placement options, refer to
the Getting Started section of the on-line help file.
=?45< 3?>CDBE3D9?>
The bulk of this tutorial focuses on the construction of a simple piping model. Separate chapters
are provided on project-setup, building the model, working with model data, annotating and
dimensioning the model, and producing reports. At the end of the tutorial, you will have
constructed a sample piping model, obtained a good working knowledge of the program, and
learned how to apply these techniques to create your own models.
@B5CD1BD 3853;<9CD
Tutorial 1-21
9>DB?4E3D9?>
CE@@<5=5>D1< 1@@<931D9?>C
CE@@<5=5>D1< 1@@<931D9?>C
AutoPLANT software is shipped with a set of supplemental applications. These utilities are
provided in the main Rebis menu and toolbar as shown below. The top part of the menu contains
AutoPLANT applications. Options that appear grayed-out in the menu have not been installed.
8Y^d Directly launch all of these applications (except Import/Export) from the Windows Start
menu by selecting the start icon from the AutoPLANT 3D/Customization Tools and Help
group.
A brief description of each of these applications is provided in the following table. A more detailed
explanation of each application is provided in Chapter 8, Supplemental Applications at the end of
this tutorial. Each of these supplemental applications has its own associated context-sensitive help
file, which can be launched from the application. Refer to the application help file for a detailed
explanation of every available feature and function.
>1=5 45C3B9@D9?>
Import/Export Import/Export is intended to facilitate transfer of CAD data between
AutoPLANT and other CAD/CAE software. The transfer is
accomplished using Rebis’ Plant Design (PXF) data format, which can
either be generated or read by AutoPLANT. AutoPLANT also supports
output to a Piping Component Format (PCF) for input to Alias Limited’s
ISOGEN software.
Explorer EXPLORER may be purchased separately. It is an interactive 3D
viewer for models and sets of models that interact with these at a
guaranteed frame rate. It supports multiple formats, as well as its own
native file formats. Navigation and view controls enable the most
complex model to be explored with ease.
Explorer ID EXPLORER ID may be purchased separately. The Explorer
Interference Detection add-on, is designed to help you control clash
tests and leave an audit trail of clashes throughout the life of the
project. It runs within the EXPLORER interface.
>1=5 45C3B9@D9?>
Configuration Editor AutoPLANT is designed to support multiple configurations for
drawing/model defaults and settings. The Configuration Editor is the
tool for modifying these files and creating saved sets of configuration
definitions that can be applied to a particular project or drawing.
Class Editor The Class Editor provides a single source for the manipulation of
AutoPLANT PIPING and ISOMETRICS modules, components, and
their associated configuration files.
Script Editor 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.
Dialog Editor 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. The Basic statements that
construct the dialog instance may be inserted directly into custom
scripts created with the Rebis Script Editor.
Specification The Rebis Specification Generator is provided to enable you to
Generator create/modify the external drawing database specifications.
AutoPLANT provides Imperial, Metric, and Mixed Metric catalogs,
which contain tens of thousands of components from which your
project-specific specifications can be generated.
NOTE: This application can only be launched from the Windows Start
menu.
Tutorial 1-23
9>DB?4E3D9?>
D538>931< CE@@?BD 1>4 DB19>9>7
>_dU Please contact your Rebis Inside Sales Representative for more information on MES.
Internet Support: Online Support is a reserved area for active MES subscribers. A few benefits
are described below:
Input and track support incidents related to your organization. You will be automatically
notified via email when the status of your support incident has changed. New incidents
go directly into our Technical Support database, and you can track the incidents remotely
over the web. You can even change the status of your incident live!
View our Solutions Database. Much more than a set of FAQs, this is a comprehensive
database of solutions compiled and maintained by our Tech Support staff.
View Software Bugs. Rebis is confident about our products, and we want to help you
resolve any problems you may be experiencing. Because of this, we expose our Tracker
database to our customers.
You can see the advantages of obtaining an MES contract: Search the knowledge browser for
a list of solutions, see if your problem has been reported already as a bug, add a new incident
and track it... all from the web and without requiring a phone call!
4?3E=5>D1D9?> 3?>F5>D9?>C
The following conventions are maintained throughout this tutorial in order to emphasize menu
selections, user-interaction, file names, and other standards.
3?>F5>D9?> 45C3B9@D9?>
>?D5* Precedes information of general importance.
89>D* Precedes optional time-saving information.
G1B>9>7* Precedes information about actions that should not be performed under normal
operating conditions.
FILENAMES Directory paths and file names are italicized.
Example: \AT-EQP directory, AUTOEXEC.BAT file.
3URJUDP &RGH Excerpts from text or basic script files, script variables, and statements appear in the
font shown.
INPUT Commands or information that must be manually entered is bolded in the font shown.
Menu & Menu commands and dialog buttons appear in a sans serif font that stands out from
Buttons normal body text.
Example: After selecting the File menu, press the OK button in the dialog.
@B?354EB5 3?>F5>D9?>C
Procedures are provided throughout this tutorial. Menu selections and user input are emphasized in
bold while the toolbar equivalent is shown in the margin. Refer to the example below.
C 5<53D9?> 5H1=@<5
By following the procedures, a model is constructed. Samples of how the model should look at
different stages of the tutorial are also provided. All screens and toolbar icons shown were saved
while running the application in AutoCAD 2000.
Tutorial 1-25
381@D5B
@B?:53DC5DE@
This chapter explains how AutoPLANT configurations may be setup/customized.
Configurations may be used to assign a series of drawing settings that apply across
an entire project.
OVERVIEW 2-2
?F5BF95G
This chapter provides an overview of the system AutoPLANT uses to control drawing settings on a
project-wide basis. It is provided as an overview only and is NOT required for completion of this
Tutorial. The remaining Tutorial chapters use one of the sample configurations provided in the
shipping version of the software.
When you create a new PIPING drawing, the following dialog displays to enable you to select the
desired configuration.
The Configuration drop-down lists all of your configurations, including the three sample
configurations (Imperial, Metric, and Mixed Metric) provided with your software.
The shipping version of AutoPLANT software provides three base configurations: Imperial,
Metric, and Mixed Metric. Each of these configurations defines the drawing settings for the
environment indicated by the configuration name, and should not be modified. These
configurations may be used as templates for defining new configurations based on imperial, metric,
and mixed metric units.
When you create a new drawing, and then select a custom configuration, the system will search the
custom configuration directory path for custom versions of all files first. For example, if you use
the Configuration Editor to create a configuration named MYCONFIG, then used CE to modify
the drawing script for a gate valve in your MYCONFIG configuration. CE will save the modified
gate valve script within your MYCONFIG configuration directory structure. When you create a
new drawing and select the MYCONFIG configuration, then attempt to place this gate valve, the
system will search for the gate valve drawing script in your MYCONFIG directory path first,
thereby using your custom script to place the gate valve. If the system does not find a custom file
for any component placement option, it will use the file located in the path of the configuration
(Imperial, Metric, or MMetric) that you selected as a template when you created your custom
configuration.
3?>697EB1D9?> 69<5C
When you install PIPING, if you accept the default (REBIS) installation directory, a
REBIS\CONFIG subdirectory will be created. The provided Imperial, Metric, and Mixed Metric
(Mmetric) configuration directories will also be created on your system, and the required
configuration files will be installed in these configuration directories. For example, the
REBIS\CONFIG\IMPERIAL directory will be created and will contain all of the sample Imperial
configuration files.
As mentioned previously, the system is designed to enable you to create a custom configuration
using the provided configuration for the units desired. For example, if you want to create a custom
Imperial configuration, you will use the provided Imperial configuration as a template. The
provided configurations should NEVER be directly modified. If you modify these configurations
directly, future upgrades to your AutoPLANT software will overwrite any changes made. This is
why the Configuration Editor and Class Editor will not let you modify any of the settings in the
provided configurations.
Tutorial 2-3
@B?:53D C5DE@
" 3B51D9>7 1 3ECD?= 3?>697EB1D9?>
! Select AutoPLANT 3D/Customization Tools and Help/Configuration Editor from your Windows
Start menu (this application may also be launched within AutoCAD).
" Select File/New Configuration. The first time you attempt this command, the following dialog
displays to indicate that the system cannot find the root custom directory. In general, the
system is designed for you to create you custom configurations under a primary custom
directory. Press Yes to specify the root custom directory.
# If you are working in a network environment and want your custom configurations available to
other users, you should specify a network path for this directory. Enter the desired root custom
directory path in the dialog below, then press OK.
Tutorial 2-5
@B?:53D C5DE@
" =?496I9>7 1 3ECD?= 3?>697EB1D9?>
! Press Add when you are finished to create the new configuration record. A new configuration
becomes the active configuration in the Configuration Editor when it is created. This
configuration will have the same configuration settings as the template until modified.
!! When the configuration has been created, the following dialog displays to remind you where
the methods or functions that you modify for this configuration will be stored. Press OK.
!" The active configuration name, MYIMPERIAL, now displays in the bottom-left corner of the
status bar.
The following exercise explains how to access and modify some of the default settings that will
display in the PIPING and ISOMETRICS application's Drawing Preferences dialog.
The System tab contains options for units and other required system paths. For example, if you
created your own custom specs for this custom configuration and stored them in a location
other than the default shown, you could modify the Root Spec Directory to point to the path
where your custom specs reside. When you create a new drawing, only the specs that reside in
the directory specifies will appear available for selection in the Drawing Preferences dialog.
You can click on the Help button for a complete description of all of these variables.
" Click on the Component tab to display the dialog as shown below.
If you are an experienced AutoPLANT user, these fields should be familiar. These fields are
common in the PIPING and ISOMETRICS Drawing Preferences dialogs. The values assigned
Tutorial 2-7
@B?:53D C5DE@
" =?496I9>7 1 3ECD?= 3?>697EB1D9?>
to these variables will display as the defaults in these dialogs when you create a new drawing
and select this custom configuration.
# You can also set the default values for other fields such as: Area, Paint Code, Service, etc. If
you know that these values will be used for a particular project, assigning defaults here would
reduce the set up required for each drawing created for that project.
$ You can save changes by pressing Save. Press Close at this time to exit without saving
changes.
>_dU The Restore button will automatically reset all variable assignments to their last saved
value. Once you have saved a configuration change, it will have to be updated manually.
" The Setup tab variables primarily assign the defaults for the Model Setup dialog shown below,
which displays when you create a new PIPING/EQUIPMENT drawing.
# For example, the state of the North Arrow Flag check box on the Setup tab determines the state
of the Insert North Arrow check box on the dialog above. If you enable the Insert North Arrow
check box when you create a drawing, then AutoPLANT will insert the north arrow symbol
that you assigned to the configuration's North Arrow setting on the Setup tab. It will locate this
symbol from the path assigned in the configuration's Directory for Arrows field on the Setup
tab. You can modify the north arrow symbol by editing the north arrow drawing, or saving a
new one in the directory assigned to the configuration's Directory for Arrows.
$ The Modelling Configuration dialog’s CAD Setup tab contains keys to assign defaults for
AutoCAD environment variables that will apply during a PIPING or EQUIPMENT drawing
session. Press the Help button, then click on the CAD Setup tab for a detailed explanation of
each of these settings.
% You can save changes by pressing Save. Press Close at this time to exit without saving
changes.
>_dU The Restore button will automatically reset all variable assignments to their last saved
value. Once you have saved a configuration change, it will have to be updated manually.
Tutorial 2-9
@B?:53D C5DE@
" =?496I9>7 1 3ECD?= 3?>697EB1D9?>
The Preferences tab contains keys that define the default settings for PIPING drawing options
displayed in the Drawing Preferences dialog the first time it is opened.
" If you want to save the CADLink and Port Data to the external drawing database you can
enable these check boxes on the Preferences tab. Assigning these defaults at the start of a
project will reduce the amount of time spent setting up for each of your new project drawings.
# There are several variables that may be set to control the manner in which AutoPLANT
PIPING components are copied. The Copy tab on the Piping Configuration dialog contains
keys that assign the defaults that display in PIPING's Setup/Component Copy Preferences dialog.
This option enables you to establish rules that define how copied components are updated.
When using AutoCAD’s 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 specify how
they are updated. Press the Help button on this dialog, then select the desired tab from the help
window to display a detailed explanation of each of these variables.
$ You can save changes by pressing Save. Press Close at this time to exit without saving
changes.
>_dU The Restore button will automatically reset all variable assignments to their last saved
value. Once you have saved a configuration change, it will have to be updated manually.
=?496I9>7 3?=@?>5>DC
As mentioned in the overview at the start of this chapter, the AutoPLANT Class Editor application
is provided with your PIPING application to enable you to customize AutoPLANT component
scripts and methods. Any file changes or additions made to your AutoPLANT components during
a Class Editor session will be saved in the custom configuration directory structure, thereby
maintaining the integrity of the shipping version of these files.
This process is beyond the scope of this tutorial. Detailed instructions on Class Editor are provided
in the on-line help for that application. An introduction to the Class Editor is provided in Chapter
9, Supplemental Applications of this tutorial.
Tutorial 2-11
@B?:53D C5DE@
" 381@D5B B5F95G
381@D5B B5F95G
In summary, the system is pretty basic. You shouldn't modify the shipping version of any
AutoPLANT files directly. You must use the Configuration Editor to create a custom configuration
using one of the configurations in the shipping version of the software as a template. This step will
create a custom directory structure and copy the required files. You can then use Configuration
Editor to modify application specific settings, or the Class Editor to modify the modules and
component scripts or methods. When you save your work in CE, it will create custom versions of
all files affected by your changes in your custom configuration directories. When you create a new
drawing and select your custom configuration, the custom versions of all modified files will be
used.
This overview was intended to provide a general overview of the functionality of the Configuration
Editor and Class Editor applications. Refer to the on-line help for each of these applications for
more specific information.
G81DµC >5HD
Chapter 3 explains how to start the PIPING application, select a configuration that defines the
default drawing settings, and then provides a tour of the interface. The Drawing Preferences
dialog, which is the central location for the modification of drawing and component preferences, is
also introduced.
75DD9>7CD1BD54
This chapter explains how to start the PIPING application, select a configuration that
defines the default drawing settings, and then provides a tour of the interface. The
Drawing Preferences dialog, which is the central location for the modification of
drawing and component preferences, is also introduced.
OVERVIEW 3-2
?F5BF95G
This chapter explains how to start AutoPLANT and load the PIPING application. It also provides
a tour of the interface, and examines the Drawing Preferences dialog.
CD1BD9>7 @9@9>7
This section explains how to start the AutoPLANT Plant Design system and load the PIPING
application.
D? CD1BD @9@9>7
=?45< C5DE@
AutoPLANT is designed to support multiple configurations for drawing/model defaults and
settings. A configuration defines the units, specs, drawing database format, borders, drawing
templates, module, and component options that you want to apply to a set of drawings in a project.
When you start a new AutoPLANT drawing, the Model Setup dialog displays as shown below.
This dialog provides options to select a configuration, which defines the default units and settings
that will apply to the drawing. Once a configuration is selected, then the drawing is saved, you will
not be able to change the configuration for that drawing.
A number of configuration files were required to serve as placeholders for the definition of the
configuration defaults and settings. The AutoPLANT Configuration Editor was designed to simplify the
tedious effort that would have been required to manually edit these configuration files to create and
customize project configurations. It provides a highly intuitive graphical user interface with tabbed
dialogs to enable you to create/modify project configurations. This application may be launched
from the Rebis menu or toolbar, or the Windows Start menu. An introduction to the Configuration
Editor was provided in Chapter 2, Project Setup.
! The Configuration drop-down list box enables you to select the desired configuration. The
shipping version of the AutoPLANT software provides three base configurations: Imperial,
Metric, and Mixed Metric. Each of these configurations defines the default drawing settings for
the environment indicated by the configuration name. Select Imperial {Metric}.
" Check to ensure that the North direction is set to 90 (degrees), and that the World Length is 100’
{30000} and the World Width is 60’ {18000} as shown.
# Enable the Insert North Arrow and Draw Limits Box options. The first option will insert a north
arrow symbol in the drawing, while the second causes a box to be drawn around the defined
world limits. Press Done to close the dialog and accept the remaining values.
$ A box is drawn to indicate the world limits, and the prompt
Select the location for the north arrow symbol:
Tutorial 3-3
75DD9>7 CD1BD54
1 D?EB ?6 D85 9>D5B6135
displays. Pick a point in the upper right corner of the drawing to place the north arrow.
% The Piping menu is added to the AutoCAD pull-down menu, and the application toolbars
display. The menu and toolbars provide access to all PIPING commands and functions.
Experiment with the placement of these toolbars, as you will be accessing them frequently during
the tutorial drawing sessions. In the example above, the Piping Component and Function toolbars
were docked to the left of the drawing area, while the Direction Aids and Responses toolbars were
docked along the bottom of the drawing area.
The size of the toolbar icons may also be customized. Toggle the display of large or small buttons
according to your preference and monitor size by right-clicking on any button in a toolbar, then
selecting Customize from the pop-up menu. When AutoCAD’s Toolbars dialog appears,
enable/disable the Large buttons option as desired, then press Close.
8Y^d PIPING stores each user’s preferences separately in their local ACAD.INI file. If you are
running on a network, you do not need to worry about establishing display preferences
that would interfere with other user settings.
Several toolbar selections contain “fly-outs,” which are denoted by the small black triangle in the
lower right-hand corner of the toolbar button. Fly-outs are the equivalent of cascading menus;
however, they provide the additional benefit of displaying the most recent selection as the default.
This technique enables the program to automatically display the most recent selection made from a
toolbar.
>_dU If a button has a triangle in the bottom right corner, it means that it contains “flyouts.”
Once an item is selected from a flyout, it becomes the default button at that location in
the toolbar for the remainder of the drawing session.
8Y^d To view the name of the command that will be executed by any toolbar button, simply
position the cursor over an item and pause. A “tool tip” will display describing that item.
If you find yourself frequently accessing the commands in one of the flyouts, you may want to
open that toolbar individually. Select Piping/Toolbars, then select the desired toolbar from the
menu.
Tutorial 3-5
75DD9>7 CD1BD54
4B1G9>7 @B565B5>35C
4B1G9>7 @B565B5>35C
Now that you are familiar with the working environment, the Drawing Preferences dialog will be
examined. This dialog contains settings that define drawing parameters such as the component
size, the specification used to draw components, the drawing mode, line number, etc. It is
important to establish drawing settings prior to beginning work on a new model.
Drawing preferences control various settings that apply to components when they are placed in the
model. For example, the Nominal Size field defines the nominal main piping size of the next
component placed in the drawing, while the Line Number field enables you to define the line
number value that will be written to the component’s external drawing database record when it is
placed. This can be important in generating reports and automatic isometrics.
>_dU The defaults displayed in these fields are assigned to the Imperial {Metric} configuration
that you selected when you created this drawing. Chapter 2, Project Setup, covers the
procedure for modifying these defaults.
4B1G9>7 =?45B5@B5C5>D1D9?>C
The Drawing Mode area of the dialog has been re-organized for this release into Drawing Mode
and Representation areas to support the implementation of the new flat 2D PIPING application.
Refer to the 2D Piping Overview in the on-line help for more information on this new application.
2D PIPING 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
selections from 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. 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 AutoCAD objects,
which have been generated via the new Hidden Line Removal (HLR) interface.
1 449D9?>1< ?@D9?>C*
Surface Resolution: When you enable the 3D Drawing Mode radio button, a Surface
Resolution setting will be activated. This value assigns AutoCAD’s 685)7$% and
685)7$% 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
inserted components. You toggle the 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
Tutorial 3-7
75DD9>7 CD1BD54
4B1G9>7 @B565B5>35C
Options dialog shown below, 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 If the "Light bulb" is ON (yellow), then visibility is turned ON and hidden lines will be visible.
Color Assigns the color of the visible hidden lines.
Linetype Selects the line type to be used for the hidden line. Only loaded line types can be used from this
selection 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 a dialog to assign the desired settings. Select the
desired Units, then pick the desired line weight that will be used for your 2D representations.
A brief description of the remaining fields in this dialog is provided below. Review the
descriptions below, then set the starting values as shown in the previous figure and press OK.
695<4 45C3B9@D9?>
Specification Displays the root specification directory path. Sub-directories that reside below this directory will
Path appear as options in the Specification: selection list covered below. This path is defined in the
configuration selected when you started this drawing.
Specification Lists the specification directories that reside below the Specification Path shown. Select a spec
directory from this list to make it active. New specifications can be created (or existing ones
edited) using the Rebis Specification Generator.
Nominal Size Lists the available main nominal pipe sizes from the selected specification. The selected size is
applied to all subsequent components placed in the model, provided the size is available for that
component in the specification.
Line Number Line numbers can be assigned using any alphanumeric combination of characters. All
subsequent components placed in the drawing will be assigned a Line Number from this field.
However, if the “Data Mode” is set to “From Connecting Component,” the Line Number value will
be determined by the connecting component.
Line Number information is used in reporting, annotation, generating isometrics, and other
functions of the program.
695<4 45C3B9@D9?>
Other Database Settings are provided to enable you to specify the value that will be written in the external drawing
Fields database for Insulation Thickness, Insulation Spec, Paint Code, Area, Unit No., and Service.
These values will be stored in the external drawing database for components when they are
placed. To graphically control the display of pipe insulation, enable/disable the Show Insulation
check box in this dialog.
Drawing Mode/ Refer to the explanation prior to this table.
Representation
Component These settings determine the set of rules that define component color and layer attributes.
Color/Layer Components of the same Size, Layer, Spec, Line No., or Paint value can be colored the same in
order to visually distinguish them when viewing the model. Likewise, components can be
arranged on the same layer according to their specification or Line Number.
Data Mode Determines how settings are applied when routing components. “From Connecting Component,”
extracts the component preferences (size, spec, line number, and insulation thickness) from the
existing component and applies them to the connecting component that is being placed. This
option overrides the Drawing Preferences dialog settings to provide an easy method of
maintaining consistency. “From Settings,” will enforce the settings assigned in the Drawing
Preferences dialog despite the preferences associated with a connecting component.
Auto Router Enable this switch to automatically connect a selected component to the run end of the previous
Mode component. This is the fastest method of placing a series of connected components in a
continuous pipeline. If the selected component contains a branch or a bend, you will still be
prompted to specify the orientation.
Show Insulation This check box controls the graphical display of insulation on pipe components in the drawing
when they are placed.
Debug Mode This switch should ONLY be enabled if you are customizing/creating component placement
scripts or related functions. When enabled, this switch places BasicScript execution in debug
mode. When a Basic Script function is executed, it will display in the Rebis Script Editor in Debug
Mode to enable you to step through each step of the function as it is executed. This is primarily
used to locate/test for errors in customized Basic scripts.
Default Spec When a component is selected for placement, PIPING searches the selected specification for the
Choice component record based on the component preferences set in the Drawing Preferences dialog
and the type of component selected. If more than one match is found, the Specification Selection
dialog displays to enable you to select the desired component from the matching records. For
example, the component records may have the same size and type, but may have different
facings, 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 specification record using the Spec Generator application.
Tutorial 3-9
75DD9>7 CD1BD54
4B1G9>7 @B565B5>35C
695<4 45C3B9@D9?>
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.
Save CAD Links This option defines whether or not the CADLINK table is added to the external drawing database
to store component handle information externally as well as in the drawing. If you are using MS
Access, an extra table will be added to the drawing database. If you are not using MS Access, an
additional database table will be created when the drawing is saved. The new table will have the
name of the drawing, followed by an extension specified in the DBCONFIG.INI file.
Save Port Data This option defines whether or not the PORT, JOINT, and FASTENER tables are added to the
drawing database to store component port, joint, and fastener connection information externally
as well as in the drawing. If you are using MS Access, extra tables will be added to the drawing
database. If you are not using MS Access, additional database tables will be created when the
drawing is saved. The new tables will have the name of the drawing, followed by an extension
specified in the DBCONFIG.INI file.
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.
3?=@?>5>D @B565B5>35C
An abbreviated form of the Drawing Preferences dialog that contains the most commonly
modified settings is available via the Piping/Setup/Component Preferences… command.
This dialog may be left open on the desktop at all times. To change the Spec, Size, Line Number,
or Data Mode, simply edit the associated field. This technique prevents you from having to
repeatedly open and close the Drawing Preferences dialog to make changes to these component
preferences.
Tutorial 3-11
75DD9>7 CD1BD54
381@D5B B5F95G
381@D5B B5F95G
Starting PIPING: PIPING is started by from the Windows Start menu by selecting
Programs/AutoPLANT 3D/Start AutoPLANT Plant Design icon, then pressing the Piping button
from the Rebis toolbar.
Model Setup: When you start a new drawing, the Model Setup dialog displays to enable you to
select the configuration that you want to apply to the drawing. This configuration defines the
default units and other drawing settings for the model. The shipping version of the
AutoPLANT software provides three base configurations: Imperial, Metric, and Mixed
Metric. Each of these configurations define the drawing settings for the environment indicated
by the configuration name.
Interface: The PIPING interface has been designed to provide easy access to components and
commands. The use of toolbars, in particular, aids in component selection by providing quick
access and always displaying the most recent selection made from a component group. The
toolbars can be resized and positioned along the perimeter of the drawing area.
Drawing Settings: The Drawing Preferences dialog enables you to customize parameters used in
a drawing session. Through a single dialog, the specification, drawing mode/representation,
main size, connectivity check, and other options can be controlled.
G81DµC >5HD
Chapter 4 provides an introduction to component placement commands and techniques. The entire
range of placement and connection options is discussed, and several examples are provided. A
brief discussion of drawing modes is also provided.
3?=@?>5>D@<135=5>D21C93C
This chapter focuses on component placement concepts and techniques. Particular
attention is given to the prompts that appear during placement, and how to combine
options and placement techniques to produce a variety of results. A discussion is
also provided on component placement from the menus and toolbars.
OVERVIEW 4-2
?F5BF95G
This chapter provides an introduction to component placement. It begins by reviewing the basic
placement procedure, then moves on to exercises that focus on the more sophisticated placement
concepts and techniques. Component placement from plan and perspective views will also be
covered in these exercises.
! Select the component: Components may be selected for placement from the toolbars or the
menu system.
" Specify a reference and placement point: Components are always placed with respect to a
reference point. In most cases, the reference point and the placement point are one and the
same because the default reference point is always the end point of the component previously
placed in the model. You can attach a component directly to this reference point, place it a
known distance from this point, or select one of the following options:
“In space”: not connected to another component, centerline, or piece of equipment. In
this case, the user picks (or inputs) a new point in the model, which becomes the
reference point. You can also specify an elevation prior to picking the point.
Inserted on an intelligent centerline: The component run direction and orientation will be
extracted from the geometry of the centerline. The component will also assume the size,
spec, and line number attributes from the line, if they were defined.
Aligned with existing components: A component can be placed so that its centerline
automatically aligns with the centerlines of two existing components.
Attached to previous Placed “in space” Inserted on a centerline Tee aligned with two
component existing elbows
# Toggle insertion point: If you specify the reference point on an existing component, you can
toggle to any of the connecting component’s ports to specify the port that you want to connect
to on the existing component. For example, a tee may be inserted with respect to either of its
main run end ports, center point, or branch port as shown below (some components, such as
pipe, do not have a center point or a branch end and do not provide this prompt option).
$ Orient the component: Many components have a branch or bend that must be oriented
separately (for example, when placing an elbow, the downstream leg can be placed in the X,
Y, or Z plane, or rolled along a specified angle). This prompt will only appear for component
placements that require it.
Each of these four generic steps is illustrated in the exercises provided in the following sections.
These exercises illustrate how to combine the placement options to produce a variety of results.
After a little practice, you will find that these options enable you to position and place components
with ease and precision.
3?=@?>5>D C5<53D9?>
PIPING components can be selected from either the Piping menu or the Piping Components Main
toolbar.
>_dU The components shown in this section are part of the default carbon steel module
shipped with PIPING. Several other component modules are also provided with your
software, and can be loaded with the Setup/Module Setup… command. Each module
provides its own component placement menu and toolbar.
Tutorial 4-3
3?=@?>5>D @<135=5>D 21C93C
3?=@?>5>D C5<53D9?>
@Y`Y^W =U^e
The Piping menu, shown below, provides access to the complete range of components. Note that
component types are grouped together in this menu, and that the menus “cascade.”
8Y^d Because the Piping Components Main toolbar is used so frequently, experiment with its
positioning. It can be docked at the top of the screen just below the AutoCAD toolbars, at
the bottom of the screen above the command line, or at the left or right edge of the
drawing area.
4YbUSdY_^ 1YTc
The Direction Aids toolbar shown below may be used to specify the orientation of a component in
response to the component placement prompts. These tools are particularly useful when placing
components that run towards or away from the viewer in the current plane, or when working in a
skewed view.
Placement in space
Connecting components
Placing from a reference point
Placing components in a skewed view
Aligning components
Attaching to a centerline
Automatic pipe placement
75DD9>7 CD1BD54
The procedure to start PIPING was provided in the previous chapter. If you do not already have
the PIPING application loaded, follow the generic procedure outlined below.
! Select Programs/AutoPLANT 3D/Start AutoPLANT Plant Design from the Windows Start menu.
" Select Rebis/Piping to start the PIPING application.
# When the Model Setup dialog displays, select the Imperial {Metric} configuration, then press
Done to accept the remaining defaults. After the dialog closes, pick a point in the upper right
corner of the drawing area to place the north arrow.
>_dU If using the metric configuration, set the World Length to 10000mm and the World Width
to 7500mm.
$ Open the Piping Components Main, Piping Functions Main, Direction Aids, and Responses
toolbars from the Piping/Toolbar menu.
Tutorial 4-5
3?=@?>5>D @<135=5>D 21C93C
21C93 @<135=5>D 5H5B39C5C
% Open the Drawing Preferences dialog and set the Nominal Size to 6” {150mm}.
& You are now ready to begin the exercises.
! Select Piping Tools/Display Modes/Set Wireframe w/Centerline to change the component display
mode.
" Select Piping/Pipe Components/Pipe. The prompt
Elevation/<Pick point>:
displays. Type E and press N to display the Set Elevation dialog shown below.
Type 6’ {1800mm} and press OK to set the AutoPLANT elevation to 6-feet (1800mm).
# The prompt
Elevation/<Pick point>:
displays. Pick any point near the left edge of the drawing area.
$ The prompt:
Connect to/<Enter Length>:
displays. Note that a ghost line “rubber bands” from the initial point. You can either pick the
distance from the original point, or input a length at the command line. Type 10’ {3000} then
press N to specify a ten-foot {3000mm}length of pipe.
8Y^d By default, the Imperial Configuration uses architectural units. You can change the unit
type and precision with AutoCAD’s DDUNITS command.
% The prompt
Enter direction:
displays. This last step orients the component. For example, if a point is selected to the right
i
of the insertion point (with ORTHO ON ), the pipe will extend in the +X direction from the
base point. You can also use the Direction Aids toolbar to specify this information. For
example, press the +X button on the Direction Aids toolbar, then press N to place the pipe as
shown below.
Direction
Distance
1 Placement Point
>_dU The direction vector is necessary because the pipe is being placed “in space.” When
connecting to an existing component, the direction vector is determined automatically.
& Use AutoCAD’s zoom controls to view the entire length of the pipe segment. Leave some
extra space to place additional components.
Tutorial 4-7
3?=@?>5>D @<135=5>D 21C93C
21C93 @<135=5>D 5H5B39C5C
8Y^d By default, whenever you place a bend or branching component “in space,” PIPING
assumes that you want to insert it from its center point.
$ To toggle a component’s insertion point, press the Toggle icon on the Responses toolbar, or
type T and press N at the command line. The Figure below illustrates how the insertion point
will toggle for an elbow and a tee.
ELBOW TEE
= Insertion point
Continue to Toggle the reference point until the elbow port shown below is selected, then
press N, or click the right mouse button, to accept this point.
8Y^d Pressing the right mouse button is the equivalent of pressing N. This technique is
standard to all AutoCAD operations that request the user to press N at the command
line.
% The prompt
Enter direction
displays, and a “ghost line” extends from the point specified in Step 4. Specify the run
direction of the elbow by selecting a point any distance to the left of the anchor point (with
i
ORTHO ON ), or press the --X icon on the Direction Aids toolbar.
& The prompt
Enter orientation
displays. The Direction Aids toolbar is particularly useful for specifying an orientation that is
difficult to pick in the current viewing plane (for example, specifying that an elbow should be
oriented vertically while working in the plan view). The following Figure illustrates a few
elbow orientations that may be obtained using the Direction Aids toolbar options.
+Y -Y +Z -Z
To specify the orientation of the elbow leg, pick a point any distance below the last point
picked, or press the -Y icon on the Direction Aids toolbar. The elbow is drawn as shown
below.
Direction
2
Orientation
3 1
Placement Point
' Erase the elbow to demonstrate how components are removed from a model. Type E then
press N to execute AutoCAD’s Erase command. When the
Select objects:
prompt appears, pick the outline of the elbow, then press N. The elbow is removed from the
drawing.
>_dU Later in this tutorial, you will learn how to “clean” the external drawing database to ensure
that the records in the database are synchronized with the model.
Tutorial 4-9
3?=@?>5>D @<135=5>D 21C93C
21C93 @<135=5>D 5H5B39C5C
3?>>53D9>7 3?=@?>5>DC
When connecting components in PIPING, the software can automatically “snap” to the open end
of the last component placed. This feature, along with a Connectivity Checker, helps to ensure that
components are connected properly, and that their end conditions are compatible. The following
exercises demonstrate how to connect components using the fitting to fitting method. The default
mode is demonstrated first, followed by an exercise that utilizes the AutoRouter.
% Select the first gasket option in the list, then press OK. The model appears as shown in the
following Figure.
Tutorial 4-11
3?=@?>5>D @<135=5>D 21C93C
21C93 @<135=5>D 5H5B39C5C
! Before you start, adjust the view of the model so that you can place components south and east
of the elbow. Use AutoCAD’s zoom controls and scroll bars to obtain a view similar to the
one shown below.
" Select Piping/Setup/Drawing Preferences… and disable the Auto-Router Mode check box, then
press OK. Components cannot be placed from a reference point until this switch is disabled.
Tutorial 4-13
3?=@?>5>D @<135=5>D 21C93C
21C93 @<135=5>D 5H5B39C5C
! In this exercise, you will place an elbow using the center point of the tee as a reference. You
will place the elbow so that one of its legs moves away from the plan view. Select
Piping/Bends and Returns/90° LR Elbow.
" The prompt
Relative/Toggle/Elev/<Pick point or Return for fit-fit>: T
displays. Continue to type T and press N until the branch tee port is selected.
When the tee branch port is highlighted, type R and press N to choose the Relative
placement option.
# The reference point becomes the center of the tee and the prompt
Toggle /Align/change Ref point/<Enter Distance or Return for fit-fit>: T
displays. Notice that there are two points highlighted: the center of the tee, which is the
reference point, and the north end of the tee, which indicates the desired run direction. Press
the Toggle option until the branch end of the tee is highlighted as shown in the graphic below.
You can now place the elbow a specified distance along the branch direction.
Reference Direction
Point Indicator
$ The prompt
Toggle /Align/change Ref point/<Enter Distance or Return for fit-fit>: 5’ {1500}
displays. Type 5’ {1500} and press N to pick the placement point 5-feet {1500mm} away
from the center of the tee.
% An outline of the elbow appears at that point and the prompt
Toggle insertion point/<Return to select>:
displays. Type T and press N until the reference point is toggled to the end of the elbow,
then press N to accept the point.
FYUg`_Y^d bUfYUg
You should make extensive use of AutoCAD’s View commands, and/or the View toolbar. These
commands enable you to quickly move around the model to a number of pre-defined viewing
perspectives. Particularly useful for controlling views is the View toolbar shown below. From this
toolbar, users can easily toggle between plan, elevation, and isometric viewing planes of the
current model. Refer to your AutoCAD documentation for more information.
First, you will change the viewpoint, then continue placing components on the pipe run created
earlier.
Tutorial 4-15
3?=@?>5>D @<135=5>D 21C93C
21C93 @<135=5>D 5H5B39C5C
! Type VPOINT and press N, and then type -1,-1,1 and press N, or select the SW Isometric
View icon from AutoCAD’s View toolbar.
" Zoom in around the area of the model shown below. Note that the last elbow placed is
oriented in the vertical plane.
Routing from a skewed view is no different from routing in the plan. The only difference is that
you are better able to visualize the model and can easily select objects that may be hidden when
viewing the drawing from a plan perspective.
$ The Specification Selection dialog displays as shown below. This dialog will always display
when placing a reducer to enable you to define the reduced size (remember, only the main size
is set from the Drawing Preferences dialog). Select the 6X4 {150 x 100} Buttweld Concentric
Reducer as shown, then press OK.
& Select Piping/Branching Components/Straight Tee to add a tee to the end of the reducer.
' The prompt
Relative/Elev/<Pick point or Return for fit-fit>:
displays. Press N, or press the right mouse button, to connect to the end of the reducer.
( The prompt
Toggle insertion point/<Return to select>:
displays. Press N to accept the default insertion point.
) The prompt
Enter orientation:
displays. Press +Y on the Direction Aids toolbar to orient the branch in the +Y direction. The
model appears as shown in the following Figure.
Tutorial 4-17
3?=@?>5>D @<135=5>D 21C93C
21C93 @<135=5>D 5H5B39C5C
>_dU Notice that a 4” {100mm} tee was connected to the reducer. One of the default settings in
the Drawing Preferences dialog enables you to automatically match the settings of the
last component placed in the drawing. Also of note is the color of the tee. A separate
setting in the Drawing Preferences dialog controls how colors are assigned in PIPING. By
default, objects that share a nominal size are colored the same so that size ranges can
be easily distinguished in the model.
1<97>9>7 3?=@?>5>DC
Refer to the Figure above. Suppose you were to remove the 6” {150mm}tee that is aligned with the
flange and the upward turning elbow. To place it again, you would have to find the intersection
point between the two centerlines. In the past, this meant routing centerlines or construction lines
to determine the point, or getting out the calculator to compute the desired insertion point. With
PIPING, aligning a component to existing centerlines has never been easier.
D? 1<97> 3?=@?>5>DC
! To begin this exercise, erase the 6” {150mm} tee that you placed earlier. Type E and press
N , then pick a point on the outline of the tee and press N. The model appears as shown
below.
" Now you will re-insert the tee using the Align option. Select Piping/Branching
Components/Straight Tee.
# The prompt
Relative/Toggle/Elev/<Pick point or Return for fit-fit>:
displays. PIPING assumes you want to continue routing off the 4” {100mm} tee. Select the
open end of the flange instead.
$ The prompt
Relative/Elev/<Pick point or Return for fit-fit>: R
displays. Type R(elative), then press N.
% The prompt
Align/change Ref point/<Enter distance or Return for fit-fit>: A
displays. Type A(lign), then press N.
& The prompt
Pick component to align to
displays. Select the open end of the upward-turning elbow.
' The prompt
Toggle/<Enter to select currently highlighted port>
displays, and the two selected alignment ports are highlighted. Confirm that you want an
insertion point placed at the intersection of these two ports by pressing N.
( An outline of the tee is inserted at the specified point, and the prompt
Toggle insertion point/<Return to select>:
displays. Press N to place the tee at its center.
) The prompt
Toggle alignment port/<Return to select>:
displays. You can toggle the connection port so that the branch or a run end is facing toward
the flange. Press N to accept the default port alignment.
! The prompt
Enter orientation:
displays. Pick a point in the +X direction, or press the +X button on the Direction Aids toolbar
to indicate the branch direction of the tee. The tee is aligned with the centerline of the flange
and elbow as shown in the following Figure.
Tutorial 4-19
3?=@?>5>D @<135=5>D 21C93C
21C93 @<135=5>D 5H5B39C5C
1DD1389>7 D? 1 35>D5B<9>5
Another method of component placement is to place a component directly on a centerline. PIPING
provides centerline router functions to enable you to define a piping path with a high degree of
precision. Components can then be placed directly on the line to ensure placement at proper
elevations. In this exercise, you will route a simple centerline, then place an elbow on it to
demonstrate this feature.
# The prompt
Exit/<Options>/Start Point: end
displays. Type END and press N, then select the endpoint of the tee as shown in the
following Figure.
If the end was not picked as shown above, type T and press N to toggle the selection point
until the end is selected. Press N when the point is selected as shown to accept this point.
$ The prompt
Exit/<Options>/Pick Point:
displays. Press N to display the Routing options dialog shown below.
% To pick the next point 5-feet {1500mm}south from the end of the tee, scroll down and select
South from the Options list, type 5’ {1500} in the Distance field, then press OK to pick the
point.
& Press N to return to the Router dialog.
' To pick the next point sloping at a 45-degree angle, select Sloping from the Options list, type
45 in the Z Angle field, then press OK.
Tutorial 4-21
3?=@?>5>D @<135=5>D 21C93C
21C93 @<135=5>D 5H5B39C5C
Next point:
displays. Type @5’{1500}<0 at the command line, then press N to draw the line as shown
below.
! You can now place an elbow at the intersection point. PIPING will roll the elbow
automatically. Select Piping/Bends and Returns/90° LR Elbow.
" The prompt
Relative/Toggle/Elev/<Pick point or Return for fit-fit>:
displays. Pick a point near the corner of the centerline that was just created. PIPING will
automatically recognize the intersection as the desired point and place the elbow.
>_dU Notice that the insertion point and orientation prompts were bypassed, and the elbow
graphic was placed without further interaction.
you will manually select the components between which pipe should be placed. Enable the
Manual radio button, then press OK.
# The prompt
Select objects:
displays. Select the flange, the 6” {150mm} tee, and both elbows as shown below, then press
N.
$ Connecting pipe is placed between the selected components. Notice that AutoPipe recognized
the branch run on the tee. Type REGEN and press N. The model appears as shown below.
Tutorial 4-23
3?=@?>5>D @<135=5>D 21C93C
49C@<1I =?45
49C@<1I =?45
PIPING components are constructed from a series of Rebis Custom Objects, which have inherent
display properties. PIPING provides the Display Mode options to enable you to instantaneously
display components using any of the four inherent display modes. These display modes do not
affect the size of the drawing. These commands may be executed from the Piping/Piping Tools/3D
Display Modes menu, or from the Display Modes toolbar (flyout of Piping Tools toolbar).
>_dU The mesh density used to display components in the Mesh Display Mode is defined by
setting the value of the Surface Resolution in the Drawing Preferences dialog prior to
component placement.
381@D5B B5F95G
Basic Placement Procedure: To insert a component, select it from the menu or toolbar, indicate
its placement point, then orient the component for branches and bends. Within each of these
basic steps, the user has a variety of options available.
Fitting to Fitting: Because most components are placed using the fitting-to-fitting method,
PIPING automates many of these tasks. To connect a component to the previous one, simply
select the new component, then press the N key, or the right mouse button.
Working in a Skewed View: PIPING is a true 3D package. To fully utilize its power, you can
work in a three-dimensional view using AutoCAD’s standard View commands and controls.
Other Placement Options: In addition to the automated placement capabilities, PIPING allows
components to be placed with a great deal of precision and accuracy. Toggle the Relative
command to change the reference point from which a component is placed. The Align
command can be used to orient two components along the same centerline.
Drawing Mode: The drawing mode switch can toggle the display of the model between various
inherent custom object display properties. Changing the drawing mode does not affect
drawing size.
G81DµC >5HD
In Chapter 5 you will use the techniques introduced in this chapter to construct a simple piping
model. You will begin with an equipment drawing and connect directly to the existing nozzles.
Two piping lines will then be constructed. You will also take a closer look at some of the tools that
are available to automate piping tasks.
Tutorial 4-25
381@D5B
B?ED9>7@9@51>469DD9>7C
This chapter contains several exercises that explain how to build a simple model. The
focus is on providing an overview of the major PIPING placement functions.
OVERVIEW 5-2
?F5BF95G
This chapter builds upon the connection methods discussed in Chapter 3. A tutorial drawing has
been provided that contains the vertical and horizontal vessels shown below. You will begin by
connecting pipe directly to the nozzles on these vessels, then execute various connection and
placement techniques to construct the simple pipe run shown here. At the completion of this
chapter, you will be capable of placing any arrangement of components as shown below.
>_dU You can also connect to xreferenced drawings which share the same Workspace.
Workspaces allow several designers to share each other’s models. This powerful feature
of AutoPLANT is discussed in greater detail in Chapter 7, Drawing Production.
! Select Programs/AutoPLANT 3D/Start AutoPLANT Plant Design from the Windows Start menu.
" Select File/Open. When the file selection dialog appears, locate the …USER/SUPPORT
directory on your local drive. Open the file PIPE01.DWG {PIPEM.DWG}.
# Select Rebis/Piping to start the PIPING application.
$ The model opens to the extents of the drawing limits.
% Select Piping Tools/3D Display Modes/Set Wireframe w/Centerline to set the display mode. Type
Regen and press N, then zoom around the area shown below. Note that there are two nozzles
on the horizontal vessel and one on the vertical vessel. These vessel's and their associated
nozzles were created using the AutoPLANT EQUIPMENT application.
& Open the Piping Components Main, Piping Functions Main, Direction Aids, and Responses
toolbars from the Piping/Toolbars menu.
>_dU The vessels and nozzles shown in the model above were created using the EQUIPMENT
application. The drawing/model file (PIPE01.DWG/PIPEM.DWG), has an associated
drawing database file (PIPE01.MDB/PIPEM.MDB), which contains a record for each
component in the model. Every AutoPLANT drawing will have an associated drawing
database file, the format of which can be configured.
' (Optional): You might want to save the drawing in a new directory in order to preserve the
original should other users want to perform the tutorial on the same workstation. Select
File/Save As, then select a unique directory. Chapter 1 of this tutorial recommends creating a
directory on your local drive named \TUTOR. As you save the drawing throughout these
lessons, the associated drawing database file will be updated automatically.
Tutorial 5-3
B?ED9>7 @9@5 1>4 69DD9>7C
4B1G9>7 C5DD9>7C
4B1G9>7 C5DD9>7C
The first step in beginning a new drawing session is to establish the initial component size,
specification, drawing mode, line number, etc., in the Drawing Preferences dialog.
" You will initially use the drawing preferences shown above. Ensure that your drawing
preferences match those shown above, then press OK. These settings will enable you to place
3D 6” {150mm}components from the CS150{MCS150}specification.
>_dU The default values that appear in this dialog are defined in the configuration selected
when a new drawing is created. These defaults can be modified using the AutoPLANT
Configuration Editor, which can be launched from the main Rebis menu or toolbar. An
overview of the operation of this application was provided in Chapter 2, Project Setup.
Zoom around the horizontal vessel as shown. Throughout this tutorial, we refer to the “West” and “East” nozzles.
4B1G9>7 =?45
In this tutorial we will be displaying wireframe graphics with centerlines. This may be the default
in use already on your system. To ensure it is set properly, select
Piping/Piping Tools/3D Display Modes/Set Wireframe w/Centerline.
Tutorial 5-5
B?ED9>7 @9@5 1>4 69DD9>7C
@<135=5>D CDB1D5795C 1>4 3?>C945B1D9?>C
<9>5 <!
3?>>53D D? D85 >?JJ<5
! Select Piping/Flanges/Weldneck.
" The prompt
Current Elevation <COP 0”>:
Elevation/<Pick point>:
displays. Select any point on the face of the West nozzle. As long as a point is selected near
the outline of the nozzle, PIPING will automatically recognize that you want to connect to the
end of it.
# The prompt
Relative/Elev/<Pick point or Return for fit-fit)>:
displays. Press N to place the flange using the “fitting-to-fitting” method.
$ The Specification Selection dialog displays to enable you to select the desired connecting
gaskets. This dialog appears during component placement whenever there is more than one
specification record for the selected component in the specification. For example, there are
two gaskets that match the connecting criteria in the CS150 specification. You can view
additional fields in this dialog by “grabbing” the horizontal scroll bar at the bottom of the
dialog and sliding it to the right to reveal the remaining fields as shown below. Select the first
gasket option in the list, then press OK.
8Y^d You can use the Spec Generator to establish a set of default components. When the
Default Spec Choice switch is enabled in the Drawing Preferences dialog, the default
components will be placed automatically and bypass the Specification Selection dialog
during component placement. Refer to the Spec Generator’s on-line help for more
information on how to define default component choices.
In the following procedure, you will use the Relative placement option to place an elbow 4-feet
{1200mm}south of the flange.
@<135 1> 1G1I6139>7 5<2?G $ 655D k!" ==m 6B?= D85 6<1>75
Tutorial 5-7
B?ED9>7 @9@5 1>4 69DD9>7C
@<135=5>D CDB1D5795C 1>4 3?>C945B1D9?>C
4’{1200mm}
Now that you have connected the flange to the nozzle and placed the elbow, you will connect pipe
between the two components. In this step, the Connect To command will be demonstrated.
8Y^d In this example pipe was placed between two existing components. A separate
command, AutoPipe, is available for placing connecting pipe between several
components. This feature will be demonstrated later in this chapter.
<9>5 <"
The nozzle on the east end of the horizontal vessel is the starting point for line L200. In this
exercise you will turn on the Auto Router switch, then add a valve/flange assembly to the nozzle.
Afterwards you will copy the away-facing elbow placed earlier and assign it to this line.
>_dU The east nozzle was assigned the Line Number L200 when it was created using Rebis
EQUIPMENT. Since the From Connecting Component option is enabled in the Drawing
Preferences dialog, the line number will be automatically reset once you attach a
component to this nozzle.
! Select Piping/Valves/Gate/Gate.
" The prompt
Elevation/<Pick point>:
displays. Since you are not continuing to route off the last component (the away-facing elbow
on line L100), you must specify a new reference point. Pick the open face of the east nozzle.
Tutorial 5-9
B?ED9>7 @9@5 1>4 69DD9>7C
@<135=5>D CDB1D5795C 1>4 3?>C945B1D9?>C
# The prompt
Relative/Elev/<Pick point or Return for fit-fit)>:
displays. The reference point symbol is now centered on the east nozzle. Press N to accept
the fitting-to-fitting designation and attach the gate valve at this location.
$ The Specification Selection dialog displays to enable you to select the desired gate valve from
the spec. Select the first record in the dialog, then press OK.
% The AutoPLANT Selections dialog displays to enable you to connect an operator to the valve.
Press Cancel for no operator.
& The Specification Selection dialog displays to enable you to select the desired gasket from the
spec. Select the first record in the dialog, then press OK. After responding to the three dialogs,
the valve is placed as shown below.
' All of the components placed in the model to this point were inserted without using the Auto
Router. To enable this function, select Piping/Setup/Drawing Preferences…. Enable the Auto-
Router Mode check box, then press OK to close the dialog.
( Attach a flange to the valve by selecting Piping/Flanges/Weldneck. Note that you are not
prompted for the insertion point. With the Auto Router switch enabled, PIPING automatically
assumes that you want to connect to the endpoint of the last component.
) PIPING determines the facing on the end of the valve and filters the Specification Selection
dialog to display only those gasket records that match the facing designation. Select the first
gasket option from the next dialog, then press OK. A default bolt set has been defined in the
specification. The model appears as shown in the following figure.
! Select Piping/Setup/Drawing Preferences…, disable the Auto Router switch, then press OK to
close the dialog.
3?@I9>7 3?=@?>5>DC
PIPING components can be copied, moved, mirrored, or arrayed just like any other AutoCAD
entity. When components are copied, a separate database record is created for each component. A
dialog also displays to enable you to change/revise the line number drawing database field values
for the copied components. In the tutorial model, the two nozzle centerlines are 6-feet (72”)
{1800mm}apart. Since this design calls for away-facing elbows equidistant from the vessel shell,
you can use AutoCAD’s COPY command to copy the existing elbow.
GQb^Y^W Do NOT use AutoCAD’s Edit/Copy command or its associated icon on the AutoCAD
toolbar. These commands are members of the COPYCLIP family, and are related to
Object Linking and Embedding (OLE) functions. OLE operations are not supported in the
current version of PIPING.
Tutorial 5-11
B?ED9>7 @9@5 1>4 69DD9>7C
@<135=5>D CDB1D5795C 1>4 3?>C945B1D9?>C
# The prompt
<Base point or displacement>/Multiple:
displays. Pick any point on the elbow.
$ The prompt
Second point of displacement: @6’{1800}<0
displays. Type @6’{1800}<0 at the command line, then press N. The copied elbow is placed
six -feet {1800mm} in the +X direction from the selected elbow as shown in the following
Figure.
6’
% The message
Rebis post-copy/explode component update in progress…
Retrieving copied components...
Updating database links...
Re-establishing connectivity...
Updating component data...
is echoed to the command line, and the following dialog displays to enable you to change the
line number drawing database value of the copied elbow.
8Y^d By default, LINENUMBER is the only field that appears in this dialog. You can customize
the list of fields that may be updated after a COPY is performed using the
Piping/Setup/Component Copy Preferences… command.
& Finally, you will place connecting pipe between the flange and the elbow using the same
technique you learned earlier. Select Piping/Pipe Components/Pipe. Press N to designate the
end of the flange as the first point. When the
Connect To/<Enter Length>:
prompt appears, type C then press N. The
Select component:
prompt displays. Pick the open end of the elbow that lies in the XY plane. The model appears
as shown below.
Tutorial 5-13
B?ED9>7 @9@5 1>4 69DD9>7C
@<135=5>D CDB1D5795C 1>4 3?>C945B1D9?>C
! Change the viewpoint in order to get a better working view of the model. Press the SW
Isometric View button (or type vpoint -1,-1,1 at the command line), then zoom around the
horizontal vessel to obtain a view similar to that shown below.
Enable the Center of Pipe radio button, then type 2’ {600} in the Elevation field and press OK to
insert the elbow at an elevation of 2-feet {600} relative to the selected elbow.
% The prompt
Toggle insertion point/<Return to select>:
displays. Press N to accept the default and insert the elbow at its center point.
& The prompt
Enter orientation:
displays. With the ORTHO lock ON, select any point in the +X direction to set the orientation.
The elbow is placed in the drawing as shown.
Elev: 2’
4’
Tutorial 5-15
B?ED9>7 @9@5 1>4 69DD9>7C
@<135=5>D CDB1D5795C 1>4 3?>C945B1D9?>C
that it aligns with two existing components, even if those components lie at different planes and
elevations.
D? 1<97> 1 D55
# The prompt
Relative/Toggle/Elev/<Pick point or Return for fit-fit>:
displays. Press the Relative button (or type R then press N).
$ The prompt
Toggle/Align/change Ref point/<Enter Distance or Return for fit-fit>:
displays. In this example, you want the tee’s branch to align with the elbow on line L200.
Press the Align button.
% The prompt
Pick component to align to:
displays. Select the away-facing elbow on line L200 (point PT2 in the Figure above).
) The last step determines how the branch is oriented. Press the +Z button on the Direction Aids
toolbar to set this orientation and place the tee as shown.
Tutorial 5-17
B?ED9>7 @9@5 1>4 69DD9>7C
3?>>53D9>7 @9@5
3?>>53D9>7 @9@5
Earlier in this chapter, you used the Connect To placement option to connect two components that
were placed in the same plane. In this section, the PIPING's AutoPipe command will be used to
place connecting pipe between all of the “floating” components in the model.
Connecting pipe is automatically placed between all open-ended components that have
another component with an open end along the same plane as shown in the following Figure.
This elbow
belongs to L200
Connecting pipe
is not placed
This tee belongs
to L100
# Note that connecting pipe was not placed between the downward turning elbow and the tee.
This is because the elbow belongs to line L200 while the tee is assigned to L100. AutoPIPE
will not place connecting pipe between components on different line numbers. This prevents
faulty assignment of line number identifiers. Select Piping/Pipe Components/Pipe.
$ The prompt
Current elevation <COP 2'>
create taP/Elevation/<Pick point>:
displays. The component you pick in this step determines the line number assigned to the pipe.
If you pick the elbow, the pipe will be assigned to line L200. If you pick the tee, the pipe will
be assigned to L100. Select a point on the open end of the elbow.
>_dU In Chapter 5, The Drawing Database, you will learn how to manually edit the line number
assigned to a component, and to groups of components.
% The prompt
Relative/create taP/Elev/<Pick point or Return for fit-fit>:
display. Press N to connect to the elbow.
& The prompt
Connect to/<Enter Length>:c
displays. Type C and press N, then select a point on the branch of the tee. The model
appears as shown below.
Tutorial 5-19
B?ED9>7 @9@5 1>4 69DD9>7C
B?ED9>7 1 35>D5B<9>5
B?ED9>7 1 35>D5B<9>5
Another method of component placement involves routing a centerline to define the piping path,
then placing components directly on the line to ensure proper alignment. This method has the
advantage of laying out the entire pipe run at the outset.
A centerline in PIPING is intelligent, meaning that the application can read the positional data
stored on these lines to insert components. Component preferences can also be saved with the line
and automatically applied to any components placed on it. In this section, you will route a
centerline to connect the open end of the tee with the nozzle on the vertical vessel. Afterwards, you
will add elbows at the intersections and then use the AutoPipe feature to complete the model.
! Change the display view so that both the end of the tee and the nozzle on the vertical vessel
display as shown in the following Figure.
" Attach a gasket and flange to the nozzle on the vertical vessel. Select
Piping/Flanges/Weldneck.
# The prompt
Elevation/<Pick point>:
displays. Select the open end of the nozzle on the vertical vessel, then press N to attach the
flange to the nozzle at the reference point.
$ The Specification Selection dialog displays to enable you to select the desired gasket. Choose
the first option in the dialog. The flange is attached to the nozzle as shown in the following
figure.
' The Component Preferences dialog displays as shown below. This dialog enables you to
define component preferences that will be stored with the line and applied to all components
that are placed on the line. Set the dialog values as shown, then press OK.
Tutorial 5-21
B?ED9>7 @9@5 1>4 69DD9>7C
B?ED9>7 1 35>D5B<9>5
( The prompt
Exit/<Options>/Start Point: end of
displays. Type END and press N, then select the end of the flange connected to the vertical
vessel’s nozzle. The Router will automatically extract the elevation parameters from that
point.
The prompt
Toggle/<Enter to select currently highlighted port>:
displays. This prompt enables you to change the port of the flange that was picked above. If
the port on the open end of the flange is selected, press N, or if it is not, type T until it is
selected.
) The prompt
Exit/<Options>/Pick Point: @2’{600}<135
displays. You can either input points directly from the command line using standard AutoCAD
techniques, or press N to open a dialog of options. In this instance, use the command line:
Type @2’{600}<135 and then press N. A line is drawn 2-feet {600mm} from the end of the
flange.
! Press N to open the Routing dialog shown below.
Select Box Router Pick from the Options section of the dialog, then press OK. The Box Router
Pick option will draw a temporary box between the current point and a user-selected point.
This makes it a simple matter to route 90-degree changes in direction between two points
which lie at different elevations.
!! The prompt
Pick End Point of Box: end of
displays. Type END and press N, then pick the end of the tee as shown below.
!% Type K then press N to accept (<Keep>) the highlighted centerline path. The centerline is
routed between the selected points.
Tutorial 5-23
B?ED9>7 @9@5 1>4 69DD9>7C
1449>7 5<2?GC 1D D85 9>D5BC53D9?>C
Tutorial 5-25
B?ED9>7 @9@5 1>4 69DD9>7C
3?=@<5D9>7 D85 =?45<
# The prompt
Select objects:
displays. In a previous exercise, you selected the components individually. You can also
window the components and let AutoPipe determine where the pipe should be placed. For
example, respond to the prompt by windowing the shaded area shown in the following Figure,
then press N.
Window the
shaded area
$ Connecting pipe is placed at the proper locations as shown in the Figure below.
% Use the AutoCAD Zoom All command to get a better look at the model. Select
Piping/Piping Tools/3D Display Modes/Set Wirefame, then type HIDE and press N to display
the model as shown in the Figure below.
Tutorial 5-27
B?ED9>7 @9@5 1>4 69DD9>7C
381@D5B B5F95G
381@D5B B5F95G
The following important features and/or concepts were introduced in this chapter.
Drawing Preferences: The Drawing Preferences dialog contains settings that are applied
throughout a drawing session. The Data Mode determines whether settings are applied based on
the values in this dialog or extracted from the connecting component. The Auto-Router Mode
switch enables components to automatically attach to the endpoint of the last component
placed in the drawing.
Specification Selection: If more than one valid record exists in the current specification, a
dialog displays to enable you to choose the desired component.
Relative Placement: The Relative placement option allows components to be placed a given
distance away from an existing component. Toggle options are available to place the
component with respect to its centerpoint or endpoint.
Copying Components: PIPING components can be copied just like any other AutoCAD entity.
Separate records are created in the drawing database, and the user is prompted to (optionally)
change the line number associated with the copied component.
Align To: The Align to option (available when placing components using the Relative command)
enables you to place bends or branching components so that the centerlines are aligned with
the centerlines of selected components.
AutoPipe: The AutoPipe feature automatically places connecting pipe between selected
components.
Centerline: The Router dialog contains options for drawing centerlines. After a piping path is
defined, components can be placed directly on it to ensure proper connectivity and elevation
settings. If the router is initiated with Info Mode set to ON, component preferences defined
when the line was drawn are applied to any component placed on it.
G81DµC >5HD/
In the next chapter, you will explore the commands associated with viewing and editing the
external drawing database information. You will add a tag value to a valve, view the database
record, and learn how to clean the external drawing database so that it accurately reflects the
components contained in a model.
D854B1G9>741D121C5
PIPING creates intelligent models. There is a dynamic link between the components
in the model and the associated records in the external drawing database. You can
query this data to produce reports or to modify the records. This chapter introduces
you to some of PIPING’s database manipulation and editing tools.
OVERVIEW 6-2
?F5BF95G
?F5BF95G
When a component is placed in a PIPING model, a record is written to an external drawing
database. All data defined in the component’s spec record and additional descriptive data defined
in the Drawing Preferences dialog (e.g., Line Number, Insulation Thickness, etc.) are written into
this record.
The external drawing database may be configured as a single MS Access-formatted database with
multiple tables, or multiple dBASE-formatted database tables. The drawing database format should
be configured at the start of a project and used throughout the project. The drawing database, by
default, is configured for MS Access databases.
There may be multiple database tables associated with a single drawing file. The tables that are
actually created for a drawing depend on a number of factors. When a PIPING drawing is first
created, the system adds PIPING and CONTROL tables to the database. If the PIPING drawing is
loaded into EQUIPMENT, the EQUIP and NOZZLE tables are added. If you start with an
EQUIPMENT drawing instead of a PIPING drawing, the EQUIP, NOZZLE, and CONTROL tables
are created. If you later open the drawing in PIPING, the PIPING table would be added.
In addition to these tables, you may specify that extra PORT, JOINT, FASTENER, and CADLINK
tables and data are created, and their data stored in the external drawing database. The data in
these tables is already stored in the drawing, but a mechanism is provided to enable you to also
store this data in the external drawing database. 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 PORT, JOINT and
FASTENER tables and write their data to the drawing database, enable the Save Port Data check
box.
The database format is configured in the file DBCONFIG.INI. If the system is configured to create
an MS Access drawing database, 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 in
DBCONFIG.INI.
8Y^d The Drawing Database format may be configured by editing the text control file
DBCONFIG.INI as described in the AutoPLANT Program Customization help. This file
may be launched via the AutoPLANT 3D/Customization Tools and Help program group in
your Windows Start menu.
>1=5 45C3B9@D9?>
CONTROL The CONTROL data table stores general drawing information in the external drawing
database (e.g., drawing name, user who last modified the drawing, etc.).
PIPING The PIPING data table stores all data for components placed in a PIPING or
ISOMETRICS drawing.
EQUIP The EQUIP data table stores all data for equipment components placed using the
EQUIPMENT application.
NOZZLE The NOZZLE data table stores all data for nozzles placed using the EQUIPMENT
application.
PORT (optional) The PORT data table stores all component port data in a model. The JOINT
JOINT data table stores the joint connection data for connected components in a PIPING
FASTENER drawing. These joints are checked whenever you attempt to connect components. The
FASTENER table stores component data for fasteners placed between components in a
PIPING or ISOMETRICS drawing. Joint, fastener, and port data is stored in the drawing,
but may also be stored in the external drawing database by enabling the Save Port Data
check box in the Drawing Preferences dialog.
CADLINK (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 be
stored in the external drawing database by enabling the Save CADLinks check box in
the Drawing Preferences dialog.
TRANSACT The TRANSACT table contains a record of significant transactions that have taken
place and can be viewed by executing Database Tools/Database Information, then
pressing the View Transactions button. These transactions can be purged using the
Purge Transaction button on that dialog. In addition, under the [PLANT] 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
In addition to these tables, there are a number of tables used by the application to temporarily store
drawing port, joint, fastener, and attachment data used to store joint information on joints that span
across drawings (e.g., from a drawing into an xref). These table names start with the CNN prefix
and should not be removed from the database format configuration.
Tutorial 6-3
D85 4B1G9>7 41D121C5
This chapter demonstrates two database edit methods: the first involves the simple editing of a
selected component; the second method involves updating the attributes of several components
simultaneously. In addition, you will learn how to clean the drawing database to ensure that the
records in the database are synchronized with the components in the model.
8Y^d The intent of this chapter is to provide an overview of database concepts and capabilities.
For an in-depth discussion of database configuration and customization topics, refer to
the AutoPLANT Program Customization help file that may be launched from the
AutoPLANT 3D/Customization Tools and Help group of your Windows Start menu..
There are separate Component Information dialogs to display the drawing database information for
most of the different component types. These are defined in the component script files that reside
in your network ..\MODULES\BASE\COMMON directory. Each dialog displays the General
Information from the drawing database in the top area of the dialog, and the Class Information in
the bottom area. The tile window at the top right of the dialog displays an illustration of the
component type and the points where ports are located. Ports are points that contain connection
and vector information as you will see in Page 2 of this dialog.
>_dU The fields displayed in the Component Information dialog can be customized. Refer to
the AutoPLANT Program Customization help file for the procedure to modify these
dialogs.
Tutorial 6-5
D85 4B1G9>7 41D121C5
This dialog is divided into two sections. The top list box displays port information. The
coordinates for the ports are listed along with the vector information that defines the run direction
of the component. The Main Size, End Condition, Facing, and Pressure Class associated with the
ports are also listed.
The bottom text box lists all of the component’s drawing database fields and their values. You can
select an item in the bottom list box to edit its value. If an item is not editable, a warning message
will be issued indicating that the field is READ-ONLY.
! From the first page of the Valve Information dialog, type A2R in the Tag field, then press OK
to close the dialog.
" Select Piping/Database Tools/Edit Component to re-display the dialog. Note that the new value
has been saved in the component database record.
>_dU Note that this component information dialog is formatted slightly differently from the valve
dialog. Each of the major component types has its own dialog.
>_dU This is the pipe segment that was assigned to L200 when you connected the pipe to the
elbow in the previous chapter. If you had connected the pipe to the tee, you could have
easily revised the Line Number field to read L200 inside this dialog.
% Press OK to close the dialog. Press N to terminate the Edit Component command.
GQb^Y^W Exercise caution when using a database editor to edit component records directly. We
recommend using the Edit Component or Update Component commands to edit values,
as doing so will ensure compatibility with other operations of the program. When using an
editor, do NOT edit values that provide dimensional information about the component.
Tutorial 6-7
D85 4B1G9>7 41D121C5
8Y^d The Advanced option enables you to create a database query that will filter the
component records displayed in the Database View dialog.
" After creating your selection set, the Database View dialog displays as shown below. Use the
scroll bar to view the entire list of component records.
8Y^d You can select a record in this dialog and press Go To to zoom into the selected
component and center it within the display, or press Edit to execute the Database
Tools/Edit Component function on the component.
E@41D9>7 3?=@?>5>DC
AutoPLANT applications make extensive use of databases to track and manage component data.
This includes the use of specification databases to extract the parametric data used to draw
components, as well as a drawing database to store information about the components in a drawing
or model. By storing component information in an external database, a high level of control can be
maintained over the components in a drawing.
For example, an engineer may determine that the pressure rating of a given line must be upgraded
because of the demands of the system, or that the material of a given line should be changed from
carbon steel to stainless. The Update Component function enables you to create a selection set of
components that match user-defined criteria, then to specify a new value for a selected drawing
database field and apply that value to update the drawing database records for all selected
components.
Changes can be made to component records in the current drawing, or to component records in
multiple drawings. The following example demonstrates how to define a selection set of
components, then revise the line number drawing database field value for every component in the
selection set.
8Y^d This example demonstrates how to revise a line number. The same techniques described
here can be used to select and revise other component drawing database field values.
" This is the same dialog that appeared when you selected the Auto-Pipe command earlier in this
tutorial. This selection dialog displays whenever a command may be applied to more than one
component. Select Advanced, then press OK.
# The Advanced option displays the following dialog to enable you to define a search criteria that
will be used to define the selection set of components included in the update. This dialog
enables you to create a selection set of components based on the value of a specific drawing
database field, or based on drawing attributes, such as Color or Layer. In this example, you
will define a query condition to select all components in the model whose LINENUMBER
drawing database field value is L100.
8Y^d Press the dialog’s Help button for a detailed explanation of every dialog option.
Tutorial 6-9
D85 4B1G9>7 41D121C5
E@41D9>7 3?=@?>5>DC
$ The Query Selection area of the dialog enables you to select a query from those that have been
previously defined, or were included with the shipping version of the software. Since you only
want to apply this query to the current drawing and do not want to save it for future use, you
can ignore the settings in Query Selection area of the dialog.
% The Define Query area of the dialog is where you define the condition that will be used to
select the component records. The Type field indicates the drawing database table that will be
searched. To only include piping components in the search, select the Piping Data table.
& The Attribute Field drop-down list will now list all fields in the PIPING drawing database
table. Select the LINENUMBER field from this list. The list of fields in this drop-down list is
extracted from the drawing database.
' The Constraint field defines the relationship between the Attribute Field and its value. For
example, you can specify that you want to search for all component records whose line
number is L100 (LINENUMBER = L100), or for all component records whose line number is
NOT L100 (LINENUMBER != L100). Select the equal “=” Constraint.
( Specify the desired field value in the Attribute field. There are two methods available to
specify the value: you can type it directly in the space provided, or select it from a list. Press
the browse button (shown at left) to display the dialog shown in the following figure.
When Browse is pressed, PIPING will search the drawing database and compile a list of
unique values for the selected attribute. The Filter List Content field enables you to filter the
list of entries displayed in the dialog. For example, if you have a large drawing that contains
hundreds of line numbers 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. Select L100, then press OK.
) The last step is to add the query to the active list, then execute the query. As each query is
defined, you must add it to the Active Queries list. In this manner, you can construct a highly
detailed search by adding multiple queries in combination with the And and Or operators (refer
to on-line help for more information). This example is a simple one: press Add-> to add the
query to the Active Queries list as shown below.
Tutorial 6-11
D85 4B1G9>7 41D121C5
E@41D9>7 3?=@?>5>DC
>_dU The Include XREF's check box at the bottom of this dialog is provided to enable you to
also update the components that in attached xref'd drawings.
8Y^d By default, LINENUMBER is the only field that appears in this dialog. You can revise it to
include as many fields from the drawing database as desired. Select Piping/Setup/
Component Update Preferences…. Refer to the on-line help for more information.
!" All components whose LINENUMBER drawing database field value was previously set to
L100 are updated so that their LINENUMBER field value is now L300.
To check the update, select Piping/Database Tools/Edit Component, then select one of the
components previously belonging to L100 (For example, any segment of pipe between the tee
and the vertical vessel). Confirm that L300 now appears in the Line Number field, then press
OK to close the dialog.
>1=5 45C3B9@D9?>
Clean Database Enable this check box to synchronize the external drawing database so that it will match the
Records 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.
Clean Graphics On rare occasions a graphic component is created without a corresponding database
Data record. This implies there is no intelligence associated with this component. Enable this
check box to move those graphical components that exist without an associated database
record to the piping_orphan layer.
Display Status This enables you to "quietly" clean the database. Current cleaning statistics are still
Dialogs 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.
Enable all of the check boxes, then press OK. Status messages will display on the command line to
indicate changes to the drawing during this process.
Tutorial 6-13
D85 4B1G9>7 41D121C5
381@D5B B5F95G
381@D5B B5F95G
The following important features and concepts were introduced in this chapter.
G81DµC >5HD/
In the next chapter, you will learn how to use PIPING’s Drawing Production commands to setup
tiled viewports in Layout View (Paper Space), then place dimensions and annotation text in the
drawing. Rebis encourages the use of layouts (paper space) to perform these activities as it ensures
the model will be kept clutter-free. It also helps to visualize how the final production plot will look
and enables you to conveniently manipulate several views of your drawing in one environment.
4B1G9>7@B?4E3D9?>
This chapter explains how production drawings are created from a PIPING model.
The concept of a Work Area is explained, and two saved Work Area views are
inserted into Paper Space. Each of these viewports is dimensioned and annotated to
create a Plan and Sectional view of the model on the same drawing sheet.
OVERVIEW 7-2
DIMENSIONS 7-16
ANNOTATION 7-22
?F5BF95G
This chapter introduces PIPING’s drawing production commands. Two key concepts: Work Space
and Work Space Views, are discussed in detail. Two Work Space Views are defined and placed in
Paper Space as a Plan and Sectional view. Later in the chapter, dimension and annotation tools are
demonstrated. After completing these exercises, your drawing will look similar to the one shown
below.
Another advantage of paper space is that it keeps the model clutter-free. You can place dimension
lines, annotation, and Bill of Materials in paper space, without worrying about freezing these
layers in order to view a “clean” representation of the model.
The remaining exercises in this chapter (and the next) rely on the use of Paper Space.
Tutorial 7-3
4B1G9>7 @B?4E3D9?>
C5DD9>7 E@ @1@5B C@135
>_dU The title block drawings shown in this dialog are controlled by the current configuration.
In the configuration you can define the directory used to display the available border
drawings.
& Select the dbord.dwg {a2bord} border file, then press OK. The Edit Attributes dialog displays
as shown below. You can input the drawing name and file name in the fields provided to
include them in attribute blocks in the border. Type PIPING TUTORIAL MODEL in the
DOC_NAME field, then press OK. The string entered in the DOC_NAME field will
automatically be placed on the title block when it is inserted.
' The ANSI-D {ISO-A2} Size title block is placed as shown in the following figure. Press x
to end the title block insertion command.
G?B; 1B51
Now that the title block has been placed in Paper Space, you can return to Model space to define
the areas of the model that will be placed on the sheet.
For example, before placing piping elements, you might normally xreference steel and equipment
drawings in order to ensure placement at the proper coordinates (i.e., connecting a flange directly
to an xreferenced equipment nozzle). Similarly, drafters and designers from these other disciplines
might need to xreference the piping drawing. The Drawing Production utilities drastically simplify
this process by providing a mechanism to define a common Work Area. Individual drawings can
be added to a Work Area in order to create a set of saved xreferenced drawings that overlay each
other.
Tutorial 7-5
4B1G9>7 @B?4E3D9?>
G ?B; 1B51
= C urrent D ra w ing
P IPIN G
L200
= R eferenced D raw in g
P IP IN G
L 100 W ork A rea E Q U IP M E N T
PROCESS AREA 1
After the Work Area is defined, three-dimensional viewing cubes can be defined and associated.
These views represent coordinates within the Plant Model which are shared by the set of
referenced drawings. The view direction, scale, front and back clipping planes, etc. can also be
saved with the view.
Step 2: D efine the 3D V iew s (C lipping Planes) from the W ork A rea V iew s d ialo g.
Vie w A rea 2
V V-IN
View A rea 1
H V-O U T = N am ed View w ith Front,
B a ck, a nd E levation clipping
Applied: When in Model Space, an applied Work Area View is similar to a saved View Name
that includes the set of referenced drawings. The result is a working view, which can be shared
among all team members, or across multiple drawings.
Inserted: When in Paper Space, Work Area Views can be inserted as tiled viewports. Match
lines and plant coordinates can be automatically placed along with the graphic, and users can
edit the orthogonal projection of the view. The ability to create and edit orthogonal views is
useful in generating a variety of sectional views from the same Work Area.
The Work Area tools are versatile and powerful. The next several exercises demonstrate how to
create Work Areas, assign Views to the Work Area, and then how to place these views in Paper
Space.
Tutorial 7-7
4B1G9>7 @B?4E3D9?>
G ?B; 1B51
8Y^d If you save the file on a shared network drive, other drawings can be added to the Work
Area by other users.
$ The Work Area Setup dialog displays. The filename specified in the previous step now appears
in the title bar.
% In the Title field, type TUTORIAL WORK AREA.
& For this tutorial, the current drawing is the only one defined in the Work Area. Enable the
Member radio button from the Membership Status area. Notice that the current drawing is
immediately added to the list of referenced drawings. The Member Status determines the
relationship between the current drawing and the Work Area’s referenced drawings as follows:
CD1DEC 45C3B9@D9?>
Guest The current drawing is not added to the list of drawings associated with the Work Area. Joining
as a Guest allows you to view how the current drawing is positioned in relation to the
referenced drawings; however, your drawing will not be visible when this same Work Area is
opened from one of the Member drawings.
Member The current drawing is permanently added to the list of referenced drawings, and will be visible
when the Work Area is opened from one of the other Member drawings.
Non-Member When this option is selected, the drawings in the Work Area are not visible inside the current
drawing. Use this option to recall saved views or to place view ports in Paper Space using the
coordinates associated with the selected Work Area (without including reference drawing
information or graphics).
( Notice that when a drawing in the Reference Drawings list is highlighted, the Insertion Point
fields are enabled. This enables you to insert a drawing in the Work Area at specific
coordinates. You can specify the coordinates manually. Use the Pick option to graphically
designate the point, or accept the default origin (0,0,0). In this tutorial, you will accept the
default.
>_dU The Reference Drawings area contains a list of the drawings associated with the Work
Area. Files are added to this list by pressing Add and selecting the file. Drawings
referenced in this way are linked to the current drawing using AutoCAD’s XREF/Overlay
command (as opposed to XREF/Attach).
) When the dialog appears as shown in the following figure, press Save to save the Work Area
definition, then press Done to exit the dialog. The Work Area is now defined. Once the dialog
is closed, the referenced drawings overlay the current drawing. In this example, since there is
only one drawing, there are no xreferenced elements visible after closing the dialog.
Tutorial 7-9
4B1G9>7 @B?4E3D9?>
G ?B; 1B51
>_dU If the Work Area Views command is selected and a Work Area has not been opened in
the current drawing, you are prompted to select an RWA file. Otherwise, the dialog opens
the last Work Area that was active.
# Note that there are no views associated with this Work Area. Press Add from the Views group
to define a new Work Area View.
$ The View Properties dialog displays as shown below. This dialog enables you to define a
three-dimensional cube within the plant/model world. The coordinates are defined in the 3D
Envelope area of the dialog. Once the cube is defined, you can specify the side (view) that will
display in the Work Area View. The active projection is illustrated by a red box in the tile
window. These views can be applied in Model Space, or placed as tiles in Paper Space.
Tutorial 7-11
4B1G9>7 @B?4E3D9?>
G ?B; 1B51
>_dU The graphic on the left is updated based on the selected View. For example, if you select
Front, the front side of the cube is highlighted in red.
' Set the Scale to ½”=1’0” {1:30}. The scale applies when placing Work Area Views as tiled
viewports in Paper Space.
( The View Options are annotation and layer control options that are applied when the Work
Area View is placed as a viewport in Paper Space. The Match Line setting draws a border
around the viewport in Paper Space. The Coordinates display the plant world coordinates
from which the view was “cut,” provided the Match Line option was enabled. The Clipping
options exclude components (or parts of components) that do not lie within the boundaries of
the 3D Envelope. The Viewport Visible option causes ALL AutoCAD viewport borders to
become visible in the drawing. This option must be enabled if you want to be able to re-
position viewports after they have been inserted. Make the following selections:
) The next step is to specify the 3D Envelope settings. These points define the boundaries of the
three-dimensional viewing cube. The First Point and Second Point fields determine the
opposite corners of a box projected on the model from the plan. You can input these
coordinates manually, or interactively select them from the plan view of the model. The
Elevation fields determine the Top and Bottom clipping planes, which define the height of the
three-dimensional Work Area View. Input the following values:
First Point East 7’ {2100}
North 28’ {8500}
Second Point East 36’ {11085}
North 4’ {1240}
8Y^d You can pick these points manually by selecting the Pick View Area by Window option,
then picking the window from the Plan view of the model. If you are creating a Top view,
it is not necessary to specify elevation values. However, if you are creating a sectional
view (Front, Left, Right, Back), you must specify Upper and Lower values to designate
the height of the box. A sectional view is created later in this chapter.
! Press OK to close the View Properties dialog. Changes to the view properties are saved
automatically.
!! Control is restored to the Work Area Views dialog. Notice that AREA 1- PLAN VIEW is now
listed in the window. Select the new view and press Preview.
!" The dialog temporarily closes, and a dashed red line is drawn around the defined view. Press
x to return to the dialog. In the next section, you will create a Front View section.
>_dU The Coordinates option, which was not selected in the previous view, will annotate the
plant coordinates of the projected view.
& Input the following values to define the 3D View Envelope. Note that Elevation values are
required for the Front View projection.
First Point East 11’ {3200}
North 23’ {6742}
Second Point East 28’ {8375}
North 12’ {3758}
Tutorial 7-13
4B1G9>7 @B?4E3D9?>
G ?B; 1B51
7. Press OK to close the View Properties dialog and add the front view to the Work Area.
( Press Preview to confirm that the new view encloses the two pipe lines in the model.
) Press x to return to the Work Area Views dialog, then press Close to exit. REGEN to remove
the dashed view envelope.
Tutorial 7-15
4B1G9>7 @B?4E3D9?>
4 9=5>C9?>C
>_dU The size of the coordinate text is determined by the current value of AutoCAD’s DIMTXT
system variable.
49=5>C9?>C
PIPING relies on AutoCAD for its dimensioning tools. In general, you should refer to your
AutoCAD documentation for instructions on using their dimension commands and the capabilities
of these features. In this section, a few exercises are presented to illustrate the dimension
placement process.
>_dU For users already accustomed to the use of Paper Space, you should be aware that we
have defined the DIMLFAC environment variable. This variable sets a global scale factor
for linear dimensioning measurements. All linear distances measured by dimensioning
(including radii, diameters, and coordinates) are multiplied by the DIMLFAC setting
before being converted to dimension text. This means that even though you will be
selecting points from within paper space, the dimension values will reflect the distances
in the model.
Before beginning these dimension exercises, establish the dimensioning and annotation preferences
outlined below in the AutoCAD environment indicated.
1ED?314 B!$
! Type DDIM and press x to display AutoCAD’s Dimension Styles dialog.
" Select Geometry to open AutoCAD’s Geometry dialog. Type 1/8” {3} in the Arrowhead Size
field, then press OK.
# Press Annotation to open AutoCAD’s Annotation dialog.
$ Type 1/8” {3} in the Text Height field.
% Press the Units button on the Annotation dialog to display AutoCAD’s Primary Units dialog.
& Select Architectural Stacked {Decimal} from the Units selection list, then select 1/16” {0.00} in
the Dimension Precision field as shown above. Press OK to close the Primary Units dialog.
' Press OK to close AutoCAD’s Annotation dialog, then press OK again to close the Dimension
Styles dialog.
1ED?314 "
! Type DDIM and press x to display AutoCAD’s Dimension Style Manager dialog.
" Press Modify to override the current settings.
# On the Lines and Arrows tab, type 1/8” {3} in the Arrow size field.
$ Click on the Text tab, then type 1/8” {3} in the Text height field.
% Click on the Primary Units tab. Ensure that the Unit format is set to Architectural {Decimal} and
that the Fraction format is set to Horizontal. Set the Precision to 1/16” {0.00}.
& Press OK, then press Close to exit.
You are now ready to dimension the drawing. The annotation settings were also established when
you set the annotation text height.
D? @<135 49=5>C9?>C
! Zoom Window around the boundaries of the first viewport as shown below.
" The quickest method to execute AutoCAD’s dimensioning commands is through a toolbar.
Select View/Toolbars… to display the Toolbars dialog. Enable the Dimension check-box to
open the Dimension toolbar shown below, then press Close to exit the dialog.
8Y^d You can either dock this toolbar to the perimeter of the screen or leave it floating,
depending on your preference and working style.
# Select Tools/Drafting Settings… to display the Drafting Settings dialog, then select the Snap
and Grid tab and disable the Snap On check box to turn the snap mode OFF for this exercise.
Press OK to exit the dialog.
$ Press the Linear Dimension button on the toolbar.
% The prompt
Tutorial 7-17
4B1G9>7 @B?4E3D9?>
4 9=5>C9?>C
NOD
PT3 PT2
of
END
PT4
of
( To continue dimensioning from the last point, press the Continue Dimension button on the
Dimensioning toolbar. The prompt
Specify a second extension line origin or (UNDO/<Select>): end of
displays. Type END and press x, then select the point labeled PT4 in the Figure above. The
second dimension line is placed as shown below. Press } to end the command.
) Now you will dimension the points shown below. Select the Linear Dimension command, type
END and press x, then pick the vessel reference seam labeled PT5 in the Figure below.
END
PT9 of
END
of PT5
END
PT10 of
CEN CEN
PT6 of PT8 of
PT7
Tutorial 7-19
4B1G9>7 @B?4E3D9?>
4 9=5>C9?>C
In this last phase, you will place an angular dimension to highlight the angle of the nozzle
connected to the vertical vessel.
$ The prompt
Specify first angle endpoint: nod of
displays. Type NODE and press x, then select the node on the away-facing elbow near the
vessel’s nozzle.
% The prompt
Specify second angle endpoint:
displays. With ORTHO ON i, select any point on the dimension line attached to the west end
of the vertical vessel.
& The prompt
Specify dimension arc line location (Mtext/Text/Angle):
displays, and a ghost image of the 45-degree angular dimension is centered on the crosshairs.
Position it as shown below.
Tutorial 7-21
4B1G9>7 @B?4E3D9?>
1>>?D1D9?>
1>>?D1D9?>
In this section, you will place annotation on the drawing. You will annotate the valve’s Main Size
and Tag, and place Line Number annotation on the two lines running from the horizontal vessel.
Like dimensions, annotation should be placed in Paper Space.
Notice that when the dialog first opens, Default Settings is listed in the Annotation Style field. You
can establish settings that are applied to all annotation types, or select a specific type from the
Annotation Style list box to define properties unique to that type. In the first several exercises, you
will be using the default values. Press OK to close the dialog. Later you will re-open this dialog to
place rotated text as the default. (If using a Metric configuration, accept the default settings also).
F1<F5 1>>?D1D9?>
In this section, you will annotate a valve’s main size and tag.
" Select Piping/Annotation/Database Fields/Main Size. Notice that as soon as the annotation
command is selected, the drawing switches to Model Space. This enables you to select the
component in Model Space. When the annotation is placed, PIPING automatically switches
back to Paper Space for the placement of the annotation.
# The prompt
Select the component:
displays. Pick the point at the center of the gate valve.
$ The prompt
Annotation location:
displays. You can select multiple leaderline points to position the annotation. Pick point a
point to the right of the valve, then press x to complete the definition of the leader line and
place the annotation as shown below.
Tutorial 7-23
4B1G9>7 @B?4E3D9?>
1>>?D1D9?>
% The prompt
Format/Edit vertex/Rotate/Move/Annotation/eXit <X>: x
displays. The placement prompts enble you to control how annotation is placed. You can
rotate the text, format it, insert blocks, etc. Press x to complete the placement.
8Y^d If you prefer to place annotation without seeing this prompt, you can select another
Placement Method from the Annotation Preferences dialog.
8Y^d To exit the command immediately after placing annotation, choose a different Placement
Method from the Annotation Preferences dialog.
In the previous chapter, you defined a valve tag using the Edit Component command. In this
section, the Tag value will be extracted from the drawing database and placed as annotation.
Tutorial 7-25
4B1G9>7 @B?4E3D9?>
1>>?D1D9?>
Metric
Imperial
Metric
Tutorial 7-27
4B1G9>7 @B?4E3D9?>
3B51D9>7 1>4 1>>?D1D9>7 1 C53D9?>
Imperial
Metric
Tutorial 7-29
4B1G9>7 @B?4E3D9?>
381@D5B B5F95G
381@D5B B5F95G
Working with Paper Space (Layouts): Paper Space is the recommended work environment for
placing dimension lines and annotation text. It keeps the model clutter-free, and enables you to
define and arrange several viewports on a single sheet for plotting.
Work Area Definition: A Work Area is a set of referenced drawings that share the same
physical location in a plant layout. Members of the Work Area can view each others’ drawings
and data. Guests of the Work Area can only view drawings that are permanent to the group.
Work Area Views can be associated with Work Areas.
Work Area Views: A Work Area View is a three-dimensional cube that exists at defined
coordinates that is specific to a saved Work Area. Members of the Work Area can apply saved
views to their current drawings. In model space, this creates shared working views. Placing a
Work Area View in Paper Space will ensure consistency in production drawing output among
various members of a Work Area.
Annotation: Like dimensions, we encourage you to place annotation in Paper Space. When an
annotation command is selected, the model will automatically switch into Model Space to
enable you to select a component to annotate. An Annotation Preferences dialog enables you
to specify whether or not leader lines are included, containers are placed around the text, and
other variables that can be associated with individual annotation styles.
Creating a Section: In PIPING, a section is created by defining an Elevation Work View, then
placing this view in Paper Space. Commands are available in the View Properties dialog to
place coordinates along the boundary of the view. This helps to annotate the relative
coordinates from which the section was created.
G81DµC >5HD/
In the next chapter, you will remain in Paper Space to place a Bill of Materials. The options in the
Bill of Materials dialog will be discussed, as well as the placement procedure.
75>5B1D9>7129<<?6=1D5B91<C (
In this chapter, you will learn how to generate a Bill of Materials and place it on the
drawing sheet.
OVERVIEW 8-2
SUMMARY 8-8
75>5B1D9>7 1 29<< ?6 =1D5B91<C
( ?F5BF95G
?F5BF95G
AutoPLANT provides functions to generate a Bill of Materials (BOM) for placement on your
drawing, or to generate external reports that are not placed on the drawing.
A Bill of Materials may be placed in either Model or Paper Space; however, as in previous
chapters, the emphasis here will be on placing this report in Paper Space. This exercise
demonstrates how to generate a standard BOM that is placed on the drawing sheet. Other report
options are available to generate reports that can be viewed on-screen, sent to a file, or sent to a
printer. You can also generate equipment lists, nozzle schedules, and create customized reports.
For more information on generating reports, refer to PIPING’s on-line help file.
Several options are available to generate the BOM, including the ability to ignore components
marked as “existing” and to recalculate cutlengths. Formatting options are also available to control
the appearance of the BOM. After you generate and place the Bill of Materials in this chapter, the
drawing will appear as shown below.
>_dU Before beginning these exercises, you should have completed all exercises in the
previous chapters.
Tutorial 8-3
75>5B1D9>7 1 29<< ?6 =1D5B91<C
( 75>5B1D9>7 D85 29<< ?6 =1D5B91<C
695<4 45C3B9@D9?>
Report Select the desired report type. For PIPING and ISOMETRICS, available reports are
as follows:
BOMCADCutLengths: BOM with individual cutlengths for insertion in the drawing.
BOMCADStandard: BOM with accumulated cutlengths for insertion in the drawing.
BOMCADSFCutLengths: BOM with individual cutlengths with components sorted
according to Shop/Field designations.
BOMCADMaintenance: BOM with individual cutlengths and all other components
listed individually.
BOMTotal: BOM with accumulated cutlengths and weight.
BOMWeight: BOM with accumulated weights for each component type.
BOMRounded: BOM that will round up cutlengths to the nearest foot or meter.
Report File Displays the file name associated with the selected Report Type.
Units The units reported on the Bill of Materials. The BOM units can be different than the
units in the current drawing. The choices are Metric, Imperial, and Mixed Metric.
Precision Select the level of numeric precision reported for pipe lengths.
Suppress 0 These options are read-only, and display the settings as set for by AutoCAD’s
Feet/Inches DIMZIN environment variable. Only the imperial (architectural) settings are currently
honored. Refer to your AutoCAD documentation for more information.
Bore Precision Assigns the precision of the display of the bolt nominal size.
Omit Codes When 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 whether components will
be omitted from B.O.M. processing. Components whose sort order code is greater
than this value will be omitted from the BOM.
Ignore Existing PIPING components can be marked as Existing using the Edit Component command
Components to distinguish components that already exist in the field, and those that are part of a
new design or revision. You may then update the drawings associated with a
particular system, and generate a Bill of Materials that contains only those
components that did not previously exist.
Enable the Ignore Existing Components field to omit components marked as Existing
from the BOM.
Clean Database This option removes those fasteners that are no longer used for connecting
Fasteners 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.
Append Pipe End Specifies whether or not Pipe End Preparations will be appended to the Pipe
Preparations Description in the BOM.
695<4 45C3B9@D9?>
Append Topwork Specifies whether or not Topwork Descriptions will be appended to Valve
Descriptions Descriptions in the BOM.
Ascending If this check box is disabled, then the BOM records are sorted from largest to
SORT_CODE Order smallest component SORT_CODE value. If this check box is enabled, the records
are sorted smallest to largest component SORT_CODE value.
Material Tag Options: 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 This option enables you to specify how the material balloon tags are formatted. Two
options are available.
Starting Tag Number This field enables you to specify the starting tag number for material tag placement
and numbering.
No Material Tags 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.
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.
Reinsert Material Tags This option is disabled in PIPING, and applied to ISOMETRICS drawings only.
Enable this option to automatically update existing material balloon tags that may
have been placed from a previous BOM run.
Do Not Update This option is disabled in PIPING, and applied to ISOMETRICS drawings only.
Existing Material Tags Enable this option to leave the existing tags and use them in the BOM, then only
generate and place material tags for new items that were not tagged from the
previous BOM run.
Show Material Tags The Show Material Tags option is only available when generating a BOM with
Show Support Tags AutoPLANT ISOMETRICS or AUTO-ISO. If enabled, the system will attach a
Show Fastener Tags 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 this
check box is enabled, the Show Fastener Tags and Show Support Tags option will
also be made available to enable you to optionally display tags for supports and
fasteners. (These options are disabled in PIPING)
# Press Options to display the Bill of Materials configuration dialog as shown in the following
figure. Notice that the dialog contains several tabs to modify the elements that control how the
BOM is placed and formatted in the drawing. From the General tab, select Standard from the
Format selection list, then enable By Pick Placement option and the Lower Right radio button
Placement Corner option. Press OK when the dialog appears as shown in the following figure.
Tutorial 8-5
75>5B1D9>7 1 29<< ?6 =1D5B91<C
( 75>5B1D9>7 D85 29<< ?6 =1D5B91<C
Select Standard,
then enable the
By Pick and
Lower Right
options.
$ Press OK to close the configuration dialog, then press OK again to execute the BOM. The
Drawing Selection options dialog displays. As mentioned previously, this dialog enables you
to create a selection set of components based on a drawing database search criteria. For
example, it would be possible at this point to limit the BOM so that only components from
Line L200 would appear on the report, or to manually select the components that should be
included. To generate the BOM on all the components in the drawing, select All then press OK.
% During processing, the following dialog displays to indicate that the function is processing
component records for the BOM.
& After the model is analyzed and the report prepared, the prompt
Select lower right point:
displays. Type INT and press N, then pick the point where the border intersects the top of the
title block.
8Y^d After the BOM is placed, you can move it as an entire block to reposition it more
precisely.
>_dU The BOM can be customized so that it is placed using another method (i.e., by its upper
right point), or at a specific coordinate location. Refer to the on-line help file for more
information.
' The BOM is placed in the drawing. Zoom Window around the Bill of Materials to examine it
more closely as shown below.
>_dU The Annotation/Tags/Material Tag command may be used to annotate the value shown
in the No. column above for selected components in the drawing.
Tutorial 8-7
75>5B1D9>7 1 29<< ?6 =1D5B91<C
( 381@D5B B5F95G
Materials do not appear in the model. These items were placed in Paper Space, and therefore
do not appear in Model Space, reducing drawing clutter.
381@D5B B5F95G
Generating a BOM: Select Reports/Bill of Materials to generate the standard BOM. Your model
is immediately analyzed, and you are prompted to select a point for insertion. Additional
reports include the ability to generate equipment lists, nozzle schedules, and to create custom
reports. The Reports/Generate Reports option is also available to generate reports that will not
be placed on the drawing sheet.
Clean database: The Database Tools/Clean Database option may be executed in order to remove
any reference to components which may have been deleted from the model, but have not yet
been removed from the drawing database. This option is automatically invoked when you run
a BOM.
Customization Options: A separate dialog has been provided for customizing the Bill of
Materials. This dialog controls placement options, as well as variables such as linetype and
scale.
CE==1BI
This completes the drawing phase of the PIPING Tutorial. You should now be familiar with the
basic commands and techniques used to complete a model. Combine these techniques in your own
models to suit your working style. For specific command reference and more information on
customization options, refer to the on-line help files.
CE@@<5=5>D1<1@@<931D9?>C
This chapter introduces the Supplemental Applications that are either shipped free of
charge with your AutoPLANT software, or are available for purchase. These utilities
are used for program customization, project configuration, migration from previous
release drawings, model visualization, interference detection, and specification
generation. Each of these applications provides their own on-line help file, which
covers the available features or functions.
OVERVIEW 9-2
?F5BF95G
This chapter provides an overview of AutoPLANT supplemental applications. Most of these
applications can be launched directly from the Rebis main menu or toolbar after you start
AutoPLANT Plant Design, or directly from the Windows Start menu. Each of these applications
has its own context-sensitive on-line help that provides detailed explanations of every available
feature and function.
These help file may be displayed by selecting Help/Contents from the application’s menu, or by
running the help file directly from the AutoPLANT/Customization Tools and Help menu in your
Windows Start menu.
The Contents page of every AutoPLANT help file contains an Update Now button. If you have a
connection established with an Internet provider, press this button to access the Rebis Help/Doc
Update web page for the help file that you are viewing. View the main web page at
KWWSZZZUHELVFRPVXSSRUWGRFV. You can then click on a specific AutoPLANT application
to display a list of its available help/doc downloads.
Help file builds are tracked by the build date that displays in the title bar of each help system
window. Compare the build date on your existing help file with the build date of the file available
from the download area of the Rebis web site to determine if a newer version is available.
1ED?@<1>D9=@?BD5H@?BD
The Import/Export utility is intended to facilitate transfer of CAD data between AutoPLANT and
Rebis’ AutoPIPE stress analysis CAD/CAE software. The transfer is accomplished using Rebis’
proprietary Plant Design Format (PXF), which can either be generated or read by AutoPLANT.
AutoPLANT also supports output to a Piping Component Format (PCF) for input to Alias
Limited’s ISOGEN software for the automatic generation of ISOGEN isometrics.
This section explains how to create PXF files from your AutoPLANT DESIGNER and PRO-
SERIES PRO-PIPE drawings, then how to use Import/Export to generate AutoPLANT drawings
and databases from these PXF files. If you have purchased and installed ISOGEN or
AutoISOGEN, you can complete that section, which explains how to generate an ISOGEN
isometric from a PIPING model.
! A PXF file may be generated by loading the DESIGNER drawing into AutoCAD,
AutoPLANT Plant Design, or AutoPLANT. Start AutoCAD now.
" Select File/Open and then select your DESIGNER drawing file and press OK.
# Type APPLOAD and press x to display the application load dialog.
$ Press File. Browse to your network ..\PIPING directory and select the file AT_DES.LSP, then
press OK.
% Press Load to load the Lisp file and display the following prompt:
Type [DesPxf] to run the pxf function.
Tutorial 9-3
CE@@<5=5>D1< 1@@<931D9?>C
1ED?@<1>D 9=@?BD5H@?BD
& Type DESPXF and press x to generate the PXF file. The PXF file will be stored in the same
directory as the file from which it was created. It will use the name of the drawing and with the
PXF extension.
The Plant Exchange\Import command will generate an AutoPLANT compatible drawing and
database from a PXF file generated from a PRO-SERIES PRO-PIPE model. The following
procedure explains how to create a PXF file from a PRO-PIPE model. The procedure to create an
AutoPLANT drawing and database from this file is covered in the next procedure.
! The PXF file may be generated by loading the PRO-PIPE drawing into AutoCAD,
AutoPLANT Plant Design, or PRO-PIPE. Start AutoCAD now.
" Select File/Open and then select your PRO-PIPE drawing file and press OK.
# Type APPLOAD and press x to display the application load dialog.
$ Press File. Browse to your network ..\XCHG directory and select the file PROPXF.LSP, then
press OK.
% Press Load to load the Lisp file and display the following prompt:
Type [ProPxf] to run the pxf function.
& Type PROPXF and press x to generate the PXF file. The PXF file will be stored in the same
directory as the file from which it was created. It will use the name of the drawing with the
PXF extension.
' Optional: After the execution is complete, you can use APPLOAD to load the lisp file
ERASEPRO.LSP and execute the command EraseProComponents to remove all the components
previously exported. This will enable you to use the current drawing as the starting point for
the import sequence, thereby preserving all layout information, etc.
The following procedure explains how to create an AutoPLANT drawing and database from a PXF
file generated from an AutoPLANT DESIGNER or a PRO-SERIES PRO-PIPE drawing.
" Select Import/Export from the Rebis menu to load the Import/Export utility and its menu.
# The AutoPLANT PIPING Model Setup dialog displays. Select the desired model
configuration and modify the Model Layout parameters as desired, then press OK.
$ Select Plant Exchange/Import from the Import/Export menu.
% Select your PXF file and press OK.
& The Import/Export Progress dialog displays to enable you to view the status of the
conversion. When the process is complete, press OK to close the dialog.
' Select File/Save As, then enter the new drawing file name to save the drawing. You now have
an AutoPLANT compatible drawing and external database.
( Select Piping from the Rebis menu to load the PIPING application.
) Select Piping/Database Tools/Edit Component, then select any of the converted components to
view its drawing database record.
! Select File/Exit to exit AutoPLANT.
Tutorial 9-5
CE@@<5=5>D1< 1@@<931D9?>C
1ED?@<1>D 9=@?BD5H@?BD
>_dU This procedure will also enable you to generate a piping model from your AutoPLANT
ISOMETRICS drawings.
There are basically four (4) operating modes that may be applied to generate ISOGEN isometrics
via Import/Export. A limited version of the ISOGEN application, which we call AutoISOGEN, is
shipped free of charge when you purchase AutoPLANT PIPING. The AutoISOGEN Plus
authorization may be purchased from Rebis at a substantial discount when compared to the price of
a server ISOGEN lock. The primary difference is that with full ISOGEN you can generate as many
PCF files as you want on separate machines, then run them through ISOGEN on a single machine,
while with AutoISOGEN Plus, you must run the PCF through ISOGEN on the same machine and
at the same time it is generated. The AutoISOGEN Plus authorization must be performed using the
Rebis Security Manager and may only be authorized for use on a workstation basis.
Demo Version of Software (e.g., no PIPING lock): you will be able to run a limited
demonstration version of the AutoISOGEN software. This will enable you to see how an
AutoISOGEN iso is created, but output items such as dimensions and BOM values will be
marked out in the output drawing file. You can also only generate a “Final” iso type.
AutoISOGEN: A limited option switch version that comes with PIPING at no extra charge. This
will enable you to see how an AutoISOGEN iso is created, but output items such as
dimensions and BOM values will be marked out.
AutoISOGEN Plus: A full option switch version that is locked to a single workstation. You
must generate ISOGEN isos by enabling the Automatically run ISOGEN check box in the
Preferences dialog, then use Export to PCF to generate the PCF. If the PCF is generated
successfully, it will be processed through ISOGEN to create the DXF output file.
Server ISOGEN: A full option switch version using a hardware lock. This version can run PCF
files generated on any workstation.
This section will walk you through the procedure to generate a AutoISOGEN isometric in
AutoCAD DWG format from the IMPORT01.DWG model provided with your software.
! Start AutoPLANT Plant Design, then open the IMPORT01.DWG (this file is installed in your local
..\SUPPORT directory).
" Select Import/Export from the Rebis menu to load the Import/Export utility and its menu.
# Select Preferences from the Import/Export menu. The ISOGEN(PCF ) tab on this dialog
contains the fields described below:
>1=5 45C3B9@D9?>
Continuing Specifies the number of additional components that do not belong to the criteria, but which
Components connect to the criteria, to output into the PCF file. For example, if you select a line with a
TEE and the line number changed at the branch of the TEE, you could include X number of
components that connect to the branch of the TEE in the PCF. In ISOGEN, continuing
components are dashed and do not appear in the BOM.
System Iso System isos are a means of putting multiple lines (for example) on a single iso. If this check
box is enabled, all components matching the criteria are put into a single PCF. The iso will
display annotation indicating the change in line number.
Automatically When you export your model to PCF using Import/Export's ISOGEN/Export to PCF, if this
run ISOGEN check box is enabled, PCF Export will automatically send an error free PCF file through
ISOGEN if the export was successful.
Output Dir Specifies the directory path where the ISOGEN PCF files created during an Export to PCF
will be placed.
$ Ensure that the Automatically run ISOGEN check box is enabled, and that the System Iso check
box is disabled, then press OK.
! The next step is to set up your AutoISOGEN project. Select ISOGEN/ISOGEN Interface. If you
have not previously created a project, a message box will display indicating that you must
press the Config button to create a project.
" Press Config on the Rebis ISOGEN Interface dialog to display the Project Manager dialog.
# Press Create Project to display the following dialog.
Tutorial 9-7
CE@@<5=5>D1< 1@@<931D9?>C
1ED?@<1>D 9=@?BD5H@?BD
$ Type REBISPROJ in the Project field to specify the project directory name. This project
directory will be created in your network ..\PISOGEN\PROJECTS directory. The Iso Types
selection list enables you to specify the type of isometric that you want to generate. ISOGEN
requires a Reference File (FLS), which defines all of the files that can either be read or written
during a run through the ISOGEN system. When you generate a PCF file from a PIPING
model, you are required to specify the Reference (FLS) File to use when it is run through
ISOGEN. These settings must be defined in a file named ISOGEN.FLS. Rebis provides a set
of pre-configured ISOGEN.FLS files for each of the listed Iso Types. These files reside in
directories of the same name as the Iso Types listed under the ..\PISOGEN\STANDARD
directory. Sets of these files is provided for Imperial, Metric, and Mixed Metric Units. The file
that is used depends on the Units selected in this dialog. Select Imperial {Metric} Units and the
Final Iso Type for this exercise, then press OK. The ISOGEN.FLS and other related files will
be copied from the provided directories into your project directory structure, so they may be
modified without losing the integrity of the provided files.
GQb^Y^W Only the “final” Iso Type can be run without AutoISOGEN Plus or Server ISOGEN
authorization. When run without either of these, the ISOGEN.FLS file is modified and an
I-GEN.OPL file is created. If an AutoISOGEN or Server ISOGEN authorization is later
activated for this project’s “final” Iso Type, you will still get a limited AutoISOGEN
isometric. To activate full ISOGEN, the ISOGEN.FLS file must be edited to point to
FINAL.OPL instead of I-GEN.OPL. Also any optional files must be added, i.e.
DRAWING-DEFINITION or ALTERNATIVE-TEXT.
>_dU To be safe, it is recommended that after the project manager has customized the
project’s “final” Iso Type, the ISOGEN.FLS file should be copied, or saved as,
FINAL.FLS. If the project’s “final” Iso Type is run without an AutoISOGEN Plus or Server
ISOGEN authorization (either accidentally or intentionally), you will only need to copy the
FINAL.FLS to ISOGEN.FLS to get a full ISOGEN isometric.
% The version of AutoISOGEN that ships with AutoPLANT provides ISOGEN’s ATEXT,
Option Switches, and Symbols Editors. These programs may be launched from the Project
Manager dialog. We have automatically disabled the fields in these editors that will be
ignored if you have not purchased AutoISOGEN Plus or Server ISOGEN authorization. If you
have purchased either of these authorizations, you can enable the Full Option Switches Editor
check box in this dialog to activate the remaining ISOGEN settings in the Editor applications.
ISOGEN provides three editor applications to enable you to customize the format of the ISOGEN
isometric drawing generated by this process. These editors are provided with AutoISOGEN and
may be launched from the Project Manager dialog, which displays when you press the Config
button on from the main Rebis ISOGEN Interface dialog. The executables for these editors reside
in your ..\PISOGEN\ISOUTILS directory. Each of the editor subdirectories contains a
READMExx.TXT file that describes the operation of each application.
When you created a project earlier in this exercise, you selected the Iso Type in the Create Project
dialog. The Iso Types selection list enables you to select the type of isometric that you want to
generate. Rebis provides a set of pre-configured settings and switches files for each of the listed
Iso Types. These files reside in directories of the same name as the Iso Types listed under the
..\PISOGEN\STANDARD directory. A set of these files is provided for Imperial, Metric, and
Mixed Metric Units. When you create an ISOGEN project, the files that reside in the ..\UNITS\ISO
type directory are copied into your projects ..\PROJNAME\ISO type sub-directory.
In this example, you selected Imperial Units and the Final Iso Type in the Create Project dialog,
therefore, the system copied the files from the ..\PISOGEN\STANDARD\IMPERIAL\FINAL
directory into your project directory structure. You can then use the editor programs to modify the
individual settings in these files.
>_dU As mentioned previously, if you have not purchased AutoISOGEN or Server ISOGEN, a
number of switches will be disabled in the editor applications. If you later purchase either
of these, you can enable the disabled switches by running the ISOGEN Interface
program, pressing Config, then enabling the Full Option Switches Editor check box.
>_dU You should refer to your ISOGEN documentation for more specific information on using
the editor applications. After you start an Editor, select About, then View Read Me to
display ISOGEN’s help on this utility.
The ISOGEN Reference (.FLS) File assigns all of the files that are either read or written during a
run through the ISOGEN system. The ISOGEN Interface application provides an interface to
create/modify the required ISOGEN Reference (FLS) File.
When you created a project earlier in this exercise, you selected the Iso Type in the Create Project
dialog. The Iso Types selection list in this dialog enables you to select the type of isometric that
you want to generate. Rebis provides a set of pre-configured ISOGEN.FLS files for each of the
listed Iso Types. These files reside in directories of the same name as the Iso Types listed in your
..\PISOGEN\STANDARD directory. A set of these files is provided for Imperial, Metric, and
Mixed Metric Units. When you create an ISOGEN project, the ISOGEN.FLS file that resides in
your ..\units\iso type directory is copied into your projects ..\projname\iso type sub-directory.
Tutorial 9-9
CE@@<5=5>D1< 1@@<931D9?>C
1ED?@<1>D 9=@?BD5H@?BD
In this example, you selected Imperial Units and the Final Iso Type in the Create Project dialog,
therefore, the system copied the ISOGEN.FLS file from the
..\PISOGEN\STANDARD\IMPERIAL\FINAL directory into your project directory structure.
The settings in this ISOGEN.FLS file may be modified using the ISOGEN Inteface program as
follows:
! Press Reference File in the Project Manager dialog to display the Reference File Editor
dialog.
" The path to ISOGEN.FLS file for the current project and iso type selected will display in this
dialog. You can press the browse button, then navigate to your project directory and then the
Iso Type sub-directory below your project to select a different ISOGEN.FLS file to modify.
The settings defined in that file will propagate the dialog fields.
# You can manually edit any of these field values, or press the Browse button next to the field to
select a path and file name. The assignments in the Input Files area of the dialog are optional.
$ Press Close to return to the Project Manager. Now that you have setup your Reference File,
you are ready to generate the PCF output file from your PIPING model and run it through
ISOGEN.
This procedure explains how to generate the PCF (Piping Component File) required by ISOGEN
from a single line in a PIPING model.
! Press Close to return to the main dialog interface. The REBISPROJ project now appears as the
current Project, and the final Iso Type is selected.
" At this point, if you had previously generated PCF files using Import/Export's Export to PCF
function, you could specify the directory where the PCF files were created in the PCF Dir
field, then select a PCF from the PCF Files list and press Run to generate and AutoCAD DXF.
In Step 1 of this exercise, however, you enabled the Automatically run ISOGEN check box in
Import/Export's Preferences dialog. Therefore, the remainder of this procedure explains how
to return to Import/Export and generate your PCF and resulting DXF from there.
# Press Close to exit the ISOGEN Interface.
$ From the Import/Export menu, select ISOGEN/Export PCF. This function will use the project
selected when you closed the ISOGEN Interface to create your PCF.
% The Drawing Selection Options dialog displays to enable you to define the selection set of
components that you want included in the iso output. Enable the Advanced radio button, then
press OK.
& In this example, you will define a temporary query condition to select all components in the
model whose LINENUMBER drawing database field value is L100. In the Query Selection
group, select the Select by line number query. This will propagate the Define Query group’s
Type, Attribute Field, and Constraint fields. Press the Browse button next to the empty
Attribute field. A dialog will display listing all of the line numbers in the current drawing.
Select line number L100, then press OK. Press Add-> to add the query to the Active Query text
box. Press OK to execute the query. The system will search the current drawing for all
components whose external drawing database LINENUMBER field value matches the value
that you assigned in the query definition.
' The Connection Criteria dialog displays to enable you to define the criteria used to break the
model into separate PCF files. For example, if you had selected “All” components instead of
only one line number when you defined your query, you could have specified here that you
want to break the model into separate PCF files for every change in the line number. This
Naming Rule area of this dialog also enables you to specify the conventions used to name the
generated PCF files. Since you only selected one line number, you can leave the defaults and
the system will create one PCF file using the line number as the file name prefix. Press OK to
create the files.
( The Export Progress dialog will display the status of the process. Since you had the
Automatically run ISOGEN check box enabled in the Import/Export Preferences dialog, the
Export to PCF function automatically runs the PCF file output from the IMPORT01.DWG
model through AutoISOGEN and then deletes the PCF file. If this option were disabled, Export
to PCF would have only generated the PCF output file, L100.PCF. You would then have to
manually run this file through AutoISOGEN using the Run option in the ISOGEN Interface
program.
) At this point you now have an ISOGEN isometric drawing named L100.I01.DXF in your
..\PISOGEN\PROJECTS\REBISPROJ\FINAL\OUTPUT directory. Press OK to close the
progress dialog.
>_dU If an error occurs during the creation of the ISOGEN PCF file, then the DXF will not be
generated. Review the process log and correct any errors, then repeat this process.
>_dU If you have purchased a Server ISOGEN authorization, instead of running each of your
lines all of the way through this system, you may optionally elect to simply create all of
the PCF files for the lines you want to output, then generate the DXF output. This may be
accomplished by disabling the Automatically run ISOGEN check box in the
Import/Export/Preferences dialog. When you run Export to PCF, the process will stop
after the PCF file has been generated. You can then start the ISOGEN Interface program
and use the Run option to generate the DXF files. This option is not available if using
AutoISOGEN Plus.
Import/Export provides a DXF to DWG utility to enable you to create an AutoCAD drawing from
this file.
Tutorial 9-11
CE@@<5=5>D1< 1@@<931D9?>C
1ED?@<1>D 9=@?BD5H@?BD
! To Create and AutoCAD DWG from your ISOGEN DXF File, select ISOGEN/DXF to CAD
Drawing. The file selection dialog displays requesting you to specify the DXF file that you
want to convert.
" Select the L100.I01.DXF from the Files to edit list. Is the file does not appear in the list, set the
Input Path to the location where your DXF resides.
# Specify the directory where you want the AutoCAD DWG output from this function to reside
in the Output Path field, then press OK. The AutoCAD drawing L100.I01.DWG will be created
in the directory specified and loaded into AutoCAD.
8Y^d Refer to the Import/Export on-line help for a detailed explanation of every available
feature or function.
B529C 5H@<?B5B94
The new Rebis EXPLORER, which may be purchased separately, is an interactive 3D viewer for
large models and sets of models as shown below. You can load multiple models varying from
thousands to millions of triangles in size and interact with them at a guaranteed frame rate.
Rebis EXPLORER supports multiple file formats via a plugin mechanism. As well as its own
native file formats, AutoCAD’s DWG and DXF files and 3D Studio’s 3DS files are supported.
A range of navigating and viewing controls enable even the largest and most complex model to be
explored with ease.
5H@<?B5B@B?7B1= CD1BD
The procedure to start Rebis Explorer is provided below. This application can be launched from
the Rebis menu/toolbar or from the Windows Start menu.
Tutorial 9-13
CE@@<5=5>D1< 1@@<931D9?>C
B529C 5H@<?B5B94
The procedure to start Rebis Explorer ID is provided below. This application can be launched
from the Rebis menu/toolbar or from the Windows Start menu.
Explorer ID checks your model and shows you any areas where the models interfere or ‘clash ’
with each other. Explorer ID is a tabbed dialog box accessed through the Tools menu, allowing you
to manage your test and results. From the Explorer ID dialog box you can set up your clash tests,
view the results, sort the results and produce a report.
Managing a series of clash tests can get complicated, especially if you have a whole set of different
layers you want to clash separately. The Explorer ID is designed to help you control these clash
tests and leave an audit trail of clashes throughout the life of the project.
One simple but time-saving way it does this is by remembering the names of clashes throughout
the project’s life so you don’t have to go through each clash every time you do a test to figure out
whether it’s a new clash, or one you’ve already seen and approved.
The Explorer ID also allows you to assign a status to a clash and can update this status
automatically, informing you of the current state of the clashes in the model.
You can set up a batch of clash tests that you could run overnight, every night and for each test,
choose the objects to clash against, along with the options for the test. These batches can be saved
as *.nwx files, independently of Explorer files.
Tutorial 9-15
CE@@<5=5>D1< 1@@<931D9?>C
1ED?@<1>D 3?>697EB1D9?> 549D?B
1ED?@<1>D3?>697EB1D9?> 549D?B
AutoPLANT is designed to support multiple configurations for drawing/model defaults and
settings. This design enables you to define the units, specs, drawing database format, borders,
drawing templates, module and component options, etc. in a specific configuration.
>_dU Chapter 2, Project Setup provides an overview and walkthrough example of this utility.
1ED?@<1>D3<1CC 549D?B
A module is defined in AutoPLANT as a set of files that define the components that may be placed
when the module is active in the PIPING or ISOMETRICS applications. PIPING and
ISOMETRICS share the same module and component class configurations. The shipping versions
of AutoPLANT PIPING and ISOMETRICS software include the following modules:
The AutoPLANT Class Editor provides a single source for the manipulation of these modules, and
their associated component and configuration files. The procedure to start the Class Editor is
provided in the next section. The three sections that follow give a brief overview of Class Editor
operation and the files involved in this process.
The Class Editor (CE) works hand-in-hand with the AutoPLANT Configuration Editor application.
The shipping version of the AutoPLANT software provides three sample configurations: Imperial,
Metric, and MMetric, 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 configuration directory, therefore, maintaining the integrity of the shipping version files.
>_dU Chapter 2, Project Setup provides an introduction to the Configuration Editor application
When you create a new drawing in PIPING/ISO, and select your custom configuration, the system
will search your custom configuration directory path for custom version of all files first. For
example, if you used the Configuration Editor to create a configuration named MYCONFIG, then
used the CE to modify the drawing script for a gate valve in your MYCONFIG configuration. CE
will save the modified gate valve script within your MYCONFIG configuration directory structure.
When you create a new drawing in PIPING/ISO, and select the MYCONFIG configuration, then
attempt to place this gate valve, the system will search for the gate valve drawing script in your
MYCONFIG directory path first, thereby using your custom script to place the gate valve. If the
system does not find a custom file for any component placement, it will use the file located in the
Tutorial 9-17
CE@@<5=5>D1< 1@@<931D9?>C
1ED?@<1>D 3<1CC 549D?B
path of the configuration (Imperial, Metric, or MMetric) that you selected as a template when you
created your custom configuration.
@B?7B1= CD1BD
The procedure to start AutoPLANT Class Editor (CE) is provided below. This application can be
launched from the Rebis menu/toolbar or from the Windows Start menu.
The remainder of this section provides an overview of Class Editor operation. Refer to the on-line
help for a more detailed explanation of every available feature and function.
75DD9>7 CD1BD54
When the Class Editor first starts it reads the project configuration definition file,
..\CONFIG\CONFIGS.INI, which contains a group record for each defined configuration. The /RF
keyword is assigned to the configuration’s main directory, which contains its configuration
definition file, CONFIG.INI. This is the file that the Configuration Editor application enables you
to view/modify. The >6\VWHP@ group in this file contains keyword assignments that define the
location of each configuration’s module configuration file, MODULES.INI. This file consists of
module records that specify the module’s directory and paths to its method script, dialog, and
picture files. These files define the components available in the module.
Once the CE finds the configuration’s MODULES.INI, it extracts the module group records into a
temporary database, CE.MDB. From the data in this temporary database, CE creates a navigation
tree for each configuration to enable you to view/configure the module and its component methods.
The modules defined in MODULES.INI are denoted by the symbol in the navigation tree.
Each modules main directory is defined in its MODULES.INI record. This tells CE where the
component class, methods, ports and specification search criteria control files are located. These
files define the components available in the module.
A component is defined by its class record in the file CLASS.INI. In general, a component class
defines the Basic Script methods or functions executed to associate intelligence and draw the
component. Several components may be assigned to the same class, which defines the base
methods that apply to all components assigned to that class. For example, all valves are assigned to
the same parent class, which enables you to assign a set of methods that are common to a number
of components to a parent class, then assign this parent class to each of these components instead
of repeatedly assigning the same methods to all of these similar components.
C5<53D9>7 1 3?>697EB1D9?>
The drop-down list next to the CE toolbar enables you to select the
configuration whose module and associated component methods you want to modify. When you
select a configuration, the navigation tree will automatically be updated to reflect the modules and
associated components available in that configuration.
>_dU As noted previously, the Class Editor will not allow you to modify any of the information in
the provided modules. You must use the configuration editor to create a custom
configuration using one of the provided configurations as a template, then you may select
that configuration in the Class Editor to modify its modules/components.
=?496I9>7 1 =?4E<5
As mentioned above, modules are denoted by the symbol in the navigation tree. The following
procedure illustrates how to view/edit the Ductile Iron module definition for the Imperial module
configuration.
! Select Imperial from the configuration selection drop-down list next to the CE toolbar.
" Select Ductile Iron Module from the CE navigation tree.
Tutorial 9-19
CE@@<5=5>D1< 1@@<931D9?>C
1ED?@<1>D 3<1CC 549D?B
% The first column in this dialog contains the keywords, while the second column contains the
keyword assignment and can be modified.
& Press the button in the upper right-hand corner of this dialog to exit.
>_dU Refer to the Command Reference area of the Class Editor help for a detailed description
of the information presented in each dialog and how it may be modified.
! Select Imperial from the configuration selection drop-down list next to the CE toolbar.
" Press the button next to the AutoPLANT Root Piping Class to expand the tree, then press the
button next to the Parent Class - All Base Components to expand the navigation tree.
# Select Parent Class - Base Valves from the CE navigation tree.
$ There are three methods available to modify a parent/component class:
Select Edit/View from the CE menu.
& This dialog separates the selected parent/component’s methods, ports, specification, and other
properties defined in its class record into separate tabs. If you want to view the script file
function for a particular method assignment, simply move the cursor into the Function field
and press the browse button.
' Press the button in the upper right-hand corner of this dialog to exit.
Tutorial 9-21
CE@@<5=5>D1< 1@@<931D9?>C
1ED?@<1>D 3<1CC 549D?B
>_dU Refer to the Menu Command Reference area of the Class Editor help for a detailed
description of the information presented in each of these tabs and how it may be
modified.
Since a temporary database stores all of your changes during a CE session, you can play around
with the program, then exit without saving to keep your original system intact while experimenting
with the Class Editor application.
C3B9@D 549D?B
AutoPLANT provides an intuitive and highly functional script editor to create/customize
BasicScript function and component drawing scripts. The Rebis Script Editor highlights keywords,
commands, etc. to simplify the script construction process. You may elect to use this editor, or one
that you are already more familiar with to create your basic scripts.
@B?7B1= CD1BD
The procedure to start Rebis Script Editor is provided below. This application can be launched
from the Rebis menu/toolbar or from the Windows Start menu.
! From your Windows Start menu, select AutoPLANT 3D/Customization Tools and Help/Script
Editor to start the Script Editor application. This editor highlights standard Basic language
data types, controls, functions, and comments to simplify the editing process.
Context-sensitive help is provided for most standard Basic language elements by simply
b
"
placing the cursor within the element you need help on and then pressing the function key.
For example, select File/Open, then open the VALVES.EBS file from your
..\MODULES\BASE\PIPING\DRAW directory. Scroll down the file and move the cursor into
one of the standard Basic elements, which will be highlighted in blue as shown below, then
b
press to display its help.
Tutorial 9-23
CE@@<5=5>D1< 1@@<931D9?>C
C3B9@D 549D?B
# This functionality is also available for the Rebis API Extensions to the Basic language. Most
of these extensions are easy to identify within a script because they start with the string “DWB”.
For example, select Edit/Find and type at_Component_getPoint and then press Find Next. Move
b
your cursor anywhere within this function call, then press to display its help as shown
below.
8Y^d The Basic Language file, BSCRIPT.HLP, that resides in your network ..\SUPPORT
directory will be updated continuously to include new and better descriptions of every
available Rebis API Extension. You should periodically check the Rebis web page for
help file updates at http://www.rebis.com/support/docs. The Script Editor also provides its
own help file, EBS_EDIT.HLP, which describes the general operation of the application.
452E7 =?45
The Script Editor can also be placed in debug mode by enabling the Debug Mode check box in
PIPING’s Drawing Preferences dialog. If this switch is enabled when you execute an PIPING
component placement command, the drawing scripts that are executed will display in the Script
Editor to enable you to step through each statements that is executed to draw the component.
This switch should only be enabled when you are modifying or customizing PIPING component
placement or function Basic script files.
491<?7 549D?B
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. These
dialogs can be inserted directly into custom scripts created with the Rebis Script Editor.
@B?7B1= CD1BD
The procedure to start Rebis Dialog Editor is provided below. This application can be launched
from the Rebis menu/toolbar or from the Windows Start menu.
! From your Windows Start menu, select AutoPLANT 3D/Customization Tools and Help/Dialog
Editor from the Rebis menu or toolbar to start the Dialog Editor application shown below.
This application can also be launched directly from within the Rebis Script Editor by selecting the
Edit/Insert New Dialog command. This command will start the Dialog Editor, enable you to define a
new dialog instance, then exit the Dialog Editor and automatically insert the Basic statements that
define the dialog instance into your script in the Script Editor.
You can also modify a dialog that is already defined in a script by simply selecting the statements
that define the dialog in the editor, then selecting the Edit/Edit Dialog command. This will display
the dialog instance in the Dialog Editor. When you have finished modifying the dialog, select
File/Update to update the dialog statements in the script. Then select File/Exit and Return to close
the Dialog Editor.
Tutorial 9-25
CE@@<5=5>D1< 1@@<931D9?>C
B529C C@5396931D9?> 75>5B1D?B
A specification is a set of databases that define the range and properties of components applicable
to a specific project and that meet certain design specifications. The Spec Generator provides a
user-friendly interface, which makes it easy to create a specification by graphically selecting
records from a catalog database table. In general, the process involves creating a selection set of
records, then adding these records to the equivalent specification database. Records that are in the
selection set are highlighted, enabling you to graphically review the items that will be added to the
spec.
The Spec Generator may be launched from your Windows Start menu by selecting AutoPLANT
3D/SpecGen/Specification Generator.
>_dU Refer to the Spec Generator on-line help for a complete description of every available
feature and function. A help menu is provided on the application dialog as shown above.
The help may also be launched from your Windows Start menu in the same program
group that the Spec Generator application selection resides.
The Spec Converter is the first utility, which is a separate program that must be executed outside of
the Spec Generator. It has been provided to convert your older AutoPLANT
DESIGNER/ISOMETRICS specifications to the format required by the latest AutoPLANT
products.
The AutoPLANT Spec Conversion program is an optional add-on program that can be installed in
conjunction with the Spec Generator installation. The application start icon resides in the
AutoPLANT/SpecConverter group of your Windows Start menu. Select the Specification Converter
option to launch the application, then press the Help button on the application dialog to display
instructions to convert your AutoPLANT Version 13.x applications to the new AutoPLANT
format.
The DB Converter is the second utility, which may be executed from the Spec Generator's Tools
menu. It converts specifications created with the previous Spec Generator v5.0 application into the
format used by the latest AutoPLANT applications. Spec Generator v5.0 created separate database
files for each component table. The new AutoPLANT applications use the Microsoft Access MDB
format, which consolidates specifications into a single database with separate tables according to
component type.
>_dU Press the Help button from the Tools/DB Converter dialog to display instructions for its
use.
Tutorial 9-27