Ds Admin

PlantSpace®
Design Series
V8 XM Edition
Administrator Guide
DAA011510-1/0007
PlantSpace Design Series Administrator Guide August 11, 2008
Trademarks
AccuDraw, Bentley, the “B” Bentley logo, MDL, MicroStation and SmartLine are registered
trademarks; PopSet and Raster Manager are trademarks; Bentley SELECT is a service mark of
Bentley Systems, Incorporated or Bentley Software, Inc.
Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun
Microsystems, Inc. in the U.S. and other countries.
Adobe, the Adobe logo, Acrobat, the Acrobat logo, Distiller, Exchange, and PostScript are
trademarks of Adobe Systems Incorporated.
Windows, Microsoft and Visual Basic are registered trademarks of Microsoft Corporation.
AutoCAD is a registered trademark of Autodesk, Inc.
Other brands and product names are the trademarks of their respective owners.
Patents
United States Patent Nos. 5,8.15,415 and 5,784,068 and 6,199,125.
Copyrights
©2000-2007 Bentley Systems, Incorporated.
MicroStation ©1998 Bentley Systems, Incorporated.
IGDS file formats ©1981-1988 Intergraph Corporation.
Intergraph Raster File Formats ©1993 Intergraph Corporation.
Portions ©1992 – 1994 Summit Software Company.
Portions ©1992 – 1997 Spotlight Graphics, Inc.
Portions ©1993 – 1995 Criterion Software Ltd. and its licensors.
Portions ©1992 – 1998 Sun MicroSystems, Inc.
Portions ©Unigraphics Solutions, Inc.
Icc ©1991 – 1995 by AT&T, Christopher W. Fraser, and David R. Hanson. All rights reserved.
Portions ©1997 – 1999 HMR, Inc. All rights reserved.
Portions ©1992 – 1997 STEP Tools, Inc.
Sentry Spelling-Checker Engine ©1993 Wintertree Software Inc.
Unpublished – rights reserved under the copyright laws of the United States and other countries.
All rights reserved.
August 11, 2008 PlantSpace Design Series Administrator Guide i

ii PlantSpace Design Series Administrator Guide August 11, 2008
About This Administrator Guide

The PlantSpace Design Administrator Guide provides the explains the system tools
provided to set up, configure, and customize Design Series and your data source.
This preparation will enable users to engineer and design process plants.
Who This Book Is For

This book is for users who perform any of the following roles:
• Oracle, Microsoft Access, or Microsoft SQL Server database

administrator
• System engineer
• PlantSpace system administrator
How This Book Is Organized
Chapter 1: Introduction
Provides an overview of the family of PlantSpace products, the features of Design
Series, and the process of setting up the Design Series product
Chapter 2: Configuring Your Project the Traditional Way

Explains the Design Series modeling tables, class libraries, and the project directory
structure with procedures on how to configure the tables by editing text files that
define the attributes, adding data to component catalogs, modifying lookup tables,
creating a label definition file (rimref.dat file), updating the volume table, checking
the attribute definitions and classes tables, building BUD tables, and executing SQL
and script commands
Chapter 3: Configuring Your Project Using Bentley Project

Administrator
Explains how integrating PlantSpace Design Series with the project databases makes
the product easier to administer and adds value to the project data produced using
PlantSpace Design Series
✍ This method is an alternative to the traditional method in Chapter 2.
August 11, 2008 PlantSpace Design Series Administrator Guide iii

Chapter 4: Configuring Bolts

Explains the concept of bolts and how to configure them for use in output
applications such as Object Reporter and AutoISOGEN
Chapter 5: Configuring Design Series for ProjectWise

Explains how to configure Design Series for Bentley ProjectWise, the application
used for the content management and publishing of engineering information
Chapter 6: Managing Your Project

Explains how to change the directory structure and site ID, use the master volume
definition file, append files, work with label display and label conversion, manage
external files and JSM files, and manage your project database
Chapter 7: Creating and Checking Piping Specifications

Explains how to convert previous versions of Spec Gen and Spec Maker data, set up
a project specification file, work with component types and criteria, maintain the
specs, and configure the Specification Check utility
Chapter 8: Managing Component Types

Provides one interface for all operations to eliminate the cumbersome task of having
to go to different locations in the application to configure or edit the setup of
components such as the attribute definitions, label position, and catalog tables
Chapter 9: Configuring Equipment Modeler

Explains how to configure Equipment Modeler including Nozzle Manager
Chapter 10: Configuring Additional Areas of the User Interface

Explains how to configure areas of the user interface that are not covered in the
previous chapters
Chapter 11: Using the Expert System in Design Series

Explains the expert system, the underlying knowledge built into the Design Series
software
iv PlantSpace Design Series Administrator Guide August 11, 2008

Chapter 12: Configuring the Pipe Stress Interface for Your Project
Explains how to configure the files that control the way that you want users to
create stress analysis neutral files in the Pipe Stress Interface application
Chapter 13: Configuring Report Output for Your Project

Explains how to configure the files that control the way that you want users to
create report output in the Object Reporter application
Chapter 14: Running Piping Drawing Extraction

Explains how to use the Piping Drawing Extraction utility to resymbolize piping
components as simplified symbols so that large drawings are easier to read
Appendix A: File Extensions in PlantSpace Design Series

Is a quick reference to explain the different file formats by file extension that you
may find in using PlantSpace Design Series
Appendix B: Software Directory Structure

Is a quick reference showing the current directory structure of Design Series
How to Use This Book

You should read Chapters 1 through 4 to understand the software to set up required
operations.
Read the remaining chapters and appendixes in any order as needed depending on
your business needs.
Use the PlantSpace Design Series Reference Guide for Administrators as a supplement. It
contains lookup information (such as tables, component data, and functions).
✍ For information on configuring applications for creating isometric drawings

that work with Design Series, see the IsoExtractor Guide and the ISOGEN
Interface Guide with the products, IsoExtractor by Logos B.V or Personal
ISOGEN by Alias, Ltd, under separate license. For information on configuring
the SupportModeler application for placing pipe supports, see the
SupportModeler Guide with the SupportModeler product by Pelican Forge
Software Corporation under separate license.
August 11, 2008 PlantSpace Design Series Administrator Guide v

Style Conventions
The following conventions explain the style of the text in this Administrator Guide.
Style
Use in Text
Convention
ALL CAPITAL Names of acronyms and terms in object-oriented
LETTERS programming such as classes, properties, and methods
LetterGothic Text that you type in a field, messages displayed online,
and programming code or syntax
Bold Names of commands, menus, buttons, and items that
you select
Italic Variables such as a filename, terms defined in text, and
names of books as references
Important information that the user must know (for
example, to avoid losing data)
Information of note that is useful to know
Related Documentation
The following related publications provide supporting information.
Bentley Interference Manager User Guide

This Guide explains how to extract geometric data from 3D CAD applications such
as MicroStation, set up the data, run interference detection, and review the results.
JSpace Concepts and Technical Reference Help

This online help provides a comprehensive overview of the JSpace object-oriented
environment. It also provides technical information about fundamental aspects of
JSpace that are employed in JSpace-based applications.
JSpace Class Editor User Help

This online help provides information on using the Class Editor and the technical
details about object classes, properties, methods, relationships, and inference rules.
vi PlantSpace Design Series Administrator Guide August 11, 2008

JSpace MicroStation Connection User Guide

This Guide provides information on using the JSpace MicroStation Connection to
extract CAD model data and create JSpace object model files.
Model Control System (MCS) Guide

This Guide provides information on using the Model Control System and its related
programs, the Database Setup Tool, MCS Database Administrator and User Tools,
and the Define Volume Utility. A PDF of this guide is available on the TriForma
Help menu or in the ...\Bentley\Documentation directory.
PlantSpace Design Series Reference Guide for Administrators

This Guide provides lookup or reference information such as functions and
database schema to accompany this Administrator Guide
PlantSpace Design Series User Help

This online help provides information for the user on how to use PlantSpace Design
Series, which enables you as an administrator to view the software from the user’s
perspective
PlantSpace Design Series QuickStart Guide

This Guide is the tutorial for PlantSpace Design Series and provides basic
procedures to get you started using the software
Online Documentation
User documentation is provided in online help on the Help menu of the
MicroStation menu bar. Administrator and tutorial (QuickStart Guide)
documentation is provided in PDF (Portable Document Format) files.
PDF Files
PDF files are platform independent. You can browse, search, and print them,
regardless of your operating system, by using the supplied Acrobat Reader utility
from Adobe Systems, Incorporated. PDF files of the documentation are displayed
on the Help menu on the MicroStation menu bar or in the
...\Bentley\Documentation directory created after the software is installed.
For more information on using the Acrobat Reader to browse, search, and print
PDF files, see the Help menu in the Acrobat Reader program.
August 11, 2008 PlantSpace Design Series Administrator Guide vii

Customer Support
Please contact your local authorized Bentley Value-Added Reseller (VAR) for
support. To find out the name and contact information for a Bentley VAR near you,
please call Bentley Systems, Incorporated at:
(800) BENTLEY or (610) 458-5000
For requests to obtain license keys, contact Bentley Systems, Incorporated:
Americas headquarters, Fax (610) 458-1060

European headquarters, Fax +31 23 556 0565
Asia-Pacific headquarters, Fax +61 3 9699 8677
For more information about the Bentley family of software products:
E-mail: family@bentley.com
For support, problems, and questions regarding Bentley software:
E-mail: support@bentley.com
For more information about Bentley Systems, Incorporated, please visit our Internet
web site at:
http://www.bentley.com
viii PlantSpace Design Series Administrator Guide August 11, 2008

Table of Contents
About This Administrator Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-iii
Table of Contents
1. Introduction
About the PlantSpace Design Series Product . . . . . . . . . . . . . . . . . . . . . . 1-1

Design Series within PlantSpace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Design Series Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Data Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Advanced Modeling System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
What Is New in V8 XM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

New Programs and Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
New Configuration Variables and Attribute . . . . . . . . . . . . . . . . . . . 1-4
Software Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Documentation Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Upgrading Legacy Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

Upgrading Legacy Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Upgrading Legacy Data from Design Series v8.5 to V8 XM . . . . . . 1-6
Saving Modified Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Creating a New Database Instance. . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Upgrading the Design Series Administrator Machine . . . . . . . . . . . . 1-7
Installing a New Design Series Project . . . . . . . . . . . . . . . . . . . . . . . 1-8
Populating the Current Design Series Database . . . . . . . . . . . . . . . . 1-8
Upgrading Your Project Database Tables from Version 8.5.2 to XM1-9
Converting Component Labels to the Current Version of Design Series1-
13
Upgrading the Typical User to the Current Version of Design Series1-14
Stages in the Process of Configuring and Customizing Design Series. . . 1-15

Navigating Through Programs That You Need to Set Up or Configure
Your Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16
August 11, 2008 PlantSpace Design Series Administrator Guide ix

Table of Contents
2. Configuring Your Project the Traditional Way
Understanding Project Creation and Configuration . . . . . . . . . . . . . . . . . 2-1

Project Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Project Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Design Series Modeling Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Design Series Class Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Project Directory Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
How You Configure Your Project . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Design Series Class Libraries, Ams.lib and Ams_user.lib . . . . . . . . . . . . . 2-5

JSpace Class Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Class Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Changing Data in the Class Libraries . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Synchronizing Ams.lib with the Project Database and Ams_user.lib2-9
Procedure for Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
Procedures for Configuring Your Project . . . . . . . . . . . . . . . . . . . . . . . . . 2-14

Modifying Attribute Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15
Adding Catalog Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-36
Updating Expert System Rule Files . . . . . . . . . . . . . . . . . . . . . . . . . . 2-39
Updating Product Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-43
Updating the Volumes Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-45
Accessing Data from the PlantSpace P&ID Application . . . . . . . . . 2-46
Accessing Data from Third-Party Applications. . . . . . . . . . . . . . . . . 2-52
Displaying the Component Type Name in the Attributes Dialog Box2-58
Customizing the Value Column in the Attributes Dialog Box . . . . . 2-59
Displaying PlantSpace Component Information Using the TriForma Ele-
ment Information Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-60
Creating a Label Position File (Rimref.dat File) . . . . . . . . . . . . . . . . 2-62
Executing Your Own SQL Commands . . . . . . . . . . . . . . . . . . . . . . . 2-63
Executing Your Own Script Commands . . . . . . . . . . . . . . . . . . . . . . 2-65
Creating Multiple Project Schemas in One Database Instance. . . . . 2-67
3. Configuring Your Project Using Bentley Project Administrator
Understanding Bentley Project Administrator . . . . . . . . . . . . . . . . . . . . . 3-1

Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Setup Performed During Installation . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
x PlantSpace Design Series Administrator Guide August 11, 2008

Table of Contents
Creating a Design Series Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4

Stage 1. Create a new project using Bentley Project Administrator . 3-4
Stage 2. Edit the PlantSpace files . . . . . . . . . . . . . . . . . . . . . . . . 3-5

Stage 3: Integrate PlantSpace Design Series. . . . . . . . . . . . . . . . . . . . 3-5
Stage 4. Run the Database Setup utility to prepare the project for use with
PlantSpace Design Series. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
Maintaining Your Project Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7

Editing Your Project Using Bentley Project Administrator . . . . . . . 3-7
Configuring Database Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7
Setting Up Piping Specifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7
Setting up ISOGEN Styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8
Locating Your PCF Files and Root Folder . . . . . . . . . . . . . . . . . . . . 3-8
4. Configuring Bolts
Understanding Bolts and the Bolts Engine . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Details by Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
V8 XM Enhancements in the Bolts Engine . . . . . . . . . . . . . . . . . . . . . . . 4-2
Bolt Generation Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2

Stage 1: Trigger Bolt Creation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Stage 2: Identify Component Groups That Make Up the Bolt Assemblies
4-4
Stage 3: Retrieve Bolt Information for the End Components . . . . . 4-5
Stage 4: Determine Bolt Properties for the Assembly. . . . . . . . . . . . 4-6
Stage 5: Group and Order Bolt Assemblies. . . . . . . . . . . . . . . . . . . . 4-6
Stage 6: Report Results of Bolt Generation . . . . . . . . . . . . . . . . . . . . 4-7
Customizing the Bolts Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7

Objects and Relationships Set Up by the Bolts Engine . . . . . . . . . . 4-7
Customization Options and Constraints . . . . . . . . . . . . . . . . . . . . . . 4-9
Sample Customization Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12
Modifying the Bolt Catalog Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13

Incorporating Bolt Changes into Your Project Database . . . . . . . . . 4-16
Configuration Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16
Troubleshooting Bolts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18
August 11, 2008 PlantSpace Design Series Administrator Guide xi

Table of Contents
5. Configuring Design Series for ProjectWise
Understanding Bentley ProjectWise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Configuring Design Series . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

Limitations and Assumptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Scope of Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
ProjectWise Client Setup for PlantSpace Design Series . . . . . . . . . . 5-3
PlantSpace Design Series Setup for ProjectWise. . . . . . . . . . . . . . . . 5-4
Version Compatibility Dependencies. . . . . . . . . . . . . . . . . . . . . . . . . 5-4
Improved Integration with ProjectWise . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4

How the Integration Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
6. Managing Your Project
Understanding Project Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Digital Signatures and Digital Rights . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Required Selection of a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Default Configuration Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Enabling Group Project Selection for Users . . . . . . . . . . . . . . . . . . . 6-3
Viewing Your Configuration Variables . . . . . . . . . . . . . . . . . . . . . . . 6-5
Digital Rights and Digital Signatures . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Procedures Involved in Managing a Project . . . . . . . . . . . . . . . . . . . . . . . 6-9

Changing the Directory Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10
Customizing the Units of Measurement . . . . . . . . . . . . . . . . . . . . . . 6-10
Changing Project Units and the Seed File . . . . . . . . . . . . . . . . . . . . . 6-12
Managing External Files and JSM Files . . . . . . . . . . . . . . . . . . . . . . . 6-13
Appending Individual JSMs to the Database. . . . . . . . . . . . . . . . . . . 6-14
Appending JSMs to the Database in Batch Mode . . . . . . . . . . . . . . . 6-14
Working with Component Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16
Procedures for Setting Up Digital Rights and Digital Signatures . . . . . . . 6-23

Digital Rights. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-23
Digital Signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-24
Enabling Scrolling on Values in the Attributes Dialog Box . . . . . . . . . . . 6-25
7. Creating and Checking Piping Specifications
Understanding the PlantSpace Specification Maker . . . . . . . . . . . . . . . . . 7-1
xii PlantSpace Design Series Administrator Guide August 11, 2008

Table of Contents
Features of Spec Maker. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Spec Maker Data Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Spec Maker Objects as JSpace Objects . . . . . . . . . . . . . . . . . . . . . . . 7-2
Structure of a Project Specification File . . . . . . . . . . . . . . . . . . . . . . . 7-3
Project Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Tool Bars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Procedures for Opening and Closing the Application and Files . . . . . . . 7-8
Opening and Closing the Application . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Opening and Closing a Project Specification File . . . . . . . . . . . . . . . 7-9
Using Auto-Save or Manually Saving a File . . . . . . . . . . . . . . . . . . . . 7-12
Procedures for Converting Spec Gen 2.0 Data . . . . . . . . . . . . . . . . . . . . . 7-13

Customizing the INI File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
Customizing the SCR File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Converting Spec Gen Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20
Procedures for Using Spec Maker 2.0 Spec Files . . . . . . . . . . . . . . . . . . . 7-23

Using Spec Maker 2.0 Spec Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23
Converting Spec Maker 2.0 Files into 7.1 Format . . . . . . . . . . . . . . . 7-24
Procedures for Viewing the Project Specification File . . . . . . . . . . . . . . . 7-30

Moving Through Levels of the Tree Structure . . . . . . . . . . . . . . . . . 7-31
Selecting View Options on the Tool Bar, Menu Bar, Popup Menu, and Key-
board . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31
Manipulating the Project Window . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-41
Procedures for Customizing the Display of the Spec Maker Interface . . 7-42
Displaying the Status Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-43
Displaying, Moving, and Enlarging the Tool Bars. . . . . . . . . . . . . . . 7-43
Displaying Dimensions in Imperial or SI (Metric) Units . . . . . . . . . 7-44
Procedures for Setting Up a Project Specification File . . . . . . . . . . . . . . . 7-49

Creating a New File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-49
Assigning, Entering, Changing, and Resetting a Password on the Project
Specification File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-53
Procedures for Working with Component Types . . . . . . . . . . . . . . . . . . . 7-55

Customizing the Rules in Database Lists . . . . . . . . . . . . . . . . . . . . . . 7-56
Creating a New Component Type . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-59
Associating a Spec with a Component Type . . . . . . . . . . . . . . . . . . . 7-60
Deleting Component Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-61
Copying and Moving Component Types . . . . . . . . . . . . . . . . . . . . . . 7-62
Renaming Component Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-64
August 11, 2008 PlantSpace Design Series Administrator Guide xiii

Table of Contents
Procedures for Working with Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-65

Creating Criteria for a Component Type . . . . . . . . . . . . . . . . . . . . . . 7-65
Reordering Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-74
Setting Criteria Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-75
Deleting Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-78
Copying and Moving Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-79
Renaming Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-81
Procedures for Maintaining Specifications . . . . . . . . . . . . . . . . . . . . . . . . 7-82

Globally Updating the Names of Specs, Component Types, and Guidelines
in the Project Tree Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-82
Clearing Spec Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-83
Changing the ODBC Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-84
8. Configuring Equipment Modeler
Understanding How to Configure Equipment Modeler. . . . . . . . . . . . . . 8-1

Concept of an Equipment Class Definition . . . . . . . . . . . . . . . . . . . 8-1
Nozzle Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
Procedures for Creating a Parametric Equipment Definition . . . . . . . . . 8-4
Procedures for Configuring Nozzle Manager . . . . . . . . . . . . . . . . . . . . . . 8-17

Configuring an Equipment Datum . . . . . . . . . . . . . . . . . . . . . . . . . . 8-17
Configuring a New Nozzle Placement Type . . . . . . . . . . . . . . . . . . . 8-20
9. Configuring Additional Areas of the User Interface
Understanding How to Configure the User Interface . . . . . . . . . . . . . . . 9-1
Quick Lookup of the Configurable Areas of the User Interface . . . . . . . 9-1
Custom Keypoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2

Permanently Disabling or Enabling Custom Keypoints . . . . . . . . . . 9-2
Customizing the Information Displayed by Custom Keypoints . . . 9-3
Custom Reference Notes for Structural Columns . . . . . . . . . . . . . . . . . . 9-3
Interactive Compatibility Checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-6
Annotation Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-7

Annotation and TriForma Drawing Extraction Manager . . . . . . . . . 9-7
xiv PlantSpace Design Series Administrator Guide August 11, 2008

Table of Contents
Procedures for Configuring the Text Styles, Content, and Terminators9-8
Check Design Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-18

Procedures for Configuring the Check Design Utility . . . . . . . . . . . 9-19
Superimposed Components Option . . . . . . . . . . . . . . . . . . . . . . . . . 9-20
Specification Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-21
Slope Direction Option. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-25
Compatibility Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-26
Duplicate ID Option. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-27
Gap Correction Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-29
Overlap Correction Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-29
Label Edit Utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-30

Strict Mode Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-30
How the Configuration Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-31
How Users Will Work with Label Edit . . . . . . . . . . . . . . . . . . . . . . . 9-32
Label Convert Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-33

Procedure for Converting Component Labels . . . . . . . . . . . . . . . . . 9-34
Update Symbology by Attribute Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-40

Configuring Symbology Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . 9-40
Level Symbology and Your V7 Files . . . . . . . . . . . . . . . . . . . . . . . . . 9-44
Intelligent Line String Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-45

Procedures for Configuring Options in Intelligent Line String Tools9-45
Pipe Stress Interface Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-48

Procedure for Configuring the Pipe Stress Interface Program . . . . . 9-49
Component Placement Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-50

Configuring to Prevent Matching on Specific Attributes . . . . . . . . . 9-50
Configuring to Prevent the Placement of Short Pipe . . . . . . . . . . . . 9-52
Custom Piping, Equipment, and HVAC Component Tools . . . . . . . . . . 9-54

Defining Attributes at Placement of a Custom Component. . . . . . . 9-54
Editing Commands That Configure Custom Components . . . . . . . 9-54
10. Configuring the Pipe Stress Interface for Your Project
Understanding the Pipe Stress Interface Configuration . . . . . . . . . . . . . . 10-1

Internal Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
How Users Create a Stress Analysis Neutral File . . . . . . . . . . . . . . . 10-1
August 11, 2008 PlantSpace Design Series Administrator Guide xv

Table of Contents
Pipe Stress Interface Data Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
Procedure for Configuring Your Pipe Stress Interface Files . . . . . . . . . . 10-4
11. Configuring Report Output for Your Project
Understanding Report Output Configuration. . . . . . . . . . . . . . . . . . . . . . 11-1

Processing Report Data on Specific Areas of a Model . . . . . . . . . . . 11-1
Procedures for Customizing the Output . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2

Defining Report Filters and Report Fields . . . . . . . . . . . . . . . . . . . . 11-2
Grouping and Summarizing Data . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-8
12. Running Piping Drawing Extraction
Understanding the Piping Drawing Extraction Utility . . . . . . . . . . . . . . . 12-1

Features of Piping Drawing Extraction . . . . . . . . . . . . . . . . . . . . . . . 12-1
Configuration Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-4
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-4
Customizing the Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-5

Classification of Cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-5
Cell Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-6
How the Process of Cell Replacement Works. . . . . . . . . . . . . . . . . . 12-7
Customization Example: Mitered Elbows. . . . . . . . . . . . . . . . . . . . . . . . . 12-9

Modifying an Existing Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-14
Resymbolizing Components from Legacy Cell Libraries . . . . . . . . . 12-18
Reference Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-19

Orientations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-19
Replacement Cell Rotations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-27
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-29
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Alphabetized Listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
B. Using the Expert System in Design Series
xvi PlantSpace Design Series Administrator Guide August 11, 2008

Table of Contents
Understanding the Expert System in Design Series . . . . . . . . . . . . . . . . . B-1

How Knowledge Is Represented . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
Backward Chaining . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-2
Layout of the Rule File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-4
Knowledge Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-4

Variable Declarations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-4
IF-THEN Production Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-9
Comments and End Of Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-16
Parametric Modeling System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-16

Parametric Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-16
Parametric Modeling Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-17
Parametric Modeling Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-19
Parametric Modeling Primitives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-20
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
New Locations Used for PSDS XM . . . . . . . . . . . . . . . . . . . . . . . . . B-1
...\Program Files\Bentley\Documentation Directory . . . . . . . . . . . . . . . B-2
…\Bentley PlantXM Projects\DesignSeries Workfiles Directory. . . . . . B-3
…\Bentley PlantXM Projects\PSDS_Imperial or PSDS_SI Directory . B-4
...\Program Files\Bentley\Program Directory . . . . . . . . . . . . . . . . . . . . . B-8
...\Program Files\Bentley\Plant XM\DesignSeries Directory . . . . . . . . B-9
...\Projects85 Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-10
...\ProjPcfs Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-10
Glossary
Index
August 11, 2008 PlantSpace Design Series Administrator Guide xvii

Table of Contents
xviii PlantSpace Design Series Administrator Guide August 11, 2008

1 Introduction
Welcome to PlantSpace Design Series, the software that is based on
JSpace technology and that provides you with a full range of
intelligent 3D modeling applications. These applications enable you
to engineer and design process plants. This chapter describes the
features of PlantSpace Design Series and provides a visual overview
of the setup process.
About the PlantSpace Design Series Product

The PlantSpace Design Series product, or simply Design Series, provides a full range
of intelligent 3D modeling applications for the engineering and design of process
plants and discrete manufacturing. Also included in MicroStation TriForma and
PlantSpace is a full suite of tools to produce the documents required to assist in the
engineering, construction, and maintenance of the plant.
Design Series provides you with a consistent interface between design modules that
operates without live links to a database. JSpace, the object-oriented technology, is
the basis on which the PlantSpace family of application software products is built.
Design Series within PlantSpace

Design Series enables you to design and engineer a 3D model. The software includes
3D modeling applications for piping, equipment, HVAC, and raceways (trays and
conduits). Using Design Series, you can also:
• Generate deliverables from an object model, such as isometric

drawings and material take-offs (MTOs)
• Produce orthographic drawings using the TriForma Drawing
Extraction Manager
• Produce isometric drawings using ISOGEN by Alias, Ltd.
• Perform interference detection using the Detection module of the
Bentley Interference Manager (requires a separate license)
• Generate input files for stress analysis programs
Design Series is typically used with other JSpace tools and Design Series
applications. Based on your company’s business rules, you can modify and adapt
these applications to fit your specific engineering design and data management
August 11, 2008 PlantSpace Design Series Administrator Guide 1-1

1 Introduction
About the PlantSpace Design Series Product
needs. For more information about JSpace tools and PlantSpace products, see the
JSpace Concepts and Technical Reference help and the JSpace Class Editor User help.
✍ You must have a working knowledge of MicroStation 2D and 3D modeling

software. Modeling uses standard MicroStation conventions, such as
AccuDraw, AccuSnap, precision key-in, display depth, active depth, and view
manipulations.
Design Series Features

Each product that is a member of Design Series shares the following general
features:
• Operates on Intel-based workstations and popular Windows

operating systems
• Has a graphical user interface (GUI), which enables you to visually
access the database components, and to control and maintain the
database
• Enables you to check out components of specific areas or systems
defined by the designer
• Enables you to manage projects on a file level or component level
• Enables you to create, edit, and maintain intelligence on
components
• Enables you to create and define project area volume files
• Enables you to copy information from one project, and re-use it in
another project
• Works with ProjectWise for document management
Data Storage
Design Series uses component-based storage of data from your project database
through the Model Control System (MCS). For details, see the chapter "Setting Up
and Maintaining Your Project Database" in the Model Control System (MCS) Guide on the
TriForma Help menu or in the ...\Bentley\Documentation directory.
Advanced Modeling System

During modeling, Design Series uses a program called the Advanced Modeling
System (AMS) to parametrically draw the 3D graphical components that you want in
your design file. AMS takes the data in your project database and applies rules that
1-2 PlantSpace Design Series Administrator Guide August 11, 2008

Introduction
What Is New in V8 XM
define the shape and type of graphical elements to be placed. Your project database
can be located on a local PC or on a network for multiple users to access.
For example, when you select the Pipe tool, you are prompted to give it certain
values, such as the pipe spec, diameter, and line number. AMS then applies the
appropriate rules that enable you to place the pipe component dynamically in the
design file, as described in the following graphic.
✍ For the new features for users, see the Design Series online User Help > New
Features on the MicroStation menu bar.
New Programs and Utilities

• Project configuration using Bentley Project Administrator instead
of the traditional method from earlier releases. For details, see
“Configuring Your Project Using Bentley Project Administrator” on page
3-1.
• Piping Drawing Extraction utility for converting piping
components in 3D models to simplified symbols in 2D

1 Introduction
orthographic drawings. For details, see “Running Piping Drawing

Extraction” on page 12-1.
• Create Project tool for copying an existing project to create a new

project. For details, see “Project Creation” on page 2-1.
• Group Project Selector tool for configuring setup to enable your

users to select different projects to work on, making the names
descriptive for easy recognition. For details, see “Enabling Group
Project Selection for Users” on page 6-3.
New Configuration Variables and Attribute

• Expression capability added to INPUT_METHOD called
EVALUATE. This type calculates values that are not easily put in a
table, like a schedule. For details, see “INPUT_METHOD” on page
2-23.
• MCS_BLOCK_REFERENCE_ON_CHECKOUT configuration
variable to force or block the creation of reference files during MCS
checkout. For details, see Chapter 5 in the Model Control System in
TriForma Guide delivered with the software.
• DS_DELDUP_AUTO_DELETE configuration variable for use
with superimposed components. For details, see “Superimposed
Components Option” on page 9-20.
• COMPLENG attribute assigned at MCS Check-in, Append, and
Update Database operations enabling report generation directly
from MCS tables. For details, see Chapter 2 in the TriForma Model
Control System (MCS) Guide in ...\Bentley\Documentation.
W Design Series does not make use of MicroStation’s Task Navigation

Tool Box. Therefore, in a PlantSpace Design Series session, the Task
Lists in the tool box displayed on the right pertain only to MicroStation.
Software Changes
The location of workspaces has been changed in MicroStation to {hard
drive}:\Documents and Settings\All Users\Application Data\Bentley
\WorkSpace\{product name}.
W Design Series uses different default paths. The path to the sample
dataset is C:\Bentley Plant XM Projects\DesignSeries Workfiles.

Introduction
Documentation Changes
The path to the administrator files for setup and configuration is

C:\Bentley Plant XM Projects\PSDS_Imperial or PSDS_SI.
Additional changes are:
• The ps_user.rul file is retained, but is limited to loading applets (the

same as ps_apps.rul). The PSDS_menu.dgnlib file replaces
ps_init.rul and ps_help.txt.
• V7 workmode is not supported in PlantSpace Design Series V8 XM
Edition. V7 workmode in the previous release enabled you to edit a
V7 design file in a V8.x application without updating the design file
to V8 format. For details on this workmode, see MicroStation
documentation.
• The settings for the database connection and database type have
been moved to the *.pcf file from the projvars.cfg file.
• Mslocal.cfg has been renamed dslocal.cfg.
Documentation Changes
A new Chapter 3 has been added to the Administrator Guide called Configuring Your
Project Using Bentley Plant Project Database. The configuration from earlier releases is
retained in Chapter 2, Configuring your Project the Traditional Way.
Appendix B: Software Directory Structure reflects the new and changed paths to the
application files.
The PlantSpace Design Series Setup Guide is no longer needed and is therefore not
provided in this release.
Upgrading Legacy Data

✍ If you start a new project and want to take advantage of the new features in
Design Series V8 XM, you can install it on the same workstation with your
earlier version of Design Series that you are using with existing projects.

If you are upgrading data created from version 8.1, see chapter 1 of the PlantSpace
Design Series Administrator Guide from release 8.5 at the same web sites.

1 Introduction
If you are upgrading data created from version 8.0, see chapter 1 of the PlantSpace
Design Series Administrator Guide from release 8.1 at the same web sites.
If you are upgrading data created from version 2.x or 7.1.4, see chapter 1 of the
PlantSpace Design Series Administrator Guide from release 8.0 in Bentley's Web
downloads or http://docs.bentley.com.
Upgrading Legacy Data from Design Series v8.5 to V8 XM

✍ Be sure to view the changes.txt file in the ...\Bentley\Home\PSDS_Imperial
\project\dbload\data directory for a list of specific changes to the format of
the catalog and specification tables.
W In upgrading from a previous version, you must perform the following

tasks in the order shown. With the exception of upgrading the user
machines, these tasks must be executed from the Design Series
administrator’s machine.
The sections that follow explain these tasks in detail.
1. Saving to a safe place, all modified files from a previous version of

Design Series, if installing the software to the same location
2. Creating a new instance of the database
3. Upgrading the Design Series administrator’s machine
4. Installing a project
5. Populating the current Design Series database
6. Upgrading your database tables
✍ This task is necessary only if you changed any of the delivered
DAT files from a previous version or created your own user or
project DAT files.
7. Converting component labels to the current version of Design
Series, if upgrading a project from a previous version, or to copy
components created using a previous version
8. Installing the current version of Design Series on all user machines
using the Local User or Network Client setup type

Introduction
Saving Modified Files
Saving Modified Files

Before starting the upgrade process, you should save any Design Series files that you
have modified to a safe place.
W Because the Design Series installation program overwrites the files in

the selected directory with the same name and with an earlier date than
the files on the CD-ROM, you should take precautions to avoid
overwriting your customized data files.
You should safeguard the following files:
• Catalog files, such as pelb.dat and pelb_user.dat

• Attribute definition files, such as pip_atre.dat and pip_atre_user.dat
• The current copy of the rimref.dat file
• Class libraries, such as ams_user.lib and ps_iso.lib
• Project specification files, such as *.spc (spec gen) or *.spe
(Spec Maker 2.0)
• Object reporter and stress analysis
Also, after you confirm that all components have been checked into the database,
you should create a model snapshot of each product.
Creating a New Database Instance

You should create a new database instance using either Oracle or SQL Server. For
more information about creating a new database instance, see Chapter 1 of the
Model Control System (MCS) Guide on the MCS Help menu on the MicroStation menu
bar or in the ...\Bentley\Documentation directory.
Upgrading the Design Series Administrator Machine

➤ ToupgradetheDesignSeriesadministrator’smachinetothecurrentversion
1. Uninstall your previous version of Design Series from the
administrator’s machine.
2. Install the current version of Design Series on the administrator’s
machine using the Administrator setup type.
✍ For more information about the Administrator setup type, see the
procedure in the PlantSpace Design Series Setup Guide.

1 Introduction
Installing a New Design Series Project

As an administrator, you need to create the files that all project users need for a
Design Series application. You should store these files with read-only access in a
convenient location for all users. However, the project leaders or lead engineers need
read/write access to the files.
W Database location and setup are critical. If the database is on a remote

site, such as in another office, you must obtain access to local database
links for placing components.
InstallationGuidelinesforaTypicalProjectUsingComponent-Based
Storage
If your company uses component-based storage, these guidelines enable you to set
up a typical project environment with multiple users. The process includes the
following:
• Locating the database on a wide area network (WAN) for the

project
• Requiring a login name to protect write-access to the database used
to store components (called a BUD table)
• If the project is installed on a public-access server, placing the
project in a protected directory
• Providing designers with a local installation of the Design Series
user applications
• Providing selected PCs with local Design Series administrator
installations so that you can remotely administer the database
• Storing temporary files on the user’s PC
W You should build your new Design Series project on the network server.
For more information about building a project, see the procedure on
installing the Project setup type on a project network server in the
PlantSpace Design Series Setup Guide.
Populating the Current Design Series Database

You need to populate the current Design Series database with the current project
data from your previous version of Design Series. All files to be updated are located
in the project directory created in the task, Installing a New Design Series Project.

Introduction
Upgrading Your Project Database Tables from Version 8.5.2 to XM
➤ To populate the current Design Series database
W You must complete the following tasks:
1. Incorporate into the current version of the Design Series attribute

definition files, all user modifications to the product attributes
definitions from the previous version.
✍ Before you make any changes to the attribute definition files, see
the chapter “Configuring Your Project the Traditional Way” on page
2-1 of this Guide.
2. Incorporate into the current version of the Design Series rule files,
all user modifications to the product rule files from the previous
version.
3. Incorporate into the current version of the Design Series class
libraries, all user modifications to the class libraries from the
previous version.
W This task is necessary only if you changed any of the delivered DAT files
from a previous version, or created your own user or project DAT files.
In your project database, you must compare the old set of columns to
the new set of columns for each table to find any changes and update
them.
The changes to your project database tables refer to the data in the modeling tables
in the chapter “Configuration Data for Your Project Database Tables” on page 4-1 in the
PlantSpace Design Series Reference Guide for Administrators.

1 Introduction
➤ To upgrade your project database tables for piping components

1. Do the following:
Add Columns To Tables

MAT_NAME PIPE_APLT
MANU_FACT PIPE_ATEE
SHORT_DESCR PIPE_PBRN
LONG_DESCR PIPE_CLMP
WEIGHT_DRY PIPE_DADP
COG_X_PAR PIPE_DBLK
COG_Y_PAR PIPE_PESO
COG_Z_PAR PIPE_FERR
SURF_AREA PIPE_FLEX
SPARE, ORDER_INFO PIPE_FMTR
SYSID PIPE_IBOX
PIPE_ITEE
PIPE_PADP
PIPE_PBRN
PIPE_PBUS
PIPE_PCAP
PIPE_PCPL
PIPE_PELB
PIPE_PERD
PIPE_PFLG
PIPE_PGKT
PIPE_PINS
PIPE_MGLN
PIPE_MRNG
PIPE_WPIP
PIPE_PNPL
PIPE_POPL
PIPE_POUB
PIPE_POUS
PIPE_PPLG
PIPE_PRED
PIPE_PSBN
PIPE_PSTR
PIPE_PSWE
PIPE_PSWG
PIPE_PTAP
PIPE_PTRP
PIPE_PUNI
PIPE_PVOP
PIPE_RBND
PIPE_SIGL
PIPE_STUBLEN
PIPE_TTAP

Introduction

GEOMTYPE PIPE_BLLW
MAT_NAME
MANU_FACT
SHORT_DESCR
LONG_DESCR
WEIGHT_DRY
COG_X_PAR
COG_Y_PAR
COG_Z_PAR
SURF_AREA
SPARE
ORDER_INFO
SYSID
MANU_FACT PIPE_PVLV
SHORT_DESCR PIPE_WPIP
LONG_DESCR
WEIGHT_DRY
COG_X_PAR
COG_Y_PAR
COG_Z_PAR
SURF_AREA
SPARE
ORDER_INFO
SYSID
RATING PIPE_PIPE
MANU_FACT
SHORT_DESCR
LONG_DESCR
WEIGHT_DRY
COG_X_PAR
COG_Y_PAR
COG_Z_PAR
SURF_AREA
SPARE
ORDER_INFO
SYSID

1 Introduction

THICK_MM PIPE_ORNG
MAT_NAME,
MANU_FACT
SHORT_DESCR
LONG_DESCR
WEIGHT_DRY
COG_X_PAR
COG_Y_PAR
COG_Z_PAR
SURF_AREA
SPARE
ORDER_INFO
SYSID
2. Rename column THICK to THICK_IN in table PIPE_ORNG.

3. Add new table BEND_VALID_MATERIAL.
4. Do the following:
Add Column To Table

ISO_SUFFIX CONN_DESC
GEOMTYPE PIPE_PIPE_SPEC
RATING PIPE_ORNG_SPEC
THICK_MM
5. Rename column THICK to THICK_IN in table

PIPE_ORNG_SPEC.
6. Add columns JS_OBJECT_ID and STOCK_CODE to table
PIPE_TTAP_SPEC.
7. Move rows from table PIPE_PVLV_Y to table PIPE_PVLV.
8. Add tables:
• SCHEDULE_LIST
• SHOP_FIELD_DESC
• FIELD_ITEMS
• FIELD_ENDS
• SLOC_TYPE_DESC

Introduction
Converting Component Labels to the Current Version of Design Series
9. Update the set of key columns for table BOLTS_SPEC to also have
columns STNDRD and BOLT_LEN_PAR.
➤ To upgrade your project database tables for cable tray components
✍ The mode of selecting the width and depth from the TCODE table has been
replaced with a method that uses a catalog of specific items, similar to piping
with catalog tables and specification tables.
1. Add catalog tables:

• TRAY_TRAY
• TRAY_TELB
• TRAY_TRED
• TRAY_TBRN
2. Add specification tables:
• TRAY_TRAY_SPEC
• TRAY_TELB_SPEC
• TRAY_TRED_SPEC
• TRAY_TBRN_SPEC
3. Add table TRAY_TEND.
4. Add table TRAY_TYPE_DESC.
Converting Component Labels to the Current Version of Design Series
W You need to perform the Label Convert operation because changes in

the attribute definition were made in this version. As a general rule, even
if you think that no labels were changed, it is still recommended that you
perform Label Conversion as a safeguard.
You must run the Label Convert utility on each of the design files:
• To convert components to a newer version if they were modeled in

a design file with a previous version of Design Series
• To add attribute values to existing components
• To modify attribute values
• To move attribute values to new positions

• To change the type of a component, for example to change an item
to a new component type
For Design Series V8 XM, all component types have updated
definitions of the attributes that require label conversion.
✍ For details, see “Procedure for Converting Component Labels” on page 9-34.
Upgrading the Typical User to the Current Version of Design Series
W You must perform this procedure.
➤ To upgrade the typical user’s machine to the current version of

Design Series
✍ It is not necessary to uninstall the previous version of Design
Series.
1. Select the user installation configurations that you want and install
them accordingly.
2. Follow the additional upgrade considerations where necessary.
Additional Upgrade Considerations

• The same spec files (.s71) used in versions 8.1 and 8.5 can be used in V8
XM without modification or conversion.
• Some changes were made to the rule (*.r) files in this version. The
general procedure is that any rule file additions or modifications done in
a previous version will need to be manually updated in the new version
rule files.
• In updating a previous version project to this version using MCS, all
components must be checked out of the database using the Model
Snapshot option, opened in the new version session, updated to the new
attribute definition using the Label Convert utility, and appended to the
new version database.
• In Design Series 8.x, version 7.x cell libraries are automatically updated
to version 8. when they are attached.
W Version 8.x cell libraries are backward compatible to version 8.x only,
not to version 7.x. If you have two Design Series applications, versions
7.1.4 and 8.x, running on the same machine and you want to attach a

Introduction
Stages in the Process of Configuring and Customizing Design Series
version 7.1.4 cell library in the version 8.x application, make a copy
before attaching it.
Stages in the Process of Configuring and Customizing Design

Series
W Be sure that you have first followed the chapters in Part 1, For the
Administrator, in the Model Control System (MCS) Guide to define any
necessary MCS configuration variables, define your ODBC data source,
and set up your project database. The PDF of this book is on the
The process of configuring your project database in the current version of Design
Series involves the following stages. Each stage refers to a chapter in this Guide.
1. Configuring your project the traditional way (Chapter 2)

2. Configuring your project using Project Database (Chapter 3)
3. Configuring bolts (Chapter 4)
4. If applicable, Configuring Design Series for ProjectWise (Chapter 5)
5. Managing your project (Chapter 6)
6. If applicable, Creating and checking piping specifications
(Chapter 7)
Use the remaining chapters on various applications as needed depending on your

business needs.

The following diagram visually explains these stages:
Navigating Through Programs That You Need to Set Up or Configure

Your Project
The following diagram shows the programs and applications in Design Series. You
typically set up or configure any of them.
✍ Some of the programs in this program group must be purchased separately

from Design Series. If your company did not purchase the complete set of
programs, some program icons may not be displayed.

2 Configuring Your Project the
Traditional Way
✍ This chapter covers the traditional way to configure your project by working
with the modeling tables and class libraries. See also the new alternative,
“Configuring Your Project Using Bentley Project Administrator” on page 3-1.
Understanding Project Creation and Configuration
Project Creation
You can use the Create Project tool to create a new project by copying an existing
project, or the base or template project. The base project was installed with Design
Series. If you are a new customer, you would likely copy one of the sample projects
or the base project, and then customize that project to your needs. You would likely
copy this customized project for subsequent new projects.
The delivered sample projects contain data and components in DGN files. The
delivered base project is like a template of a project. It contains data but no DGN
files.
Project Configuration
You can configure your project database to suit your business needs. In some cases,
you must configure the database to achieve the results that you want. Design Series
uses the tables of your project database to define the behavior of the modeling
software.
W Model Control System (MCS) resides in the TriForma EC, along with its
related programs (Define Volume Utility and MCS Administrator
Database Tools). Therefore, for any information on configuring your
project database as it relates to the MCS tables and these related
programs, be sure to read the chapters in Part 1 for the Administrator in
the Model Control System (MCS) Guide on the TriForma Help menu or in
the ...\Bentley\Documentation directory.

2 Configuring Your Project the Traditional Way
As mentioned in the Model Control System (MCS) Guide, the project database tables
can be classified into two categories:
• MCS tables, which are dynamic tables that change frequently

✍ These tables are common to all applications that use MCS. They
are explained in Chapter 2 of the Model Control System (MCS)
Guide. Be sure that you have read this chapter.
• Design Series modeling tables, which are static tables that change
minimally
✍ The modeling tables are listed in the next section but explained in
detail in the chapter “Design Series Modeling Tables” on page 2-1 of
the PlantSpace Design Series Reference Guide for Administrators.
Sample data from the delivered tutorial PlantSpace database (PltSpace.mdb) is used
to demonstrate the table format. However, when you start a project, rather than use
this data and then have to modify it, you might want to start with an empty database
and add your own data to the tables.
Design Series Modeling Tables

The modeling tables are divided into the following categories:
• CLASSES table
Defines the hierarchy for all components
• Attribute definition tables
Define the attributes for each component
• EXPERT_RULES table
Contains parametric rules that are used to model components
• Catalog tables
Define the dimensional data for the components
• Specification tables
Store the piping specification data
• Configuration tables
Contain project-specific configuration information
• Description tables
Affect the way that values are displayed to users in the attributes
dialog box

Configuring Your Project the Traditional Way
Design Series Class Libraries
✍ For a detailed explanation of these tables, see the chapter “Design Series Modeling
Tables” on page 2-1 of the PlantSpace Design Series Reference Guide for
Administrators.
Design Series Class Libraries

Another task in configuring your project involves working with the class libraries.
The class libraries are explained in the section “Design Series Class Libraries, Ams.lib
and Ams_user.lib” on page 2-5.
Project Directory Structure
W To eliminate the chance of overwriting your customized data when you

install upgrades to Design Series, you should create a project directory
structure. Using the project installation, refer to the PlantSpace Design
Series Setup Guide.
Guidelines on Creating a Project Directory Structure
When you use the project installation, a directory tree will be created in the location
selected during the installation (for example, {network drive}\Projects85\new_project).
✍ You should edit the files in this directory tree when you want to make
modifications to your project.
When you edit files, you can keep a revision log at the top of the file containing
notations similar to the following:
Modified
Rev Date Comment
By
1.0 Dec 12, 1996 SJW Added UNIT_NO attribute to all piping
components as requested by A. Smith
You can use this method to track the customization that you do for a project. If you
are the PlantSpace administrator for several projects, you can maintain a clear
separation between project implementations by using this method.
✍ For more information, see the chapter “Managing Your Project” on page 6-1.

How You Configure Your Project

To configure your project, you should use the following approach to work on your
project database:
1. Editing text files

2. Using the Database Setup Tool
Editing Text Files
Design Series uses ASCII text files to load the project database. The text files are in
product subdirectories in your ...\{ProjectName}\dbload\data directory. Each
product directory contains all the data and parametric rule files needed for that
product.
To configure the project database, you can edit one or more of these text files and
then load the edited text files into the database with the Database Setup tool.
✍ Typically, you will rarely need to edit the parametric rule files. The primary
reason would be to add a component used in your company that does not
come with the Design Series software. For information about editing the rule
files, see the chapter “Using the Expert System in Design Series” on page B-1 in this
Guide.
Advantages of Maintaining Data in Text Files
Maintaining data in text files that can be loaded into the database (instead of editing
the database tables directly) has the following advantages:
• You can use the text files to load either an Access database or an
enterprise-size database such as Oracle or SQL Server. If a project
increases in size, a project can easily be transferred from Access to
an enterprise-size database.
• You can maintain a modification history in each text file.
• The text files can provide a level of redundancy for the data that has
been customized.
• The data in some tables, such as the EXPERT_RULES table, is
easier to modify in the text files than in the database.
W You should not maintain data in text files to define piping specifications.
Piping specifications should be defined and loaded into the database
through the Specification Maker program. For more information about

Design Series Class Libraries, Ams.lib and Ams_user.lib
creating piping specifications, see the chapter “Creating and Checking

Piping Specifications” on page 7-1 in this Guide.
Using the Database Setup Tool
The Database Setup Tool is used to set up and maintain an existing project database.
This tool is also used for a variety of administrator tasks such as updating edited text
files in the project database, and synchronizing ams.lib (the delivered Design Series
class library) with the project database and ams_user.lib (the user-defined class
library). The Database Setup Tool performs these tasks by loading four types of files: script files,
data files, rule files, and product files.
• Script files
SQL script files are used primarily to create database tables.
• Data files
The database tables are populated by using data files containing
catalog data for components. If your project requires components
with dimensions not supplied in the standard installation, you must
edit the appropriate data file and then load the data file into the
database.
• Rule files
Rule files define the steps required to create the 3D geometric
representation of a component in your model. If your project
requires components with geometric representations that are
different from those in the standard installation, you must modify
the rule files or create new rule files.
• Product files
Product files are the text files required for a product, such as pipe.
Product files for both metric and imperial model units are delivered
for every Design Series product. These files list the data files and
rule files to be loaded. For example under:
...\dbload\data\{product} such as pipe\english or metric\pipee.dat
for imperial or pipem.dat for SI (metric)

To configure PlantSpace Design Series, you need to understand what class libraries
are.

JSpace Class Libraries

In PlantSpace applications, a JSpace class library, or simply a class library, contains
classes with their sets of class definitions. A class library is normally identified by the
LIB file extension. You can create and use multiple class libraries, and you can
organize classes within class libraries according to your own particular needs. For
example, you could have one class library for each project, such as one for the
design of a plant, one for a bridge, and another for a commercial building. The
design of a class library is based on JSpace object-oriented technology. The JSpace
Class Editor is the JSpace program that creates and manages class libraries and their
classes, and creates and browses object model files.
Classes
An object class, also known as a class, is a classification of objects by type that you
defined. An object created in JSpace must belong to a class, and objects of the same
class must have the same characteristics. Classes are used to define the types of
objects that can be placed into a JSpace object model file. The objects are stored in
JSpace object model files.
The class is created and maintained in the class library file external to the JSpace-
based application itself. Therefore, you can create and manipulate objects of that
class without changing the application software.
Class Definitions
A class definition contains the categories of information that describe each class in a
class library. A class definition serves as a template for creating objects of the same
type. A class definition consists of the following categories:
• Children
• Parents
• Properties
• Methods
• Relationships
• Rules
✍ For complete details, see the JSpace Class Editor User help in the
...\Bentley\Documentation directory.

Changing Data in the Class Libraries
Changing Data in the Class Libraries

The Design Series class library used to create objects from the Design Series 3D
components is ams.lib. Many post-processing modules, such as Object Reporter and
Interference Manager, use and depend on the classes defined in ams.lib.
Inheritance from multiple parent classes is a feature of JSpace technology, the

object-oriented technology used to develop Design Series software. All of the
component classes in ams.lib have a corresponding parent class (*_USER) in
ams_user.lib.
W In general, you should not modify the ams.lib class library.
The ams_user.lib class library enables you to edit and modify the component
descriptions without modifying the ams.lib class library directly. As shown in the
following diagram, the parent of the PIPE_PELB class in ams.lib is the
PIPE_PELB_USER class in ams_user.lib.

Temporary or Intermediate Properties
Temporary or intermediate properties are properties that have their Include With
Object flag deselected. In the class of PIPE_BASE_USER in ams_user.lib, several
temporary or intermediate properties are defined.
For example, the ZZ_B_RADIUS_DESC property is the temporary holding place

for the expanded description for the B_RADIUS property. All of these class names
begin with ZZ_, which has no meaning other than to force all of these properties to
the bottom of the alphabetical list in the Class Editor.
The following are temporary or intermediate properties in ams_user.lib in the class

of PIPE_BASE_USER:
Corresponding
Piping Object
Temporary
Property Name
Description Property
ADP_TYPE ZZ_ADP_TYPE_DESC
BR_TYPE ZZ_BR_TYPE_DESC
CONN_1 ZZ_CONN1_DESC
CONN_2 ZZ_CONN2_DESC
FL_FACE ZZ_FL_FACE_DESC
FL_TYPE ZZ_FL_TYPE_DESC
STR_TYPE ZZ_STR_TYPE_DESC
STYLE ZZ_STYLE_DESC
VLV_TYPE ZZ_VLV_TYPE_DESC
Because PIPE_BASE_USER is the parent class for all the PIPE_*_USER classes,
the temporary properties of the parent class are inherited by all of the child classes.
The temporary properties are also inherited by the PIPE_* classes in the ams.lib
library.
W If you make any changes to the classes in ams_user.lib, you must then
use the Database Setup tool to synchronize the ams.lib library with the
new ams_user.lib. This operation ensures that all changes to the parent
class are inherited by the child classes. For more information, see the
section “Synchronizing Ams.lib with the Project Database and Ams_user.lib” on
page 2-9.

Synchronizing Ams.lib with the Project Database and Ams_user.lib
JSpace Expressions as Sources of Values
For each of the ZZ_* properties in the classes in ams_user.lib, a Fixed Expression
determines the value assigned. This expression uses the built-in function
DB_QUERY to query the appropriate database table to obtain the description for a
coded value.
In the following example, the expression uses the current value of the BR_TYPE
property (for example, ITE) to look up the description (for example,
INSTRUMENT TEE) from the BR_TYPE_DESC table and assign it to the
ZZ_BR_TYPE_DESC intermediate property:
ZZ_BR_TYPE_DESC = DB_QUERY("PS_CODES_DB", "SELECT
DESCRIPTION FROM BR_TYPE_DESC WHERE CODE = '"+BR_TYPE+"'");
✍ The double quotation marks (") and the single quotation mark (') in the
previous expression must be used properly to construct a valid SQL Select
clause.
The intermediate properties are then used to build the complete COMP_DESC
string, as in this example for the class PIPE_PBRN_USER:
COMP_DESC = ZZ_BR_TYPE_DESC + ", " + ZZ_CONN1_DESC;
This expression results in COMP_DESC receiving a string like "INSTRUMENT

TEE, SOLDERED".
MicroStation Configuration Variable PS_CODES_DB
PS_CODES_DB must be defined as the ODBC data source name for your Design
Series database in the Project PCF file.
For more information on the Project PCF file, see the chapter “Managing Your
Project” on page 6-1 in this Guide.
This variable is used in the DB_QUERY function call to identify and connect to
your Design Series database where the lookup tables reside.
Synchronizing Ams.lib with the Project Database and Ams_user.lib

✍ The ams.lib file is the delivered Design Series class library and the only class
library that the Database Setup tool synchronizes.

Procedure for Creating a Project
The Database Setup tool enables you to synchronize ams.lib with the corresponding
information in the project database and ams_user.lib (the user-defined class library).
The project database stores class-related information in the ATTRDEFN and
CLASSES tables.
✍ The AMS.lib is automatically synchronized whenever the project database is

loaded.
Creating New Classes or Adding Properties
Using the Database Setup tool, you can create new classes or add properties to the
classes by modifying the appropriate data files that are loaded into the database. The
information in the ATTRDEFN and CLASSES tables and the associated rules in
EXPERT_RULES define the behavior for modeling of each design component.
Using JSpace object model (JSM) files with the Object Reporter production tools,
you can post-process the created components.
Synchronization Process
The class definition for each component type in the database (for example,
PIPE_PIPE from the ATTRDEFN and CLASSES tables) is used to create a
corresponding class of the same name (for example, PIPE_PIPE) in ams.lib.
Every class in ams.lib inherits properties from a corresponding class in ams_user.lib.
W You must edit the class definitions in ams_user.lib, not in ams.lib.
The Database Setup tool re-creates the ams.lib file. Therefore, user-defined
attributes from corresponding classes (for example, PIPE_PIPE_USER) in
ams_user.lib become a part of the class definition in ams.lib.

You can create a project by using the Create Project tool.

➤ To create a project
1. From the Windows Start > Programs menu, select Bentley >
PlantSpace Design Series V8 XM Edition > Administrator >
Create Project.
The Design Series Project Setup dialog box is displayed.
2. At the Existing project or base folder field, type the path or click the
browse (...) button to access the folder for your project.
3. At the Project configuration file (pcf) field, type the path or click the
browse (...) button to access the PCF file to copy.
✍ The *.pcf files for the sample projects are in the
projects\examples folders under the MicroStation Workspace
folder, which defaults to C:\Documents and Settings\All
Users\Application Data\Bentley\WorkSpace.
4. Click Next.

5. In the next dialog box displayed, type a name for the project and
select the units for the project, as shown in the example.
6. Click the browse (…) button by the Project group folder field to
open the Project Group Selector dialog box to select the Project
Group Folder. The Project Group Folder is the folder where the
project's *.pcf file will be located.
For details on the Project Group Selector, see “Enabling Group Project
Selection for Users” on page 6-3.
7. Select a new location from the Recent roots table (below) or click
Browse to browse and select a new location, and then click
Change and Exit.

The Design Series Project Setup dialog box is redisplayed with the
new path displayed in the Project group folder.
The Project location field pertains to the tree of project files. This
defaults to the project group location plus a folder named for the
project.
8. To choose a different location for the project, click the browse (…)
button by the Project location field or type a location.
9. Click Next.
10. In the next dialog box, select the type of database for this project,
and type the information for the ODBC Data Source, User Name,
and Password fields.
W 1. The Create Project tool will create the DSN (on the current
workstation only), but the DSN will not be linked to a database.
2. The Create Project tool does not create a new instance of an
MS Access, Oracle, or MS-SQL/Server database. You must link the
DSN to an existing instance, creating one first if necessary.
11. Click Finish.

Procedures for Configuring Your Project
After the progress bar finishes showing the files being copied, a
dialog box with the status is displayed.
The Project Creation Report lists the information about the name
of the project, the DSN, the units, and locations with the number of
files copied.
✍ 1. The sample projects do not contain the dbload folder. Instead,
they link to the dbload folder of the base project (used with
Project Administrator). If you want each project to have its own
dbload folder, use Windows Explorer to copy the dbload folder
from the base project to your new project. The dbload folder is in
the Options\psds\standards\psds folder under the Base folder.
2. You should review the newly-created *.pcf file to verify its
settings. New settings in the *.pcf include:
DS_SAMPLE_PROJECT = 1 and %include $(PS_PROJ)config/
ds_product_PIW.cfg.

Configuring your project can involve any of the following tasks:
• Modifying attribute definitions

• Adding catalog (or dimensional) data
• Updating expert system rule files
• Updating a product file

Modifying Attribute Definitions
• Updating the volume table

• Accessing data from the PlantSpace P&ID application
• Accessing data from third-party applications
• Displaying the component type name in the attributes dialog box
• Customizing the Value column in the attributes dialog box
• Displaying PlantSpace component information in the dialog box of
the TriForma Element Information tool
• Creating a label position file (Rimref.dat file)
• Executing your own SQL commands (optional)
• Executing your own script commands (optional)
• Creating multiple project schemas in one database instance
W Because Model Control System resides in the TriForma EC, the sections
on updating the volume table and building storage tables are in Part 1:
For the Administrator, in the Model Control System (MCS) Guide on the
Each task is explained in the following sections.
W Configuration of attribute definitions should be done early in the project

life cycle. Changes to component attribute definitions should be
completed before implementing the Model Control System (MCS)
because the Catalog_BUD tables that MCS uses for storage contain
columns that correspond to the attributes of every component.
Within MicroStation, the attributes for every Design Series component are stored in
a text string that is commonly referred to as the component label. The component
label consists of the attributes displayed in the attributes dialog box. The contents of
every component label and the position of each attribute within the label are defined
in the ATTRDEFN table of the project database. The ATTRDEFN table is
specification driven and is used as the default means of accessing data for

component placement. The ATTRDEFN table makes the data accessible to users
when they select the Specifications option in the Placement Mode field.
To meet project requirements, you can edit the attribute definition of any Design
Series component and then load the text file.
Stages in Editing the ATTRDEFN Table
W The ATTRDEFN table should not be edited directly.
The process of editing the ATTRDEFN table consists of the following stages:
1. Editing the appropriate text file in your project directory and

adding, changing, or deleting attributes as required
2. Updating the edited data file by using the Database Setup tool
3. Checking for errors in the attribute definitions
4. Re-creating the Rimref.dat file (the delivered label position file) and
building the storage tables (the <product>_BUD table and
DEL_<product>_BUD table)
5. Synchronizing the ams.lib file with the project database
6. Placing components in the modeling environment to confirm the
attributes updates
These stages of the process are detailed in the following sections.
✍ If you modify attributes that define the geometry of a component (attributes

with GRAPHICS_PAR = Y), you must update the parametric rule files that
reference the same attribute.
W Before modifying component attributes, you should make a backup

copy of the Rimref.dat file (the delivered label position file). Because
label attributes are accessed based on the Rimref.dat file, design files
must access the same version of the Rimref.dat file that you used when
you created the design file. For more information about the Rimref.dat

file, see the section “Creating a Label Position File (Rimref.dat File)” on page
2-62.
Editing the Text Files Containing Attribute Definitions
The following table lists the text files that contain the attribute definitions for each
Design Series product.
✍ All the text files reside in product subdirectories in your

...\{ProjectName}\dbload\data directory.
Text File and Path by Table

Description
Product Populated
\pipe\english\pip_atre.dat Imperial piping with ATTRDEFN
specifications
\pipe\english\pipcatre.dat Imperial piping using catalog ATTRCDEF
information
\pipe\metric\pip_atrm.dat SI piping with specifications ATTRDEFN
\pipe\metric\pipcatrm.dat SI piping using catalog ATTRCDEF
information
\pipe\*standard\pipatr_*standar The term *standard means the ATTR_XXn
d.dat standard name. For example, if or
ANSI is used, the directory and ATTRC_XXn
file name are
...\pipe\ANSI\pipatr_ANSI.
\equip\english\eqp_atr.dat Imperial equipment ATTRDEFN
\equip\metric\eqp_atrm.dat SI equipment ATTRDEFN
\hgr\english\hgr_atre.dat Imperial pipe supports ATTRDEFN
\hgr\metric\hgr_atrm.dat SI pipe supports ATTRDEFN
\hvac\english\hva_atre.dat Imperial HVAC ATTRDEFN
\hvac\metric\hva_atrm.dat SI HVAC ATTRDEFN
\cndt\english\cnd_atre.dat Imperial electrical conduit ATTRDEFN
\cndt\metric\cnd_atrm.dat SI electrical conduit ATTRDEFN
\tray\english\tra_atre.dat Imperial electrical cable tray ATTRDEFN
\tray\metric\tra_atrm.dat SI electrical cable tray ATTRDEFN

Column Data in an Attribute Definition Table
The following table shows the columns that you see when you open the text file of
an attribute definition table. This table provides an overview of all the attribute
definition tables. The following codes indicate which column data is used and not
used in controlling the attributes:
I = Ignored, never used by software U = Used

NO = Used, but not modifiable X = Not Used
✍ For applications of the ATTRDEFN table, refer to later sections in this

chapter.
ATTRC_XXn
(catalog driven)
(catalog driven
ATTRDEFN
ATTRCDEF
ATTR_XXn
(spec driven)
(spec driven
Attribute Definition
Table
Column Name
LEVEL_1 U NO NO NO
LEVEL_2 U NO NO NO
LEVEL_3 U NO NO NO
LEVEL_4 U NO NO NO
LEVEL_5 U NO NO NO
ATTR_NAME U NO NO NO
UNITS U X X X
CASE U X X X
ATTR_TYPE U X X X
LBL_POS U X X X
COL_WIDTH U X X X
LBL_WIDTH I X X X
DEC_PLACES U X X X
DESCRIPTION U U U U
BOX_ORDER U U U U
DEFAULT_VALUE U U U U
INPUT_METHOD U U U U

ATTRC_XXn
(catalog driven)
(catalog driven
ATTRDEFN
ATTRCDEF
ATTR_XXn
(spec driven)
(spec driven
Attribute Definition
Table
Column Name
OVERRIDE_ALLOWED U U U U
VALID_MASK I X X X
GRAPHIC_PAR U X X X
WRITE_PRIVILEGE I X X X
READ_PRIVILEGE I X X X
APP_FLAG U U U U
USER_FLAGS U U U U
W The ATTRDEFN table must contain all attributes. The Layer 1 and
Layer 2 attribute definition tables (explained in the section “Using
Different Sets of Attributes for the Same Component” on page 2-4 of the
PlantSpace Design Series Reference Guide) cannot define new attributes. They
can only redefine user input data.
In the previous table for example, if the ATTRCDEF table overlays the
ATTRDEFN table, only the columns marked used (U) for the ATTRCDEF table
will take precedence over the columns in the ATTRDEFN table. Therefore, the
ATTRDEFN table can have a different input method from that for the
ATTRCDEF table. The ATTRCDEF input method will be used only when the user
selects information that is catalog driven from within Design Series.
Levels Used to Define Hierarchical Relationships
As described earlier in the section CLASSES Table, Design Series components are
hierarchically classified. Each component belongs to a specific class and subclasses
(levels), and each class has some common attributes. The LEVEL_1 through
LEVEL_5 columns are used to define hierarchical relationships.
When collecting the label fields for a particular component, the system performs a
sequence of queries of the ATTRDEFN table starting with the upper level and
going to lower levels. For example, if the component PIPE_PVLG belongs
sequentially to the PIPE class, PVLG subclass, and REDUCING sub-subclass, the
system first collects attributes that are:

• Common for all components

WHERE LEVEL_1 IS NULL
• Then for class PIPE
WHERE LEVEL_1 = PIPE AND LEVEL_2 IS NULL
• Then for subclass PIPE.PVLG
WHERE LEVEL_1 = PIPE AND LEVEL_2 = PVLG AND LEVEL_3 IS
NULL
• Then for subclasses PIPE.PVLG.REDUCING
WHERE LEVEL_1 = PIPE AND LEVEL_2 = PVLG AND LEVEL_3 =
REDUCING AND LEVEL_4 IS NULL
This flexible method of classification helps organize the attributes and decreases
redundancy.
➤ To edit the fields
W As you edit the fields, keep in mind that component labels of the
attributes cannot overlap. The Label tool can be used to locate free
space in the labels.
1. Using a text editor such as Notepad, open the appropriate text file
from your project directory structure.
The data required for each attribute definition is listed as a
comment near the top of the text file.
2. Use the information from the tables in the following sections.
✍ Pay particular attention to the sections on attributes that should
not be changed, and the required fields.
3. Save and close the text file.

Attributes That Should Not Be Changed
W The following attributes should not be changed, moved, or deleted:
Attribute Name Description Position

COMPTYPE Component type 1-4
DATABASE Discipline or module 66-70
SRC_CODE Date of creation 71-76
SEQ_NUMB Sequence number 77-80
BUD_TYPE Bud type 81-92
BUD_ID ID number 93-102
CAE_ID Reserved 103-110
SITE_ID Site ID 111, 112
To create a component, the expert system requires most of the default attributes
that are displayed in the dialog box when you place the component. Therefore,
deleting or renaming default attributes can compromise the integrity of your system.
For example, if you delete or rename SIZE_1, the nominal diameter in imperial
units of piping components, the Design Series will not be able to perform certain
functions.
Description of the Required Fields
Each required field is listed as follows with an explanation of the field. These fields
correspond to the schema of the Attrdefn table in the project database.
✍ For more information about the Attrdefn table, see the section “Design Series
Modeling Tables” on page 2-2 explained earlier in this chapter. For more
information about the attribute definition tables, see the chapter “Design Series
Modeling Tables” on page 2-1 in the Design Series Reference Guide for Administrators.
Column Name Description

LEVEL_1 The product name by convention and for
compatibility with other software
LEVEL_2 through Form a hierarchy within the product
LEVEL_5


ATTR_NAME and Identify the field name and its user prompt
DESCRIPTION Note: ATTR_NAME has a 9-character maximum
length.
UNITS and CASE Identify the measurement units (and case for the
field where applicable) and are used to format the
values
LBL_POS and Define the position and length of the text
LBL_WIDTH representation of the attribute value in the label
DEC_PLACES Defines the number of digits to the right of the
decimal point for real numbers
DEFAULT_VALUE The initial value for the attribute


INPUT_METHOD The source for the attribute values. Allowable
sources are:
• ENVVAR
Uses the value of a Windows environment
variable (in Control Panel>System) or a
MicroStation configuration variable to set the
attribute value. For example, to set your
Windows login name, the value is
ENVVAR(USERNAME).
• EVALUATE
Calculates values that are not easily put in a
table, like a schedule.
--Example 1: In the ATTRDEFN table, type
“EVALUATE [(10 * 10)-3]00” without the
quotation marks in the INPUT_METHOD
column for the LINENO attribute. Start
Design Series Modeling and click the Place Pipe
tool to display the attributes dialog box. For
every value of Size 1 specified in the attributes
dialog box, the value of Line No. is 9700.
-- Example 2: In the ATTRDEFN table, type
“EVALUATE [$SIZE_1 * 1]” without the
quotation marks in the INPUT_METHOD
column for the INSULAT attribute. Start
Design Series Modeling and click the Place Pipe
tool to display the attributes dialog box. For
every value of Size 1 specified in the attributes
dialog box, the value of Insulation Thickness is
the same as that for Size 1.
• KEYIN
Indicates that the user enters the value when the
component is placed
• QUERY
Provides a list of choices retrieved from a table
Note: See the next section “Using the
INPUT_METHOD Query” on page 2-24.
• VALUES
Provides a list of choices, such as VALUES
V1,V2, V3...,
OVERRIDE_ALLOWED Indicates if the user is allowed to override the
INPUT_METHOD restrictions


BOX_ORDER Orders the display of fields in the attributes dialog
box
GRAPHICS_PAR Indicates if an attribute is related to the graphic
representation of the component
APP_FLAG Indicates if this label field should be displayed or
copied for a particular label operation. The
allowable flags are:
A = Automatically set single value
B = build label
C = copy label
E = edit single label
M = edit multiple labels
R = read label
H = do not display the attribute if only one value
exists for that attribute
T = display the number of digits to the right of
the decimal point defined in DEC_PLACES
including trailing zeros
The presence of a flag prevents the attribute from

being used during the named operation. More
than one flag can be listed. For example, if the
APPS_FLAG for a label field is BEM, the field
would not be displayed in the attributes dialog box
during build (B) or edit (E and M) label
operations, but would be displayed during the
read (R) label operation and would be copied (C)
during a label matching operation.
USER_FLAGS Identifies user-modified and added attributes. The
allowable flag is:
USER = user-modified attribute or added
attribute
Using the INPUT_METHOD Query
This section details the use of the INPUT_METHOD column and the Query
source described in the previous table. Lookup tables define values for certain
attributes of a component based on the values assigned to the other attributes.
These tables typically reflect established project specifications for various
components, and provide you with flexible, tailored selection lists.

The INPUT_METHOD query defines the LOOKUP tables to use and the
attributes involved in using the QUERY keyword.
✍ The INPUT_METHOD query uses a modified form of Structured Query

Language (SQL). For complete details on using SQL statements, refer to third-
party documentation on this topic.
In Design Series, the general format of an INPUT_METHOD query is:

QUERY [DISTINCT] relation_name[:column_name]
[USING attribute1 [, attribute 2, [, ...]]
[WHERE attribute = $attribute [AND attribute2 = $attribute2
[...]]
[other SQL statements]
[ORDER BY attribute]
✍ Design Series uses an abbreviated form of SQL syntax as synonyms in parts of

the query statement to simplify the statement and to remain within the 511
character limit of the INPUT_METHOD query.
The parts of the query statement are explained as follows:
Part of the
Query Explanation
Statement
QUERY Clause The QUERY keyword is a synonym for the SQL
keyword SELECT.
Note: This is required.
DISTINCT The DISTINCT keyword is standard SQL. It directs
Keyword ODBC to retrieve only those values that are unique and
not to return any value that has been returned
previously.
Note: When both the DISTINCT keyword and the
ORDER BY clause are used, the ORDER BY clause
cannot refer to columns that were not mentioned in the
QUERY.
Relation_Name The relation_name is the name of the table.
Column_Name The [:column_name] portion is optional if the column
name of the specified table is the same as the attribute
name of the label definition.

Part of the
Query Explanation
Statement
USING Clause The optional USING clause is a synonym for the SQL
command:
WHERE attribute1 = 'attribute1_current_value' AND
attribute2 = 'attribute2_current_value' AND ...
That is, the SELECT statement is qualified using the
named label attributes and their current values.
WHERE Clause The WHERE clause is standard SQL. It qualifies the
query and can be used alone or with any other valid SQL
operation, such as UNION statements and embedded
SELECT statements.
Note: Within a standard SQL WHERE clause, the
$attribute construction is automatically replaced by the
current value of the named attribute in single quotation
marks if required for SQL syntax. (Text values are
quoted, but numbers are not.) However, these additional
expressions cannot use any other PlantSpace
abbreviated SQL syntax.
ORDER BY The optional ORDER BY clause is standard SQL. It
Clause alphabetically sorts the selected values to ensure a
meaningful presentation to the user. Without this clause,
the selected values can be in any order.
Note: When both the DISTINCT keyword and the
ORDER BY clause are used, the ORDER BY clause
cannot refer to columns that were not mentioned in the
QUERY.
Incorporating User Modifications and Additions to the

Attribute Definition Text Files
The table on page 2-17 of this Guide lists the attribute definition files for each
Design Series product.
W Whenever modifications or additions need to be made to the attribute

definition file for any product, you need to perform the following tasks:

1. Create a user-defined attribute definition file.

You create this file by copying the attribute file that you are going to
modify, and adding the suffix _user to the file name. For example:
copy Pip_atre.dat and rename it Pip_atre_user.dat.
You then open Pip_atre_user.dat in any text editor and delete all the
attributes between DATA_BLOCK_BEGIN and
DATA_BLOCK_END.
Last, you modify the DELETE FROM statement to remove all
attributes where USER_FLAGS is set to USER. For example:
DELETE_FROM attrdefn "where level_1='PIPE' and
user_flags =’USER’".
2. To modify an existing attribute, simply set USER_FLAGS for that
attribute to the value USER in the delivered attribute definition file.
The following example shows this modification made to the
LINENO attribute in the Pip_atre.dat file.
PIPE,,,,,\
LINENO,,,INTEGER,121,10,,,\
"Line No.",18,"000",\
KEYIN,\
Y,"999",N,,,,USER
3. After USER_FLAGS is set in the delivered attribute definition file,
copy the block of data for that attribute into the user-defined
attribute definition file.
For example: copy the LINENO attribute from Pip_atre.dat to
Pip_atre_user.dat. After the attribute is copied, you can modify any
data associated with that attribute.
The following example shows the description for LINENO
changed from “Line No” to “Line Number”:
DATA_BLOCK_BEGIN
/* Modified label attributes */
PIPE,,,,,\

"Line Number",18,"000",\
KEYIN,\
Y,"999",N,,,,USER
DATA_BLOCK_END
4. To add a new attribute, simply create that attribute in the user-
defined attribute definition file and set USER_FLAG to USER.
For example: create an attribute called INS_CODE in the
Pip_atre_user.dat file.
DATA_BLOCK_BEGIN
...
/* Modified label attributes */
PIPE,,,,,\
"Line Number",18,"000",\
KEYIN,\
Y,"999",N,,,,USER
/* New label attributes */
PIPE,,,,,\
INS_CODE,,U,CHAR,300,3,,,\
"Insulation Code",20,"A2",\
VALUES A1, A2, B3, D4,\
Y,,N,,,,USER
...

DATA_BLOCK_END
5. To update the user-modified and new attribute, first load the
delivered attribute definition file into the database and then load the
user-defined attribute definition file into the database.
For example, load Pip_atre.dat into the database and then
Pip_atre_user.dat into the database. For details, see the next section
on updating the attribute definition tables.
Loading the Modified Text File
After all modifications are complete, you must load the text file into the project
database for the changes to occur in the modeling environment.
➤ To load the modified text file

1. From the Start>Programs menu, locate the PlantSpace Design
Series program group.
2. Click the Database Setup icon.
✍ If you have two or more PCF files in the location pointed to by
the MicroStation configuration variable, _USTN_PROJECT, the
Select Workspace dialog box is displayed. Once you select
triforma (or whatever you as the administrator set up) in the
User field, select a project, and click OK, you can continue.

The PlantSpace Database Setup window is displayed with the

project name in the title bar, as shown in the following example.
3. In the Load group, click the Data File button.

4. Select the copy of the text file that you just modified in the previous
stage and click Open.
• If you made any syntax errors in the file, an error message is displayed.
• If an error message is not displayed, the ATTRDEFN table in the
project database is updated.
5. Click OK in the message dialog box.
Checking for Errors in the Attribute Definitions
Label positions 600 through 1196 in the default database are empty for every
component type to enable you to add new attributes to this section of the label. The
ATTRDEFN table is the only table that uses the label positions.

To help update the label positions, you can use the moveuser.sql file in your
...\{ProjectName}\dbload\data directory to move the attributes when they are in the
database. A suggested strategy is then to export the DAT files from the database.
W Although the data in the ATTRDEFN table is updated successfully, you

must still check for overlapping attributes and for discrepancies between
classes in this table and the CLASSES table. The Database Setup tool
performs the Check Definitions/Classes operation to run a series of
checking programs. These programs validate the attribute definitions in
the ATTRDEFN table and verify that all the classes in the ATTRDEFN
table match the classes in the CLASSES table.
➤ To check for errors in the ATTRDEFN table against the CLASSES table
✍ If you are starting the Database Setup tool, see the procedure "To start the
Database Setup Tool," steps 2 through 5, in Chapter 2 of the Model Control System
(MCS) Guide.
1. In the PlantSpace Database Setup window, click the Check

Definitions button.
The Check ATTRDEFN and CLASSES dialog box displays the
progress of the checking operaton.

When the operation is finished, the messages displayed indicate if

any errors were found.
2. Click OK to continue, or click the Save As button to save the

messages.
If you clicked the Save As button, the Save Messages to File dialog
box is displayed.
3. Select a file or enter a file name in the directory where you want to
save the messages, and click Save.
4. If you had errors, resolve the errors and repeat this procedure.

W After any errors are resolved, you must next re-create the Rimref.dat file
and rebuild the storage tables. Continue to the next procedure.
Re-Creating the Rimref.dat File and Building the Storage

Tables
✍ Rimref.dat is used by the Label Convert utility and the MicroStation

Connection. The storage tables are the <product>_BUD table and
DEL_<product>_BUD table.
➤ To re-create the Rimref.dat file and build the storage tables
(MCS) Guide.
1. In the PlantSpace Database Setup window, click the Create Label

Position File button.
The Select Label Position File dialog box is displayed.
2. In your ...\{ProjectName} directory, select the rimref.dat file or

type the name of the new file with a DAT extension.
3. Click Save.

If a previous rimref.dat file exists, a message is displayed.
4. To replace the rimref.dat file, click Yes.

5. Click OK in the message displayed that the rimref.dat file was
successfully created.
6. Click the Build Storage Tables button.
W In reference to the Model Control System (MCS), if any changes were

made to the component attribute definitions, you must build the BUD
tables before implementing the MCS. If any modeled components
have been stored in the MCS, BUD tables cannot be rebuilt with this
menu item. To do this, see this topic in the administrator chapter of
the Model Control System (MCS) Guide.
7. When the tables are successfully built, click OK.
Continue to the next procedure.
Synchronizing the Ams.lib File with Your Project Database
✍ The system automatically synchronizes the ams.lib file. However, if you want to
synchronize the file for any reason, you can do so.
The ams.lib file is the class library used by most of the Design Series post-processing
programs.
W To synchronize ams.lib with your project database, ams.lib and

ams_user.lib must be stored in the JPATH directory located by default
in your ...\{ProjectName}\etc directory (as set by the JPATH
configuration variable). Also, you must have a valid ODBC data source
pointing to your project database. If you make changes to ams.lib
instead of to ams_user.lib, you will lose those changes when ams.lib is
synchronized to ams_user.lib. Therefore, you should always modify
ams_user.lib.

➤ To synchronize the ams.lib file with your project database
(MCS) Guide.
1. In the PlantSpace Database Setup window, click the Synchronize

AMS.LIB button.
The following message is displayed.
2. Click OK in the message dialog box to synchronize the ams.lib file

with your project database.
All component classes in ams.lib are re-created and old information
is lost.
3. Close the Database Setup window.
Changes made to ams.lib are then written to the disk.
Placing Components to Confirm the Attribute Updates
Once the database is successfully updated, you should try to place a component in
the modeling environment.
➤ To place components to confirm the attribute updates

1. From the Windows Start > Programs menu, choose PlantSpace
Design Series V8 XM > Design Series Modeling and open
your design file.
2. Place a component and check the changes you made, for example:
• If you added a new attribute, you should confirm that the attribute is
included in the label (attributes dialog box) and that it behaves in the
manner that you want. For example, if you specify a query for the
INPUT_METHOD, you must confirm that the appropriate choices are
displayed.

• If you enabled a value to be overridden, you should be able to type in a

new value.
3. Close the application.
Adding Catalog Data

Adding catalog data makes the data accessible to users when they select the Catalogs
option in the Placement Mode field.
The stages in the process of adding data to component catalogs are similar to those
for editing text files covered in the previous sections.
✍ For details on adding catalog data specific to bolts, see the chapter, “Configuring
Bolts” on page 4-1.
Stages in Adding Catalog Data
The process of adding data to component catalogs consists of the following stages:
1. Editing the text file by adding the rows of data needed to define the
additional components
2. Updating the catalog tables by using the Database Setup tool
3. Placing the components and confirming their dimensions within the
modeling environment
4. If your project requires piping specifications, add the new
components sizes to a guideline by using the Specification Maker.
✍ To include the new component in the piping specifications, you
must synchronize the database within the Specification Maker.
For information about adding a new guideline, modifying an
existing guideline, and synchronizing the database for piping
components, see the chapter “Creating and Checking Piping
Specifications” on page 7-1 in this Guide.

Adding Catalog Data
✍ An example on modifying bolt catalog data follows these stages to show you
how to apply these procedures to a specific set of data.
Editing the Text File
✍ For piping components, the data required for each type of component is
documented in each of the text files and in the chapter “Configuration Data for
Your Project Database Tables” on page 4-1 in the PlantSpace Design Series Reference
Guide for Administrators. To add a line of data in the proper format, you can
copy an existing line and change the values as needed. The order of the lines of
data in the text file is arbitrary.
If your project requires piping specifications, add the new components sizes to a
guideline by using the Specification Maker. To include the new component in the
piping specifications, you must synchronize the database within the Specification
Maker. For information about adding a new guideline, modifying an existing
guideline, and synchronizing the database for piping components, see the chapter
“Creating and Checking Piping Specifications” on page 7-1 in this Guide.
Adding Data for Existing Component Types

If you want to add a new component type to a table, such as elbows, the data may
need to be added to other tables such as the end prep table and diameters table.
Some component types, such as valves, refer to other tables as well.
➤ To edit the text file

1. Using a text editor such as Notepad, open the required text file in
the appropriate subdirectory in your ...\{ProjectName}\dbload\data
directory.
2. Edit the text file by adding the rows of data to define the new
components.
3. Save and close the file.
Updating the Catalog Tables
After you add project-specific catalog information or define new components, you
must load the edited data file into the project database to update the catalog tables
so that the changes occur in the modeling environment.

The standard catalog files are in your ...\{ProjectName}\dbload\data\<product>

directories:
Where Means
<product> The specific product name such as pipe
To determine the name of the appropriate data file, see the chapter “Configuration
Data for Your Project Database Tables” on page 4-1 in the PlantSpace Design Series
Reference Guide for Administrators.
➤ To update the catalog tables
(MCS) Guide.
1. In the PlantSpace Database Setup window, click the Data File

button.
The Select Data File dialog box is displayed.
2. Select the data file that you want to load.

You can select multiple data files. Each file is loaded in turn.
3. Click Open.
The amount of time that passes before the process is completed
increases as the size of the file increases.
A message is displayed indicating that the file was successfully
loaded.

Updating Expert System Rule Files
4. Click OK.
Placing Components to Confirm the Dimensions
Once the database is successfully updated, you should try to place a component in
the modeling environment to verify that the dimensions are correct.
➤ To place components to confirm the dimensions

1. From the Windows Start > Programs menu, choose PlantSpace
Design Series V8 XM > Design Series Modeling and open
your design file.
2. Place a component and check the dimensions that you added.
3. Close the application.

If you make any changes to the expert system rule files, you must load the rule files
into the project database to update the data in the EXPERT_RULES table.
✍ For more information about rule files, see the EXPERT_RULES Table section
in the chapter “Using the Expert System in Design Series” on page B-1 in this
Guide, and the chapter “Design Series Modeling Tables” on page 2-1 in the
The rule files are in your ...\{ProjectName}\dbload\data\<product> directories:
Where Means
<product The specific product name such as pipe
>
➤ To update an expert system rule file
(MCS) Guide.

1. In the PlantSpace Database Setup window, click the Rule File

button.
The Load Rule File dialog box is displayed.
2. In the Product field, select a product.

The File Name field becomes enabled.
3. Type the file name, or click the Browse button to locate the name
of the rule file.
The Select Rule File dialog box is displayed.
4. Select the rule file that you want to load, and click Open.

The Load Rule File dialog box is redisplayed.
The rule name automatically defaults to the base name of the file
selected, but must agree with the entry in the CLASSES database
table.
5. Type the subcodes in the Subcode 1 field and the Subcode 2 field.
✍ These fields are required.
When you load individual rule files, these fields are typically left
blank. However, these fields must be filled in when you load the
following rule files for the CORE product:
Subcode
Rule Name Subcode 1
2
ATDFN001.R CHECKERS AD
ATDFN002.R CHECKERS AD
CLASS001.R CHECKERS CL
6. Click OK.
increases as the size of the file increases
loaded.
7. Click OK again.
Example: Setting Symbology by System
This example demonstrates the use of the symb.r rule file, which controls the
behavior of symbology. The symbology (color, line-weight, and level) is set (as
delivered) for most of the piping components based on the SYSTEM (service)

attribute. The system names and values are used from the PIPE_SYMB table (in the
symbolgy.dat file explained on “PIPE_SYMB Table” on page 2-12 of the PlantSpace
Design Series Reference Guide for Administrators). The values in this table will be used
when components are created or when the Design Series>Utilities>Update System
Color command is used.
When most of the piping components are created, the symb.r rule file is called,
which searches the database based on SYSTEM using the PIPE_SYMB table.
(Gasket, as delivered, is one of the components where the symb.r rule file is not
called.) If you want a different behavior in symbology such as color by line number
or color by system and diameter, you can implement the changes by editing the
symb.r rule file.
➤ To change the SYSTEM names and symbologies

1. Open the symbolgy.dat file in your
...\{ProjectName}\dbload\data\pipe directory.
2. Add the SYSTEM names and symbologies that you want.
✍ The color values are MicroStation color numbers, and so on.
3. In the Database Setup tool window, choose Load>Data File.
➤ To change the behavior of the symbology in a component

1. Open the symb.r rule file in your
...\{ProjectName}\dbload\data\pipe\rules directory.
As delivered, the code format is:
TEXT service;
(RULE) then service = parse_label(label, 'SYSTEM')
(RULE) then flag[0] =
QUERY("SELECT
lvl_num(level),color(color),weight(weight) FROM
PIPE_SYMB where sys_name = '%a'",service)
2. To change color by line number, edit the code as follows.
W As a prerequisite to this step, you must create and fill in a table named
LINENO_SYMB with columns named LINENUM, LVL_NUM,
COLOR, and WEIGHT.
TEXT lineNumber;
(RULE) then lineNumber = parse_label(label, 'LINENO')

Updating Product Files
QUERY("SELECT
LINENO_SYMB where linenum = '%a'",lineNumber)
3. To change color by system and diameter, edit the code as follows.
✍ As a prerequisite to this step, you must create and fill in a table
named BOTH_SYMB with columns named SYS_NAME,
SIZE_1, LVL_NUM, COLOR, and WEIGHT.
TEXT service;
REAL nomDiameter;
(RULE) then service = parse_label(label, 'SYSTEM')
(RULE) then nomDiameter = parse_label(label, 'SIZE_1')
QUERY("SELECT
BOTH_SYMB where sys_name = '%a'" AND size_1 =
'%a'",service, nomDiameter)
Updating Product Files

If you make changes to an existing product file or need to use a new product file,
you must load it into the project database to update the appropriate tables. Loading
a product file loads a group of data files or rule files (or both) into the database.
The standard product files are in your ...\{ProjectName}\dbload\data\<product>

directories and are named <product><unit>.dat:
Where Means
<product> The specific product name such as pipe
<unit> The reference to imperial or SI units
➤ To update a product file
(MCS) Guide.

1. In the PlantSpace Database Setup window, click the Product File

button.
The Load Product dialog box is displayed.
2. In the Product field, select a product.

The File Name field becomes enabled.
3. Type the file name, or click the Browse button to locate the name
of the product file.
The Select Product File dialog box is displayed.
4. From the Data subdirectory, select the product file that you want to
load.
An example would be the pipee.dat product file in the ... \dbload
\data\pipe\english subdirectory. Product files specify one or more
data files, rule files, SQL command files, catalog data, and label
attribute information to be loaded into the data source.
5. Click Open.

Updating the Volumes Table
The Load Product dialog box is redisplayed with the appropriate

commodity name in the Product field.
W Be sure that the Product drop-down list box displays a commodity

name, such as PIPE in the example. This name points to the
appropriate commodity tables in your project database based on the
product file that you selected. If the drop-down list box is blank, you
have not selected an appropriate product file. The system will not be
able to return the proper data from the database.
6. Click OK.
increases as the size of the file increases.
loaded.
7. Click OK again.
Updating the Volumes Table
W You must update the VOLUMES table with your project master volume
definition file before you use the Model Control System (MCS). To do
this, see this topic in Part 1, For the Administrator in the Model Control
System (MCS) Guide on the TriForma Help menu or in the ...\Bentley
\Documentation directory.

Accessing Data from the PlantSpace P&ID Application

Design Series enables users to open a PlantSpace P&ID in Design Series and place
pipe components from the P&ID into Design Series. Users can access P&ID data
through the P&ID tool box in the Pipe tool box, as shown.
✍ This feature is useful for adding customized attributes that exist in P&ID.
Placing components from the PlantSpace P&ID application into Design Series is
controlled by the PID_COMPONENT and PID_MAP tables in the project
database.
PID_COMPONENT Table
The PID_COMPONENT table maps the PlantSpace P&ID cell name to the
Design Series Component Placement command. This command is issued so that the
Prompt dialog box is displayed for the selected component. This table has two
columns, OBJNAME and COMMAND. They are used to map the P&ID
component to the component type of the Design Series component and to map the

command to be issued. The PID_COMPONENT table is in the pidcomp.dat file in

your ...\{ProjectName}\dbload\data\pipe directory.
PID_MAP Table
The PID_MAP table enables you to map PlantSpace P&ID tags to Design Series
pipe attributes. While building the Prompt dialog box, the program searches for
each Design Series attribute in the PID_MAP table:
• If the entry is found in the PID_MAP table in the

DESIGN_SERIES column, the program uses the corresponding
PID column entry to extract the property value from the P&ID tag.
• If a lookup table is specified in the MAP_TABLE column, the
program uses this table and maps the property value from the
P&ID tag as CODE_PID and extracts a value in the column
CODE. This value (CODE in case MAP_TABLE is specified) or
property value from the P&ID tag (if MAP_TABLE is not
specified) is used as a value for the Prompt dialog box.

The default PID_MAP table delivered with Design Series matches the delivered
P&ID configuration and will need to be modified to meet your project’s
requirements. The pidattr.dat file creates the PID_MAP table. Pidattr.dat is in your
...\{ProjectName}\dbload\data\pipe directory.

The columns of the table are described as follows:

PID This column can be any Jspace expression. This
expression can be as simple as the tag name of the P&ID
component "SERVICE" or JSpace expression like
"SUBSTRING(TAG, 0, 1)"
DESIGN_SERIES Design Series attribute name. Any attribute from the
pipe label. This column must contain the desired pipe
attribute. For example, “SYSTEM” maps to SERVICE
in the PID column.
Note: Only pipe attributes should be defined in this
column.
MAP_TABLE A description table that maps P&ID component names
to Design Series component names. For example,
Design Series and P&ID both identify valve operators
with different names. Therefore, we would list the
OP_TYPE_DESC table in the MAP_TABLE column.
For example, for a handwheel operator, this would
equate the P&ID value “Hand” to the Design Series
value “Hand_WHL.”
✍ If you need to customize the attributes of P&ID (assuming they are not
mapped yet), use the following procedure.
➤ To customize the attributes of P&ID

1. Open the Pidattr.dat file (which contains the PID_MAP table) in
your ...\{ProjectName}\dbload\data\pipe directory.
2. In the PID_MAP table, add the P&ID attribute name in the column
PID.
3. Add the corresponding Design Series attribute name in the column
DESIGN_SERIES.
4. If the P&ID tag value (attribute value in Design Series) has a many-
to-one relationship with the Design Series attribute (for example, if
for more than one value of the attribute only one value is available
in Design Series), create a new table that has at least two fields
named CODE and CODE_PID.
5. Type CODE_PID (tag values) and CODE (Design Series attribute
value) in this new table.

6. Add the name of this new table in the MAP_TABLE column for
that attribute.
Stages in Editing the PID_MAP Table
The process for adding or modifying data to the PID_MAP table consists of the
following stages.
1. Creating and editing a user-defined Pidattr.dat file (for example,

named Pidattr_user.dat)
2. Updating the edited Pidattr_user.dat file by using the Database
Setup tool
3. Testing your changes
W You must not change the PID_MAP table directly in the database.
➤ To create and edit a user-defined Pidattr.dat file

1. To create a user-defined Pidattr_user.dat file, copy the Pidattr.dat
file and add _user to the file name.
✍ It is recommended that all user-defined files be stored in a
separate directory under the project (for example by creating a
user directory in \data as in your
…\{ProjectName}\dbload\data\user\pipe).
2. To edit an existing mapped attribute row, make the changes to the
appropriate columns.
3. To add a new attribute row, create that attribute row in the user-
defined Pidattr_user.dat file.
For example, add the INSUL tag from P&ID and map it to the pipe
attribute INSULAT as follows:
DATA_BLOCK_BEGIN
/* New label attributes */
'INSUL', 'INSULAT',
DATA_BLOCK_END

✍ The INSUL tag is not delivered in the default P&ID program

and, therefore, would have to be added to P&ID to test this
example.
➤ To update the edited Pidattr_user.dat file

After all data defining the P&ID mapping has been added to the text file, you must
update the file by loading it into the project database for the changes to occur in the
modeling environment.
(MCS) Guide.
1. In the PlantSpace Database Setup window, click the Data File

button.
2. Select the Pidattr_user.dat file that you edited and click Open.
• If you made any syntax errors in the file, an error message is displayed.
• If an error message is not displayed, the PID_MAP table in the project
database is updated.
3. Click OK in the message dialog box.
➤ To test your changes

1. Open a piping design file in Design Series.
2. In the Pipe tool box, drag the seventh tool in the first column to
display the P&ID tool box.
3. To attach a P&ID to your piping design file, click the Attach PID
tool.
4. In the Select P&ID File dialog box displayed, select the P&ID and
click OK.
The P&ID should be displayed in a view.
5. Click the Select from P&ID tool.
6. Identify a component in the P&ID and confirm that the piping
attribute values displayed agree with the changes that you made.

Accessing Data from Third-Party Applications

The Access External Data utility enable users to access data from third-party
applications. The new utility is displayed to users by choosing Design
Series>Utilities>Access External Data from the MicroStation menu bar.
The delivered software is configured to access data in the form of a sample graphic
through the Windows Paint program. You can configure the software to access data
in a different application such as Microsoft Access or Excel. The
EXE_REPORT_CRITERIA table, EXE_REPORT_TYPES table, and
EXE_REPORT_ARGS table are used to control the functionality of this command.
These tables define the commands to be issued to the operating system, the
components that can be selected for each command, and the arguments defined for
each command.

EXE_REPORT_CRITERIA Table
The EXE_REPORT_CRITERIA table is defined in the Report_Criteria.dat file in

the {network drive}\Projects85\dbload\data\pipe directory.

EXE_TYPE Text string to be displayed in the Access External Data
dialog box
ORDER_BY Defines the order of items within each EXE_TYPE
BUD_TYPE Defines the type or types of components that can be
processed. An asterisk (*) can be used to specify all
BUD_TYPES.


CRITERIA JSpace expression evaluated against each selected
component. If the result is TRUE, the component will be
processed.
REPORT_ID Name of the report (used to relate to the
EXE_REPORT_TYPES table)
When the Access External Data utility is run, a list of applications that can be run is
displayed to the user. This list actually contains the values from the EXE_TYPE
column in the EXE_REPORT_CRITERIA table. When the user selects the
application, the user is prompted to select a component. If the selected component
meets the criteria defined in the BUD_TYPE and CRITERIA columns, the value
for REPORT_ID is retrieved. The REPORT_ID value is then used to obtain
information from the EXE_REPORT_TYPES table.

EXE_REPORT_TYPES Table
The EXE_REPORT_TYPES table defines the command string used to start the
external application. This table is defined in the Report_Types.dat file in the {network
drive}\Projects85\dbload\data\pipe directory.

REPORT_ID Name of the report
EXE_NAME Command used to execute the desired program
ARG_LIST Name used to define the argument list items (used
to relate to the EXE_REPORT_ARGS table)
DATA_SOURCE_NAME Optional ODBC data source name

Arguments are appended to the command string based on values queried from the
EXE_REPORT_ARGS table.
EXE_REPORT_ARGS Table
The EXE_REPORT_ARGS table is defined in the Report_Arguments.dat file in

the {network drive}\Projects85\dbload\data\pipe directory.


ARG_LIST Argument list name
ORDER_BY Defines the order of the arguments
DESCRIPTION Description of the argument
EXPRESSION JSpace expression to evaluate. The result of the
expression is passed as the argument value.
➤ To set up access to data in third-party applications
✍ To make this procedure more meaningful, the following example explains how
to set up access to data in Microsoft Excel.
1. Open the Report_Criteria.dat file in the {network drive}\Projects85

\dbload\data\pipe directory to edit the
EXE_REPORT_CRITERIA table.
2. Between the lines, DATA_BLOCK_BEGIN and
DATA_BLOCK_END, add the following new row of data:
"View Spreadsheet Data", 1, "*", "TRUE", "EXCEL"
4. Load the file into the project database by using the Database Setup
tool.
5. Open the Report_Types.dat file in the same directory to edit the
EXE_REPORT_TYPES table.
"EXCEL", "C:\Program Files\Microsoft Office\Office
\Excel.exe", "EXCEL_ARGS", "#"
7. Repeat steps 3 and 4.
8. Open the Report_Arguments.dat file in the same directory to edit
the EXE_REPORT_ARGS table.

"EXCEL_ARGS", 1, "File Name", GETENV('PS_USER') +

'dgn\po.xls'
✍ Po.xls is a delivered sample file. However, you can use any Excel
file.
10. Repeat steps 3 and 4, and then test the access.
Displaying the Component Type Name in the Attributes Dialog

Box
The title bar of the attributes dialog box displays the common name for a
component. This is the default setting of the software. However, you can configure
the CLASSES table to display the component type name in the title bar, if your
prefer.
Common Name Component Type Name
➤ To display the component type name

1. Access your ...\{ProjectName}\dbload\data\pipe directory.
2. Open pip_cls.dat in a text editor.
3. For the component type that you want, delete its common name
contained within double quotation marks.
For example, "Field Weld" would become "" (with nothing
between the double quotation marks after the deletion).
5. Start the Database Setup tool if it is not already open.

Customizing the Value Column in the Attributes Dialog Box
✍ If you are starting the Database Setup tool, see the procedure "To
start the Database Setup Tool," steps 2 through 5, in Chapter 2 of the
Model Control System (MCS) Guide.
6. Click the Data File button.
7. In the Select Data File dialog box, select the pip_cls.dat file.
If no errors are found, a message is displayed indicating successful
completion.
8. Place a component and verify that the component type name is
displayed.
Customizing the Value Column in the Attributes Dialog Box

You can edit the Description tables to customize the display of codes and
descriptions (such as abbreviations compared to full names) in the Value column of
the attributes dialog box. You can also update the SI or imperial values displayed in
this column when you click the Display Nominal As button.
✍ To recall the various ways to customize the Value column, see “Description
Tables” on page 2-15 in the chapter "Design Series Modeling Tables" in the
➤ To customize codes and descriptions in the Value column

1. Access the Glossary.dat file in your ...\{ProjectName}\dbload\data
directory.
2. Make the necessary changes to codes and descriptions, or add new
codes and descriptions.
tool.
➤ To customize the imperial or SI (metric) values in the Value column

1. Access the Psnomdsc.txt file in the
...\Bentley\Program\DesignSeries\default directory.
This file controls the dimensional values displayed in the Value
column and tells the system where to find the appropriate table in
the project database containing the values.
2. Make the necessary changes, and save and close the file.

Displaying PlantSpace Component Information Using the

TriForma Element Information Tool
If your company has one or more disciplines such as any of the TriForma
applications (Architecture, Structural, and HVAC) using multiple projects and your
users want to access PlantSpace component information, they can do so. By
selecting the TriForma Element Information tool and selecting a PlantSpace
component in a design file, a tab called PlantSpace Data should be present so that
the component information can be displayed. Users can read this information
without having to be in an active Design Series session.
To use an example, if your company has one or more disciplines such as any of the
TriForma applications (Architecture, Structural, and HVAC) using multiple projects
and your users want to access PlantSpace component information from multiple
reference files, they can do so. By selecting the TriForma Element Information tool
and selecting a PlantSpace component in a design file, a tab called PlantSpace Data
should be present so that the component information can be displayed. Users can
read this information without having to be in an active Design Series session.
The descriptive attribute names (such as Insulation Thickness) require information

that is stored in the ATTRDEFN table in the database. Therefore, PS_CODES_DB
must be set so that a database connection can be made. The component's attribute
information is stored in the component's label, and the rimref.dat file is needed to
parse the component's label.
✍ If users are not connected to a PlantSpace database, they can still access
component information as long as the rimref.dat file is available. However,

Displaying PlantSpace Component Information Using the TriForma Element Information
without the database, the display of the descriptive information will not be
available, as shown in the following example.
If the PlantSpace Data Tab Is Not Displayed
If the PlantSpace Data tab is not displayed, it means that your project database may
need to be configured. To display the PlantSpace component information, TriForma
requires:
• The PS_CODES_DB configuration variable to specify the

database's ODBC data source name, user ID, and password
• The ATTRDEFN table in your project database
• The configuration of TriForma so that the system can find the
rimref.data file by defining PS_PROJ to point to the directory
containing the rimref.dat file.
➤ To configure the TriForma Element Information Tool to display

PlantSpace component information
✍ You can enhance the data display to use full (descriptive) attribute names and
values instead of abbreviations.
1. Open your project configuration (PCF) file and set PS_PROJ so

that it points to the directory containing rimref.dat.
2. Open projvars.cfg and define PS_CODES_DB so that it
contains an ODBC data source name, user ID, and password
(separated by semicolons).

✍ If you are not using PlantSpace, and your configuration does not
include a projvars.cfg file, define PS_CODES_DB in
MicroStation using Workspace > Configuration on the Design
Series menu bar.
3. To display full names in the Values column instead of abbreviations
(for example, "Long" instead of "L"), access the glossary.dat file
in your ...\{ProjectName}\dbload\data directory.
4. Make the necessary changes to codes and descriptions, or add new
codes and descriptions.
tool.
Creating a Label Position File (Rimref.dat File)

The Database Setup tool creates a label position file or updates an existing one. This
is an ASCII file called by convention the RimRef.Dat file and is delivered with the
software.
W You should also save a copy of the RimRef.dat file in case label changes
are made in future releases.
➤ To create a label position file
(MCS) Guide.

Executing Your Own SQL Commands
1. In the PlantSpace Database Setup window, click the Create Label

Position File button.
The Select Label Position File dialog box is displayed.
2. In your ...\{ProjectName} directory, select the rimref.dat file or

type the name of the new file with a DAT extension.
3. Click Save.
If a previous rimref.dat file exists, a message is displayed.
4. To replace the rimref.dat file, click Yes.

5. Click OK in the message displayed that the rimref.dat file was
successfully created.
Executing Your Own SQL Commands

In the PlantSpace Database Setup window when you click the Load Database
button, the SQL commands that come with the Design Series software are
automatically executed to build the database. However, if you want a particular set of
operations to take place based on the way you do business, you may find it efficient
to create your own file containing SQL commands.

For example, if you have legacy data that needs to be modified for use in your
project database, you can have a SQL command file copy the data in the correct
format for the tables.
If you know how to create SQL command files, you can place your files in the
appropriate data source subdirectory (Access, Oracle, or SQL Server) in your
...\{ProjectName}\dbload directory. The Database Setup Tool can then access the
files to execute the SQL commands against the database.
➤ To execute your own SQL commands
(MCS) Guide.
1. In the PlantSpace Database Setup window, click the SQL File

button in the Run group.
2. In the Execute SQL Commands File dialog box, access the
appropriate data source subdirectory in your ...\{ProjectName}
\dbload directory, as shown.
3. Select your SQL command file with an SQL extension.

You can select multiple SQL command files at one time, and each
file is loaded in turn.
4. Click Open.

Executing Your Own Script Commands
A message is displayed indicating that the file or files were

successfully executed.
5. Click OK.
Executing Your Own Script Commands

In the PlantSpace Database Setup window when you click the Load Database
button, the script commands that come with the Design Series software are
automatically executed to build the database. However, if you want operations on a
large scale to take place in a particular order based on the way you do business, you
may find it efficient to create your own file containing script commands. For
example, you can include SQL command files that control the database setup in
general.
If you know how to create script command files, you can place your files in the
appropriate data source subdirectory (Access, Oracle, or SQL Server) in your
...\{ProjectName}\dbload directory. The Database Setup tool can then access the
files to execute the script commands against the database.
➤ To execute your own script command
(MCS) Guide.

1. In the PlantSpace Database Setup window, click the Script File

button in the Run group.
2. In the Execute Script Commands dialog box, access the appropriate
data source subdirectory in your ...\{ProjectName}\dbload directory,
as shown.
3. Select your script command file with an SCR extension.

You can select multiple script command files at one time, and each
file is loaded in turn.
4. Click Open.

Creating Multiple Project Schemas in One Database Instance
Messages are displayed indicating that the file was successfully

executed.
5. Click OK to continue, or click the Save As button and save the

messages.
The PlantSpace Database Setup dialog box is displayed.
6. Click OK again.
Creating Multiple Project Schemas in One Database Instance

Design Series provides the capability to load multiple projects into one database
instance, thereby making the maintenance of the projects easier and more efficient.
W Important points to note:
• Each project must use a different project user name.

• For Oracle, the supplied scripts create the users for the database.
However, for SQL Server, you need to manually create the users, as
explained in Chapter 1 of the Model Control System (MCS) Guide on
the TriForma Help menu or in the ...\Bentley\Documentation
directory.
• For Oracle, if a project already exists from an earlier version, then it
should be cleaned up by reloading the project.
➤ To create multiple project schemas in one database instance
(MCS) Guide.
W In the PlantSpace Database Setup window, make sure that the

information displayed in the fields is correct.
1. In the Database Load/Replace group, click the Load Database

button.
2. When the process is finished, close the PlantSpace Database Setup
window.
3. For a different project repeat step 1.

3 Configuring Your Project Using
Bentley Project Administrator
✍ This enhancement for V8 XM Edition is an alternative to “Configuring Your
Project the Traditional Way” on page 2-1.
Understanding Bentley Project Administrator

For release V8 XM, you can configure your project to use Bentley Project
Administrator instead of the delivered PlantSpace/MCS databases. This
enhancement makes it possible to read database and project information using
shared project tools.
Integrating PlantSpace Design Series with the project databases makes the product
easier to administer and adds value to the project data produced using PlantSpace
Design Series as follows:
• Simplified project administration

In the traditional way explained in the previous chapter, you, as the
administrator, must manually create a new ODBC data source for
each project on each workstation. Consider an example where 100
workstations are able to work on 10 projects. This would involve
manually configuring 1000 ODBC data sources. Bentley Project
Administrator eliminates that labor.
• Simplified project creation by using Bentley Project Administrator
Enable the integration of PlantSpace Design Series 3D data with the
functional design data already resident in the project database for
related plant applications (for example, PlantSpace P&ID and
AutoPLANT P&ID).
• Project views to post MCS components as ProjectWise components
• Project ISOGEN styles to create, edit, and use with Bentley Project
Administrator
W Design Series does not support using an Oracle database with Bentley
Project Administrator.

3 Configuring Your Project Using Bentley Project Administrator
Understanding Bentley Project Administrator
✍ This enhancement will become the standard for configuring projects in all
future releases.
Prerequisites
W Bentley Plant Core Framework (FW) must be installed before installing

PlantSpace Design Series.
Core Framework should be installed on each of the project workstations.
Next, PlantSpace Design Series should be installed and fully functional using either
the delivered sample project or a project created with the 2004 Edition or earlier
project creation methods.
Setup Performed During Installation

The PlantSpace Design Series installation performs two tasks:
• Adds the following registry keys, which are needed to enable the
PlantSpace features of Project Administrator:
[HKEY_LOCAL_MACHINE\SOFTWARE\]

Configuring Your Project Using Bentley Project Administrator
Setup Performed During Installation
"sPSDS_PCF"="True"
"showPSDS_PCF_UI"="True"
Creating a new project with Project Administrator will copy the

%network_root%\base\project\template.pcf and set these values
in the copied PCF file:
PS_PROJ
PS_UNIT
DBSETUP_DB_VENDOR
PROJECT_ROOT
PROJECT_ID
✍ 1. PROJECT_ROOT and PROJECT_ID are used instead of
PS_CODES_DB.
2. References to "PS_CODES_DB" in JSpace class libraries will

be mapped by the software to use the database referred to by
PROJECT_ROOT and PROJECT_ID. For example:
DB_QUERY("PS_CODES_DB", "SELECT DESCRIPTION
FROM PIPE_SYMB WHERE SYS_NAME = " + "'" +
.SYSTEM + "'" )
• Sets up the PlantSpace Design Series base project
The Design Series installation creates a new optional "Base project"
which will contain all the files that PlantSpace Design Series
applications need. These were formerly installed using the "Project"
option in the PlantSpace install set. These should be created as an
optional base project to the Plant XM directory structure.
This functionally replaces the version 8.5 "Project" option in the
installer used to create a project. Once the PlantSpace Design Series
"Base project" option is set up, Bentley Project Administrator
presents a new optional base project to the user when creating a
new project in the list of Project templates.

Creating a Design Series Project

So that you as the administrator understand the scope of this task, this process is
broken down into the following stages.
Stage 1. Create a new project using Bentley Project Administrator

You will use the Bentley Project Administrator application to create projects exactly
like the procedure involved to create AutoPLANT projects, followed by most of the
same steps for setting up a Design Series project in earlier versions. Consult the
Bentley Project Administrator online help for more instruction on the operation of
this application and the creation of projects.
W Because the project database and PlantSpace Design Series both require
a table named "classes", you must rename the Classes table already in the
base project before proceeding to populate the project with PlantSpace
data.
W After the project is created, you should review the settings in the PCF
file.
✍ The top-level folder in the Design Series project tree is now located at
...\Standards\psds from the top-level folder of the project tree.

Stage 2. Edit the PlantSpace files
Stage 2. Edit the PlantSpace files

Edit the following files as required by your project environment:
• *.dat
• *.scr
• *.sql
• *.lib
• *.rul
This is similar to setting up the project in previous versions.
Stage 3: Integrate PlantSpace Design Series

The project can be setup to use either the Isogen Styles delivered with Bentley
Project Administrator or those delivered with PSDS in the same location within the
project tree as with 2004 Edition. The former require adding a MicroStation .dgn
backing sheet to each style or generating the drawing in .dwg format. The latter
cannot be managed with BPA nor shared with Plant Design Works.
To select the Isogen Styles delivered with BPA, edit the project configuration file for
the project and search for PS_ISO_PROJ. Add or un-comment these lines:
_PS_TEST4= ${parentdevdir {PS_PROJ}}
_PS_TEST5=${parentdevdir {_PS_TEST4}}
PS_ISO_ROOT = $(_PS_TEST5)/Config/
PS_ISO_PROJ = isogen
And delete or comment-out these lines:
PS_ISO_ROOT = $(PS_PROJ)
PS_ISO_PROJ = Pisogen
Integrate PlantSpace Design Series with the schematic data in the project. The
dataset that was installed as an optional base is set up to map certain fields to the
values entered in the P&ID database, unless you are using MS-Access for the
project database, in which case this integration is not available. In this way, the list of
line numbers will be a drop-down list rather than a free text field. Similarly the
nominal diameter is limited to those used in the schematic with that line number.
Equipment ID information is limited to a list of the equipment tags from the
schematic. This will help your users ensure consistency with schematic (PID)
information. If you do not wish to use this integration for you Oracle or MS-SQL/

Server, comment out the PIW "product" file in the *.pcf file. This picture shows this
commented out, so that the data is not integrated.
Stage4. Runthe DatabaseSetup utilityto prepare theprojectfor usewith

PlantSpace Design Series
PlantSpace Design Series uses the Database Setup utility to read the source files
(now stored in the shared and project "Standards" path) to populate the PlantSpace
Design Series project database.
At startup, this program typically prompts the user to select the MicroStation PCF
file. For versions prior to XM Edition, this program read the name of the ODBC
data source from the configuration files and used this source to connect with the
database. For the XM Edition, the Database Setup utility is enhanced to first look
for a reference to a Bentley Plant Project in the PCF file. If this reference is present,
then the Database Setup will connect to the project database. No further ODBC
configuration is required.
Installing PlantSpace Design Series will add a new "Tools" option to the Bentley
Project Administrator (registry entry) to allow it to start the Project Group Selector
utility, Database Setup utility, and Specification Maker utility.
First select your project in the project root folder. Then you must run the Project
Group Selector and select the project root folder. The Database Setup utility will
already be connected to the current project when Bentley Project Administrator
starts it.
Database Setup utility will use the new project database as the output destination for
all of the actions selected. Refer to the PlantSpace Design Series Administrator Guide on
the Design Series Help menu for information about using the Database Setup utility
and setting up a PlantSpace Design Series project database. Also see the related
Model Control System (MCS) Guide on the same menu.
✍ You can also run Specification Maker from the Windows Start > Programs >
Bentley > PlantSpace Design Series V8 XM Edition menu to populate the
specification tables used by Design Series.

Maintaining Your Project Database

Maintaining your project database involves the following tasks:
• “Editing Your Project Using Bentley Project Administrator” on page 3-7

• “Configuring Database Schema” on page 3-7
• “Setting Up Piping Specifications” on page 3-7
• “Setting up ISOGEN Styles” on page 3-8
• “Locating Your PCF Files and Root Folder” on page 3-8
Editing Your Project Using Bentley Project Administrator

Currently the maintenance and administration of PlantSpace Design Series remains
relatively unchanged since the 2004 Edition release.
W Changes required to the database, rule files, and so on should be made

to the appropriate project data files.
These files are now located in the standards subdirectory of the project that you
created. Once you have completed your changes to the data files you can either:
• Start Database Setup from the Windows Start > Programs >
Bentley > PlantSpace Design Series V8 XM > Administrator Tools
menu (navigating to the PCF file)
• Select the project in the project tree (using Bentley Project
Administrator) and run the Database Setup utility using the Tools
menu.
Configuring Database Schema

Once a project is created using Bentley Project Administrator, the structure of the
project database can be further configured using the database node of the project
tree. For details, see the documentation for Bentley Project Administrator.
Setting Up Piping Specifications

PlantSpace Design Series Spec Maker can be loaded from Bentley Project
Administrator. This setup is exactly like a V8.1 project with the exception that the
specs are output to the same project database.
✍ Sample s71 files were copied to the ...\Standards\psds\SpecMakr subdirectory

to be used to seed your new pipe specs.

Setting up ISOGEN Styles

The projects created and maintained using Bentley Project Administrator already
have a list of ISOGEN styles that will be used by PlantSpace Design Series.
The PlantSpace Design Series ISOGEN interface will use the PCF file to locate the
ISOGEN styles associated with the project.
Styles can be created, configured or deleted using the ISOGEN node of you project
in the Bentley Project Administrator tree.
The PlantSpace Design Series ISOGEN interface will display this list of ISOGEN
styles as the available options to output isometrics.
Locating Your PCF Files and Root Folder

The dslocal.cfg file is copied to each workstation during the installation of
PlantSpace Design Series. Among the many configuration variables set when this
file is loaded, the location of the project configuration files (PCF) is specified by the
setting "_USTN_PROJECT=<project path>".
The Design Series installation sets this value to the sample projects folder under
MicroStation's WorkSpace folder.
W This value must be changed to have the location of the project root
folder so that MicroStation and the Design Series applications can find
your project.

Locating Your PCF Files and Root Folder
You should use the Project Group Selector utility to browse to this file and update
the _USTN_PROJECT setting, but you can also edit the file with an editing tool
such as Notepad.
Currently, Bentley Project Administrator allows multiple project roots to be

displayed in the same session. This is useful while configuring and managing several
projects, but many of the project applications will assume the user intends to use the
active project root as specified by the APPROJDB configuration variable in the
at.ini to find the active root. In a similar way MicroStation applications find the
active location of projects (PCF files) using the value of the _USTN_PROJECT
configuration variable.


4 Configuring Bolts
This chapter explains the concept of bolts and how to configure
them for use in output applications such as Object Reporter and
AutoISOGEN.
Understanding Bolts and the Bolts Engine

Bolts are implied components, and though they do not physically exist in the model,
they are generated when certain piping components (for example, flanges) are
present in the PlantSpace model. The bolts are generated by the bolts engine when
they are needed by output applications that use the JSpace model (JSM), namely,
Object Reporter and AutoISOGEN.
The bolts engine operates on the JSpace Model (JSM) and identifies the bolt
assemblies, which are sets of piping components that are to be bolted together. The
engine then looks up bolt related tables, and through subsequent JSpace evaluations,
determines the bolts required by the assembly.
Details by Topic
This chapter contains the following topics:
• V8 XM enhancements in the bolts engine

• Overview of the bolt generation process
• Overview on customizing the bolts engine
• Modifying the bolt catalog data including a description of the bolt
database tables and the process to modify them
• Configuration variables used by the bolts engine
• Bolts troubleshooting procedures to diagnose and identify problems
with bolt generation.

4 Configuring Bolts
V8 XM Enhancements in the Bolts Engine
V8 XM Enhancements in the Bolts Engine

Bolt generation in V8 XM is entirely handled through the relationships, properties,
and inference rules in the bolts class library, and therefore, you can customize every
aspect. Specifically:
• The BOLT_ASSEMBLY class contains the logic for evaluating the

bolts (properties) for the components that are bolted together. The
evaluation involves comparing bolt properties suggested by end
components.
• The BOLT_COMPONENT class contains the customizations for
looking up bolts (properties) for the end components.
• The BOLT_ORDER class contains the customizations for
aggregating bolt information of bolt assemblies.
In V8 XM, almost all the bolt related customizations are in $PS_PROJ/etc/bolt.lib.

This library includes the classes mentioned above.
✍ The customizations in the BOLT_BASE_USER class in ams_user.lib have

been moved to the BOLT_COMPONENT class in V8 XM.
JSpace expressions are normally used by output applications to filter piping

components. It is usually necessary that the bolts that belong to these components
also pass through these filters. For this to happen, the bolt assembly objects should
contain the component properties (and appropriate values) that are used in the
JSpace filter. In V8 XM, no additional customizations are needed to do this. The
bolts engine locates the trigger component for the bolt assembly and appends all the
properties of the trigger to the BOLT_ASSEMBLY object. This action occurs only
for properties that are not already defined in the BOLT_ASSEMBLY object.
This release includes the capability to control separate output for bolt length and
bolt diameter through two new configuration variables,
PS_BOLTS_LENGTH_UNITS and PS_BOLTS_DIAMETER_UNITS.
Also provided are better error diagnostics with step-by-step error evaluations. The
ERROR_MESSAGE property in the BOLT_COMPONENT and
BOLT_ASSEMBLY objects contains detailed error messages.
Bolt Generation Process

The inputs to the bolt generation process are JSpace models (JSMs) of piping lines.
The output is a set of temporary BOLT_ASSEMBLY objects that get appended to
the JSM. Each BOLT_ASSEMBLY object represents a physical bolt assembly and
contains all the required bolt properties. These objects can then be read by output

Configuring Bolts
Stage 1: Trigger Bolt Creation
applications such as AutoISOGEN and Object Reporter to report and display the
bolts, display bolt generation errors, and so on.
Bolt generation involves the following stages:
1. Trigger bolt generation.

2. Identify component groups that make up the bolt assemblies.
3. Retrieve bolt information for the end components.
4. Determine bolt properties for the assembly.
5. Group and order bolt assemblies to get aggregate information on
the bolts that are generated.
6. Report the results of bolt generation.
These stages are further detailed in following sections.
Stage 1: Trigger Bolt Creation

Bolt creation is triggered by all Design Series components in the input JSM that
have the CREATES_BOLTS configuration variable set to TRUE. Depending on
the type of the component, each trigger could generate one or more bolt assemblies.
✍ The bolt engine ensures that no component is part of more than one bolt
assembly.
The following diagrams show examples of bolt assemblies.

4 Configuring Bolts
Stage 2: Identify Component Groups That Make Up the Bolt Assemblies

Starting with each component that triggers bolt creation, the bolt engine identifies
and groups components that make up bolt assemblies. The grouping is done
differently depending on whether the trigger component is inline or non-inline.
Inline Trigger Component
The trigger component is considered inline if the component has both conditions:
• The INLINE property set to TRUE

• Only two snap points, as in gaskets
If the trigger component is inline, the bolts engine collects connected components
at both ends of the trigger, and forms a single group of connected components. The
collection stops at non-inline components at either end, or if no more adjacent
components exist.
Non-Inline Trigger Component
The trigger component is considered non-inline if both conditions are not present.
✍ A component with only two snap points is non-inline if its INLINE property
is set to FALSE.
If the trigger component is non-inline, the bolts engine collects connected

components at each end of the trigger, and forms a separate group of connected
components for each end. The ends are identified by the snap points, and the first
snap point (snap point zero) is skipped for flanges and components with more than
two snap points. As in the inline case, the collection stops at non-inline components,
or if no more adjacent components exist.

Configuring Bolts
Stage 3: Retrieve Bolt Information for the End Components
The following diagrams show two cases where the wafer-check valve is set with
different INLINE values. In the first case, INLINE is set to TRUE and the result is
a single group of connected components. In the second case, INLINE is set to
FALSE and the result is two separate sets of connected components at each end.
Stage 3: Retrieve Bolt Information for the End Components

The bolt engine identifies end components and retrieves bolt information for these
items. This is done by instancing the BOLT_COMPONENT class in bolts.lib. The
resulting BOLT_COMPONENT objects contain all the bolt-related information.
The properties and inference rules in the BOLT_COMPONENT class retrieve bolt
information by database lookups of bolt-related tables. The bolt information would
include:
Property Description
DIAMETER Bolt diameter
LENGTH Bolt length
MATERIAL Bolt material
PIECES Number of bolts
TYPE Type of Bolts

4 Configuring Bolts
BOLTED_SNAP_INDEX The index of the snap point on the
component where the bolts are attached
BOLTED_PROPERTY_INDEX The index of the Design Series component
property at the point on the component
where the bolts are attached.
Ex: If BOLTED_PROPERTY_INDEX=2, this
value indicates that the bolted end of the
component has a nominal size of SIZE_2 and an
end prep of ENDPREP2.
✍ Other properties, such as BOLT_CODE and BOLT_STNDRD, are also

determined, but they are omitted here for clarity sake. See the class definition
for BOLT_COMPONENT if necessary.
Stage 4: Determine Bolt Properties for the Assembly

The bolts engine determines the bolt properties for the assembly by comparing the
bolt properties suggested by the end components. This is done by instancing the
BOLT_ASSEMBLY class in bolts.lib. A similar set of properties is determined as in
Stage 3, but in Stage 4 the set is for the entire bolt assembly. The bolt information
includes:
BOLT_DIAMETER Bolt diameter
BOLT_LENGTH Bolt length
BOLT_MATERIAL Bolt material
BOLT_PIECES Number of bolts
BOLT_TYPE Type of Bolts
✍ If the trigger component (in Stage 1) is inline, a single BOLT_ASSEMBLY

object is then created for the entire group of components. If the trigger is non-
inline different BOLT_ASSEMBLY objects are created for each group of
components at the ends.
Stage 5: Group and Order Bolt Assemblies

The bolts engine groups and orders the bolt assemblies to get aggregate information
on the bolts that have been generated. The BOLT_ASSEMBLY objects from Stage
4 are grouped by a set of criteria, by default, a combination of bolt diameter, length,

Configuring Bolts
Stage 6: Report Results of Bolt Generation
type, and material. A BOLT_ORDER object is created for each grouping, and the
object contains aggregate information on the bolt assemblies.
For example, the BOLT_ORDER object will contain a property that will keep count
of the total number of bolt pieces in its group of bolt assemblies.
Stage 6: Report Results of Bolt Generation

The BOLT_ASSEMBLY and BOLT_ORDER objects generated have all the
information on the bolts, bolt order, and also any errors during bolt generation.
Output applications, such as AutoISOGEN and Object Reporter, read the objects
created and report the results according to their requirements.
Customizing the Bolts Engine

To customize the bolts engine, you must first understand the objects and
relationships set up by the bolts engine during bolt generation. A description of the
available customization options and constraints follows. Finally, a few sample
customization procedures are provided.
Objects and Relationships Set Up by the Bolts Engine

The bolts.lib and ams_user.lib class libraries in the $PS_PROJ/etc directory contain
the customizations that control every stage of the bolt generation process. The JSM
generated through the MicroStation Connection dialog box serves as the input to
the bolts engine, and can be customized through the ams_user.lib class library. The
Bolts Engine then adds BOLT_ASSEMBLY, BOLT_COMPONENT and
BOLT_ORDER objects to the JSM. The customizations for these object classes are
in bolts.lib. These objects are finally parsed by downstream applications to extract
the bolt information.

4 Configuring Bolts
The following diagram shows the objects and relationships generated by the bolts
engine.
Generation Process
1. A BOLT_COMPONENT class is instanced for each end

component of the bolt assembly.
2. The BOLT_ASSEMBLY class is then instanced for the entire
assembly.
3. Finally, the BOLT_ORDER class is instanced for every group of
BOLT_ASSEMBLY objects with the same ORDER_ID property
value. Thus the BOLT_COMPONENT, BOLT_ASSEMBLY and
BOLT_ORDER classes can be customized to modify various
aspects of bolt generation.
✍ For each of these classes, the following sections summarize the input
properties and relationships available for customization, and the output that is
expected by output applications.

Configuring Bolts
Customization Options and Constraints

This section describes the customization options available (input) and the
constraints (output expected by applications) for the various bolt customization
classes.
✍ For a more detailed explanation of these customizations, see the bolts.txt file in
the $PS_PROJ/etc directory.
BOLT_ASSEMBLY Class
The BOLT_ASSEMBLY class is customized to determine bolt properties based on

the bolt information suggested by the end components in the assembly. The bolts
engine sets up the required input to the BOLT_ASSEMBLY class before instancing
it. The resulting objects contain information on the bolts required for the assembly,
and are read by output applications such as Object Reporter and AutoISOGEN.
Input (Set Up by Bolts Engine before Instancing)
Relationship END1, END2 // Point to BOLT_COMPONENT

objects that contain bolt properties suggested by end
components.
Relationship IS_ASSEMBLY_FOR // Points to the Design Series
component object that triggered bolt generation.
Relationship JOINS // Points to all Design Series
component objects that are joined by this bolt assembly.
Input Property .LENGTH_WAFER // Sum of all lengths of
inline components between the bolted ends.
Output (Read by Bolts Engine, AutoISOGEN, and Object Reporter)
✍ Some, not all, properties are listed here.
Double BOLT_DIAMETER
Double BOLT_LENGTH
String BOLT_MATERIAL
Long BOLT_PIECES // Number of bolt pieces
String BOLT_TYPE

4 Configuring Bolts
String ORDER_ID // Establishes if two

BOLT_ASSEMBLY objects are to be grouped together into a
BOLT_ORDER object
Boolean ERROR // Set to TRUE if there is an
error that’s to be reported.
String [] ERROR_MESSAGE // Error message to be
reported to user.
✍ LENGTH_WAFER that is passed in by the bolts DLL is the total thickness of

all inline components between the bolted ends. The thickness comes from the
property BOLT_THICK if it exists, or from the distances between the connect
points of the inline components.
BOLT_COMPONENT Class
The BOLT_COMPONENT class is customized to determine bolt properties for

end components in a bolt assembly. The bolts engine sets up the required input to
the BOLT_COMPONENT class before instancing it. The resulting objects contain
information on the bolts suggested by the end components. The output properties
are used only for BOLT_ASSEMBLY instancing.
Relationship ITEM // Points to the piping

component that the BOLT_COMPONENT represents.
Input Property .BOLTED_SNAP_INDEX // Index of the snap
points on the Design Series component where the bolts are
attached.
Input Property .BOLTED_PROPERTY_INDEX // Property index
corresponding to the snap point to which this bolt assembly
is attached. (for example 2 would indicate SIZE_2, SCH_RAT2
need to be used.)
Output (Read during BOLT_ASSEMBLY Class Instancing)
✍ Some, not all, properties are listed here.
Double DIAMETER
Double LENGTH
String MATERIAL

Configuring Bolts
Long PIECES // Number of Bolt Pieces

String TYPE
Long RATING
String CODE
Long BOLTED_PROPERTY_INDEX
String [] ERROR_MESSAGE
Boolean ERROR
BOLT_ORDER Class
The BOLT_ORDER class is customized to aggregate bolt information that the

bolts engine sets up to the BOLT_ORDER class before instancing it. Before
instancing this class, the bolts engine set up an ASSEMBLY relationship with all
BOLT_ASSEMBLY objects that have the same ORDER_ID value.
Relationship [] ASSEMBLY // Points to all BOLT_ASSEMBLY

objects that share the same ORDER_ID.
Output
Long BOLT_PIECES // Total number of bolt pieces

of all assembly objects that belong to this BOLT_ORDER
Double BOLT_DIAMETER
Double BOLT_LENGTH
String BOLT_MATERIAL
String BOLT_TYPE
String ORDER_ID
Boolean ERROR // Set to TRUE if there is an
error that’s to be reported.
String [] ERROR_MESSAGE // Error message to be
reported to user.

4 Configuring Bolts
Sample Customization Procedures

➤ To modify grouping components that make up the bolt assembly
✍ This procedure involves modifying ams_user.lib and ams.lib to change the JSM
that is generated through the MicroStation Connection dialog box. The library
is in the $PS_PROJ/etc directory.
1. In your ...\{Project Name}\etc directory, edit ams_user.lib in the

JSpace Class Editor.
2. Make a component trigger bolt generation, as follows:
• Add the CREATES_BOLTS property to the component.
• Add the BOLT_BASE_USER class as the parent to the component
class in ams_user.lib.
The default is set up so that CREATES_BOLTS evaluates to
TRUE for flanged elbows, flanged valves, and gaskets.
• Modify the expressions to evaluate to TRUE for the new component.
3. Include a component within a bolt assembly, as follows:
• Set up the INLINE property on the component to evaluate to TRUE.
The property is usually on the component class in ams_user.lib.
The component is then included in the assembly if it is
connected to the trigger component directly or through other
inline components.
✍ After any change to ams_user.lib, use the Database Setup tool to
synchronize ams.lib. The input JSM needs to be regenerated
through MicroStation Connection.

Configuring Bolts
Modifying the Bolt Catalog Data
The following table summarizes several relevant component

properties and their use.
Property Use
CREATES_BOLTS Marks a component as a trigger for bolt generation.
The value is TRUE or FALSE.
INLINE Includes a component within a bolt assembly, if it is
connected to the trigger component, either directly
or through other inline components. The value is
TRUE or FALSE.
Note: The inline components also need to have only
two snap points.
BOLT_THICK If the component is within a bolt assembly, this value
(in inches or millimeters) indicates the thickness of
the component to be included for bolt length
evaluation.
4. Save the class libraries and close the JSpace Class Editor.
➤ TosetupboltstobefilteredwiththeirDesignSeriescomponents(foroutput
applications)
JSpace expressions are normally used by output applications to filter piping
components. It is usually necessary that the bolts that belong to these components
also pass through these filters. For this action to happen, the bolt assembly objects
should contain the component properties (and appropriate values) that are used in
the JSpace filter.
In V8 XM, no additional customizations are needed to do this. The bolts engine

locates the trigger component for the bolt assembly and appends all the properties
of the trigger to the BOLT_ASSEMBLY object. This is done only for properties
that are not already defined in the BOLT_ASSEMBLY object.
✍ To turn off this feature, set the PS_BOLTS_FILL_PROPERTIES

configuration option to NO.

Flange bolts can be filtered using the piping specifications generated with Spec
Maker. By adding guidelines to the specification, the user can control the bolt type
being specified for the given design. This action provides an additional consistency
check and ensures error-free design.

4 Configuring Bolts
For the Object Reporter, you need to define a bolt report. The standard PlantSpace
Design Series installation program creates a sample report called Bolts. This report
creates a DBF file containing information on bolts.
Bolt Information Tables Inside the PlantSpace Database
The following database catalog tables are used to determine the bolt information:
• BOLTS
The BOLTS table contains diameter, length, number, material, and
unit of measure information for bolts that are specific for a
particular combination of standard, rating, face, component size
data, component standard, component code, bolt standard, bolt
code, and bolt type.
• BOLT_MATERIAL
The BOLT_MATERIAL table contains bolt material definitions.
Providing this information in a separate table adds more flexibility
when you are specifying multiple material descriptions.
Fields in the BOLTS Table
The primary location for the storage of bolt information within Design Series is the
BOLTS table. This table contains the following fields:
Field Name Description Data Type Field Size

SIZE_1 The diameter of the Number Double
component that is being
bolted
RATING The pressure rating of the Number Long
component that is being integer
bolted
STNDRD The standard or Text 4
manufacturer name of the
bolted
CODE The standard or Text 12
manufacturer number of the
bolted

Configuring Bolts

BOLT_COUNT The number or count of Number Long
bolts integer
FACE The flange facing of the Text 2
bolted
FL_TYPE The flange type for flanges Text 3
BOLT_STNDRD The standard or Text 4
bolt
BOLT_CODE The standard or Text 12
manufacturer number of the
bolt
BOLT_TYPE The type of bolt, MACH or Text 4
STUD
BOLT_DIA_PAR The diameter of the bolts Number Double
measured in the units defined
in PAR_UNITS
BOLT_LEN_PAR The length of the bolts Number Double
measured in the units defined
in PAR_UNITS.
PAR_UNITS The unit of measure for the Text 2
diameter and length fields.
Use IN for imperial and MM
for SI.
BOLT_MATERIAL The bolt material Text 8
✍ Design Series accesses one of the rows from the PIPE_STD_BOLTS table to
create the implied bolt components for a particular Design Series component.

4 Configuring Bolts
Configuration Variables
Fields in the BOLT_MATERIAL Table
The BOLT_MATERIAL table contains material definitions.

STNDRD The standard or Text 4
bolted
CODE Component code (for Text 12
ANSI)
BOLT_MATERIAL Bolt material name Text 8
Modifying the BOLTS Table Data
Several DAT data files in the ...\dbload\data\pipe subdirectory contain the data for
the BOLTS table. To find these data files, perform a Find operation in Windows
Explorer using *.dat and containing the text BOLTS. (Consult your Windows
Explorer documentation or Help for details on how to perform this type of
advanced search.) These files require data for all columns in the BOLTS table.
Incorporating Bolt Changes into Your Project Database

When all your changes to bolt data are complete, you can use the Database Setup
tool to incorporate these changes into the project database. In the chapter Configuring
Your Project, see the procedure “Adding Catalog Data” on page 2-36.
The following table summarizes the available configuration variables used by the
bolts engine.

Configuring Bolts
✍ All of these configuration variables are optional.
Default
Configuration Variable and Purpose PossibleValues
Value
PS_BOLTS_DEFAULT_TYPE String [example, MACH
MACH and
If the system is unable to determine the bolt type, the STUD]
bolt type defaults to this value.
PS_BOLTS_DIAMETER_UNITS String [IN or IN or MM
MM] depending
Specifies the output units of the bolt diameter. on the
project units
PS_BOLTS_LENGTH_UNITS String [IN or IN or MM
MM] depending
Specifies the output units of the bolt length. on the
project units
PS_BOLTS_ROUND_LENGTH_TO Decimal (no default
(also PS_BOLTS_LENGTH_ROUNDING) value)
If the evaluated bolt length is not found in the database

table, the system will the round the length to the next
higher decimal/integer specified by this value.
PS_BOLTS_INLINE_LENGTH_THRESHOLD Double 0.125in,
3mm
This value is subtracted from the evaluated wafer length
(of inline items in the middle of the bolt assembly). Use
configuration variable if you want to ignore the gasket
thickness for calculating the bolt length (when it has
been already included in the database table).
PS_BOLTS_FILL_PROPERTIES String [YES or YES
NO]
If set to YES, the properties of the component that
triggered the assembly are automatically appended to
the instanced BOLT_ASSEMBLY object (if not already
present).

Default
Configuration Variable and Purpose PossibleValues
Value
PS_ISO_BOLT_ERROR_LOG String $PS_TEMP/
iso_bolts.log
AutoISOGEN configuration specifies the path to the
log file.
PS_ISO_STOP_ON_BOLT_ERROR String [YES or YES
NO]
AutoISOGEN configuration stops isometric processing
if errors occur during bolt generation.
Troubleshooting Bolts
If bolt data is not properly reported after processing in a program such as Object
Reporter or PlantSpace AutoISOGEN, you can troubleshoot the problem by
running bolts_util_v89.exe on the JSM produced. This delivered file resides in the
...\Program Files\Bentley\DesignSeries\exe directory. It is easier to determine what
is happening with the bolt objects in the JSM because sometimes the class library
contains a syntax error that is not noticeable.
➤ To troubleshoot problems generating bolt data

1. On the Windows Start>All Programs>Bentley>PlantSpace Design Series
V8 XM Edition>Administrator tools, click the Bolts Troubleshooter icon.
2. If you have more than one project and the Select Workspace dialog
box is displayed, select triforma (or whatever you as the
administrator set up), select a project, and click OK.
The Bolts Calculator Utility dialog box is displayed.
3. At the Source JSM field, select the same JSM that was used with
Object Reporter or PlantSpace ISOGEN.

Configuring Bolts
✍ In the Destination JSM field, the new JSM will be generated with
bolts_ added to the beginning of the name, as shown.
4. To change the name, deselect the Default Destination JSM check

box and specify a name for the new JSM.
5. To generate an error report, select the Generate Error Report
check box.
6. Click the Create Bolts JSM button.
7. In the JSpace Class Editor, open the newly created JSM.
The new JSM contains:
• BOLT_ASSEMBLY objects, each representing the set of bolts used at a
flanged connection
• BOLT_COMPONENT objects, each representing an end component
in a bolt assembly

4 Configuring Bolts
• BOLT_ORDER objects, which sum the quantities of like

BOLT_ASSEMBLY objects.
8. Scroll down to the BOLTS_ASSEMBLY class and double-click it.

The BOLT_ASSEMBLY object has properties ERROR (set to
TRUE if an error occurred) and ERROR_MESSAGE (a text
message indicating what was not satisfactory for the set of bolts).
Also may be listed:
• Relationship END1, END2, which refer to the BOLT_COMPONENT
objects representing end components.
• Relationship JOINS, which refers to the modeled components at or
within the flanged connection

Configuring Bolts
• IS_ASSEMBLY_FOR, which refers to the component that required the

bolts (usually the gasket)
9. Review the user's bolts.lib (or ams_user.lib) to determine where the

proper assignment is not being made.
10. Check the source expression(s) and database table for the property.
11. Make any necessary edits and regenerate the JSM.

5 Configuring Design Series for
ProjectWise
Understanding Bentley ProjectWise

Bentley ProjectWise is the content management solution for the engineering office.
Users can consolidate decentralized engineering content into a single presentation to
ensure that all project team members have access to the right data when they need it.
✍ ProjectWise works in component-based storage mode, as well as file-based

storage mode.
ProjectWise is designed to handle both MicroStation V8.x DGN files and

AutoCAD 2002 DWG files, as well as other business file formats. Bentley
ProjectWise leverages existing network infrastructures and provides a common
platform for the management of content created by Bentley's portfolio of
engineering applications. Related project documents, such as those created by
Microsoft Office XP, can also be stored, viewed, and annotated within the
ProjectWise environment. This allows the creation and management of project
content throughout the design and construction process, as well as the reuse of that
content during the operational lifetime of the built asset.
Bentley ProjectWise users can publish content through the implementation of

Bentley content publishing solutions for Web plotting, Web publishing, and 3D
model streaming.
ProjectWise Configuration Procedures
✍ See the Help menu on the ProjectWise menu bar on a server/administrator

machine.

5 Configuring Design Series for ProjectWise
Configuring Design Series
Configuring Design Series
W Before a PlantSpace Design Series project can be configured to run with

ProjectWise, you must have ProjectWise Version 3.8 installed and
operating on your system.
Design Series will have to be associated with the file after the file is put into
ProjectWise. This can be done within ProjectWise Explorer by highlighting a
document and going to Document (located in main menu bar of ProjectWise
Explorer)>properties, which will open the properties window for that file. The user
will then select Design Series within the application section (save and close the
window). This will then allow Design Series to be launched when the document is
opened within ProjectWise. The other alternative to associate many documents with
Design Series from ProjectWise is to highlight all the documents that need to be
associated with Design Series and go to Document (located in main menu bar of
ProjectWise Explorer)>advanced>modify, which will open the modify documents
window. The user will then select Design Series from the application section and
click OK. This will associate the documents to Design Series and again when these
documents are opened within ProjectWise, they will launch with Design Series.
Limitations and Assumptions

In order to use ProjectWise with Design Series, ProjectWise Client must be started
first and Design Series must be launched from within the ProjectWise Client as a
Partner Application.
It is assumed that when using ProjectWise with Design Series, users will begin using
this integration environment from the start of a new project. Presently, no import
utility will be provided in this phase to import existing Design Series files into
ProjectWise.
It is assumed that all access to supported Design Series files will occur only through
the Design Series/ProjectWise Integration environment. The integration
environment will not be able to handle check in or check out of supported Design
Series files if there were created or deleted outside of this environment.
It is assumed that the TriForma/ProjectWise environment variables will be set prior

to launch of Design Series and will remain in effect until the end of the design
session. Although, the TriForma/ProjectWise environment variables are read
dynamically, changing these variables during runtime may cause unpredictable
results.

Configuring Design Series for ProjectWise
Scope of Integration
Limitation
If a database connection is lost, there is no attempt to reconnect your current

session. The user must exit Design Series, ProjectWise, and restart.
Scope of Integration
The scope of work of this Design Series integration effort with ProjectWise will
currently be limited to model files (*.dgn), history files (*.hst) [obsolete in v8], BRep
files (*.tfb), drawing document files (v7 - *.bxs, *.d, *.f, *.r, *.m, *.s, *.e, v8 - *.bxs,
*.d, *.all), and group files (*.g*). No data (components, database tables, settings,
text) will be integrated in this phase.
When a user chooses Save As from the File menu, only the dgn file will be copied
and imported into ProjectWise. Any associated drawing definition, history or brep
files, will not be copied. Additionally, any associated drawing files will not be copied.
All associated files with the original file will be checked back in.
When a group file is created, the user should name the document name, the file
name, and the description should all be named the same and should follow the rules
of group files naming. The user should also not change the folder in which is
currently located, otherwise Design Series will not be able to find the file.
ProjectWise Client Setup for PlantSpace Design Series

1. In ProjectWise Administrator, create an application called
PSDS V8 XM.
2. In ProjectWise Explorer, choose Tools -> Program Associations.
3. Select Application.
4. Double-click Open With.
5. Find the MSv8.5 executable.
6. Double-click Partner Application.
7. Set Partner App = Yes.
8. Double-click Arguments and enter:
-wcC:...\Bentley\Program\DesignSeries
\mdlapps\config\dslocal.cfg
✍ If you installed your software in C:\Program Files, you should
enclose the path in quotation marks ("), as follows, in case the
space in "Program Files" poses a problem on your machine.

Improved Integration with ProjectWise
-wc"C:Program Files\Bentley\Program\DesignSeries
\mdlapps\config\dslocal.cfg"
9. Edit C:\PWExplorer\bin\mcm.cfg by uncommenting the line:
MS_INITAPPS < pwwrkspc.ma
PlantSpace Design Series Setup for ProjectWise

1. Edit C:\Program FilesBentley\Program\MicroStation
\config\msconfig.cfg by adding the following at line 45:
_MSCONFIG_CFG=1
Version Compatibility Dependencies

• TriForma V8 XM
• MicroStation V8 XM
• ProjectWise,V8 XM
✍ None of the versions of Design Series are certified to run with ProjectWise
3.2, but Design Series can be configured to run with version 3.8.0.1.

This feature automates the posting and retrieval of specific PlantSpace Design Series
input and output files to ProjectWise. This feature can further be described as the
posting and retrieval of "static" PlantSpace Design Series files to ProjectWise folders
for selective inputs and outputs in Design Series including reports, iso's, and DGNs.
✍ The scope of this enhancement does not include the folder structure
configuration of ProjectWise and is limited to the "file based" mode of
operation.
In addition, this specification is intended to address specific types of project-

deliverable files and is not meant to be all inclusive of project-specific configuration
and definition files used by PlantSpace Design Series.

Configuring Design Series for ProjectWise
How the Integration Works
How the Integration Works

Essentially, when a PlantSpace Design Series user initiates a file operation such as
Open, Save, or Save As, the user is prompted to select a folder location. The user
will be presented with the ProjectWise login screen and then asked to specify a
folder location to store or retrieve a given file if he or she is using ProjectWise. The
scope of this phase of integration does not include "project specific" files that are
currently maintained in the PlantSpace Design Series project directory structure.
The following functionality has been included with this enhancement.
ListofPlantSpaceDesignSeriesFeaturesRequiringtheCapabilityto
Retrieve Files from ProjectWise Folders
• Attach P&ID - DGN files

• Create Object Models (JSpace MicroStation Connection) - JSM files
• Stress Interface input file name - JSM files
• Object Reporter Data Source file - JSM files
• ISOGEN Interface Data Source file - JSM files (Personal ISOGEN
is included in the Design Series installation in V8 XM.
• IsoExtractor Source file(s) - Either DGN or JSM files (LOGOS
Scope)
• L/ISO File Open - DGN files (LOGOS Scope)
ListofPlantSpaceDesignSeriesFeaturesRequiringtheCapabilityto
Post Files To ProjectWise Folders
• Create Object Models (JSpace MicroStation Connection) - JSM files

• Stress Interface output file - CII file/Caesar and APP file/
AutoPlant
• Object Reporter Output File - DBF files
• ISOGEN Interface Output file - DGN files
• IsoExtractor Output file - DGN files (LOGOS scope)
• L/ISO File Save/Save As - DGN files (LOGOS Scope)
SpecificPlantSpaceDesignSeriesItemsManagedwithProjectWise
• MCS query files

• Object Reporter output files

• Input JSMs (applicable to Append Object Model, Stress/Iso

interfaces and Object Reporter)
• Stress interface output files
• ISOGEN interface output files (DGN)
• Saved queries
• JSpace class libraries (for Label Convert and Annotation)
• Design Series Neutral Files (for Import)
• Object Reporter run files
Specific PlantSpace Design Series Items Not Managed with

ProjectWise
• Database load files (attribute definitions, catalogs, rule files)

• Project settings files
• Specification definition files
• JSpace class libraries (in general, see exception in above list)
• Project cell libraries
• Report definitions
• Report filters
• User files for Access External Data feature
• ISOGEN interface output files (PCF)
• Design Series Neutral File (for Export)

6 Managing Your Project
You can customize the project environment and directory structure
associated with Design Series software. This chapter describes
configuration variables and delivered configuration files, and
explains how to modify the configuration files, change the site ID,
load the master volume definition file, and set up digital signatures
and digital rights.
Understanding Project Configuration
W Model Control System (MCS) resides in the TriForma EC, along with its
related programs (Define Volume Utility and MCS Administrator
Database Tools). Therefore, for any information on configuring your
project database as it relates to the MCS tables and these related
programs, be sure to read the chapters in Part 1 for the Administrator in
the Model Control System (MCS) Guide on the TriForma Help menu or in
the ...\Bentley\Documentation directory.
Project configuration for the Design Series requires a unique set of:
• Directories and files

• Configuration variables for MicroStation
• Configuration variables for third party, non-MicroStation
applications
To eliminate the need to put variables in the registry and define them twice, all
aspects of Design Series now use MicroStation configuration files.
To support multiple projects, the configuration uses files that are application level
(*.cfg) and project level (*.pcf), instead of user level (*.ucf). The user level is used
only to launch the application within MicroStation.
Digital Signatures and Digital Rights

As part of your project management, you can assign digital signatures and rights so
that you can control and protect your design files and models.

Digital signatures are a mechanism for indicating one's approval of designs to other
users and communicating approval in a verifiable manner. You can digitally sign a
model or a DGN file. MicroStation graphically indicates model-specific signatures.
Multiple signatures can be affixed to a single file or model. Hierarchical signing is
also supported, where one signature pre-requisites and depends on prior signatures.
A signature can cover the content of a model or file and, optionally, attached
references.
Among other key features, signers can use cells to represent signatures with arbitrary
graphics by defining an API to allow applications to customize where signatures can
be placed and how a signer´s identity is authenticated. You can detect valid
signatures in several ways to prevent spoofing.
✍ For details, see “Procedures for Setting Up Digital Rights and Digital Signatures” on
page 6-23.
Required Selection of a Project

Applications outside MicroStation also require the user to select a project and a
user-level configuration file. The system then reads the MicroStation-appropriate
project configuration file (*.pcf) and user-level configuration file (*.ucf) to set values
for the variables.
The dialog for selecting the user-level configuration and the project lists all available
projects in the current project group (defined by _USTN_PROJECT). However,
to limit the user to only one project, you can use the following MicroStation variable
or command line switch:
Variable or Switch Description

_USTN_PROJECTNAME Defines the project PCF file in the system
environment
-wp Defines the project PCF file on the command
line, typically defined on the shortcut target
path
✍ All applications display the name of the project configuration file (*.pcf) in the
title bar in square brackets [ ].
Default Configuration Setup

✍ In V8 XM, when you install a Design Series project, only the *.pcf file is
updated when the project is installed. Neither projvars.cfg nor the *.cfg file in
your \{project}\config directory is updated. You can verify this because the

Managing Your Project
Enabling Group Project Selection for Users
database-connection information and database type have been moved to the

*.pcf file, and the unit-specific settings have been moved to ds_settings_e.dat
and ds_settings_m.dat.
The default configuration is defined in the following files, which are installed with
the application files and project files in the order shown:
• dslocal.cfg
Is run at the application level and defines the default configuration
variables that Design Series needs in MicroStation. The dslocal.cfg
file resides in the ...\Bentley\Program\DesignSeries
\mdlapps\config directory.
• {ProjectName}.pcf
Is the project configuration file for {ProjectName} and includes
projvars.cfg in the project directory
• Projvars.cfg
Is run at the project level and enables you to override or append to
configuration variables that are in dslocal.cfg. The projvars.cfg file
resides in the directory defined by the {$PS_PROJ} configuration
variable in the project-level PCF file.
W The psdesign.ucf file has been removed because it actually contained

only application-specific settings. These settings were moved to
appropriate CFG files. Design Series starts up at the project level, not at
the user level. If you want the startup to occur at the user level, use the
parameter -wu, followed by your personal UCF file.
Enabling Group Project Selection for Users

The Project Group Selector tool provides an easy convenient way for your users to
select a project outside applications if they work on multiple projects as part of their
daily tasks. You can select the location where the Design Series applications will
look for the projects.
This tool is accessed from the Windows Start > Programs > Bentley > PlantSpace
Design Series V8 XM Edition > Project Group Selector. The following example
shows four groups of projects defined. In order, they are the sample projects

delivered with Design Series, projects related to Houston, projects related to

Singapore, and projects related to London.
This tool writes the location specified with the Change button as the value for a
configuration variable in a configuration file, and stores the list of values in a text
file. The name of the configuration variable, the name/location of the text file, and
the name/location of the configuration file are all specified as parameters on the
shortcut for this tool. The installer sets these (depending on the installation
locations chosen) to:
_USTN_PROJECT,
C:\Bentley Plant XM Projects\DesignSeries Workfiles\rootpath.ini, and
C:\DocumentsandSettings\Computer Name\Application
Data\Bentley\pcfLocation.cfg, resepectively.
W These arguments are separated by commas, and must not be quoted

even if the paths contains spaces. So, the default is that clicking the
Change button sets the value of _USTN_PROJECT in the
pcfLocation.cfg file.
The text file is read when the tool starts, and if the first line of the file is:
Readonly=TRUE

Viewing Your Configuration Variables
the users will not be able to key in or browse to any folders, so they will not be able
to choose a path that is not on the list. You can use a text editor to set the list of
paths for them. Each path is specified on a line, followed by a line with the
description for that path.

After you set up all your configuration variables, you can view them in the
Configuration dialog box and see which are defined and undefined. You can view
PlantSpace Design Series user configuration variables in the Configuration dialog
box displayed when you choose Workspace > Configuration from the MicroStation
menu bar.
Each new category contains a logical grouping of Design Series project and/or
system configuration variables. These variables are read only and cannot be added,
deleted, or edited in this dialog box. Descriptions for all configuration variables have
been added and are otherwise displayed in the Description section of the dialog box.
W Any additions or changes to Design Series configuration variables need

to be made in the appropriate project or system configuration files so all

users can share them. Changes should not be made in the Configuration
dialog box.
New category groupings have been added. The following groupings are examples.
✍ Project and system configuration variables are also listed for each group.
Design Series Bolts
• Bolt information from flange catalog

• Diameter rounding
• Length rounding
• Wafer tolerance
• Bolt units
• Bolt Default type
• Bolt dll location
Design Series Label Convert
• Diagnostics
• Replace Non-valid pound sign
• Save Conversion JSM
• Old Definition File
• Default Conversion Library
Design Series Location
• Object Engine
• Equipment
• Cell Libraries
• Data Files
• Application path
• Documentation
• Install folder

Design Series Object Reporter
• Group Library
• Reports Output
• Reports JSM
• Reports Definitions
• Reports Group
• Reports Filter
• Reports configuration
Design Series Operation
• MLE failed style

• MLE failed weight
• MLE failed color
• Label-edit diagnostic
• Automatic change
• Input-method diagnostic
• Check Design Log File
• Overlap Weight
• Overlap Color
• Connect Point Weight
• Symbology Definition
• IL Join Preferences
• Design file location
• Number of attributes
• Nominal Descriptions
Design Series Project
• Modified rule files

• Project Definition
• Database commodities

• Database Loader
• User Settings Files
• Log and Temporary Files
• User work area
• Database type
• Database name
• User Config Directory
• Units
• Project
Design Series Spec Maker
• Database Version
• SpecMaker Output
• SpecMaker
Model Control System (loaded with TriForma)
• MCS diagnostics
• Object Append
• Create Object Model
• Volume file location
• Project Volume File
• MCS Failed Folder
• MCS Archive folder
• Reference files
• Saved Query files
• Editor
Digital Rights and Digital Signatures

Design Series supports Digital Rights by providing file protection by verifying user
export or edit privileges for various Design Series operations. In these cases, Design
Series checks for the proper level of authorization to perform such Export or Edit
operations for a select set of operations.

Procedures Involved in Managing a Project
Digital Rights supports the following operations:
• Label Convert
• DSNF Export
• Save as v7 (Design Series-specific command)
• MCS (checks for full digital rights before check-in or append
operations)
• All MA files that can create or edit PlantSpace data
• All RSC files
Digital Signatures supports design files only (inherent from MicroStation).
Digital Signatures does not support:
• JSMs
• Database load files (attribute definitions, catalogs, rule files)
• JSpace class libraries
• Report definitions and filters
• User files for the Access External Data operation
• ISOGEN interface output (PCF) files
• Design Series neutral files (for export)

Managing a project involves the following tasks:
• Changing the directory structure

• Customizing the units of measurement
• Managing external files and JSM files
• Appending JSMs to the database individually and in batch mode
• Working with component labels
• Setting up digital rights and digital signatures
• Enabling scrolling on values in the attributes dialog box

Changing the Directory Structure

To manage a project, you can change the configuration and directory structure. The
file that defines project configuration is {ProjectName}.pcf in the {network
drive}\projPcfs directory. The {ProjectName}.pcf file includes the projvars.cfg file,
which defines configuration variables that are specific to the project.
➤ To change the directory structure

1. Open the {ProjectName}.pcf file in the directory in the previous
section and edit it accordingly.
2. To change the root project directory, edit the value of PS_PROJ in
{ProjectName}.pcf.
3. To refer to the projvars.cfg, which contains the default values, open
it in your ...\{ProjectName} directory.
4. To change the directories within a project, edit the appropriate value
in projvars.cfg.
Customizing the Units of Measurement

The delivered Design Series software enables users to work in one of the following
diameter/length units:
• Imperial/imperial
• SI (metric)/SI (metric)
• SI (metric)/imperial
• Imperial/SI (metric)

Customizing the Units of Measurement
The installation program automatically configures your project for either imperial or
SI (metric) units of measurement. Some projects may require users to work in
imperial/SI (metric) mode.
In the attributes dialog box, the Display Nominal as button toggles between
Imperial and SI (metric) so that users can view nominal values in either imperial or
SI units in any database. For example, by clicking Imperial, a user can view imperial
pipe diameters.
✍ No administrator task is needed to configure Design Series to work in imperial

or SI mode other than to install an SI configuration. However, you as the
administrator can customize the imperial and SI units of measurement that are
made available to users.
➤ To customize the units of measurement

1. Open the dslocal.cfg file and locate the $(PS_DEFAULT)
configuration variable.
2. Open one of the following files in the directory specified by
PS_DEFAULT:
• psnomdse$(PS_UNIT).txt (for imperial)
• psnomdsm$(PS_UNIT).txt (for SI)
3. Specify the attribute name, table name, and column name to be used
in mapping the new values that you want.
4. Set the imperial and corresponding SI values that you want in any of
the tables listed.
✍ You can create your own table but you must list it in this file.

Changing Project Units and the Seed File

To determine or change the system of units that you are using, you can examine the
PROJECT_CONFIG table and the file Projdefe.rul (imperial) or Projdefm.rul (SI)
in the project root directory (specified by the ${PS_PROJ}configuration variable).
✍ The {network drive}\Projects85\{ProjectName} directory is hereafter referred to

as the project root directory.
Based on your selection of imperial or SI as your system of units, the installation

program installs the correct rule file and creates the appropriate
PROJECT_CONFIG table.
The following parameters are set differently for each system of units:
PROP_VAL PROP_VAL
PROPERTY for Imperial for SI Description
System System
B3D_SYSTEM_UNITS INCH MM Units of measurement
Note: INCH and MM are the
only values allowed for
B3D_SYSTEM_UNITS in both
projdefe.rul/projdefm.rul and
the PROJECT_CONFIG table.
B3D_UORS_PER_SYSTEM_UNIT 25400 1000 Units of resolution per unit of
measurement
The Projdefe.rul file or Projdefm.rul file must be synchronized with the information
in the PROJECT_CONFIG table. This file duplicates some of the information
provided in the PROJECT_CONFIG table. The subdirectory contains one file for
each system of units. Depending on the system of units that you select at the time of
installation, the correct file version is in Projdefe.rul or Projdefm.rul.
The data files representing the PROJECT_CONFIG table are located in your
...\{ProjectName}\dbload\data\core directory. When you modify the following files,
the Database Setup automatically loads the correct version of the data file:
System of Units File Name

Imperial ...\english\prjcfg_e.dat
SI (metric) ...\metric\prjcfg_m.dat
W The design seed file defined by MS_DESIGNSEED (and

MS_SEEDFILES) must use the same working units that are used in the
Projdefe.rul file or Projdefm.rul file, and Proj_config table.

Managing External Files and JSM Files
The following table shows the default working units for each system:
System of Units File Name Default Working Units

Imperial ds_seede.dgn 1:12:25400 (representing feet and inches)
SI (metric) ds_seedm.dgn 1:1:1000 (representing millimeters)
➤ To change the system of units used in a project
W You must be consistent in choosing the files to copy or load. For each of
the five steps, you must select all files from either the imperial or SI
system of units.
1. Modify projdefe.rul or projdefm.rul in your ...\{ProjectName}

directory.
2. Modify the seed file.
3. Using the PlantSpace Database Setup tool, click the Data File
button in the Load group to load the appropriate file in your
...\{ProjectName}\dbload\data\core directory:
System of Units File Name

Imperial Prjcfg_e.dat
SI Prjcfg_m.dat
4. Modify the pipese.rul or pipesm.rul file in your
...\{ProjectName}\stress directory.
5. Modify the following Object Reporter configuration files in your
...\{ProjectName}\reports directory:
• filter_e.dat (imperial) or filter_m.dat (SI)
• report_e.dat (imperial) or report_m.dat (SI)
• group_e.dat (imperial) or group_m.dat (SI)
Managing External Files and JSM Files

Managing external files and JSM files involves the following tasks:
• Synchronizing the JSpace class library (ams.lib) with the project

database and user-defined class library (ams_user.lib)

See the section “Synchronizing Ams.lib with the Project Database and
Ams_user.lib” on page 2-9 in the chapter Configuring Your Project.
• Checking out JSpace object models from your project database
Use MCS to check out a design file, and Design Series>Object
Tools>Create JSM from the MicroStation menu bar to create the
JSM. You can also use the run_mcs.bat file in batch mode from a
command line to create the JSM in one step.
Appending Individual JSMs to the Database

If you have a JSpace object model (JSM) file that, for example, contains data
originally from an external application and you want to add that data to your project
database, you can do so by using the Append Object Model operation.
➤ To append individual JSMs to the database

1. Run PlantSpace Design Series.
2. From the MicroStation menu bar, choose Design Series>Object
Tools>Append Object Model.
The Select JSpace Model to Append dialog box is displayed.
3. Select the JSM file to append to your project database and click OK.
The system reads the data into the database.
Appending JSMs to the Database in Batch Mode

✍ Appending JSMs is an administrator task. However, you can find procedures
on batch processing the Check-out and Snapshot operations in the chapter for

Appending JSMs to the Database in Batch Mode
users called Using the Model Control System, in the MCS Guide. The PDF of the
guide is in the ...\Bentley\Documentation directory.
You can append JSM files to your project database in two ways:
• By choosing Design Series>Object Tools>Append from the

MicroStation menu bar
• In batch mode by using the runmcs.bat file in the default location,
...\Bentley\Program\TriForma\mdlapps
✍ If you are not familiar with the RUNMCS command, you can view examples of
its usage by right-clicking runmcs.bat and selecting Send to>Notepad from the
popup menu displayed.
➤ To append JSM files to the database in batch mode

1. At the Command Prompt, access the ...\Bentley\Program
\TriForma\mdlapps directory and type the following command:
runmcs -wc{path to your configuration file} -
wp{ProjectName} {file specification flags}
Where Means
-wc The flag for the path to your configuration file
Note: No space should be between the parameter and
the path.
-wp The flag for your project name. The delivered default
project name is PSDS_Imperial or PSDS_SI.
Note: No space should be between the parameter and
the project name.
file The flag indicated by -i, followed by a capital letter,
specification which the system reads to include the files immediately
flags following the capital letter. Valid flags are explained in
step 2.
W If any path in the command contains "Program Files", the

command cannot recognize the space in "Program Files".
Enclose each argument (the parameter+path+file name) in
quotation marks (").
2. Using the following table, add the two file specifications consisting
of -i+L+log file name and -i+I+jsm file name (with no spaces), and
press <Enter>.

W You must use these valid file specification flags.

✍ You can add multiple files after the first file by separating each
with a space. See the example that follows this procedure.
Flag Description
-iL log-file L to define the name of the log file containing messages.
The file will be created in the directory specified by
{PS_TEMP}.
-iI jsm-file I to define the name of the JSM file to import to your
project database through the MCS Append operation.
The file will be created in the directory specified by
{PS_OUT}.
3. To view the runmcs.bat file, access the ...\Bentley\Program

\TriForma\mdlapps directory, right-click runmcs.bat, and select
Send To > Notepad from the popup menu.
Example of Batch Processing
The following command imports (appends) multiple JSM model files into the
database.
runmcs "-wcC:\Program Files\Bentley\Home\PSDS_Imperial or
PSDS_SI\config\dstutor.cfg"
-wpPSDS_Imperialor-wpPSDS_SI-iImodel.jsmmodel2.jsmmodel3.jsm
model4.jsm
Working with Component Labels

Working with component labels involves the following tasks:
• Displaying component labels

• Creating a mapping of component attributes compared to label
positions
• Creating a summary of label utilization
Displaying Component Labels
The Design Series Label Display utility enables you to display the entire label (all the
attributes) for a selected component. You can then select a specific attribute to be
displayed, along with its position in the label.

✍ This utility differs from the Label>Read option on the Design Series menu in
that the Label>Read option does not display all the attributes.
The Label Display utility is especially useful when you are trying to run the Label
Convert utility and something is not working. You can look at the label based on the
values and format in your RIMREF.DAT file.
➤ To display a component label

1. Start PlantSpace Design Series and select a drawing file and a
project.
2. From the MicroStation menu bar, choose Design Series >
Utilities > Label Tool.
The Label Tool dialog box is displayed with the path to the
Rimref.dat file where the label data is stored.
3. In the Component group, click the Select button.

4. In the drawing, select a component (as shown in the example
indicated by the arrow), and accept it with a data point.

The entire label is displayed as shown in the example.
5. To display the label from a position other than the default start
position 1, type a new number in the edit box and press <Enter>.
The label information for that position is displayed. The Position
field at the bottom of the dialog box displays the position number.
6. To display a different Rimref.dat file (for example, one from an
earlier version of Design Series), click the Open Rimref Data
File button.
The Data File Open dialog box is displayed.
7. Select a data file, and click OK.

✍ You must select a data file containing the mapping information,
such as the rimref.dat file.
8. Select an attribute name from the drop-down list box.

The value of this attribute is read from the label and displayed along
with its position. In the following example, the value for the
BUD_TYPE attribute is PIPE_PIPE at position 81.
Creating a Mapping of Component Attributes Compared to

Label Positions
The Label Tool utility can also be used to create a mapping of the label attributes for
all components in a selected data file. This feature helps you determine where you
have space in a label, for example, to add new attributes. A mapping is provided for
each individual component, followed by a summary for each commodity, and a total
summary. A summary of common attributes only is also provided. This mapping
can be written to a selected output file in two different formats:
• As a mapping of component attribute names compared to label

positions
• As a summary of used and unused label positions
➤ To create a mapping of component attributes compared to label

positions
1. Follow the steps in the previous procedure on displaying a
component label.
2. Click the Open Rimref Data File button if the Rimref.dat file is
not already displayed.

3. In the Data File Open dialog box, select a data file such as the
rimref.dat file, and click OK.
4. Click Create Attribute Map.

The Create Map File dialog box is displayed.
5. Accept the default name lblmap.txt or type a new file name,

and click OK.

When the mapping is complete, the program writes the output to

the selected output directory. You can open the mapping output in a
text editor, as shown in the example.
Creating a Summary of Label Utilization
The summary lists all the used and unused label positions in the RIMREF.DAT file.
✍ The summary is rather long.
➤ To create a summary of label utilization

1. In the Label Tool dialog box, display a component label.
2. Click the Open Rimref Data File button if the Rimref.dat file is
not already displayed.
3. Select a data file, and click OK.
4. Click the Create Attribute Summary button.

The Create Summary File dialog box is displayed.
5. Accept the default name lblrpt.txt or type a new file name,

and click OK.
When the summary is complete, the program writes the output to
the selected output directory. You can open the summary in a text
editor, as shown in the example.
6. Close the Label Tool dialog box.

Procedures for Setting Up Digital Rights and Digital Signatures
Procedures for Setting Up Digital Rights and Digital Signatures
Digital Rights
With MicroStation, you can restrict the ability of your users to edit, export the
contents, or print a DGN File. This feature is generally intended to be used when
users make a copy of your DGN files to send to other users or organizations. The
rights to perform these actions are controlled by a new set of properties in DGN
files called Digital Rights. You grant digital rights to users by using either passwords
or digital certificates. These rights are contained in and are inseparable from the
DGN file and are always enforced by MicroStation. The rights are permanent and
secure and therefore travel with the DGN file regardless of the mode of
transmission.
The author controls who can access the file´s contents as well as grants or denies
rights to users to publish or modify data. MicroStation disables all commands for
which the corresponding right is not granted.
File Protection defines the following rights:
Type of
Description
Access
View See contents displayed on the screen
Print Plot contents of the file to paper
Edit Modify contents of the file
Export • Edit > Copy to copy (or cut) elements to the clipboard
• File > Export/SaveAs to save the contents of the file to a
different format
• File > Save As to save the contents of the file to a different
name without encryption or restrictions
• Fence File
• Generate an e-plot
Because view right is the default right, it is not explicitly granted by the author. Any
user authorized to access the file has the right to view it. The remaining rights
control how or if the user can capture the contents.
Unlimited Rights
File Protection also defines the “unlimited” right. Unlimited implies all basic rights,
plus the right to grant rights and authorize users. Anyone with unlimited rights fills
the role of the author who can assign unlimited rights to other users.

Specific to PlantSpace Design Series
PlantSpace Design Series supports Digital Rights providing file protection by

verifying user export or edit privileges for various Design Series operations. In
these cases, PlantSpace Design Series checks for the proper level of authorization to
perform such export or edit functions for a select set of operations.
PlantSpace Design Series supports Digital Rights on the following operations:
• Label Convert
• DSNF Export
• Save As V7 (on the Utilities menu)
• MCS operations (checks for full digital rights before check-in or
append operations)
In addition, all *.ma, *.rsc, and *.dll files are digital rights-compliant.
➤ To set up digital rights

1. Choose MicroStation Help>Contents from the MicroStation
menu bar.
2. SelectAdmininstratorGuide>DigitalRightsTechnologies to
locate the procedures for setting up various options.
Digital Signatures
At certain points in MicroStation workflows, it is often useful to "stamp" the current
state of project information to indicate review, approval, or ownership of the
information by a specific individual or function. The objective of the stamp is to
provide a mechanism that an "author" can use to notify a recipient of the
information (anyone who might access the information in the future) that the
information:
• Has been reviewed, approved, or authored

• More importantly, has not been altered since it was stamped
MicroStation provides tools for signing the content of DGN files and for
recognizing and verifying that a Digital Signature is valid.
MicroStation Digital Signatures are based on standardized cryptography and digital

certificate mechanisms. These mechanisms are widely used and trusted in Internet-
based systems. Moreover, MicroStation Digital Signatures support integrates
smoothly with the certificate management mechanism of Microsoft Windows.

Enabling Scrolling on Values in the Attributes Dialog Box
Specific to PlantSpace Design Series
PlantSpace Design Series supports Digital Signatures on design files only (inherent
from MicroStation).
W PlantSpace Design Series does not support Digital Signatures on:
• JSMs
• Load files operation (attribute definitions, catalogs, rule files) in the
Database Setup tool
• Report definitions
• Report filters
• User files for Access External Data feature
• ISOGEN Interface output (PCF) files
• Design Series neutral file (for export)
➤ To set up digital signatures

1. Choose MicroStation Help>Contents from the MicroStation
menu bar.
2. SelectAdmininstratorGuide>DigitalRightsTechnologies to
locate the procedures for setting up various options.
Enabling Scrolling on Values in the Attributes Dialog Box

In the attributes dialog box, your users can scroll through each value in a drop-down
list box in the Value column without opening the list box. By selecting the value to
highlight it, they can then press the:
• F11 key to scroll forward through each value

• F12 key to scroll backward through each value

➤ To enable scrolling on values in the attributes dialog box
1. Open the projvars.cfg file in your ...\{ProjectName} directory.
2. Set the following configuration variables:
• DS_KEY_INCREMENT = F11
• DS_KEY_DECREMENT = F12

7 Creating and Checking Piping
Specifications
Design Series provides Specification Maker to create piping
specifications used in your drawings. The related utility, Spec Check,
enables you to check piping components against an existing
specification.
Understanding the PlantSpace Specification Maker

PlantSpace Specification Maker (or simply Spec Maker) operates on data in the
project database by creating and managing material specifications (or simply, specs).
Specs are used for various component types such as pipe, fittings, and valves
associated with a Design Series model for a particular project database. Spec Maker
uses ODBC to communicate with databases and is certified for use with Access,
Oracle, and SQL Server databases.
✍ Spec Maker replaces the Specification Generator (Spec Gen) utility in previous
versions of Design Series.
Spec Maker communicates directly with your Design Series database. In your Design
Series model, when you select the Specifications option (in Placement Mode field of
the Place Component dialog box), you can place only components that are
synchronized to the various specification tables in your database.
✍ A project can be set up to allow only specification-driven modeling. Refer to

the section “Controlling Options Available in the Placement Mode Field Through the
ATTRCDEF Table” on page 2-7 of the chapter "Design Series Modeling Tables" in
the PlantSpace Design Series Reference Guide for Administrators.
Features of Spec Maker

Spec Maker enables you to:
• Convert data from previous releases (including Spec Gen data)

• Customize the Spec Maker interface
• Set up a project specification file
• View specs at various levels in a tree structure

7 Creating and Checking Piping Specifications
• Create, edit, and manipulate component types and criteria

• Maintain specs by globally updating multiple names of items in the
tree structure, clearing spec tables, and changing the ODBC data
source
• Customize the Specification Check utility for user designers or
engineers to check their piping components against a particular
specification.
Each major section of this chapter explains these features.
Spec Maker Data Files

✍ You can use your Design Series 8.0 spec files (*.s71) in V8 XM. One exception
is that bolts now have a separate material table. This change means that the
criterion will need to be changed in the *.s71 files for V8 XM.
The following lists the various default file extensions that Spec Maker uses:
Default File
Description
Extension
.s71 Spec Maker specification files compatible with the Design
Series version 7.1 enhanced database
.spe Spec Maker specification files compatible with the Design
.spt Series version 2.0 database
.spc Spec Gen specification files that Spec Maker can convert
.a
Spec Maker Objects as JSpace Objects

Spec Maker stores its data in s71, SPE, or SPT files. These file formats are actually
JSpace model (JSM) files. As such, the JSpace Class Editor can open these files.
Because Spec Maker data files are JSpace model files, Spec Maker data are JSpace
objects. These Spec Maker objects are displayed in the Spec Maker project window.
The classes along with their locations in the Spec Maker tree structure are:
• Project (first-level)
• Specifications and component types (second-level)
• Associated specifications and component types (third-level)
• Guidelines (fourth-level)

Creating and Checking Piping Specifications
Structure of a Project Specification File
• Criteria (fifth level)
A specification file can have only one project object. Several specification and
component type objects can be under the project object. Creating a relationship
between a specification object and a component type object creates an associated
specification or component type object. Therefore, several of these associated
objects can be under specification and component type objects. Guideline objects
are related to a particular specification and component type pair. Finally, criteria
objects store the constraint values for a specific guideline.

A Spec Maker specification file (*.s71, *.spe, or *.spt) contains specifications,
component types, guidelines, and criteria. The installation process places the
following files in the \SpecMakr subdirectory of your project-specific directory.
(The default project directory is {network drive}\Projects85\{ProjectName}.)
• PSDesign.s71
A complete, sample project file with specs specifically made for use
with the PlantSpace Design Series QuickStart Guide
• CompDefn.s71
A project file containing only component definitions designed to
work with the default PlantSpace database
• Eds-specs.s71
A sample project file with specs for the European Data Set (EDS)
standard
• Eds-compdefn.s71
A sample project file containing component definitions for use with
the European Data Set (EDS) standard
The following graphic shows the data structure of a Spec Maker project
specification file. Spec Maker provides two major views, namely spec view and

component view. The section “Procedures for Viewing the Project Specification File” on
page 7-30 describes in detail these two views.
Specifications
Within the project specification file are individual specifications arranged by

specification name. The following graphic shows an example of specification CS150,
which represents Carbon Steel with a 150 pound rating. Each specification (or

simply spec) is arranged in a tree structure, as shown on the left side of the following
graphic.
Component Types
Also on the left of the previous graphic, you can see at a glance all the component
types associated with a spec. When you select a component type associated with a
spec, its guidelines are displayed. In the example, component type "Adapters" for
the spec CS150 consists of three guidelines labeled GL1, GL2, and GL3.
Guidelines
A guideline is a rule representing the constraints or limitations on a component type.

The specification guidelines determine which specific component types are valid for
a Design Series model. When you select a guideline, such as GL1, the criteria and
data values for that guideline are displayed in the list pane, as shown on the right side
of the previous graphic.
Criteria
The specification criteria (displayed only in the list pane) are the data (dimensions or
values) required for a particular guideline. For example in the previous graphic,
guideline GL1 is set up so that the larger end of the adapter must have a diameter
within 0.75 to 2 inches.

Project Windows
When you open a project specification file, the contents of the file are displayed in a
project window.
Project
Windows
You can open multiple project spec files at the same time and copy data from one
file to another. In the example, two project files are displayed, PSDesign.s71 and
CompDefn.s71. All project windows can be displayed as four panes, as shown in
PSDesign.s71:
• An upper tree pane and list pane to view the project from one
perspective, such as guidelines in the example
• A lower tree pane and list pane to view the project from another
perspective, such as guideline criteria in the example
You can specify the information displayed in these panes by selecting a view option
in either the View menu or the View tool bar.
Tool Bars
The following tool bars provide quick access to the same commands on the menu
bar.

Tool Bars
Main Tool Bar

New Save Copy Delete
Open Cut Paste Find
Element Tool Bar

Cut Synchronize Select
Create New Branch Table Branch Table Active Items
Component Type
Create New Paste
Change Criteria
Guideline Branch Table
Properties
Create New Copy Unsynchronize

Criterion Branch Table Branch Table
Create New Show Delete
Specification Branch Table Reorder Criteria
Branch Table
View Tool Bar

View Active View Active View Database
Component List Specification List Table Fields
View as Project
Specifications View Component
Definition
View as Project View Specification View Component

Component Types Definition Criteria

Procedures for Opening and Closing the Application and Files
Database Tool Bar
Synchronize Unsynchronize

Opening and closing the application and files follow standard Windows operations.
Opening and Closing the Application

After installation, the Design Series program group window is displayed. You can
start Spec Maker from that window or from the Start menu on the Windows
desktop.
➤ To open and close the application

1. From the Windows Start>Programs menu, locate the PlantSpace
Design Series program group and select the Specification Maker
icon.
triforma (or whatever you as the administrator set up) in the User
field, select a project, and click OK, you can continue.

Opening and Closing a Project Specification File
The Specification Maker window is displayed with the name of the

selected project shown on the title bar.
2. To close the application, perform one of the following operations:

• Click the application icon to the left of the title bar in the application
window, and select Close.
• Click the Windows close icon (x) to the right of the title bar in the
application window.
• Choose File>Exit from the menu bar.
• Press <Alt+F4>.
✍ If you have the Auto-Save feature enabled, you do not need to save a file
before closing the application. Like database applications, Spec Maker saves
the data as you make changes or add data to a file. If Auto-Save is disabled, you
must manually save the file before closing it. See the section “Using Auto-Save or
Manually Saving a File” on page 7-12 for a detailed description of the Auto-Save
feature.

➤ To open and close a project specification file
1. To open a project specification file, perform one of the following
operations:
• Click the Open tool on the tool bar.
• Choose File>Open from the menu bar.
• Press <Ctrl+O>.

The Open dialog box is displayed.
2. In the Files of type field, select one of the following file types:
• Spec Maker Documents (*.s71) (for 7.x and 8.x documents)
• Spec Maker 2.0 Documents (*.spe)
• Spec Maker 2.0 Templates (*.spt)
3. Access the directory where your Spec Maker files reside.
The default project directory is {PS_PROJ}\SpecMaker.
4. Select a file and click the Open button.
• If the following message is displayed, you should click Yes to update the
data in your Spec Maker file.
• If the following message is displayed, you cannot open your Spec Maker
file without an updated class library file. After you click OK, you should

contact Bentley (for example, you can send email to

support@bentley.com).
The project is displayed at the root level with all the specs at the
second level in the tree structure, as shown in the example.
5. To close a file without closing Spec Maker, perform one of the

following operations:
• Click the Windows close (X) icon in the project window.
• Click the project window icon to the left of the file name and selecting
Close from the menu.
• Choose File>Close from the menu bar.
• Press <Ctrl+F4>.
✍ If you have the Auto-Save feature enabled, you do not need to save a file
before closing it. If Auto-Save is disabled, you must manually save the file
before closing it.

Using Auto-Save or Manually Saving a File

The Auto-Save feature on the File menu automatically saves your file as you add or
change data and ensures that your specification files are consistent with the state of
the database. Disabling the Auto-Save feature places the burden on you to manually
save the project specification file to maintain consistency with the database.
✍ It is highly recommended that Auto-Save remain enabled.
The Auto Save menu item switches between enabling and disabling this feature.
Selecting AutoSave places a check mark beside this menu item, which means it is
enabled. Selecting AutoSave again, removes the check mark, thereby disabling it. If
you choose to disable AutoSave, you will have to manually save your files.
➤ To manually save a project specification file

1. Perform one of the following operations:
• Click the Save tool on the Main tool bar.
• Choose File>Save from the menu bar.
• Press <Ctrl+S>.
2. Either close the file, or continue working with it and save it again
before you close it.
➤ To save a project specification file under a different name

1. Choose File>Save As from the menu bar.
The Save As dialog box is displayed.
2. Select a location to save the new file.

3. Type a file name for the new file, and click the Save button.

Procedures for Converting Spec Gen 2.0 Data

✍ All references to *.s71 files apply to Spec Maker in Design Series version 8.x.
To use a Spec Gen file in Spec Maker, you must convert the data. The conversion
process in Spec Maker converts the SPC files (used in Spec Gen) to SPE, SPT, or
s71 files used in Spec Maker. Before you convert a file, you can customize the
conversion files.
Spec Maker uses two sets of customization files:
• One set (spc2spe.ini and spc2spe.scr) is used to convert Spec Gen

files to Spec Maker 2.0 format.
• The other set (spc2s71.ini and spc2s71.scr) is used to convert Spec
Gen files to Spec Maker 7.1 format.
The INI files (spc2spe.ini and spc271.ini) are modified versions of the Spec Gen 2.0
INI file, PSpecGen.ini. The SCR files (spc2spe.scr and spc2s71.scr) are script files
containing scripting commands for finalizing the conversion process from Spec Gen
format to Spec Maker format.
Customizing the INI File

The spc2spe.ini and spc2s71.ini files are modified versions of the PSpecGen.ini file
used by Spec Gen 2.0. You can use these files as is, or you can customize them to
handle the specific requirements of your project.
✍ You should customize your INI file before you convert the Spec Gen data.
The delivered files, spc2spe.ini and spc2s71.ini, will convert your Spec Gen 2.0 data
into Spec Maker format without any further need for modification provided that
you did not modify the PSpecGen.ini file delivered with Design Series 2.0.
✍ You can safely skip this procedure if and only if you have not modified your
PSpecGen.ini file.
➤ To customize the spc2spe.ini or spc2s71.ini file

1. In Windows Explorer, change to the directory where your Spec
Maker files reside.
2. Double-click either the spc2spe.ini or spc271.ini file.

Each section in the INI file is delineated by text enclosed in square

brackets (for example, [STANDARD ELBOWS]). Each section
contains all the conversion information relevant to the particular
component type of the section. The ## symbols in the following
settings correspond to the same number as a ColumnName##
entry.
3. Find each instance of the programming statement and change the
variable (in Italics) to the value that you want:
✍ If a programming statement that you want is not in the file, you
can add it.
• SPE_ComponentName=name
Where Means
name The component
name
• SPE_SpecificationTable=specTable
Where Means
specTable The name of the database table where specifications for
the specific component are stored.
Note: If no entry exists for SPE_SpecificationTable,
Spec Maker uses the CatalogTable entry and appends
_SPEC to form the name of the default specification
table.
• SPE_DatabaseTable##=dbTable
Where Means
dbTable The name of the database table acting as the source for
the values of the criteria represented by
ColumnName##.
Note: If no entry exists for SPE_DatabaseTable##,
Spec Maker uses the CatalogTable entry as the default
database table. For example, in the [STANDARD
ELBOWS] section, ColumnName12 has the value
MAT_STD. The database table source for
ColumnName12 is MATERIAL_DATA and not the
default, PIPE_PELB. As such, SPE_DatabaseTable12
is given this value.

Customizing the INI File
• SPE_TableField##=tableField
Where Means
tableField The name of the table field acting as the source for the
values of the criteria represented by ColumnName##.
Note: If no entry exists for SPE_TableField##, Spec
Maker uses the ColumnName## entry as the default
table field.
• SPE_DescriptionTable##=descriptionTable
Where Means
descriptionTable The name of the database table mapping catalog
field codes to natural language text (for example,
BW to BUTT WELD) for the values of the
criteria represented by ColumnName##
• SPE_ModifiableOperator##=modifiable
Where Means
modifiable The operator can or cannot be modified, as
follows:
1= modifiable (the default setting)
0= unmodifiable

• SPE_CriteriaOperator##=operator
Where Means
operator The default relationship for the criteria represented by
ColumnName##
Note: If no entry exists for SPE_CriteriaOperator##,
Spec Maker uses the equal to (=) operator to mean the
default relationship. The operators used in the
relationships are:
Operator Relationship
= equal to
!= not equal to
@ element of
!@ not element of
< less than
<= less than or equal to
> more than
>= more than or equal to
() range: low exclusive, high
exclusive
(] range: low exclusive, high
inclusive
[) range: low inclusive, high
exclusive
[] range: low inclusive, high
inclusive
• SPE_TextDefault##=text
Where Means
text The default text for the criteria represented by
ColumnName##

Customizing the SCR File
• SPE_Expression##=expression
Where Means
expression The JSpace Expression for the criteria represented
by ColumnName##
For example, you can use an expression to
concatenate properties in a long description.

Spec Maker provides a rudimentary scripting command language to allow the
conversion of old Spec Gen data into the new Spec Maker formats. For example, the
criterion Adapter Type for the component type Adapters exists only in Spec Gen
2.0. Spec Maker 7.1 uses the criterion End Preparation 2 to distinguish between
male and female adapters. The following script commands accomplish this
conversion:
define rule 2 false if "Adapter Type" = "F" then "End
Preparation 2" = "FT"
define rule 2 false if "Adapter Type" = "M" then "End
Preparation 2" = "MT"
✍ The delivered files, spc2spe.scr and spc2s71.scr, will convert your Spec Gen 2.0
data into Spec Maker format without any further need for modification
provided that you did not add any new catalog data to your PlantSpace 2.0
database.
➤ To customize the spc2spe.scr or spc2s71.scr file
W You can safely skip this procedure only if you have not added any new
catalog data to your PlantSpace 2.0 database.

Maker files reside.
2. Using any text editor (for example, Notepad), open either the
spc2spe.scr or spc2s71.scr file.
Each section in the SCR file is delineated by text enclosed in square
brackets (for example, [Adapters] ). Each section contains all the

script commands necessary to convert Spec Gen 2.0 data into Spec
Maker format.
3. For each section, add the scripting commands necessary to convert
the Spec Gen 2.0 data into Spec Maker format.
The following lists all the valid scripting commands that Spec Maker
can process.
modify catalog_table <table>
modify spec_table <table>
create criteria <name> catalog <field> <desc_table>
create criteria <name> database <table> <field>

<spec_field> <desc_table>
create criteria <name> lookup <table> <map_count>

<source_fields...> <link_fields...> <output_field>
create criteria <name> expression <spec_field>

<expression>
create criteria <name> text <spec_field>

<default_value>
redefine criteria <name> catalog <field> <desc_table>
redefine criteria <name> database <table> <field>

redefine criteria <name> lookup <table> <map_count>

redefine criteria <name> expression <spec_field>

<expression>
redefine criteria <name> text <spec_field>

<default_value>
modify criteria <name> <visibility> <catalog_check>

<modifiable> <default_operator>
define rule <group> <use_default_operator> if <name1>

<oper1> <expr1> then <name2> = <expr2>

define assignment <name> = <expression>
rename criteria <old_name> <new_name>
order criteria <name> <priority>
delete criteria <name>
Where Means
<catalog_check> One of {true false} indicating whether to perform
catalog value checks
<default_operator> One of { = ! @ ! @ < < = > > = ( ) ( ] [ ) [ ] }
indicating the default
operator
<default_value> A string indicating the default text for text-type criteria
<desc_table> A string indicating a description table in the database
<expression> A string containing a valid JSpace expression
<expr1> A string containing a valid JSpace expression
<field> A string indicating a field in the catalog table
<group> A number indicating the rule group
<link_fields...> A sequential list of strings indicating fields in the
catalog table
<map_count> A number indicating the count of lookup source and
link fields
<modifiable> One of {true false} indicating whether users can
modify the default operator
<old_name> A string indicating the old criterion name
<name> A string indicating a criterion name
<name1> A string indicating a criterion name
<new_name> A string indicating the new criterion name
<oper1> One of { } indicating the type of test to perform
<output_field> A string indicating a field in the lookup table
containing the data
<priority> A number indicating the position of the criterion

Where Means
<source_fields...> A sequential list of strings indicating fields in the
lookup table
<spec_field> A string indicating a field in the specification table
<table> A string indicating a table in the database
<use_default_operator> One of {true false} indicating whether to use the
default operator for the criterion
<visibility> One of {true false} indicating whether to display the
criterion in guideline view
Converting Spec Gen Data
W Be sure that you have made all necessary changes to the INI and SCR
files before you convert the Spec Gen data.

Converting Spec Gen Data
➤ To convert Spec Gen data

1. In the Spec Maker window, choose Tools>Convert Specification
Data from the menu bar.
The Convert Specification Data dialog box is displayed.
2. Click the first Browse button at the top.

3. In the Select Data File to Convert dialog box, select SpecGen 2.0
Files (*.spc) in the Files of type drop-down list box.
4. Select an SPC file on your hard drive and click Open.

The default directory where Design Series 2.0 placed SPC files is
...\PltSpace\psdesign\specgen.
The Convert Data dialog box is redisplayed with the old file name
and the new proposed output file name.
✍ You can change the proposed output file name if you want by
clicking the Browse button beside the Output File field and
selecting a different file.
5. Optionally, to change the Design Series database table format to a

different format, click the drop-down list box for this field and
select the format.
6. Optionally, to change the script file to be processed during
conversion, click the Browse button by the Script file field and
select the file.
7. Optionally, to database source of the output file, click the Select
button by the Database Source field and select a different source.
8. Click OK.

Procedures for Using Spec Maker 2.0 Spec Files
The progress dialog box describes the stages of the conversion

process. After a few minutes, the new converted file is displayed in
its project window, as shown in the example.

✍ All references to *.s71 files apply to Spec Maker in Design Series version 8.x.
Spec Maker 7.1 can work with Spec Maker 2.0 spec files without converting them
provided that you will be using a Design Series 2.0 database with the 2.0 spec files. If
you need to use a Spec Maker 2.0 spec file with a Design Series 7.1 database format,
then you need to convert the 2.0 spec file into a 7.1 spec file.
Using Spec Maker 2.0 Spec Files

The following procedure is for working with Spec Maker 2.0 spec files and Design
Series 2.0 databases.
➤ To use Spec Maker 2.0 spec files

• Click the Open tool on the Main tool bar.
• Choose File>Open from the menu bar.
• Press <Ctrl + O>.
The Open dialog box is displayed.

2. In the Files of type drop-down list box, select either Spec Maker
2.0 Documents (*.spe) or Spec Maker 2.0 Templates (*.spt).
3. Select an SPE or SPT file on your hard drive and click Open.
The default directory where Spec Maker 2.0 placed SPE and SPT
files is ...\PltSpace\psdesign\SpecMakr.
✍ If this is the first time that you are opening a Spec Maker 2.0 file,
then the following dialog box is displayed:
4. Click Yes to update the Spec Maker 2.0 file.

After a few minutes, the updated 2.0 file is displayed in its own
project window.
Converting Spec Maker 2.0 Files into 7.1 Format

The following procedures are for converting Spec Maker 2.0 files to work with a
Design Series 7.1 database.

Spec Maker provides a rudimentary scripting command language to allow the

conversion of old Spec Maker 2.0 data into the new Spec Maker 7.1 format. For
example, the criterion Adapter Type for the component type Adapters exists only in
Spec Maker 2.0. Spec Maker 7.1 uses the criterion End Preparation 2 to distinguish
between male and female adapters. The following script commands accomplish this
conversion:
define rule 2 false if "Adapter Type" = "F" then "End
Preparation 2" = "FT"
define rule 2 false if "Adapter Type" = "M" then "End
Preparation 2" = "MT"
✍ The delivered file, spe2s71.scr, will convert your Spec Maker 2.0 data into Spec
Maker 7.1 format without any further need for modification provided that you
did not add any new catalog data to your PlantSpace 2.0 database.
➤ To customize the spe2s71.scr file
W You can safely skip this procedure only if you have not added any new
catalog data to your PlantSpace 2.0 database.

Maker files reside.
The default project directory is {network drive}\Projects85
\{ProjectName}.
2. Using a text editor (for example, Notepad), open the spe2s71.scr
file.
Each section in the SCR file is delineated by text enclosed in square
brackets (for example, [Adapters] ). Each section contains all the
script commands necessary to convert Spec Maker 2.0 data into
Spec Maker 7.1 format.
3. For each section, add the scripting commands necessary to convert
the Spec Maker 2.0 data into Spec Maker 7.1 format.
The following lists all the valid scripting commands that Spec Maker
can process.
modify catalog_table <table>
modify spec_table <table>
create criteria <name> catalog <field> <desc_table>

create criteria <name> database <table> <field>

create criteria <name> lookup <table> <map_count>
create criteria <name> expression <spec_field>

<expression>
create criteria <name> text <spec_field>

<default_value>
redefine criteria <name> catalog <field> <desc_table>
redefine criteria <name> database <table> <field>

redefine criteria <name> lookup <table> <map_count>

redefine criteria <name> expression <spec_field>

<expression>
redefine criteria <name> text <spec_field>

<default_value>
modify criteria <name> <visibility> <catalog_check>

<modifiable> <default_operator>
define rule <group> <use_default_operator> if <name1>

<oper1> <expr1> then <name2> = <expr2>
define assignment <name> = <expression>
rename criteria <old_name> <new_name>

order criteria <name> <priority>

delete criteria <name>
Where Means
<catalog_check> One of {true false} indicating whether to
perform
catalog value checks
<default_operator> One of { = ! @ ! @ < < = > > = ( ) ( ] [ ) [ ] }
indicating the default operator
<default_value> A string indicating the default text for text-type
criteria
<desc_table> A string indicating a description table in the
database
<expression> A string containing a valid JSpace expression
<field> A string indicating a field in the catalog table
<group> A number indicating the rule group
<link_fields...> A sequential list of strings indicating fields in the
catalog table
<map_count> A number indicating the count of lookup source
and link fields
<modifiable> One of {true false} indicating whether users can
modify the default operator
<old_name> A string indicating the old criterion name
<name> A string indicating a criterion name
<new_name> A string indicating the new criterion name
<oper1> One of { } indicating the type of test to perform
<output_field> A string indicating a field in the lookup table
containing the data
<priority> A number indicating the position of the
criterion
<source_fields...> A sequential list of strings indicating fields in the
lookup table

Where Means
<spec_field> A string indicating a field in the specification
table
<table> A string indicating a table in the database
<use_default_operator> One of {true false} indicating whether to use
the default operator for the criterion
<visibility> One of {true false} indicating whether to
display the criterion in guideline view
➤ To convert Spec Maker 2.0 data

1. In the Spec Maker window, choose Tools>Convert Specification
Data from the menu bar.
The Convert Specification Data dialog box is displayed.
2. Click the first Browse button at the top.

3. In the Select Data File to Convert dialog box, select Spec Maker
2.0 Files (*.spe, *.spt) in the Files of type drop-down list box.
4. Select an SPE or SPT file on your hard drive and click Open.
The default directory where Design Series 2.0 placed SPE and SPT
files is ...\PltSpace\psdesign\SpecMakr.
The Convert Data dialog box is redisplayed with the old file name
and the new proposed output file name.
✍ You can change the proposed output file name if you want by
clicking the Browse button beside the Output File field and
selecting a different file.

Procedures for Viewing the Project Specification File
5. Optionally, to change the Design Series database table format to a

different format, click the drop-down list box for this field and
select the format.
6. Optionally, to change the script file to be processed during
conversion, click the Browse button by the Script file field and
select the file.
7. Optionally, to database source of the output file, click the Select
button by the Database Source field and select a different source.
8. Click OK.
The progress dialog box describes the stages of the conversion
process. After a few minutes, the new converted file is displayed in
its project window, as shown in the example.

✍ Before you begin to add new specs or edit existing specs, it would be helpful to
understand the various ways that you can view a project specification file.
You can view various aspects of the file in the following ways by:
• Moving through the levels of the tree structure

• Selecting view options on the tool bar, menu bar, and popup menu

Moving Through Levels of the Tree Structure
• Manipulating the project window
Moving Through Levels of the Tree Structure

Spec Maker uses an interface similar to Windows Explorer, with tree panes showing
the tree structure on the left side and list panes on the right side. A plus (+) sign
beside an item in a tree pane indicates that more data is at a lower level. You can
view the lower level data by clicking a plus sign. At this point, the plus sign changes
to a minus (-) sign indicating that all the data at the lower level is displayed. Clicking
the minus sign closes the lower level of data and the sign becomes a plus sign. The
items displayed in the list panes depend on the currently selected tree item and the
current view option that you select.
Selecting View Options on the Tool Bar, Menu Bar, Popup Menu, and
Keyboard
The same view options are available on the View tool bar, the View menu on the
menu bar, and the popup menu displayed when you right-click an item in a tree
pane. You can also use a combination of keys on the keyboard.
Viewing All Specs or All Component Types in a Project
You can view the project from the perspective of:
• All specs in a project

• All component types in a project
➤ To view all specs in a project

1. In a tree pane, select Project.
• Click the View as Project Specifications tool on the View tool bar.
• Right click the mouse button on Project and select View as Project
Specifications from the popup menu.
• Choose View>Project Specifications from the menu bar.
• Press <Ctrl+1>.

All the specs in the project are displayed.
✍ When a procedure says to display the spec view, refer to this procedure.
➤ To view all component types in a project

1. In a tree pane, select Project.
• Click the View as Project Component Types tool on the View tool
bar.
• Right-click the mouse button on Project and select View as Project
Component Types from the popup menu.
• Choose View > Project Components from the menu bar.
• Press <Ctrl+2>.

Selecting View Options on the Tool Bar, Menu Bar, Popup Menu, and Keyboard
All the component types in the project are displayed.
✍ When a procedure says to display the component view, refer to this procedure.
Viewing Specs
You can view a spec from the perspective of:
• Active component types associated with a spec

• Spec definition
➤ To view the active component types associated with a spec

1. Display the spec view in a tree pane, and select a spec.
✍ Displaying the spec view was explained in the procedure “To view
all specs in a project” on page 7-31.
✍ Be sure that the spec is selected.
• Click the View Active Component List tool on the View tool bar.
• Right-click the mouse button on the spec and select View Active
Component List from the popup menu.
• Choose View>Active Component List from the menu bar.
• Press <Ctrl+3>.

The active component types in that spec are displayed in the list
pane. You can view the active component types associated with
other specs by selecting another spec in the tree pane.
➤ To view a spec definition

1. Display the spec view in a tree pane, and select a spec.
✍ Displaying the spec view was explained in the procedure “To view
all specs in a project” on page 7-31.
✍ Be sure that the spec is selected.
• Click the View Specification Definition tool on the View tool bar.
• Right-click the mouse button on the spec, and select View
Specification Definition from the popup menu.
• Choose View>Specification Definition from the menu bar.
• Press <Ctrl+4>.

The spec definition is displayed in the list pane. You can view the
definitions for other specs by selecting another spec in the tree
pane.
Viewing Component Types
You can view a component type from the perspective of:
• Active specs associated with a component type

• Catalog selection criteria
• Database table fields
• Component definition
➤ To view the active specs associated with a component type

1. Display the component view in a tree pane, and select a component
type.
✍ Displaying the component view was explained in the procedure
“To view all component types in a project” on page 7-32.
✍ Be sure that the component type is selected.
• Click the View Active Specification List tool on the View tool bar.
• Right-click the mouse button on the component type and select View
Active Specification List from the popup menu.
• Choose View>Active Specification List from the menu bar.
• Press <Ctrl+5>.

The active specs associated with the component type are displayed
in the list pane. You can view the active specs associated with other
component types by selecting another component type in the tree
pane.
➤ To view the catalog selection criteria

type.
• Click the View Component Criteria tool on the View tool bar.
Component Criteria from the popup menu.
• Choose View>Component Criteria from the menu bar.
• Press <Ctrl+6>.

The criteria are displayed in the list pane. You can view the criteria
for other component types by selecting another component type in
the tree pane.
➤ To view database table fields

type.
• Click the View Database Table Fields tool on the View tool bar.
Database Table Fields from the popup menu.
• Choose View>Database Table Fields from the menu bar.
• Press <Ctrl+7>.

The database table fields are displayed in the list pane. You can view
these fields for other component types by selecting another
component type in the tree pane.
➤ To view the component definition

type.
• Click the View Component Definition tool on the View tool bar.
• Right-click the mouse button on the component type, and select View
Component Definition from the popup menu.
• Choose View>Component Definition from the menu bar.
• Press <Ctrl+8>.

The component definition is displayed in the list pane. You can view
the definitions for other component types by selecting another
component type in the tree pane.
Viewing Guidelines
You can view guidelines individually or as a group.
➤ To view guidelines individually

1. Display the spec view or the component view in a tree pane.
✍ Displaying the spec view was explained in the procedure, “To view
all specs in a project” on page 7-31. Displaying the component view
was explained in the procedure, “To view all component types in a
project” on page 7-32.
• If you selected the spec view, click the plus (+) sign by a spec and then
the plus sign by a component type.
• If you selected the component view, click the plus (+) sign by a
component type and then the plus sign by a spec.
The guidelines for the component type are displayed.
3. Select a guideline in the tree pane.

The criteria values for the selected guideline are displayed in the list
pane.
Spec View
Component View
4. To view the criteria values for other guidelines, select another

guideline in the tree pane.
✍ When a procedure says to view guidelines individually, refer to this procedure.
➤ To view guidelines as a group

1. Depending on the whether you are in the spec view or component
view, perform one of the following operations:
• Select a spec associated with a component type.
• Select a component type associated with a spec.

Manipulating the Project Window
The guidelines as a group are displayed in the list pane.
Spec Associated with a Component Type
Component Type Associated with a Spec
✍ The check mark beside a guideline means that the guideline was
synchronized in your project database. Synchronization of
guidelines is explained in Synchronizing and Unsynchronizing
Guidelines in Working with Piping Specifications in the PlantSpace Design
Series User help.
2. To view other guidelines in the list pane, select another component
type associated with a spec.
✍ When a procedure says to view guidelines as a group, refer to this procedure.
Manipulating the Project Window

Using the standard Windows operations, you can manipulate a project window by
resizing it, resizing the panes, displaying all four panes, or displaying only two panes
(both upper panes, both lower panes, both left panes, or both right panes).
➤ To resize a project window and panes

1. To resize the project window, pass the mouse pointer along the
outside borders of the project window and when the pointer
changes to a double-headed arrow, drag the borders to the size you
want.
2. Resize a pane by dragging the inside border between the two panes.

Procedures for Customizing the Display of the Spec Maker Interface
➤ To display the four panes of a project window

1. Place the mouse pointer on the lower border of the title bar in the
project window.
2. When the mouse pointer changes to a double-headed arrow, drag
down.
The lower two panes display the current view that you were using.
The upper two panes can be used to view spec data from a different
perspective.
Procedures for Customizing the Display of the Spec Maker

Interface
Once you view the interface, you can decide if you want to change the display of the
interface. The available options are:
• Display the status bar

• Display, move, and enlarge the tool bars
• Display dimensions in imperial or SI (metric) units

Displaying the Status Bar
Displaying the Status Bar

The status bar at the bottom of the Spec Maker window displays various
information related to the Spec Maker application. For example, when you pass the
mouse button over a tool, the status bar displays more detailed information than the
tool text.
➤ To display or hide the status bar

1. Choose the View menu on the menu bar.
By default setting, the Status Bar menu item is check marked to
display it.
2. To hide the status bar, select Status Bar to remove the check mark.
3. To redisplay the status bar, select it again.
The check mark is redisplayed.
Displaying, Moving, and Enlarging the Tool Bars

The Main, Element, View, and Database tool bars, by default setting, are docked
under the menu bar.
You can hide them, move them to a different location, and enlarge their icons.
➤ To display or hide the tool bars

1. Choose View>Tool Bars from the menu bar.
2. Click the arrow by Tool Bars to display the cascaded menu.
By default setting, the tool bars are check marked to display them.
3. To hide a tool bar, select it to remove the check mark.
4. To redisplay the tool bar, select it again.
The check mark is displayed.

➤ To move the tool bars to a different location
✍ You can move the tool bars anywhere in the Spec Maker window and dock
them to all fours sides of the window.
1. Drag the border of a tool bar to a blank area in the Spec Maker
window.
2. To dock the tool bars to any side of the Spec Maker window,
position the tool bar to the side of the Spec Maker window where
you want it.
They automatically lock into place under the menu bar or along the
left, right, or bottom borders.
➤ To enlarge the icons on the tool bars

1. Choose View>Tool Bars from the menu bar.
2. Click the arrow by Tool Bars to display the cascaded menu.
3. Select Show Large Icons.

A check mark is displayed on the menu and the icons on the tool
bars are enlarged.
4. To return to the icons to their original size, select Show Large
Icons again to remove the check mark.
Displaying Dimensions in Imperial or SI (Metric) Units

When you display criteria for dimensions, you can display the dimensions in imperial
or SI units. With a mouse click you can switch back and forth between the two
displays.
First, you as the administrator must add SI lookup entries so that the system reads
the dimensions from the appropriate database tables. Once you add an SI lookup
entry, you can also copy, edit, or delete it.

➤ To add an SI (metric) lookup entry

1. Choose Tools>Options from the menu bar.
The Options - SI (metric) Lookup dialog box is displayed.
2. Select the SI (metric) Lookup tab if it is not already displayed, and

click the Add button.
The Add SI (metric) Lookup dialog box is displayed.
3. In the Property Name field, type the exact name of the dimension
criterion that needs to be displayed in both imperial and SI units
(for example, Length).
W The property name must match the criterion name.

4. Select a conversion table, imperial unit field, and SI (metric) unit

field, as follows:
Field Description
Conversion Table Database table containing conversion information
Imperial Unit Field Database table field name for imperial units
SI (metric) Unit Field Database table field name for SI units
The following fields show sample selections:
5. Click OK.
The property names are listed in the list box of the SI (metric)
Lookup tab.
➤ To copy, edit, or delete an SI (metric) lookup entry

1. To copy an SI (metric) lookup entry:
a. Select a property name (for example, Length) and click the Copy
button.
b. Click the Paste button.

The copied entry is displayed in the list box.
2. To edit an SI (metric) lookup entry, select an entry and click the

Edit button.
The Edit SI (metric) Lookup dialog box is displayed.
3. Make any changes necessary and click OK.

4. To delete an SI (metric) lookup entry, select an entry and click the
Delete button.

A confirmation message is displayed.
5. Click Yes to delete the setting or No to keep it.
➤ To display dimensions in imperial or SI (metric) units
✍ The dimensional unit settings must first be entered in the system, as explained
in the previous procedures.
1. Display a guideline.
2. Choose the View menu from the menu bar.
3. To display dimensions in SI (metric) units, select Display SI
(metric) Units.
The SI (metric) units are displayed, as shown in the example.
4. To display the dimensions in imperial units, select Display

Imperial Units.
The imperial units are displayed, as shown in the example.
✍ The Database Lists tab is used to work with rule files that affect component
types. This topic is covered in the section “Customizing the Rules in Database
Lists” on page 7-56.

Procedures for Setting Up a Project Specification File

✍ Before you begin, be sure that you have set up your project database and
defined the data source in Chapter 1 of the Model Control System (MCS) Guide on
the TriForma Help menu or in the ...\Bentley\Documentation directory.
Typically, each team or department of your engineering company will set up all the
specs in one project. Spec Maker sets up one project specification (s71, SPE, or
SPT) file for each project. Spec Maker also provides a mechanism for using an
existing specification file as a basis for creating other specification files. The process
of setting up a project specification file involves the following stages:
• Creating a new file

• Optionally assigning administrator and user passwords to the file
✍ If you set up an empty file (one not based on an existing specification file), you
will then need to add the specs, component types, guidelines, and criteria. Refer
to the appropriate sections for the procedures.
Creating a New File

Spec Maker provides the option of using any existing specification (s71, SPE, or
SPT) file as the basis or seed for a new specification file. Creating a new
specification file without a seed file results in a totally empty specification file.
Specifications, component types, guidelines, and criteria need to be added to an
empty specification file. Seed files act as a storage file for initial data (specifications,
component types, guidelines, and criteria) for new project specification files. Data
from the seed files are copied over to the new specification file.
Efficient Use of Seed Files
Typically, you as the administrator set up a single seed file for use with several new
project specification files. For example, if your company is tasked to develop
multiple plants or sections of a plant for different customers, you would want to use
the same specifications. If an existing specification file contains all the specs you
want, you can save it as a seed file for safekeeping. You can then create new
specification files based on your archived seed file.
Files That Can Be Used As Seed Files
Spec Maker supplies the following two files that can be used as seed files:
• PSDesign.s71

A complete, sample project file with specs specifically made for use
with the PlantSpace Design Series QuickStart Guide
• CompDefn.s71
A project file containing only component definitions designed to
work with the default PlantSpace database
Guidelines on Working with Spec Files and the Database
W The following guidelines are important to follow in working with the

spec files and the database:
• Every Spec Maker file draws its data from a data source, as
explained in the following procedures.
• Recommendation: Different project spec files should use different
databases as their data source.
• Avoid making a copy of a project spec file through Windows
Explorer because the link to the data source that you set up in the
original project spec file will be retained in the copy.
• Instead, if you want to re-use the contents of a project spec file to
work on another project, create a new (empty) project spec file.
Then specify the data source, and copy and paste the contents from
the original file into the new one. Alternatively, you can use seed
files, as described in the following procedures.
➤ To create a new specification file

• Click the New tool on the main tool bar.
• Choose File>New from the menu bar.
• Press <Ctrl+N>.

Creating a New File
The New dialog box is displayed.
2. Type the name in the New File Name field, or use the upper
Browse button to specify the drive and directory where you want
the new file to reside.
✍ You can use a long file name. The system will add the s71
extension.
3. Optionally, in the Based on Existing Spec Maker File field, use the
lower Browse button to select the name of the existing file used as a
basis for the new file.
4. To select which database source that you want for the new
specification file, click the Select button.

The Select Data Source dialog box is displayed.
5. Click the appropriate data source tab and select the appropriate data
source for your new specification file.
6. Click OK in the Select Data Source dialog box.
7. Click OK in the New dialog box.
The project window is displayed with the new specification file
name in the title bar
✍ If you selected an existing Spec Maker file as the basis for your
new specification file, the new file will have a copy of the
specifications, component types, guidelines, and criteria stored in
the seed file.
Once the file is set up, you can assign a password and add the specs,
component types, guidelines, and criteria.

Assigning, Entering, Changing, and Resetting a Password on the Project Specification File
Assigning,Entering,Changing,andResettingaPasswordontheProject
Specification File
Spec Maker provides the option to password protect the project spec file at two
levels: user level and administrator level. The following table shows the various
operations that can be password protected, and their password level requirement.
Administrator
Operation User Level
Level
Change passwords Not Allowed Allowed
Create new specifications Allowed Allowed
Change specification approval status Allowed Allowed
Delete specifications Allowed Allowed
Create new component types Allowed Allowed
Delete component types Not Allowed Allowed
Create new criteria Not Allowed Allowed
Change criteria definitions Not Allowed Allowed
Delete criteria definitions Not Allowed Allowed
Create new guidelines Allowed Allowed
Change guideline values Allowed Allowed
Delete guidelines Allowed Allowed
Synchronize/unsynchronize Allowed Allowed
Clear spec tables Not Allowed Allowed
Change ODBC data source Not Allowed Allowed
If you have administrator privileges, you can change the password whenever
necessary.
✍ If you forget your password, you can clear the password protection by opening
your specification file in the JSpace Class Editor and clearing out the values in
the ZZ_JSPACE_SYSTEM_ID property of the Project object.
➤ To assign a password
✍ Passwords are optional. However, if you decide to use them, they then become
required to perform certain operations.

1. From the menu bar in the Spec Maker window, choose

Tools>Assign Password.
The Assign Password dialog box is displayed.
2. Type a password in the Password and Confirm fields of the User

Level group.
3. In the Administrator Level group:
• To use the same password used for the User Level, select the Same as
User Level Password check box.
• To use a different password, type the password in the Password and
Confirm fields.
4. Click OK.
Entering a Password
If a password dialog box is displayed when you try to perform an operation such as
deleting a guideline, it means that you have assigned passwords on the specification
file (as explained in the previous section). You must then enter a password before
you can continue.

Procedures for Working with Component Types
➤ To enter a password
1. If the Password dialog box is displayed, type a password.
2. Click OK.
Spec Maker only requires the password the first time you perform a
password-protected operation. Once you have entered a correct
password, the next time that you perform a password-protected
operation, you do not have to re-enter the password.
➤ To change the password

1. Choose Tools>Change Password from the menu bar.
✍ You can tell at a glance if passwords were assigned because Assign
Password on the Tools menu becomes Change Password.
2. In the Change Password dialog box, follow the steps in the previous
procedure to type new passwords and click OK.
➤ To reset the password check status

Choose Tools>Reset Password Check Status from the menu bar.
Spec Maker now acts as if the password has not yet been checked. Therefore, if a
user then performs an operation requiring a password, Spec Maker will request that
the user enter the project password. This feature enables administrators to
temporarily have unrestricted access on a user’s workstation that should not have
unrestricted access.

Working with component types involves the following operations:
• Customizing the rules in database lists

• Creating a new component type

• Associating a spec with a component type

• Deleting component types
• Copying and moving component types
• Renaming component types
Customizing the Rules in Database Lists

Before you add a new component type, you may want to customize the rules that
affect component types. Spec Maker provides options to customize the rules in the
database lists, which consist of the following:
• Catalog tables
• Database tables
The catalog and specification tables are used in creating component types. All four
tables are used in creating criteria. You can add, edit, copy, paste, reorder, and delete
the rules.
➤ To add a rule to a database list

1. From the menu bar, choose Tools>Options.
2. In the Options dialog box displayed, select the Database Lists tab.
The rules for the selected table are displayed in the list box.

Customizing the Rules in Database Lists
3. In the List Type field, select one of the following tables from the
drop-down list box:
• Catalog tables
• Database tables
4. Click the Add button.
The Add Rule dialog box is displayed for the appropriate table.
5. At the Action Type field, select one of the following:

• Exclude (to exclude any tables containing the search text)
• Include (to include any tables containing the search text)
• Include all remaining tables
6. At the Search Type field, select either:
• Partial text (which returns all rules that contain the partial text anywhere
in the text string)
• Whole text (which returns only rules that are an exact match on the
entire text)
7. At the Search Text field, type all or part of the text you want to
search on.
✍ This field is case sensitive. The letters must be typed exactly as
they are defined in your database.
8. Click OK.

The new rule is added at the end in the list box.
➤ To edit a rule in a database list

1. In the Options dialog box, select a database list.
2. Select a rule in the list box and click the Edit button.
The Edit Database List dialog box is displayed.
3. Edit the appropriate fields and click OK.
➤ To copy and paste a rule

2. Select a rule in the list box and click the Copy button.
3. Perform one of the following:
• To paste the rule into the same list, click the Paste button.
• To paste the rule into a different database list, select the database list and
click Paste.
The copy is placed at the end of the list.
✍ If you paste a rule into a list containing a rule for the same search
text, the name of the copied rule starts with "Copy of". As in
Windows Explorer, this feature helps you tell the copy apart from
the original.

Creating a New Component Type
➤ To reorder rules
2. Select a rule in the list box.
3. Click the up and down arrows as appropriate.
✍ Spec Maker processes rules in a top-to-bottom order.
➤ To delete a rule in a database list

2. Select a rule in the list box and click the Delete button.
The appropriate confirmation message is displayed.
3. Click Yes to delete the rule or No to keep it.
Creating a New Component Type

Once you set up your specification file, you can create new component types to add
to it.
➤ To create a new component type

1. Display the component view in a tree pane.
2. Select Project.
✍ Be sure that Project is selected.
• Click the Create New Component Type tool on the Element tool bar.
• Right-click the mouse button on Project, and select Create New
Component Type from the pop-up menu.

• Choose Element>Create New Component Type from the menu bar.

• Press <Ctrl+Alt+C>.
The Create New Component Type dialog box is displayed.
4. Type a component type name (for example, Eccentric Reducers).

5. Select a catalog table.
✍ For details on the catalog tables, see the section “Customizing the
Rules in Database Lists” on page 7-56.
6. Select a specification table.
Spec Maker selects specification tables by appending _SPEC to the
catalog table name.
✍ For details on the specification tables, see the section “Customizing
the Rules in Database Lists” on page 7-56.
7. Click OK.
A confirmation message indicates that the component type is
created. The new component type is placed in alphabetical order
within the component types in the tree pane.
Typically you would next add new criteria, associate the new
component type with a spec, and add guidelines for the component
type. See the appropriate sections for these procedures.
Associating a Spec with a Component Type

Guidelines can be created only after associating a spec with a component type.
W Make sure that the component type is not related to an approved spec.
Spec Maker does not allow changes to be made to approved specs.

Deleting Component Types
➤ To associate a spec with a component type

1. Display the component view and select a component type.
• Click the Select Active Items tool on the Element tool bar.
• Right-click the mouse button on the selected component type and select
Select Active Specifications from the popup menu.
• Choose Element>Select Active Specifications from the menu bar.
The Select Active Specifications for the selected component type
dialog box is displayed.
3. Transfer items to and from the active and inactive lists to associate
or disassociate them from the selected component type.
4. Click OK.
Deleting Component Types

The Delete operation follows the standard Windows operations. You can delete a
component type in a variety of ways.
W Deleting a component type also deletes all of its criteria and any
associated specifications and their guidelines. Make sure that the
component type is not related to an approved spec. Spec Maker does
not allow changes to be made to approved specs.

➤ To delete a component type

2. Select the component type in a tree pane or list pane that you want
to delete.
• Click the Delete tool on the Main tool bar.
Delete Component Type from the popup menu.
• Choose Edit>Delete from the menu bar.
• Press <Del>.
The following confirmation message is displayed.
4. Click Yes to delete or No to cancel the deletion.
Copying and Moving Component Types

Spec Maker uses a mechanism similar to Windows Explorer for its Copy and Move
(cut and paste) operations. Spec Maker recognizes the standard Windows keyboard
shortcuts <Ctrl+C> for copy, <Ctrl+X> for cut, and <Ctrl+V> for paste. Spec
Maker also supports the drag-and-drop technique to copy and move component
types.
Similar to Windows Explorer, Spec Maker does not remove a "cut" object until a
successful "paste" operation is performed. Spec Maker maintains its own internal
clipboard for storing copied Spec Maker objects. Spec Maker checks the type of
objects stored in its internal clipboard and enables or disables the Paste command
accordingly.
✍ Component types can be pasted only when the project object is highlighted in
the tree pane.

Copying and Moving Component Types
Component types can be copied and pasted:
• Within the same project

• To another project
✍ Pasting a component type also includes the criteria associated with the copied
component type.
➤ To copy or move a component type

• Select a component type in a tree pane.
✍ You can select only one component type at a time in tree panes.
• Select one or more component types in a list pane.
✍ You can use the standard Windows operations by holding down
the Shift key to select all component types that are together, or by
holding down the Ctrl key to select component types that are
apart in a list pane.
2. To copy one or more component types, perform one of the
following operations:
• Click the Copy tool on the Main tool bar.
• Right-click the mouse button on the component types and select Copy
Component Type from the popup menu.
• Choose Edit>Copy from the menu bar.
• Press <Ctrl+C>.
3. Select the Project where you want to paste the component types.
4. Paste the component types by performing one of the following
operations:
• Click the Paste tool on the Main tool bar.
• Right-click the mouse button on Project in a tree pane, or anywhere in a
list pane, and select Paste Component Types from the popup menu.
✍ The Paste Component Type popup menu item is displayed only
when the highlighted object in the tree pane is Project and the
list pane is in the View as Project Component Types mode.
• Choose Edit>Paste from the menu bar.

• Press <Ctrl+V>.
✍ The component type is displayed with "Copy of" in front of the
name if it is the same name as another component type within the
target project. As in Windows Explorer, this feature helps you tell
the copy apart from the original.
5. To move component types, select the component types and
perform one of the following operations to first cut the component
types:
• Click the Cut tool on the Main tool bar.
• Choose Edit>Cut from the menu bar.
• Press <Ctrl+X>.
6. Select the Project where you want the component types moved and
paste them.
7. To use drag-and-drop to copy component types, select the
component types and drag them to the Project object.
The cursor changes to an arrow with a small plus sign (+) indicating
that the paste operation is valid.
If a paste operation is not valid, the cursor changes to a circle with a
slash across it.
Renaming Component Types
➤ To rename a component type

1. Display the component type view in a tree pane.
✍ Displaying the spec view was explained in the procedure, Viewing
All Specs or All Component Types in a Project.
2. Select Project.
3. In the Component Name column of the list pane, double-click the
row of the component type that you want to rename.
4. Type the new name and press <Enter>.

Procedures for Working with Criteria

Working with criteria involves the following operations:
• Creating criteria for a component type

• Reordering criteria
• Setting criteria properties
• Deleting criteria
• Copying and moving criteria
• Renaming criteria
Creating Criteria for a Component Type

Once you add new component types you would typically define criteria for that
component type. Component types can have several criteria. Spec Maker provides
five types of criteria:
• Catalog table field

• Database table field
• Database table lookup
• JSpace expression
• Text input
Each of these five criteria types are detailed in the following procedures.
➤ To create a new criterion

2. Select a component type in the tree pane.
• Click the View Component Criteria tool from the View tool bar.
View Component Criteria from the popup menu.
• Choose View >Component Criteria from the menu bar.

• Press <Ctrl+6>.
• Click the Create New Criterion tool in the Element tool bar.
• Right-click the mouse button on the selected component type, or
anywhere in a list pane, and select Create New Criterion from the
popup menu.
• Choose Element>Create New Criterion from the menu bar.
• Press <Ctrl+Alt+R>.
The Create New Criterion dialog box is displayed for the selected
component type.
5. Type a criterion name.

6. Select one of the following criterion types:
• Catalog table field
• Database table field
• Database table lookup
• JSpace expression
• Text input
✍ Each criterion type is explained in more detail in the procedures
that follow.
Continue to the next appropriate procedure.

Catalog Table Field Criterion
A catalog table field criterion enables you to create guidelines based on the values
stored in the catalog table for a particular component type. For example, the
database table PIPE_PELB stores catalog data for standard elbows. One of the
fields in the PIPE_PELB table is EPREP1. This field stores the end preparation
data for a standard elbow. For the EPREP1 field, a catalog table field criterion type
is applicable.
➤ To define a catalog table field criterion

1. In the Create New Criterion dialog box, select Catalog Table Field
as the criterion type, as shown in the example.
2. Select a catalog field.

3. Optionally, select a description table that will map the catalog field
codes to recognizable text (for example, BW would become BUTT
WELD).
4. Click OK.
Database Table Field Criterion
A database table field criterion enables you to create guidelines based on values
stored in any table in the project database. For example, Material Standard is a
database table field criterion that applies to most component types. The database
table containing this information is the MATERIAL_DATA table. The field in this
table containing the required information is MAT_STD.

➤ To define a database table field criterion

1. In the Create New Criterion dialog box, select Database Table
Field as a type of criterion.
The Create New Criterion dialog box is displayed, as shown in the
example.
2. Select a database table.

3. Select a database field.
4. Optionally, select a description table that will map the catalog field
codes to recognizable text (for example, BW would become BUTT
WELD).
5. Optionally, select a specification field to place the database field data
into the specification table.
6. Click OK.
Database Table Lookup Criterion
A database table lookup criterion enables you to create guidelines based on the
lookup value stored in any table in the project database relevant to a catalog table
field. For example, a common database table lookup operation pertains to
converting imperial units to SI units. For example, the lookup input field in the
catalog table that you may want to convert is SIZE_1. The database table containing
this conversion information is the PIPE_DIAMETER table. The lookup link field
in the PIPE_DIAMETER table containing similar values to the SIZE_1 field is

ENGLISH_OD. The lookup output field in the PIPE_DIAMETER table

containing the required SI conversion is METRIC_OD.
➤ To define a database table lookup criterion

1. In the Create New Criterion dialog box, select Database Table
Lookup as a type of criterion.
The Create New Criterion dialog box is displayed, as shown in the
example.
2. Select a database table.

3. Select the plus (+) sign by the Lookup Source Fields list box.

The Select Lookup Source Fields dialog box is displayed.
4. Select a field and click OK.

The field is displayed in the list box, as shown in the example.
5. Add more fields as needed.
6. Order the lookup source fields by clicking the arrow buttons to the
immediate right of the Lookup Source Fields list box.
These fields are the fields in the catalog table that contain the values
that you want to use to perform the lookup.
7. In the same manner, select and order a lookup link field by clicking
the buttons by that list box.
These fields are the fields in the database table specified in step 2
that you want to match with the corresponding lookup source fields
specified in steps 3 to 6.
✍ The number of lookup source fields must equal the number of
lookup link fields.
8. Select a lookup output field.
This field specifies the field in the database table specified in step 2
that contains the required values for this criterion.
9. Optionally, select a specification field to place the database field data
into the specification table.
10. Click OK.

JSpace Expression Criterion
A JSpace expression criterion enables you to create guidelines based on value

resulting from a JSpace expression. For example, Long Description 1 is a JSpace
Expression criterion that is applicable to most component types. This description
text is usually a concatenation of various properties of the guideline data.
Spec Maker uses two new JSpace functions:
• CRITERIA_VALUE (criteria_name)
where criteria_name is a string enclosed in quotation marks.
✍ The variable criteria_name is case sensitive. It must be identical in
upper and lower case letters to the criteria name you created.
Use this function to define a single value for a criterion. This
function returns the specified value of the guideline criteria that
have the same name as criteria_name.
For example, see the value A105 for the Material Code criterion
below. The expression CRITERIA_VALUE("Material Code")
returns the value of A105.
• DB_ROW_VALUE (criteria_name)
where criteria_name is a string enclosed in quotation marks.
✍ The variable criteria_name is case sensitive. It must be identical in
upper and lower case letters to the criteria name you created.

Use this function to get the current value associated with the
criterion when more than one value is defined in the guideline. This
function returns the value of the criterion evaluated for the current
row of data.
For example, the Bend Angle criterion below selects the ten rows
shown from the PIPE_PELB table. The expression
DB_ROW_VALUE("Bend Angle"):
• Has the value of 90 when the "source" row is one of the first five rows
• Has the value of 45 when the "source" row is one of the last five rows
➤ To define a JSpace expression criterion

1. In the Create New Criterion dialog box, select JSpace Expression
as the type of criterion.
2. Type a JSpace expression, such as the following example:
CRITERIA_VALUE ("Material Standard")

✍ Expressions are case sensitive.
3. Optionally, select a specification field to place the result of the

JSpace expression into the specification table.
4. Click OK.
Text Input Criterion
A text input criterion enables you to create guidelines based on text input gathered
from the user. You can optionally specify a default value for this criterion.
➤ To define a text input criterion

1. In the Create New Criterion dialog box, select Text Input as a type
of criterion, as shown in the following example.
2. Optionally, specify a default value.

3. Optionally, select a specification field to place the text input into the
specification table.

4. Click OK.
Reordering Criteria
Criteria depend on one another in a linear fashion. The higher-level criteria in the
criteria order constrain the values for their lower-level criteria.
➤ To reorder criteria
• Click the View Component Criteria tool in the View tool bar.
• Press <Ctrl+6>.
• Click the Reorder Criteria tool on the Element tool bar.
• Right-click the mouse button on the selected component type, or
anywhere in the tree pane, and select Reorder Criteria from the popup
menu.
• Choose Element>Reorder Criteria from the menu bar.

Setting Criteria Properties
The Reorder Criteria dialog box is displayed.
5. Move the various criteria by selecting a criterion in the list box and
clicking the up or down buttons.
6. Click OK.

Every criterion of a component type has four minor properties:
• Visible in guideline view

• Perform catalog table check
• Modifiable comparison operator
• Default comparison operator
These properties control the behavior of the criteria for a specific guideline.
W Make sure that the criterion is not related to an approved spec. Spec
Maker does not allow changes to be made to approved specs.
➤ To set the criteria properties


• Click the Component Criteria tool in the View tool bar.

• Press <Ctrl+6>.
4. Select one criterion, or multiple criteria by using the Windows
standard:
• By holding down the Shift key to select multiple criteria that are together
• By holding down the Ctrl key to select multiple criteria that are apart
• Click the Change Criteria Properties tool in the Element tool bar.
• Right-click the mouse button on the selected list of criteria in the list
pane, and select Change Criteria Properties from the popup menu.
• Choose Element>Change Criteria Properties from the menu bar.
The Change Properties dialog box for the selected criteria is
displayed.
6. Select or deselect the check boxes by the available properties.

✍ If a check box contains a gray check mark, it means that the
selected criteria contain conflicting settings for that property. If
you deselect the check box in this dialog box, the property will be
deselected for all the highlighted criteria. Likewise, if you select
the check box in this dialog box (displayed as a black check mark),
this property will be selected for all the highlighted criteria.

7. To change the operator displayed on the button by the Default

Comparison Operator field, click it.
✍ If the button by the Default Comparison Operator field is blank,
it means that two or more selected criteria contain differing
operators. You need to click the button to select an operator that
is common to all the selected criteria.
The following is a list of all the available operators that you can
select to apply to one or more selected criteria. The ones displayed
vary depending on the selected criteria.
Operator Relationship
Is Equal To
Is Not Equal To
Is An Element Of A List
Is Not An Element Of A List
Is Less Than
Is Less Than Or Equal To
Is More Than
Is More Than Or Equal To
X is in range, Low Exclusive, High
Exclusive
X is in range, Low Exclusive, High
Inclusive
X is in range, Low Inclusive, High
Exclusive
X is in range, Low Inclusive, High Inclusive
8. Click the operator that you want to apply to one or more selected
criteria.
9. Click OK.

Deleting Criteria
The Delete operation follows the standard Windows operations. You can delete a
criterion in a variety of ways.
W Deleting a criterion also deletes any guideline constraints that use that
criterion. Make sure that the criterion is not related to an approved spec.
➤ To delete a criterion
• Press <Ctrl+6>.
standard:
• Click the Delete tool on the Main tool bar.
• Right-click the mouse button on the selected criterion and select Delete
Criteria from the popup menu.
• Choose Edit>Delete from the menu bar.
• Press <Del>.

Copying and Moving Criteria
The following confirmation message is displayed.
6. Click Yes to delete or No to cancel the deletion.
Copying and Moving Criteria

Spec Maker uses a mechanism similar to Windows Explorer for its Copy and Move
(cut and paste) operations. Spec Maker recognizes the standard Windows keyboard
shortcuts <Ctrl+C> for copy, <Ctrl+X> for cut, and <Ctrl+V> for paste. Spec
Maker also supports the standard Windows drag-and-drop technique to copy and
move criteria.
Similar to Windows Explorer, Spec Maker does not remove a "cut" object until a
successful "paste" operation is performed. Spec Maker maintains its own internal
clipboard for storing copied Spec Maker objects. Spec Maker checks the type of
objects stored in its internal clipboard and enables or disables the Paste command
accordingly.
✍ Criteria can only be pasted when a component type is highlighted in the tree
pane.
Criteria can be copied and pasted:
• Within the same component type

• To another component type
• To another component type in another project file
➤ To copy or move a criterion


• Press <Ctrl+6>.
standard:
5. To copy one or more criteria, perform one of the following
operations:
• Click the Copy tool on the Main tool bar.
• Right-click the mouse button on the criteria and select Copy Criteria
from the popup menu.
• Choose Edit>Copy from the menu bar.
• Press <Ctrl+C>.
6. Select the component type where you want to paste the criteria.
7. Paste the criteria by performing one of the following operations:
• Click the Paste tool on the Main tool bar.
• Right-click the mouse button on a component type in a tree pane, or
anywhere in a list pane, and select Paste Criteria from the popup menu.
✍ The Paste Criteria popup menu item is displayed only when the
highlighted object in the tree pane is a component type.
• Choose Edit>Paste from the menu bar.
• Press <Ctrl+V>.
✍ The criterion is displayed with "Copy of" in front of the name if it
is the same name as another criterion within the target
component type. As in Windows Explorer, this feature helps you
tell the copy apart from the original.
8. To move criteria, select the criteria and perform one of the
following operations to first cut the criteria:
• Click the Cut tool on the Main tool bar.

Renaming Criteria
• Choose Edit>Cut from the menu bar.

• Press <Ctrl+X>.
9. Select the component type where you want the criteria moved and
paste them.
10. To use drag-and-drop to copy a criterion, select the criterion in a list
pane and drag it to a component type object in a tree pane.
The cursor changes to an arrow with a small plus sign (+) indicating
that the paste operation is valid.
If a paste operation is not valid, the cursor changes to a circle with a
slash across it.
Renaming Criteria
W Make sure that the criterion is not related to an approved spec. Spec
Maker does not allow changes to be made to approved specs.
➤ To rename a criterion
• Press <Ctrl+6>.
4. In the Criteria column of the list pane, double-click the row of the
criterion that you want to rename.
5. Type the new name and press <Enter>.

Procedures for Maintaining Specifications

On a periodic basis or as the need exists, you may need to perform maintenance
operations on the specifications. Maintaining specifications involves the following
operations:
• Globally updating the names of specs, component types, and

guidelines in the project tree structure
• Clearing spec tables
• Changing the ODBC data source
GloballyUpdatingtheNamesofSpecs,ComponentTypes,andGuidelines
in the Project Tree Structure
If you need to change multiple names of specs, component types, and guidelines in
the project tree structure, you can quickly do so through the global Find and Replace
operation.
✍ This operation cannot be used on names of items in a list pane.
➤ Togloballyupdatethenamesofspecs,componenttypes,andguidelinesin
the project tree structure
1. Select a spec, component type, or guideline that needs to be
updated.
• Click the Find tool on the Main tool bar.
• Choose Edit>Find from the menu bar.
The Find and Replace dialog box is displayed.
3. In the Find what field, type all or part of a name.

Clearing Spec Tables
✍ Spec Maker does not support the use of wild cards such as the
asterisk (*) and question mark (?).
4. In the Options group, select any of the following check boxes:
• Match Whole Line
Searches for only the entire line of text
• Match Case
Searches only for text as typed in upper or lower case letters
5. In the Find where group, select one of the following radio buttons:
• Current Branch Only
• Entire Tree
• Within Original Branch (the branch where you started the search)
6. To find text without replacing it, click the Find Next button and
continue to click the button until all searches are finished.
7. To find and replace text:
a. Select the Replace with check box, and type the text to globally
replace the text in the original name.
b. Click the Replace button to replace each searched text
individually, or click the Replace All button to replace all the text
that applies.
8. When you are finished, click the Close button or the Windows
close (X) icon.
Clearing Spec Tables

If your data in the spec tables becomes corrupted or if you want to start from the
beginning with a clean set of tables, Spec Maker enables you to clear all the spec
tables used by all the component types defined in a spec file.
➤ To clear all spec tables

1. Start Spec Maker if necessary and open a spec file.
2. Choose Database>Clear Spec Tables from the menu bar.

Spec Maker displays the following confirmation message.
3. Click Yes to continue or No to cancel the operation.
Changing the ODBC Data Source

Spec Maker enables you to change the ODBC data source for a particular spec file.
W Changing ODBC data sources can invalidate the synchronization flags

for the various guidelines in the spec file. You must take extreme caution
when you use this capability.
The following is an example of the problem that can occur if you are not careful.
Assume that a spec file has three guidelines: GL1, GL2, and GL3. GL1 and GL2 are
synchronized to data source DB1, but GL3 is unsynchronized with DB1. You then
decide to change the data source to DB2. The three guidelines can retain their
synchronization flags. While still connected to DB2, you unsynchronize GL2 and
synchronize GL3. The guideline flags are now as follows:
• GL1 and GL3 are synchronized.

• GL2 is unsynchronized.
These guideline flags can be retained when you change the ODBC data source back
to DB1. This action now results in invalid synchronization flags for the spec file
pertaining to DB1. The spec file indicates that GL1 and GL 3 are synchronized
whereas the data in the spec tables of DB1 is actually for GL1 and GL2 being
synchronized.
➤ To change the ODBC data source

1. Start Spec Maker if necessary and open a spec file.
2. Choose Database>Change ODBC Source from the menu bar.
3. Click Yes to continue or No to cancel the operation.

Changing the ODBC Data Source
If you selected Yes, the Select Data Source dialog box is displayed.
4. Click the appropriate data source tab and select the new data source
for the spec file.
5. Click OK in the Select Data Source dialog box.
Spec Maker displays the following message.
6. Either:
• Click Yes to mark all guidelines as unsynchronized and to clear all spec
tables tin the new database source.
W If you proceed, the operation cannot be undone.

• Click No to retain the current synchronization settings stored in the
spec file and to retain all the existing data stored in the spec tables of the
new database.
If you clicked Yes, Spec Maker displays the following confirmation
message.
7. Either:
• Click Yes to proceed with clearing all the spec tables for the new
database.
• Click No to leave the spec tables unchanged.

8 Configuring Equipment Modeler
Configuration usually involves the use of JSpace class libraries.
This chapter explains how to configure Equipment Modeler

including Nozzle Manager.
Understanding How to Configure Equipment Modeler

One of the ways to configure the user interface is to use JSpace class libraries
through the JSpace Class Editor application. PlantSpace applications use JSpace
class libraries to store classes and class definitions for the objects used in the
applications.
✍ The detailed discussion of class libraries was covered in the section “Design
Series Class Libraries, Ams.lib and Ams_user.lib” on page 2-5.
Concept of an Equipment Class Definition

Within the modeling environment, PlantSpace Equipment Modeler in Design Series
provides an object-based parametric tool for building equipment. New parametric
equipment definitions can be created to facilitate modeling project equipment
through the object-based parametric tool.
Two tasks are involved in creating parametric equipment definitions:
• Creating a JSpace class definition of the geometries, such as cones,

cylinders, or spheres, to use to create the cell placed in the design
file.
• Creating a MicroStation cell that shows the meaning of the
parameters, such as the length of a pump. This cell is referred to as
the diagram because it may look like the diagram in the
manufacturer’s catalog. This second part is optional, but is
recommended as it should reduce the number of input errors.
✍ For the procedures, see “Procedures for Creating a Parametric Equipment Definition”
on page 8-4.

Understanding How to Configure Equipment Modeler
Equipment class definitions follow the standard JSpace class definition concepts,
along with some special conventions, which are described in this section.
✍ The following information applies only to classes for the Place Equipment
command. For more information on creating a class definition in general, refer
to the Built-In Functions section of the JSpace Concepts and Technical Reference.
The PDF of this book is in the ...\Bentley\Documentation directory created
during the installation of PlantSpace Design Series.
Naming Convention for the Class Name
The class name currently is prefixed with the type of the equipment. For example,
all pump classes start with PUMP. The current list of prefixes is:
Tanks TANK
Pumps PUMP
Heat Exchangers HEX
Desuperheaters DESUP
Deaerators DEAER
✍ This list is defined in the eqpalias.dat file in your ...\{ProjectName}\equip

directory.
Prompt Property
The Place Equipment command enables the user to set the values of properties that
have a source of type Prompt (Prompt properties). Those properties must also have
a fixed source.
If you want the dimension of the Prompt property highlighted in the diagram cell,
then place a unique (for this class) string in parentheses ( ) in the Prompt string. For
example, "Enter diameter of shell (P2):" The diagram cell would have text P2 and
whatever graphics to show the dimension.
Cell Name Property
The $CELLNAME property defines the name of the equipment cell placed. Create
a Fixed property with one source, that is the name of the cell. This will be a name
that PlantSpace understands, or you can use it to separate your equipment types. If
this property is not defined, the system uses the default name.

Configuring Equipment Modeler
Nozzle Manager
Other Properties
The $BUDTYPE property defines the bud type of the equipment cell.
The $DIAGRAM property defines the cell library and the cell name of the diagram
cell.
The $DEFUNITS property defines the units of the default values. Define this
property so that the place equipment command can automatically convert the
default values in the class library to the master units of the design file. This property
is optional considering most class definitions are given default values in the same
units as the design file.
Unit Names
The following unit names are recognized:
Unit Name Unit Name

Unit Name
Abbreviation Symbol
Feet ft '
Inch in "
Millimeter mm
Meter m
✍ If the unit conversion is not used, default values may be entered in

MicroStation (MU:SU:PU) format, but when the unit conversion is used,
default values must be entered as decimal values.
You should create connect points (placement points) with sub-objects of $CLASS
"POINT". At placement, the user can switch the connect point to any zero-length
line in the cell.
W You should not add to the class libraries or cell libraries delivered with
the product. You should define your own libraries, such as mypumps.lib
and mypumps.cel. The cell library and class library do not have to have
the same name.
Nozzle Manager
Nozzle Manager enables you to add, remove, and edit nozzles on parametric and
non-parametric equipment. Nozzle Manager is the first tool in the Nozzle Tools

Procedures for Creating a Parametric Equipment Definition
tool box. The advantages of using Nozzle Manager over traditional tools from
earlier releases are:
• One tool for nozzle placement on both parametric and non-

parametric equipment
• Nine new nozzle placement types
• Nozzle placement based on user-defined datums
• Nozzle placement from catalog or specification data
• Ability to define nozzles parametrically on equipment
• Ability to easily edit or update nozzles
• Ability for administrators to add their own nozzle placement types
• Aid to checkers with validating modeled equipment with vendor
drawings
As the administrator, you can configure Nozzle Manager by creating new nozzle
placement types.
✍ For the procedures, see “Procedures for Configuring Nozzle Manager” on page 8-17.

✍ This is an advanced topic on creating a parametric equipment definition.
Because general procedures would not be meaningful or specific enough, this
section provides procedures by example.
The process of creating a parametric equipment definition involves the following

stages:
• Creating a class definition

• Creating a diagram cell
The following sections describe each stage as an example.

Example of Creating a Class Definition
This example is for a tank that consists of a vertical cylinder with a hemispherical
cap on a square slab, as shown.
➤ To copy common properties

1. In the JSpace Class Editor, open the jclass.lib library file in the
...\Bentley\Program\TriForma\mdlapps directory.
2. Open the placeequ.lib library file in your ...\{ProjectName}\equip
directory.

3. Choose File>New from the menu bar and create a new class
library called Demo.lib.
4. Click the Add button in the Demo.lib dialog box.
5. In the Add Class dialog box, type TANK_FB_ON_SLAB in the text
field and click OK.
6. In the DEMO.LIB dialog box, double-click the line
TANK_FB_ON_SLAB.
7. Change the option at the top from Properties to Parents, and click
the Add button.
8. In the Add Parents dialog box, select the placeequ.lib class library
from the drop-down list box.
9. In the Classes list box, select BASE_TANK and click the Apply
button.
BASE is displayed in the TANK_FB_ON SLAB dialog box.
10. Change the option back to Properties.

11. Highlight all the properties in the list box, and click the Localize
button.
To refresh your memory on localization, the process of changing
the ownership of a property from the parent to the child is known
as localizing the property. Localizing breaks the link from the
property in the parent class to the property in the child class.
However, if the child class is the parent of another class, that

parent-child linkage is not broken. For complete details on

localization, see the JSpace Class Editor.
Continue to the next procedures to add Prompt and Fixed properties.
➤ To add prompt properties

1. Click Add in the Class Editor - TANK_FB_ON_SLAB dialog box.
2. In the Property Editor dialog box, type DIAMETER for property
name, and change the data type from STRING to DOUBLE, as
shown.
3. Change the Array Length field to 1.

4. Click the Add a Fixed Source button.
✍ You must add a Fixed property before you can add a Prompt
property.

The Fixed Source Editor dialog box is displayed.
5. Click the Input Property List button, which adds the

DIAMETER property to the list box, and click OK.
6. In the Property Editor dialog box, click the Add a Prompt
Source button.
The Prompt Source Editor dialog box is displayed.
7. In the Prompt Message field, type:

Enter tank diameter (P3):

8. Click the mouse button in the list box.
A text field is displayed with a check mark and red X. The check
mark indicates that the value that you enter will be a default value.
9. Type 3 and press the <Enter> key.

The red X is removed. The red X means that the value is not valid
until you press <Enter> so that the system evaluates the values as
being valid.
10. Click OK to close this dialog box.

The Property Editor dialog box is redisplayed with the Fixed

property and Prompt property.
You have now added a Prompt property to the class.

11. Click Apply.

The Class Editor - TANK_FB_ON_SLAB dialog box is

redisplayed with the DIAMETER property.
12. Click the Add button and repeat the same steps to add the
following Prompt properties:
Name Prompt Default Value

HEIGHT Enter height of shell (P2): 10
HEAD Enter height of head (P1): 1
SLAB_HT Enter height of slab (P4): 0.5
SLAB_LEN Enter length of slab (P5): 8
➤ To add fixed properties

1. Click Add in the Class Editor - TANK_FB_ON_SLAB dialog box.
2. In the Property Editor dialog box, type $DIAGRAM for the
property name, and leave STRING as the data type.
3. Click the Add a Fixed Source button.
4. In the Fixed Source Expression Editor dialog box, type:
"DEMO.CEL:VTFBSL"
✍ The $DIAGRAM property defines the name of the diagram cell.
5. Click OK in the Fixed Source Editor dialog box, and click Apply
in the Property Editor dialog box.

You have now added a Fixed property to the class.

6. Repeat the same steps to add the following Fixed properties:
Name Type Length Fixed Source

SHELL:$CLASS STRING 1 "CYLINDER"
SHELL:ATTRIBUTES SHORT 10 ATTRIBUTES
SHELL:RADIUS DOUBLE 1 DIAMETER / 2.0
SHELL:WORKING_POINT DPOINT 2 DP (0,0,0)
SHELL:WORKING_POINT[0]
+ DP (0,0,HEIGHT)
CAP:$CLASS STRING 1 "HEMI_CAP"
CAP:ATTRIBUTES SHORT 10 ATTRIBUTES
CAP:AXIS DVECTOR 1 DV(0,0,1)
CAP:HEIGHT DOUBLE 1 HEAD
CAP:ORIGIN DPOINT 1 DP (0,0,HEIGHT)
CAP:RADIUS DOUBLE 1 DIAMETER / 2.0
SLAB:$CLASS STRING 1 "BOX"
SLAB:WORKING_POINT DPOINT 2 DP (-SLAB_LEN/2.0, -
SLAB_LEN/2.0, 0)
DP (SLAB_LEN/2.0,
SLAB_LEN/2.0, -SLAB_HT)
SLAB:ATTRIBUTES SHORT 10 ATTRIBUTES
➤ To edit common properties

1. Double-click PLACE_POINTS.
2. Change the Fixed source to:
DP (-SLAB_LEN/2.0, -SLAB_LEN/2.0,-SLAB_HT)
DP (-SLAB_LEN/2.0, 0,-SLAB_HT)
3. Click OK and Apply.
4. Double-click $RELATION.
5. Change the Fixed source to:
REPEAT("MEMBERS", 3+PROPERTY_LENGTH(PLACE_POINTS))


7. Double-click $OBJECT.
8. Change the fixed source to:
"SHELL"
"CAP"
"SLAB"
"SNAP"
10. Click the Close button.
11. Click the Save button in the Demo.lib dialog box.
✍ To add an equipment datum in the parametric class definition, see “Procedures

for Configuring Nozzle Manager” on page 8-17.
Now you have created a class definition.
Example of Creating a Diagram Cell
The diagram cell can be 2D or 3D. However, the cell will be displayed only from the
top view.
Rules for Creating the Cell
The only rules for creating the cell are for the dimensions in the cell, as follows:
• The text of the dimension should match the unique name in

parentheses ( ) in the Prompt property (including case).
• The text must precede the graphics that are to be highlighted with
the text.
• All graphics following the text (until the next text element or the
end of the cell) will be highlighted with the text.
• The unique name in the Prompt property is allowed to match any
number of dimensions in the diagram cell, to allow for multiple
representations in the diagram.

Explanation of the Example
In the example that follows, the heavy lines, and the text Origin and its leader are
the non-dimension elements. They were placed on level 1. The text P2 was placed,
followed by the dash-dot lines, then text P1, followed by the dashed lines, then text
P4 followed by the dashed lines, then text P3 followed by the solid lines, and then
text P5 followed by the solid lines.
✍ A line was placed for both P2 and P1 where they meet, and for both P2 and
P4 where they meet. Because the graphics can be "associated to" (by following)
only one text element.
Troubleshooting Problems in Placing Parametric Equipment
If a user has a problem placing parametric equipment, it could be due to any of the
following error messages that the application may display.

Problem: Any of these four error messages can occur when JSpace cannot create the
item (instance the class) from the class definition.
Resolution: Perform any of the following operations:
• Correct the incorrect class definition.

• Load the library with a needed sub-class.
• Correct the property values in the appropriate dialog box.
Problem: A property is not defined.

Resolution: In this case, you must define the $BUDTYPE property in the class
definition.
Troubleshooting Problems in Placing Building Blocks
If a user has a problem placing the building block, it could be due to any of the
following error messages that the application may display.
Problem: Any of these four error messages can occur when JSpace cannot create the
item (instance the class) from the class definition.
Resolution: Perform any of the following operations:
• Correct the incorrect class definition.

• Load the library with a needed sub-class.
• Correct the property values in the appropriate dialog box.

Procedures for Configuring Nozzle Manager
Problem: A property is not defined.
Resolution: In this case, you must define the $BUDTYPE property in the class
definition.

The administrator tasks for customizing setup of Nozzle Manager include
configurations in the following areas:
• Database tables
• MicroStation cell libraries
These configurations largely involve customizing the nozzle types that are available
for your users to select.
Configuring an Equipment Datum

The first task in configuring Nozzle Manager is to configure an equipment datum.
For Nozzle Manager to convert parameter values to placement points on a piece of
equipment in a design file, the equipment needs a datum. A datum is the short name
for a coordinate system datum, which is a reference point on the equipment used as
a basis for calculating or measuring the position of a nozzle. A datum consists of:
• Origin point
• Z axis
• Y axis
• Identifying name
W Nozzle Manager requires at least one datum to add or place a nozzle.

✍ You can pre-specify this datum for your users by adding it to the parametric
equipment so that it will be available when the users place that equipment. Or,
you can allow your users to configure their own datums by using Datum
Manager, a program that enables users to specify the datum by simply placing a
few data points in the design file. For more details on datums and Data
Manager, see the PlantSpace Design Series user help on the Help menu of the
MicroStation menu bar.
➤ To configure an equipment datum

1. In the JSpace Class Editor, open the placeequ.lib file in your
...\ {ProjectName}\equip directory.
✍ If you are not familiar with the JSpace Class Editor and JSpace
technology, refer to the JSpace Class Editor User help and JSpace
Concepts and Technical Reference help on the MicroStation Help menu.
You can use this procedure to edit the TANK_VBODY class,
which contains an example datum, or you can use this procedure
as a basis to add a datum to another class.
2. Edit the TANK_VBODY class.
The Class Editor - TANK_VBODY dialog box is displayed.
The four properties that start with $CSYS_DATUM_ are used in

this configuration. These are all variable length properties and, if
indexed with a certain number, will refer to the same datum. For
example, $CSYS_DATUM_NAME[0],

Configuring an Equipment Datum
$CSYS_DATUM_ORIGIN, $CSYS_DATUM_Z_AXIS, and

$CSYS_DATUM_Y_AXIS refer to the first datum on this
equipment. In Nozzle Manager, your users will choose the datum
(reference point) for each nozzle. The datum is actually contained in
a Line String element within the equipment's cell header.
3. Using the TANK_VBODY class as an example, edit
$CSYS_DATUM_NAME[0], $CSYS_DATUM_ORIGIN[0],
$CSYS_DATUM_Z_AXIS[0], and $CSYS_DATUM_Y_AXIS[0]
for each datum that you want to add.
✍ If the property source already has a value, you can add
expressions to this property source.
• $CSYS_DATUM_NAME
a. If you adding this property to a class, set the data type to
String.
b. Add the identifying name for this datum to the property
source and enclose the name in quotation (" ") marks.
Note: Currently, this is limited to 8 characters.
• $CSYS_DATUM_ORIGIN
a. If you adding this property to a class, set the data type to
Dpoint.
b. Add to the property source, the origin point for this datum as
an expression evaluating to a Dpoint.
• $CSYS_DATUM_Z_AXIS
a. Set the data type to Dvector.
Note: You can also use Dpoint instead to specify a particular
point that determines this axis.
b. Add the Z axis, either as an absolute direction relative to the
local coordinate system (using the DV function), or as a point
on this equipment (for example, a point on the centerline of
the tank).
This step means to select a point on the vessel body that will
determine the reference axis perpendicular to the nozzle (if
there is no skew).

• $CSYS_DATUM_Y_AXIS
a. Set the data type to Dvector.
You can also use Dpoint instead to specify a particular point
that determines this axis.
b. Add the Y axis, either as an absolute direction relative to the
local coordinate system (using the DV function), or as a point
on this equipment (for example, a point on the base circle of
the tank).
This step means to select a point on the vessel body that will
determine the reference axis for the radial angle of placement
around the equipment.
4. Use this example to update other parametric equipment classes.
5. Save the changes to your class library and close JSpace Class Editor.
Configuring a New Nozzle Placement Type

To add a new nozzle placement type, you will need to:
• Configure the NOZZLE_PARAMETERS table

• Configure the NOZZLE_TYPES table
• Configure nozzle type diagrams
• Configure a nozzle type class library
Configuring the NOZZLE_PARAMETERS Table
The NOZZLE_PARAMETERS table represents the superset of parameters used

for all nozzle types. Each row is one parameter. This table is in the
nozzleParameters.dat file. The following diagram is a database table view of this
DAT file.

➤ To configure the NOZZLE_PARAMETERS table

1. Using a text editor such as Notepad, open nozzleParameters.dat in
your ...\{ProjectName}\dbload\data\equip directory.
2. Set each parameter (row) using the following information on the
column headings:
• NAME is the name of the attribute on the Design Series component.
To add a new parameter, you must complete the procedures to add a
new attribute to nozzle components. The values in this column should
also be columns in the NOZZLE_TYPES table, explained in the next
section.
• DISPLAY_NAME is the actual name that your users will see as a
column heading in the grid in the Nozzle Manager dialog box. (See this
dialog box in the topic, Nozzle Manager, in the PlantSpace Design Series
user help.) This displayed name should correspond to the annotation on
the diagram for each nozzle type that uses this parameter.
• DISPLAY_ORDER is used to determine how the parameter columns
are laid out in the grid in the Nozzle Manager dialog box.
W You must enter unique positive values for this column.

3. Load the table into your project database using the Database Setup
tool.
(The procedures for using the Database Setup tool are in the
chapter, Configuring MCS Related Programs, in the Model Control System
(MCS) Guide delivered with the product documentation.)
Configuring the NOZZLE_TYPES Table
The NOZZLE_TYPES table represents the set of nozzle placement types that your
users can choose from. Each row is one nozzle type. This table is in the
nozzleTypes.dat file. The following diagram is a database table view of this DAT
file.

➤ To configure the NOZZLE_TYPES table

1. Using a text editor such as Notepad, open nozzleTypes.dat in your
...\{ProjectName}\dbload\data\equip directory.
2. Specify each parameter (row) using the following information on
the column headings:
• NOZZLE_TYPE is the value of the attribute TYPE on the Design
Series component.
• DESCRIPTION is the actual name of a value that your users will see in
the Type column's drop-down list box in the grid in the Nozzle
Manager dialog box.
• GEOMETRY is the value of the attribute GEOM on the Design Series
component. This value is used with the rule file in determining the
nozzle geometry (S for Straight, E for Elbow).
• CLASS_LIBRARY is the JSpace class library file that contains the
classes that will be used to convert the parameter values (from the grid
in the Nozzle Manager dialog box) into placement points on the
equipment.
• CLASS_NAME is the name of the JSpace class in the
CLASS_LIBRARY that contains information on how to convert this
particular nozzle type's parameters into placement points. (See
“Configuring the Nozzle Type Class Library” on page 8-23.)
• DIAGRAM_CELL_LIBRARY is the MicroStation cell library file that
contains the diagrams that will be displayed in the preview window in
the Nozzle Manager dialog box. These diagram help the user when
entering data.
• DIAGRAM_CELL_NAME is the name of the cell in the
DIAGRAM_CELL_LIBRARY that contains the diagram for this
particular nozzle type. (See “Configuring Nozzle Type Diagrams” on page
8-23.
The rest of the columns are the names of the parameters from the
NAME column of the NOZZLE_PARAMETERS table, and these
determine which parameters are needed for this particular nozzle
type.
✍ Y (for Yes) in the columns means the parameter is needed. N (for
No) means the parameter is not needed.

3. Load the table into your project database by using the Database
Setup tool.
(The procedures for using the Database Setup tool are in the
chapter, Configuring MCS Related Programs, in the Model Control System
(MCS) Guide delivered with the product documentation.)
Configuring Nozzle Type Diagrams
Each nozzle type needs a diagram to represent the parameters that will be used to
place a nozzle of a particular type. The diagram will be a model in a MicroStation
cell library. A sample set of diagrams is provided called Nozzles.cel in your
...\{ProjectName}\equip directory. You can edit this file, or use the file that you
specified in the DIAGRAM_CELL_LIBRARY column of the NOZZLE_TYPES
table. This will likely be a 2-D diagram consisting of MicroStation primitives and
dimensions with annotation text. The content of the diagram can be anything that
conveys to the user what each parameter refers to. The sample uses a top view and
side view for each nozzle placement type.
➤ To configure nozzle type diagrams

1. In a MicroStation session, open your own CEL file or the sample
cell library file, Nozzles.cel in your ...\ {ProjectName}\equip
directory.
2. Open an existing model file or create a new one (using MicroStation
help if needed).
✍ The name of the model file should be the same as the name you
typed in the DIAGRAM_CELL_NAME column for this nozzle
type in the NOZZLE_TYPES table.
3. Add or edit the content using MicroStation tools.
Configuring the Nozzle Type Class Library
Nozzle Manager uses JSpace classes to convert the parameter values from the grid
in the Nozzle Manager dialog box into placement points on the equipment. A
sample file is provided called nozzletypes.lib in your ...\{ProjectName}\equip
directory. You can edit this file, or use the file that you specified in the
CLASS_LIBRARY column of the NOZZLE_TYPES table. The sample uses
certain advantages of the JSpace technology, such as class inheritance, to provide a
customization layer for the calculations that are needed. Each nozzle type has a class
that will be used in this conversion calculation specified by the CLASS_NAME
column in the NOZZLE_TYPES table.

➤ To configure the nozzle type class library
✍ You can have both the JSpace Class Editor and Design Series open while
editing a nozzle type class.
1. In the JSpace Class Editor, open nozzletypes.lib in your

...\{ProjectName}\equip directory.
✍ If you are not familiar with the JSpace Class Editor and JSpace
technology, refer to the JSpace Class Editor User help and JSpace
Concepts and Technical Reference help on the MicroStation Help menu.
2. Edit the AXIAL_ELBOW class.
The Class Editor - AXIAL_ELBOW dialog box is displayed.
3. Edit $POINTS and any dependant properties as needed using the

following information:
The $POINTS property is used in this configuration. All of the
other properties are used to compute the value of $POINTS.
If you are configuring the placement of a straight nozzle:
• $POINTS is an array of the Dpoints that are either the end points of the
nozzle.
• $POINTS[0] is the end point of the nozzle that is on the equipment
side.

• $POINTS[1] is the end point of the nozzle that would connect to a

pipe.
If you are configuring the placement of an elbow nozzle:
• $POINTS is an array of the Dpoints that are the end points and middle
point of the nozzle.
• $POINTS[0] is the end point of the nozzle that is on the equipment
side.
• $POINTS[1] is the middle point of the elbow.
• $POINTS[2] is the end point of the nozzle that would connect to a
pipe.
Nozzle Manager passes the parameter values entered by the user to
the class as part of the Input Property List, and uses the calculated
$POINTS property as local points on that equipment. These local
points will be converted to global coordinates in the design file.
4. To calculate the placement points of the nozzle, use the diagram
created for this nozzle type (from the section “Configuring Nozzle
Type Diagrams” on page 8-23).
You can use the existing inheritance structure, or create your own.
AXIAL_ELBOW is a child class of ELBOW_NOZZLE, which is
itself a child class of NOZZLE. Certain properties are localized at
each level of the inheritance.
The three properties beginning with $DATUM_ contain the datum
information that was used when Nozzle Manager instanced this
class for a particular nozzle. The sample puts these three properties
into one property as a Dpoint called DATUM. You can use this
information to help you calculate the $POINTS property by relying
on information that is contained in the datum. (For example, if you
know that the datum's Z axis was determined with a point that is on
the surface of a rectangular box, you do not need a parameter that
specifies the corresponding dimension.)
5. Save the changes to the class library, close the JSpace Class Editor,
and then close and restart Nozzle Manager to reflect the updates.

9 Configuring Additional Areas of the
User Interface
Configuration usually involves the use of JSpace class libraries.
This chapter explains how to configure additional areas of the user

interface not covered in previous chapters.
Understanding How to Configure the User Interface

One of the ways to configure the user interface is to use JSpace class libraries
through the JSpace Class Editor application. PlantSpace applications use JSpace
class libraries to store classes and class definitions for the objects used in the
applications.
✍ The detailed discussion of class libraries was covered in the section “Design
Series Class Libraries, Ams.lib and Ams_user.lib” on page 2-5.
Quick Lookup of the Configurable Areas of the User Interface

This chapter explains how you can configure the user interface to meet your user
and project needs in:
• Custom keypoints (on page 9-2)

• Custom reference notes (on page 9-3)
• Interactive compatibility checking (on page 9-6)
• Annotation utility (on page 9-7)
• Check Design utility (on page 9-18)
• Label Edit utility (on page 9-30)
• Label Convert utility (on page 9-33)
• Update Symbology by Attributes utility (on page 9-40)
• Intelligent Line String tools (on page 9-45)
• Pipe Stress Interface program (on page 9-48)

9 Configuring Additional Areas of the User Interface
Custom Keypoints
• Component placement mode (on page 9-50)

✍ This topic includes configuring to prevent matching on specific
attributes or to prevent placement of pipe that is too short.
• Custom piping, equipment, and HVAC component tools
(on page 9-54)
Custom Keypoints
Design Series connect points can be recognized by MicroStation AccuSnap. In the
past, AccuSnap recognized all the keypoints on a component without distinguishing
the Design Series connect points. The custom keypoints feature is automatically
enabled when Design Series is installed.
In MicroStation, keypoints are regularly-spaced points in an element. AccuSnap will

snap to these points when the Snap Mode (or override) is set to Keypoint on the
Settings > Snaps menu on the MicroStation menu bar.
With custom keypoints enabled, AccuSnap will snap only to Design Series connect
points so that your users can quickly and easily locate Design Series connect points
when they place a component to be attached to another component. They can
visually recognize that the custom keypoints feature is enabled when they see the
following symbol displayed near the AccuSnap X symbol when AccuSnap snaps to a
Design Series connect point.
Permanently Disabling or Enabling Custom Keypoints

The custom keypoints feature is automatically enabled when Design Series is
installed. This setting results by appending PS_MDL:dskeypts to the configuration
variable MS_DGNAPPS.
➤ To permanently enable or disable custom keypoints

1. To enable this feature, load dskeypts.ma.
2. To disable custom keypoints for the remainder of a MicroStation
session, unload dskeypts.ma by typing the keyin: mdl unload
dskeypts.

Configuring Additional Areas of the User Interface
Customizing the Information Displayed by Custom Keypoints
Temporarily Disabling or Enabling Custom Keypoints

Your users can temporarily disable custom keypoints by typing the keyin,
dskeypts disable, and re-enable the feature in the same MicroStation session by
typing the keyin, dskeypts enable. They can also type the keyin, dskeypts toggle,
to toggle between enabling and disabling the custom keypoints.
Customizing the Information Displayed by Custom Keypoints

You can format the attribute values of the components into the “hint text”
displayed by AccuSnap by defining the FLYOVER property of the class “DESC_”
+ BUD_TYPE in the dsItemDesc.lib class library.
✍ This method is very similar to the way that you customize the text placed by
the Annotation tool, and also uses a shorter class-name (for example,
DESC_PIPE for all piping components). The level and model information, if
any, displayed for all MicroStation items is added to the end of this text, and
cannot be configured.
Custom Reference Notes for Structural Columns

You can customize the Note symbol so that your users only need to update the
COLUMN_LINES table with the column lines data in either inches or metric units.
ISOGEN will output the column line references in the units that your users selected
in the JSM, independent of the units of data in the COLUMN_LINES table.
➤ To customize the Note Type:

1. Edit the columns to be added to the database.
Two example DAT files are provided as unit-specific examples
intended as a template to be used to create your own.
• {project_root}\dbload\data\core\english\clin_refe.dat
• {project_root}\dbload\data\core\metric\clin_refm.dat
These files load rows of data into a table named COLUMN_LINES
in your project.

2. Edit the clin_refe.dat or clin_refm.dat file to add records as

follows:
Field Description
Location This text field defines a named grouping of structural
columns. This can be used to differentiate one structure
from another. The example columns use the default
column group "PLANT".
Name This text field will be output to ISOGEN as the column
name to be displayed on the drawing.
X This is the X (East/West) coordinate of the column line
in inches or millimeters.
Y This is the Y (North/South) coordinate of the column
inches or millimeters.
Z This is the Z (elevation) coordinate of the column.
Currently not used.
Direction This text field is used to define the axis parallel to the
column. The system expects the values entered in this
field to be either:
• NS (North South coordinates, perpendicular to
the X-axis)
• EW (East West coordinate perpendicular to
the Y-axis).
Note: Currently all columns are assumed to run parallel
to the major X or Y axis and cannot be rotated from the
model’s coordinate system.
The following example columns are defined in the clin_refe.dat. file

provided.

3. Replace these columns as required.
✍ There is currently no relationship between the grid drawn using

the place columns feature of PlantSpace and the columns used by
the ISOGEN utility. Although you can use the visible column
lines to better orient your users to the location of the columns,
these will not be used to compose the Note added to the
ISOGEN output.
4. Run the Database Setup tool to load the data file, clin_refe.dat or
clin_refm.dat.
✍ You can perform this step as often as needed to add or remove
new columns in your project.

Interactive Compatibility Checking
Interactive Compatibility Checking

If any components are incompatible with each other while users are placing them,
the system automatically alerts users to this effect by displaying the following
message.
✍ Automatic compatibility checking cannot be turned off.
They can see which component attributes are incompatible. They must then cancel
the placement of the incompatible component. You, as the administrator, can
configure the system to allow users to place an incompatible component if it meets
your business needs.
➤ To enable the placement of an incompatible component

1. In your projvars.cfg file, define the configuration variable:
_DS_ALLOW_COMPATIBILITY_OVERRIDE=ON
When users try to place an incompatible component, they will see the following
message and will be able to place it by clicking the Allow Placement button.
✍ Automatic compatibility checking is the counterpart of the Compatibility

option in the Check Design utility (Compatibility), which you run to check the

Annotation Utility
design file after components have been placed. This check tells you if any
components became incompatible, for example, because they were edited after
placement.
Annotation Utility
The Annotation utility enables you to interactively add notations on components in
a design file. To annotate a component, users choose Design Series > Annotation
from the MicroStation menu bar to open the Annotation dialog box.
You, as the administrator, can configure the text styles available to users, the content
of the notation (the amount and type of information displayed), and the leader lines
and terminators. Your changes will be reflected in this dialog box.
W To use Annotation, the items must be valid Design Series components

or annotation items from Drawing Extraction Manager.
Annotation and TriForma Drawing Extraction Manager

When you annotate a drawing produced with the TriForma Drawing Extraction
Manager, the attributes are stored on the item in the drawing. It is no longer
necessary to attach the model as a reference file. Information about the connect
points is also stored as attributes on the item in the drawing, as follows:

Annotation Utility
• NUM_POINTS is the name for the value of the number of connect

points.
• POINT_n is the name for the coordinates of the connect point,
where n is 0 through the number of points less one. These
coordinates are in design file sub-units.
✍ For details on the TriForma Drawing Extraction Manager, see the TriForma
documentation.
Procedures for Configuring the Text Styles, Content, and Terminators

Configuration involves the following tasks:
• Configuring the content in your project-specific annotation class

library
• Configuring the content in the ANNOTATION_TYPES table
• Configuring the text styles in the MicroStation Text Styles utility
• Configuring the terminators in a MicroStation cell library
Configuring the Content in Your Annotation Class Library

The Annotation utility is delivered with several sample definitions, but other
definitions can be added. Annotation definitions are defined in an annotation class
library specified by the DS_ANNOTATION_DEFINITIONS configuration
variable in projvars.cfg. The default location of the annotation class library is:
• {PS_PROJ}\etc\annotatione.lib (for imperial)

• {PS_PROJ}\etc\annotationm.lib (for SI or metric)
✍ A sample annotation class library, annotatione.lib (imperial) or annotationm.lib

(SI or metric), is in the ...\Bentley\Home\PSDS_imperial or PSDS_SI
\project\etc directory.
In Annotation, an annotation is created by using a class and an associated property

in the annotation class library. The class name is formed by a prefix and the
BUD_TYPE of the component to be annotated.
The level name of the annotation text and leaderline (if any) can be specified with
the LEVEL_NAME property.

This dialog box shows the properties of the ANNOT_PIPE_PIPE class.
To evaluate properties, the system can use:
• JSpace expressions and functions, including the values of other

properties and database queries
• The attribute values from the Input Property List
So .SPEC means the value of the attribute named SPEC.
• Values placed on the input property list by the annotation utility, as
follows:
Value Description
.LOCATE_POINT The raw data point (where the user
clicked to identify the item)
.LOCATE_VIEW_NUMBER The MicroStation view number of
LOCATE_POINT
.LOCATE_SEGMENT The segment number that the user
clicked (such as on an IL)
.LOCATE_POINT_PROJECTED The locating point projected onto the
located item
.LOCATE_NEAREST_KEYPOINT The nearest connection or snap point
to the locating point
.LOCATE_NEAREST_KEYPOINT_INDEX The index (starting with 0) of the
nearest connection or snap point
.GLOBAL_ORIGIN The MicroStation global origin
✍ The flexibility allowed by the class name prefix and property name allow
different ways of organizing multiple definitions for one component.

Annotation Utility
The library that the Annotation utility is using is shown in the Class Library field.
✍ When you are using Annotation, the JSpace class library for annotation can be
updated or changed while the autotext.ma is loaded. The changes will be
reflected when you click the Annotate button.
➤ To configure the content of the annotation text

1. Open the JSpace Class Editor and select your project.
2. Openannotatione.lib(imperial)orannotationm.lib(SIormetric)
in your ...\{ProjectName}\etc directory, as shown in this example in
the tutorial project.
3. Copy and rename a class.

You can either edit an existing property or create a new property

within this class.
4. In the Property Editor dialog box, edit the new or existing property
by adding or editing one or more fixed sources.
✍ See the examples in the next section on various ways to configure
the displayed content.
5. Save and close the class library and the JSpace Class Editor.
➤ To configure the content by using a different class library

1. To create your own class library, copy the delivered sample
annotatione.lib or annotationm.lib, rename it, and then edit it
through the JSpace Class Editor.
2. Open projvars.cfg in your ...\{ProjectName} directory and edit the
DS_ANNOTATION_DEFINITIONS configuration variable to
specify the new class library.
Example Showing a Line Description for Piping Components

New Class: ANNOT_PIPE (copied from ANNOT_PIPE_PIPE)
Existing Property: ANNOTATION
Fixed Source Added:

.SYSTEM + "-L" + PADTEXT( .LINENO, "0", "3", "L") + "-" +
.SPEC + "-" + .SIZE_1
Where Means
.SYSTEM the value of the SYSTEM attribute "AD"
PADTEXT The parameter that forces the value to be a certain width, in
this case, left justified, 3 wide with leading 0's, changing the
LINENO attribute value of 2 to "002"
SPEC The value of the SPEC attribute "CS150"
SIZE_1 The value of the SIZE_1 attribute 4
Using this specification on a piping component in the imperial tutorial file

ps_pipe.dgn would result in the following displayed content:
AD-L002-CS150-4

Annotation Utility
Example Showing a Size Description for a Tray

New Class: ANNOT_TRAY_TRAY (copied from ANNOT_TRAY)
New Property Added: ZZ_T_CODE
Fixed Source Added:

DB_QUERY("PS_CODES_DB","SELECT DESCRIPTION FROM
TRAY_CODE_DESC WHERE CODE = " + "'" + .T_CODE + "'" )
Existing Property: ANNOTATION
Fixed Source Added:

ZZ_T_CODE
Using this specification on a tray in the imperial tutorial file ps_elec.ref would result
in the displayed content from two properties:
T12 - 12 x 4 GALV. STL LADDER TRAY
Configuring the ANNOTATION_TYPES Table

After you configure properties in the class library, you would next update the
ANNOTATION_TYPES table. This table specifies the values that match the
property values in the annotation class library. The table is described as follows:
ANNOTATION_TYPES Table
DESCRIPTION Text displayed in the drop-down list box for the
annotation type
PREFIX Class name prefix that is prepended to the BUD_TYPE
to define the class
PROPERTY Name of the property to evaluate to obtain the
annotation text
The class name is formed by adding the component-type (attribute BUD_TYPE) to

the value for the Prefix that comes from this table. If that class is not found, then
the system tries to find the class by dropping the last segment of the name and
reading the next segment from the end until it finds a match. The annotation text
comes from the evaluated property that is specified by the Property column in the
table.
The following annotation types are available for adding a notation on a component
in your design file. These types are listed in the Type field of the Annotation dialog

box. They are described in the annotation_types.dat file (shown in the next
procedure):
• Annotation
Displays the abbreviated system name, line number, spec, and size
• Elevation
Displays the elevation or work point
• Elevation BOP
Displays the elevation of the bottom of the pipe
• Elevation TOP
Displays the elevation of the top of the pipe
• Elevation Key Point

Displays the elevation of the key point nearest the location where
you place a data point
• Expanded System Name

Displays the full system name, line number, spec, and size
• Invert Elevation
Displays the elevation of the inside of the bottom of the pipe
• System Size
Displays only the abbreviated system name and size
• Multiple Line
Displays the full system name, line number, spec label and spec

Annotation Utility
number, nominal diameter abbreviation, and size on four lines of

text
• Elevation of First Point

Displays the elevation from the first point

➤ To configure the ANNOTATION_TYPES table

1. Open the annotation_types.dat file in your ...\{ProjectName}
\dbload\data\core directory.
2. Edit the data between DATA_BLOCK_BEGIN and

DATA_BLOCK_END using the following guidelines:
• Each row becomes an option in the drop-down list box of the Type field
in the Annotation dialog box.
• The Description (first) column shows the options as they will be
displayed in this list box.
W The data must match the properties in the class library.

4. Load the file into your project database through the Database Setup
tool.

Annotation Utility
Configuring the Text Styles

You can change the text styles in your seed file. Your seed file is specified by the
MS_DESIGN_SEED configuration variable. (Sample files, ds_seede.dgn for
imperial and ds_seedm.dgn for SI or metric, are delivered in the ...\PSDS_Imperial
or PSDS_SI\project directory.) In this way, all design files will use a particular set of
text styles for consistency.
➤ To configure the annotation text styles
✍ This procedure explains the basics. For complete details on the Text Styles
utility, see the MicroStation online Help.
1. Open your seed file in your ...\{ProjectName}\project directory.

2. From the MicroStation menu bar, choose Element > Text Styles.
The Text Styles dialog box is displayed. The default style (based on
your project installation) is at the top and any configured styles are
listed below this.
3. Click the New icon below the menu bar.

The tree structure in the left pane displays *Untitled - 1. In the
right pane, the parameters displayed in blue are configurable. Any
parameters in gray are not available. The General tab displays the
basic parameters for quick changes. The Advanced tab displays
more detailed, extensive parameters.
4. In the right pane, select the Value column for Style Name, type a
name, and press Enter.
The new style name is displayed in the tree structure in the left pane.

5. Change the values of any of the parameters by either typing the

value or selecting it from a drop-down list box.
6. When you are finished, click the Save Style icon below the menu
bar.
The parameters are saved when they change from blue to black.
7. Repeat these steps to configure parameters for a new style, or close
the dialog box.
The parameters will be available to users in every design file that
they create in your project. For more information, see the
MicroStation online Help.
Configuring the Terminators

The Annotation utility uses the MicroStation Cell Library dialog box for a choice of
terminators. The delivered sample cell library, symbol.cel, provides four styles as
shown.
You can configure these terminators or add a new terminator cell library.
➤ To configure the terminators

1. In the Annotation dialog box, click the browse (>) button in the
Terminator group to open the MicroStation Cell Library dialog box.
2. If the default cell library is not displayed, attach symbol.cel in your
...\{ProjectName}\cell directory.
3. Select a terminator and click the Terminator button.

Check Design Utility
✍ For complete details on using this dialog box, see the MicroStation online
Help.
➤ To add a new terminator cell library

1. In the Cell Library dialog box, attach the cell library that you want.
2. Close this dialog box.
3. Open projvars.cfg in your ...\{ProjectName} directory and edit the
DS_ANNOTATION_TERMCELLIB configuration variable to
specify the name and path of the new cell library.

The Check Design utility was developed to evaluate components in the active model
and has not been designed to consider the evaluation of components in reference
files. Check Design will process components in both design models and sheet
models, and can process multiple models as a sub-set of the active model file. The
Check Design utility checks for:
• Superimposed components (including the former Delete

Superimposed utility)
• Specification (including the former Specification Check utility)
• Slope direction
• Compatibility
• Duplicate ID
• Gap correction
• Overlap correction
Rules Used in Checking

New rules are provided to ensure that certain combinations of label attributes are
adhered to during an IL population or single component placement. When an IL is
populated, or a single component is placed, whether in Specification mode or
Catalog mode, certain label values are evaluated and tested based on user-defined
rules.

Procedures for Configuring the Check Design Utility
Checking Label Attributes

You can check a specification, system, end preparation, or a combination of any
valid label attributes in the active model file. If the values of the labels do not match
during population, you are notified and the component(s) is flagged using the
symbology-driven flagging used currently (for example, on out-of-radius pipe
elbows or mismatched HVAC ducting).
Configurable Options
✍ To enable rapid modeling of piping on projects where a lower degree of

consistency is expected, you can disable this Design Checking functionality
altogether if desired.
The system is configurable to define certain combinations of attribute values for

each component type. An example would be to allow a regular flanged end to mate
with a non-standard flanged end where that mating is appropriate. This situation
regularly occurs with valves and inline instrumentation.
Procedures for Configuring the Check Design Utility

The Check Design utility is accessed through the Check Design dialog box. Several
of the options can or need to be configured for users.

Superimposed Components Option

✍ In Design Series, components are considered to be superimposed only if they
have the same set of connect points. In other words, if two components
appear to lie one on top of the other but have distinct sets of connect points,
they are not superimposed.
For this option, all component types (except equipment) are automatically checked
without specific configuration. The superimposed components option looks for
superimposed components that are duplicates.
DS_NONMATCHING_ATTRIBUTES
The duplicate criterion is defined by DS_NONMATCHING_ATTRIBUTES, the
configuration variable that is set when users do not want to match attributes during
the duplicate check. For details on the use of this configuration variable, see
“Configuring to Prevent Matching on Specific Attributes” on page 9-50.
Users are notified that a duplicate was found. They can then select each pair of
superimposed components to delete either one in the pair.
DS_DELDUP_AUTO_DELETE
If the configuration variable DS_DELDUP_AUTO_DELETE is defined, the
check for the superimposed components portion of the check design utility prompts
the user before continuing. If the user continues, the system compares the attributes
of the two components, except those specified in
DS_NONMATCHING_ATTRIBUTES. The system automatically deletes all but
the first item of a group of super-imposed components. Any duplicate that is found
is deleted without user notification.
If the DS_DELDUP_AUTO_DELETE is not defined, the user gets a list of pairs

of components that are superimposed, and the user manually selects one of these to
delete (which is the way the command worked in the past).
✍ All of the attributes of the duplicates must have the same value for the
automatic deletion to occur. If any of the attributes have different values, the
two components are not considered to be superimposed.
Configuration for Equipment

Within this utility, specific configuration is required to perform checking on
equipment components. PS_OVERLAY_EQUIP_COMPARE_ATTR is the
configuration variable for equipment and must be defined by adding the equipment
attribute names for comparison. If any of the attributes have different values, the
two equipment components are not considered to be superimposed and no deletion
occurs.

Specification Option
➤ To configure equipment for superimposed component checking

1. Open projvars.cfg in your ...\{ProjectName} directory.
2. For PS_OVERLAY_EQUIP_COMPARE_ATTR, add the
equipment attribute names that you want used in checking.
The Specification option (in the topic Checking the Design File in the PlantSpace Design
Series User help) enables the user designer or engineer to select one or many piping
components to check against any existing specification. The user can verify that the
selected component is in compliance with a given specification or with the
specification that it was placed with.
How the Option Works in the Check Design Utility

In the Check Design dialog box at the Specification option when either {specification
name} or From Component is selected from the drop-down list box, the system
checks for the following;
• If the component was placed in Specification mode and {specification

name} is selected, the appropriate BUD_TYPE class is instanced
and queried to determine if the component passed or failed. A
component is considered out-of-specification if the attribute values
contained within the component data do not exist in the
specification table of your project database for that particular
component BUD_TYPE. This method compares the attributes
found in the component against the allowable attributes in the
specification table.
• If the component was placed in Catalog mode and From
Component is selected, the system checks the component for
catalog data. In this option, a component fails if the attribute values
contained within the component data do not exist in the catalog
table of your project database for that particular BUD_TYPE.
You as the engineer with administrator responsibilities can customize the actual
specification attributes checked. You can customize this utility in two ways by:
• Configuring the requirements for the specification check

• Configuring the class libraries in the JSpace Class Editor

Configuring the Requirements for the Specification Option

Specification Check utility uses definitions in the ams_user.lib class library to
determine if a component passes or fails the specification check. The ams_user.lib
file resides in your <{project-root-directory}>.
Standard definitions are delivered with the Design Series for each component
BUD_TYPE. Using the JSpace Class Editor to modify the class definition of the
BUD_TYPE in the ams_user.lib, you can control how the system determines if a
component passes or fails the specification check.
Several classes or files in the ams_user.lib are required for the Specification Check
utility including:
• SPECCHK_BASE
• BUD_TYPE classes
• SPEC_NAMES
• ATT_DEF
• SpecChk.ini file
SPECCK_BASE
SPECCK_BASE class is a parent of the individual BUD_TYPE classes. The
properties SPECCHK and SPECCHK_OK are defined and inherited unmodified
from this class. These two properties should not be localized to a particular
BUD_TYPE class. They are defined in this parent class for ease of maintenance and
customization of the library.
Three properties in the BUD_TYPE class affect the specification checking process
including:
• SPECCHK
SPECCHK is a DB_QUERY rule function that attempts to obtain
a row of data from the specification table. If it succeeds in obtaining
a row, the component meets the specification.
• WHERE_CLAUSE
The WHERE_CLAUSE is the WHERE clause of the SQL
statement of the SPECCHK property.
• SPECCHK_OK
SPECCHK_OK is a string value checked by the Specification
Check utility to determine if the component passed or failed. For
example, “true” indicates a pass, “false” indicates a failure.

BUD_TYPE classes
BUD_TYPE classes are child classes of the SPECCHK_BASE class and inherit its
properties. Each BUD_TYPE class must have a property called
NOSPEC_CLAUSE to be checked under Specification checking.
W The properties SPECCHK and SPECCHK_OK are directly inherited

and should not be modified.
However, the WHERE_CLAUSE property inherited from the SPECCHK_BASE

class is localized. The localized WHERE_CLAUSE property contains an SQL
query, which is a combination of the SPEC property and NOSPEC_CLAUSE.
NOSPEC_CLAUSE is also used to check components from Catalogs. You can
modify NOSPEC_CLAUSE to check a component in the database.
SPEC_NAMES
SPEC_NAMES classes are used to access your Design Series database and return a
list of available specification names from the PIPE_PIPE_SPEC table.
W These classes should not be modified.
SpecChk.ini file
The SpecChk.ini file enables you to control which BUD_TYPEs are checked against
a specification. The file contains the list of BUD_TYPES that are checked.
BUD_TYPES not found in the list satisfy the specification check by default.
SpecChk.ini is stored in the ...\Bentley\Program\DesignSeries\Default directory.
✍ You can edit SpecChk.ini to add or remove BUD_TYPEs. Comments prefixed

by a pound sign (#) character are ignored by the program.
Configuring the Class Libraries in the JSpace Class Editor

You can modify the WHERE SPEC statement and NOSPEC_CLAUSE statement
of the BUD_TYPE class that you want to use.
The WHERE SPEC statement determines which component attributes are checked
against the Specification table. A sample WHERE SPEC statement for a
PIPE_PELB component is:
" WHERE SPEC = " + "'" + SPEC + "'" + " AND " + NOSPEC_CLAUSE
This SQL statement is composed of a set of comparisons between the component

attributes and the attributes in the specification table. For example,
SPEC_NAME='"+SPEC+"' compares the value of the SPEC_NAME column in the

specification table against the value of the SPEC component attribute with the
following result:
• If the SQL statement finds exactly one matching row, the

component attributes meet the specification, the SPECCHK
property contains the same data, and SPECCHK_OK evaluates to
“true”.
• If the SQL statement does not find a matching row, the component
attribute does not meet the specification and the SPECCHK_OK
evaluates to “false”.
The NOSPEC_CLAUSE determines which properties are to be checked against the

Catalog table. A sample NOSPEC_CLAUSE statement for a PIPE_PELB
component is:
NOSPEC_CLAUSE = " EPREP1 = " + "'" + EPREP1 + "'" + "
AND SCH_RAT1 = " + "'" + SCH_RAT1 + "'" + " AND EPREP2
= " + "'" + EPREP2 + "'" + " AND SCH_RAT2 = " + "'" +
SCH_RAT2 + "'" + " AND SIZE_1 = " + SIZE_1 + " AND
SIZE_2 = " + SIZE_2 + " AND STNDRD = " + "'" + STNDRD
+ "'" + " AND CODE = " + "'" + CODE + "'" + " AND FACE
= " + "'" + FL_FACE + "'" + " AND ANGLE = " + B_ANGLE
+ " AND RADIUS = " + "'" + B_RADIUS + "'" + " AND
REIHE = " + "'" + B_REIHE + "'" + " AND GEOMTYPE = " +
"'" + GEOMTYPE + "'"
Similarly for checking catalog components in the Catalog table, the system gets the
NOSPEC_CLAUSE from the library and executes a query. If the SQL statement
finds exactly one matching row, then it reports that the component is a valid
component.
✍ Catalog checking is done only when From Component is selected and the
component was placed in Catalog mode.
➤ To configure the class libraries for the Specification option

1. In your project database, check the specification table for the
component BUD_TYPE that you want in your Design Series
database.
The table name ends in SPEC, such as the PIPE_PELB_SPEC
table.
2. Inspect and list the columns that you want to check against.

Slope Direction Option
3. Using the JSpace Class Editor, open the following files:

• jclass.lib and ams.lib by selecting them from the File menu
• ams_user.lib in the {project-root-directory}\etc directory
4. Edit the class that you want in the ams_user.lib, such as the
PIPE_PELB_USER class.
5. Inspect and list the component properties that exist in the class and
determine which properties correspond to the column names in
your specification table of the Design Series database.
These property and column names can be the same names or they
can be different. For example, the SPEC property in the class
formerly corresponded to the SPEC_NAME column in the
database.
6. Modify the NOSPEC_CLAUSE property to include comparisons
of the component properties and database column names as
required.
7. Save the ams.lib and ams_user.lib class libraries.
✍ You should test the Specification option in the Check Design utility on several
components that are known to be in spec and out of spec to ensure that the
system is working properly.
Configuring Specification Checking for Batch Mode

In Batch mode (with Specification selected) in the Check Design dialog box, you can
preset the specification that the utility uses to check the components. In this mode, a
report is generated that can be viewed through a text editor.
You can set the DS_SPEC_CHECK_BATCH_MODE configuration variable to

the specification that you want. For example:
DS_SPEC_CHECK_BATCH_MODE = CS150
Slope Direction Option

In the Check Design dialog box, the option, From System, requires configuration to
define the piping system rule for sloping. The column SLOPE in the database table
PIPE_SYMB must be populated with a value of either Up or Down according to
the piping system requirements.

➤ To configure the slope option, From System

1. In your ...\{ProjectName}\dbload\data\pipe directory, open
symbolgy.dat in a text editor such as Notepad.
2. In the SLOPE column, type the value Up or Down, as shown in the
example.

4. Start the Database Setup tool and load symbolgy.dat.
Compatibility Option
When you select the Compatibility check box, select Interactive at the Mode field,
and click the Process button, the Placement Settings dialog box is displayed.
✍ This is the same dialog box displayed when you choose Design Series>Settings
from the MicroStation menu bar.

Duplicate ID Option
The attributes are defined by a set of tables. If an attribute is included in the

COMPATIBLE_ALWAYS table, that attribute is always evaluated as part of the
processing. If the attribute is included in the COMPATIBLE_OPTIONAL table
and the Optional check box is selected, then it is also evaluated as part of the
processing.
✍ If the Optional check box is not selected, the attributes in the

COMPATIBLE_OPTIONAL table will not be evaluated as part of the
processing.
➤ To configure the attributes to consider in compatibility checking

picompat.dat in a text editor such as Notepad.
2. In the DATA_BLOCK sections of COMPATIBLE_ALWAYS or
COMPATIBLE_OPTIONAL, add or delete attributes as required.

4. Start the Database Setup tool and load picompat.dat.
Duplicate ID Option
The database table COMP_TAG_IDS is used to configure the component types to
be checked and their checking rules. The checking rules can include single or
multiple attributes.

✍ The COMP_TAG_IDS table is used for both interactively checking duplicate

IDs during component placement (enabled by selecting the Duplicate ID
Check option in the Component Settings dialog box), and for checking
duplicate IDs after placement (enabled by selecting the Duplicate ID option in
the Check Design dialog box).
The sample COMP_TAG_IDS table in the delivered tutorial project database,

pltspace.mdb, shows that a valve ID consists of three attributes: VLV_ID,
VLV_NO, and VLV_TRN.
You can configure one attribute or a combination of attributes that make up a

unique component ID.

Gap Correction Option
➤ To configure which attributes make up a component ID

compID.dat in a text editor such as Notepad.
2. In the DATA_BLOCK section, add a new component type and
attributes or edit the existing ones.
3. To add a second attribute for the same component type, repeat the
component type name on a new line and add the second attribute.
4. In the same manner, add more attributes if needed to make the
entire ID unique.
6. Start the Database Setup tool and load compID.dat.
Gap Correction Option

✍ No user-defined configuration is provided.
Overlap Correction Option

✍ No user-defined configuration is provided.

Label Edit Utility
Label Edit Utility

✍ The following enhancements work in the label edit mode only, not in the
component placement mode.
• In Multi-Component Label Edit (MLE), you can configure the

Label Edit operation to prevent automatic changes to attributes
unless the attribute has been flagged for automatic update. If an
attribute is flagged for automatic update by using the APP_FLAG’s
"A" value (meaning "automatically set single value") and if the input
method's query results in exactly 1 value, the strict mode control
mechanism will be bypassed for that attribute. This applies whether
or not the attribute is displayed for placement or editing. For
example, for a valve, you would not automatically change Size_1 or
Size_2, but you could change Size_M, Size_M2, Op_Loc, or
CompType.
A log file (mle.log) is created (and overwritten) after each Multi-
Component Label Edit attempt and is stored in the PS_TEMP
directory. The log file is extremely useful in determining which
component(s) attributes failed during an MLE attempt.
• In Single-Component Label Edit, the OK button is disabled until
the user enters a valid combination of attributes. Attributes that are
flagged for automatic update and whose input method returned
exactly 1 value will be automatically updated to that 1 value. For
example, an elbow has both Size_1 and Size_2 attributes. For most
customers, Size_2 would be flagged for automatic update. You
would not automatically update Size_1, but you could automatically
update Size_2. This will result in Size_2 being set to whatever
Size_1 is set to.
This enhancement enables you as the administrator or project lead to control the
"strictness" of the editing operation in the Label Edit tool. This enhancement also
provides an automated and interactive checking mechanism in editing PlantSpace
Design Series components.
Strict Mode Configuration

A new Label Edit configuration variable (for both multiple and single label editing)
needs to be configured to a "strict" mode setting. In this mode, the attributes dialog
box will not automatically change attribute values to match the spec or a valid
combination of catalog data. The first non-valid attribute in the dialog box will be
displayed in red. No attributes will be displayed below the first non-valid one. The

How the Configuration Works
user will be forced to purposely select a valid value for that attribute and a
subsequent set of valid attributes for each individual component edit before the OK
button can be enabled to carry out the change to the component.
How the Configuration Works

You can set up the configuration to work in a non-strict or strict mode as follows:
• To operate in non-strict mode, set the configuration variable:

DS_EDIT_ATTRIBUTE_AUTOMATICALLY_SET_DEPENDENT = 1
This setting will automatically update the value of dependent
attributes, as in version 7.1.4 and earlier.
• To operate in strict mode, you must comment out (using the pound
sign #) the configuration variable:
DS_EDIT_ATTRIBUTE_AUTOMATICALLY_SET_DEPENDENT
You will also need to modify the ATTRDEFN table to indicate
which attributes can be updated automatically.
➤ To configure the Label Edit tool

2. Define any of the following configuration variables depending on
the way that you want the Multi-component Label Edit (MLE)
operation to work:
✍ These configuration variables are commented out (marked by the
pound sign #) by default setting. You will need to remove the #.
• DS_NEEDS_ATTENTION_STYLE is the MLE style configuration
variable. It is undefined by default. To assign a MicroStation Line Style
to components that have failed a Multi-component Label Edit
operation, define this configuration variable with a numeric value that
corresponds to the MicroStation Line Style number that you want.
• DS_NEEDS_ATTENTION_WEIGHT is the MLE failed weight
configuration variable. It is undefined by default. To assign a
MicroStation Weight to components that have failed a Multi-component
Label Edit operation, define this configuration variable with a numeric
value that corresponds to the MicroStation Weight number that you
want.

Label Edit Utility
• DS_NEEDS_ATTENTION_COLOR is the MLE failed color

configuration variable. It is undefined by default. To assign a
MicroStation Color to components that have failed a Multi-component
Label Edit operation, define this configuration variable with a numeric
value that corresponds to the MicroStation Color number that you want.
• DS_MLE_LOG_VERBOSE is the MLE diagnostic configuration
variable. It is undefined by default. To write more information to the
mle.log file, change this configuration variable by defining a value (any
value). This additional information included in the mle.log file is useful
to Bentley support if you are having problems troubleshooting the
automatic update behavior.
• DS_EDIT_ATTRIBUTE_AUTOMATICALLY_SET_DEPENDENT
is the automatic change configuration variable. It is undefined by default
to disable automatic updates of attribute values. You can allow
automatic updates of specific attributes by including the APP_FLAG’s
"A" value (meaning "automatically set single value") in the attribute
definition.
How Users Will Work with Label Edit

Users will:
• Select a single component or group of components.

• When a target attribute field in the component is changed, the first
attribute field that does not match a valid set of attributes will turn
red.
• If editing a single component, the user will be forced to purposely
select a valid set of attributes before the OK button can be enabled.
If using a fence or selection set, the validation is done on each item
in the fence or selection set.
• For components that fail the validation, MLE_OK attribute will be
set on those components and they will not be updated. In addition,
a message window will be displayed indicating the number of
components that have been updated.
• The value N is written to the MLE_OK attribute field for all failed
components. Those components that pass the validation test will be
updated and will retain the Y value.

Label Convert Utility
• In the event a previously failed (N flagged) component is

encountered during subsequent MLE processing, a message will be
displayed to the user warning that components in the current
selection set must be edited (using a single label edit) with a valid set
of attributes before MLE can be used on those components again.
After selecting OK, the selection set is rebuilt with just the flagged
components.
• Using the flagged attribute in a query statement (MLE_OK EQ N),
the user will identify the components that have not been updated
during an MLE operation. Those components must then be
individually reviewed and dispositioned using the single label edit
method to remove the flag and update the component.
✍ If you create a selection set to query the failed group, the Label Edit command
treats the selection set as an MLE request. To remove the N value from the
failed components, you must perform a Single Label Edit operation on each
individual component that has been flagged. MLE will not recognize any
component that has a flagged attribute value of N from a previous Label Edit
operation.

To convert to a newer version, the components in a design file modeled with a
previous version of Design Series, to add attribute values to existing components, or
to modify attribute values, you must run LBLCVT (the name of the Label Convert
utility) on each of the design files.
The naming of the classes used is "LBLCVT_" + component-type (attribute

BUD_TYPE). If that specific class does not exist, then, successively more general
class names are evaluated by removing the last underscore (_) until a class is found.
For example, for an elbow (BUD_TYPE=PIPE_PELB), the software looks for

class LBLCVT_PIPE_PELB. But if that class is not found, then the software looks
for class LBLCVT_PIPE. If that class is not found, the software looks for class
LBLCVT.
Thus, class LBLCVT could be used for all components, or LBLCVT_PIPE could
be used for all piping component-types.
LBLCVT
The Label Convert utility, LBLCVT, supplied in Design Series does the following:

• Writes the new components into a copy of the design file, which is
placed in the .../new directory compared to the original file. The
"bad" file is also created in this directory with the extension *.bad.
• Creates the lblcvt.log in the PS_TEMP directory to record the
results of each model conversion. The log file shows the label and
the error message for any problem that occurs in the conversion of
a label.
• Enables you to select multiple design files to update with one click
of a button.
• Defaults to the label-position export file defined by the
configuration variable LBLCVT_OLD_DEFINITION_FILE
• Defaults to the JSpace class library defined by the configuration
variable LBLCVT_LIB
• Extracts the existing attribute values from the components by using
a label-position export file (also known as a rimref.dat file)
• Applies an optional mapping of both names and values using a
JSpace class library
• Uses the attribute definition table of the new database to place the
resulting values into a new label
• Places the resulting values into a new label by using the attribute
definition table of the new database
• Uses the LBLCVT_REPLACE_NONVALID_POUND_SIGN
configuration variable to replace the "#" sign values with the first
matching value
• Uses the LBLCVT_SAVE_CONVERSION_TO_JSM
configuration variable to save the objects created during the
conversion
Procedure for Converting Component Labels
W It is most important that the rimref.dat file be generated from the

existing attribute definition, and that the Label Convert utility be run in
a project that has the new attribute definitions in its database.
How the Utility Processes a Component

The Label Convert utility processes each component in the following order:

1. The utility extracts the component type (BUD_TYPE) from the

existing label.
2. The utility uses that type and the label-position export file to extract
the rest of the attribute values from the existing label.
3. If a class library is specified and contains a class named component
that has a name prefixed by "LBLVBT_", the utility creates an
object of the class with the attribute values as input.
4. If an object was created, the utility uses its value (if any) to
determine the new component type. If an object was not created or
if the object does not have a property name BUD_TYPE, the utility
uses the component type extracted from the existing label.
5. For each attribute of the new component type, the utility attempts
to get its value first from the object, second from the attribute
values from the existing label, and third from the default value and
input method defined in the new attribute definition.
6. If an attribute value is not valid (according to the
INPUT_METHOD selected by the values, SPC_MODE and
STNDRD), it is recorded in the log file. If the “Ignore new input
method if any current value” check box is not selected, the
component is presented in the "bad" file.
7. If no components are presented in the "bad" file, the "bad" file is
deleted.
Setup Guidelines Before Running the Label Convert Utility

Use the following guidelines to determine what setup you need to do beforehand to
get the results that you want after running LBLCVT:
• If you just want to add new attributes to the components (a typical

task performed during the life of a project), you would open
projvars.cfg and leave the configuration variable LBLCVT_LIB
undefined. The new attributes will get the default value defined in
the new attribute definition.
• If you want to perform special tasks, such as assigning a value to a
new attribute based on a particular condition (other values), you
would use the JSpace Class Editor to create (and use) your class
library. Then you would edit the particular class by adding a fixed
source to a particular property of that class to set up the condition.

• If you want to change an attribute value from one component type

to another or to remove a sub-type, you would use the JSpace Class
Editor. Then you would edit the particular class by adding a working
property (a property used on a temporary basis) containing a fixed
source to change the component type.
• If you want to rename an attribute, such as changing CONN1 to
EPREP1, you would use the JSpace Class Editor to edit the
particular class by adding a fixed source to a property to rename the
attribute.
• If you want to change the type of component, such as changing
PIPE_PBR3 to PIPE_PBRN (or a spool to a nipple), you would
use the JSpace Class Editor to edit the particular class by adding a
fixed source to the BUD_TYPE.
✍ You can run LBLCVT from a graphical user interface (GUI). You must specify
a project, which in turn specifies the data source name, user ID, and password.
You can create the design files by using MCS > Model Snapshot if you store
your components in the Model Control System.
➤ To convert component labels
✍ When you are using Label Convert utility, the JSpace class library for label
conversion can be updated or changed while the labelConvert.ma is loaded.
The changes will be reflected when you click the Process Files button.

1. From the MicroStation menu bar, choose Design Series >

Utilities > Label Convert.
The Label Convert Utility window is displayed.
2. In the Files to Convert list box, create a list of files to convert by

clicking the Browse button.

3. In the Select Design Files to Convert dialog box displayed, access

the your ...\{ProjectName}\dgn directory (which is created when you
create a project if different from this sample default path).
4. Select one or more design files by using the Shift or Ctrl key, and
click the Add button to add each file to the Design Files to Convert
list box.
✍ You can also double-click a file to add it to the Design Files to
Convert list box.
You can use the Remove button to edit the list.
5. Click the Done button.
The Label Convert dialog box is redisplayed with the selected files
in the list box.
6. In the Label Definition group, use the old rimref.dat file displayed,
or click the Browse button to select a different file that specifies the
existing label definition for the labels.
7. Select a JSpace conversion rule library, which defaults to a library of
known conversions for version upgrades.
For example, lblcvt_85to89.lib should be used to convert design
files from Design Series version 8.5.
8. To force non-valid components into the ''bad'' file, deselect the
Ignore new input method if any current value check box.

9. In the Log File group, leave the default path displayed where the
lblcvt.log file will reside, or click the Browse button to specify a
different location.
10. To have the program write all attribute values of non-valid values to
the log file before and after conversion, leave the Display all
attributes on non-valid value check box selected.
W You can also specify 1 for the configuration variable

LBLCVT_DIAGNOSTICS to obtain a more detailed log file output.
Depending on the size of your DGN and the value specified for
LBLCVT_DIAGNOSTICS, this step could generate a huge log file.
11. Click the Process Files button.
The output results are in the log file, as shown in the example.
• Converted elements are copied to a file with the same base name with a
*.new extension.
• Elements that are not valid are copied to a file with the same base name
with a *.bad extension.

Update Symbology by Attribute Utility
• Both files are placed in the ...\new directory.

12. Close the Label Convert Utility window by clicking the Exit button.
13. Append the converted files to your database.

You can configure the Update Symbology by Attribute utility for the following
purposes:
• To configure symbology definitions

• To retain the level symbology on your V7 files
Configuring Symbology Definitions

The Update Symbology by Attribute utility is delivered with a symbology definition,
but other definitions can be added. Symbology definitions are defined in the
setsymb.lib file, a JSpace class library for setting the symbology specified by the
DS_SYMBOLOGY_LIBRARY configuration variable. The default location of your
symbology class library is ...\{ProjectName}\etc\setsymb.lib (for both imperial and
SI or metric).
✍ A sample symbology class library, setsymb.lib, is in the ...\Bentley\Home

\PSDS_Imperial or PSDS_SI\project\etc directory.
Named levels and symbology are applied by placement or re-applied by the Update
Symbology command using values from the class library specified by the
configuration variable DS_SYMBOLOGY_LIBRARY. After the component is
created, an object is created using the component's attribute values. The level name
and symbology are determined by these optional properties of the created object:
• For most components (those not in a cell with a special name):
Property Name Default Value

LEVEL_NAME System-name + LINENO
COLOR_NUMBER Queried from table PIPE_SYMB column
COLOR
WEIGHT_NUMBER <none>
STYLE_NUMBER <none>

• For components in cells named _RSRVD (Obstruction/removal

areas)

OBSTRUCTION_LEVEL System-name + LINENO + "
Obstruction"
OBSTRUCTION_COLOR Queried from table PIPE_SYMB
column R_AREA_COLOR
OBSTRUCTION_WEIGHT <none>
OBSTRUCTION_STYLE <none>
• For components in cells named _INSUL (Insulation)

INSULATION_LEVEL System-name + LINENO + "
Insulation"
INSULATION_COLOR Queried from table PIPE_SYMB
column INSUL_COLOR
INSULATION_WEIGHT <none>
INSULATION_STYLE <none>
• For the centerlines of Intelligent Line Strings:

CENTER_LEVEL
CENTER_COLOR
CENTER_STYLE
CENTER_WEIGHT
• For the points of Intelligent Line Strings
POINT1_COLOR applies to the first point of the IL
POINT_LEVEL
POINT_COLOR
POINT_STYLE
POINT_WEIGHT
• For the cones of Intelligent Line Strings:
SURFACE_LEVEL

SURFACE_COLOR
SURFACE_STYLE
SURFACE_WEIGHT
✍ The project can limit the users to use standard level names by setting
(configuration variable) _USTN_CAPABILITY < -
CAPABILITY_LEVELS_CREATE, but that prevents the application from
creating levels, which requires the project to update the level library .dgnlib
when a new level is needed, such as when a new service or line# is added. This
enhancement allows the PSDS software to create the levels as specified in the
JSpace class library setSymb.lib, by setting (configuration variable)
_DS_ALLOW_CREATE_LEVELS = 1. The setSymb.lib class library can
define the rules for the project's level naming convention so that the project
does not need to constantly update the level library .dgnlib.
Process in Forming the Class Name

1. The class name is formed by adding the component-type (attribute
BUD_TYPE) to the value SYMB.
2. If that class is not found, then the system tries to find the class by
dropping the last segment of the name and reading the next
segment from the end until it finds a match.
The symbology comes from the evaluated properties.
For example, the system will evaluate all the properties for the
SYMB_PIPE class shown. The values set in these properties

determine the default symbology used in the Update Symbology by

Attributes command.
3. To evaluate the properties, the system can use:

• The attribute values from the Input Property List. So .SPEC means the
value of the attribute named SPEC.
• JSpace expressions and functions, including the values of other
properties and database queries
➤ To configure the Update Symbology by Attribute utility
✍ When your users are using the Update Symbology by Attributes command,
setsymb.lib can be updated or changed while the b3dboot.ma file is loaded.
The changes will be reflected when they select the command again.
1. Open the JSpace Class Editor.

2. In the Open JSpace File dialog box, select setsymb.lib in your
...\{ProjectName}\etc directory.

The class library is displayed.
3. To change a default setting, double-click a class, select the

appropriate property, and edit it.
4. To add a symbology setting, double-click a class, click the Add
button to add a new property, and specify its setting.
5. Close each dialog box, save and quit the class library, and close
JSpace Class Editor.
Level Symbology and Your V7 Files

In Design Series version 8.x, you can assign attributes by system and line number.
When components are placed in a Design Series version 8.x design file, the
attributes are assigned by default according to the system and line number. To
convert version 7.x files to version 8.x, you need to run the Update Symbology by
Attributes command (on the Design Series>Utilities menu) to update version 7.x
component levels to version 8.x.
However, if you want to retain the level scheme from your version 7.x files, you need
to edit the source for the LEVEL properties.

Intelligent Line String Tools
➤ To retain the level symbology on your V7 files

2. Set the DS_SYMBOLOGY_LIBRARY configuration variable to
setsymb_v7levels.lib in your ...\{ProjectName}\etc directory.
W Note that the level values are of the form "Level 11", not "11".

Some of these tools have options that you can configure depending on the way that
you want your users to work with Intelligent Line Strings.
Procedures for Configuring Options in Intelligent Line String Tools

You may need to configure the options in the following tool(s) depending on your
project needs.
Create IL Tool and the MicroStation SmartLine

When you use the Create IL tool to create an Intelligent Line String, you can
configure the system to retain or delete the MicroStation SmartLine after IL
creation.
➤ To retain or delete the MicroStation SmartLine after IL creation

1. Open projvars.cfg in your ...\{ProjectName}\directory and locate
the DS_ILCREATE_DELETE_SMARTLINE configuration
variable.
The configuration variable is commented out by default setting.
2. To retain the MicroStation SmartLine after IL creation, leave
DS_ILCREATE_DELETE_SMARTLINE commented out, or
remove the comment marker (#) and set its value to 0 (zero).
3. To delete the MicroStation SmartLine after IL creation, remove the
comment marker (#) on
DS_ILCREATE_DELETE_SMARTLINE and set its value equal
to 1.

Create IL Tool Using a Slope with a Percent Value

In the Slope text box, the typical value is in inches per foot (imperial) or millimeters
per meter (SI or metric). However, if your users want to use a percent (%) value for
the slope in placing an IL, you can configure this field to do so.
➤ To configure a slope value of percent (%) in placing an IL

2. Locate the DS_SLOPE_UNIT_TEXT and
DS_SLOPE_MULTIPLIER configuration variables.
3. Set the following values, as shown:
DS_SLOPE_UNIT_TEXT = %
DS_SLOPE_UNIT_MULTIPLIER = 0.01
4. Save and exit the file.

Procedures for Configuring Options in Intelligent Line String Tools
Join IL Tool
When users click the Join IL tool in the Intelligent Line String tool box, the Join ILs
dialog box is displayed.
The Join IL tool is delivered with the Preferences field grayed out. To enable it, you
must configure the preferences that you want users to be able to select from the
drop-down list box. Preferences in the Join ILs operation specify which types of
joining component types should be initially considered as possible choices for
placement. The preferences are defined in the iljoin.txt file in your ...\{ProjectName}
directory.
Iljoin.txt File
The IL Join preference file is a series of one-line records. Each record is used to
define the branch types that are allowed for a particular range angles. ILs can be
joined in one of three fashions: a tee, an elbow or a cross, as follows:
• A tee is formed when the projection of Branch IL's centerline

intersects the centerline of the Main IL somewhere along its run.
• An elbow is formed when the projection of the Branch IL's
centerline intersects the Main IL centerline at an end point.
• A cross is formed when the Branch IL's centerline crosses the Main
IL centerline.
Each record in the file defines the joining type, a range of valid joining angles
(minimum and maximum angle range specified in degrees), a list of valid branch
types and the number of connect points for each branch type. The three join types
are defined by the keywords:
• GROUP_TEE
• GROUP_ELBOW
• GROUP_CROSS
Branch types should match the BR_TYPE value from the PIPE_PBRN catalog
table or PIPE_PBRN_SPEC if spec driven. Because Tee joins can be either two
connect point (snap point) components like Weldolets or four connect point (snap

point) components like Laterals, an extra field is needed in the record that identifies
the classification. Adding a 2 or 4 following each branch type adds this extra field.
A sample record would be:

GROUP_TEE, 89.0, 90.0, WLT, 2, TEE, 4, LTL, 4
GROUP_CROSS, 89.0, 90.0, CRO
GROUP_ELBOW, 89.0, 90.0
➤ To configure the Preferences field in the Join ILs tool

1. Open iljoin.txt in your ...\{ProjectName} directory.
The file contains the following sample lines of code.
GROUP_TEE,
90.0,90.0,TEE,4,RTE,4,STE,4,WLT,2,SOL,2,TOL,2,UBR,2,RB
R,2
GROUP_TEE, 46.0,90.0,WLT,2,SOT,2,TOL,2,RBR,2,UBR,2
GROUP_TEE,
44.0,46.0,LTL,4,WYE,4,LLT,2,WLT,2,SOT,2,TOL,2,UBR,2,RB
R,2
GROUP_TEE, 10.0,44.0,WLT,2,SOL,2,TOL,2,UBR,2,RBR,2
GROUP_CROSS, 89.0,90.0,CRO,5
GROUP_ELBOW,89.0,90.0,PELB,3
GROUP_CONNECT, 0, 0, PFLG, 2,PIPE,2, PUNI,2, PCPL,2,

PADP,2
2. Using the sample record as a guide, edit the code to suit your project
needs.
Pipe Stress Interface Program

Your users can output model geometry to AutoPipe (as well as CAESAR II). The
AutoPipe output file (*.ntl) has been updated to be compatible with the latest

Procedure for Configuring the Pipe Stress Interface Program
AutoPipe stress analysis input requirements for version 6.2.0. This enhancement is
consistent with ongoing plans to integrate PlantSpace products with AutoPipe.
You can add material codes by configuring the STRESS_MATERIAL database

table.
Procedure for Configuring the Pipe Stress Interface Program

A new column named APIPE_MAT_CODE has been added to the
STRESS_MATERIAL database table. This column is supplied with several
common material codes for AutoPipe. You can add material codes as required.
➤ To add material codes to the STRESS_MATERIAL database table

1. For both CAESAR II and AutoPipe, open the caesar2.dat file in
your ...\{ProjectName}\dbload\data\pipe\stress directory.
2. For CAESAR II, add the material codes, as follows:

• Use the first column, caesar2_mat_no, which is required to map
the material. For user-defined materials, the code should be the next
number after the last 900 entry.
• Use the second column, material_name. The material names will
be displayed in the Material Name field in the Pipe Stress Interface
window.

Component Placement Mode
3. For AutoPipe, add material codes by using the last column,

apipe_mat_code, which is required to map the material.
✍ No material names are added. The Material Name field is grayed
out in the Pipe Stress Interface window when AutoPipe is
selected.

When your users place a component, you can configure the system to control
component placement to make it appropriate for your project needs. The following
tasks explain how to prevent attribute matching and placement of short pipe.
Configuring to Prevent Matching on Specific Attributes

When a component is placed or a component's label is edited, the user has the
option of matching attributes from an existing component. However, you can
configure DS_NONMATCHING_ATTRIBUTES and
DS_NONMATCHING_ATTRIBUTES_LE configuration variables so that
specific attributes are not matched. These configuration variables store a list of
attributes that should not be matched during component placement.
Guidelines on Use
DS_NONMATCHING_ATTRIBUTES_LE and
DS_NONMATCHING_ATTRIBUTES are used for the same purpose, to prevent
attribute matching. However, the following guidelines explain how to use them
properly:
• DS_NONMATCHING_ATTRIBUTES_LE is applied during the

Label Edit operation.
• DS_NONMATCHING_ATTRIBUTES is applied during
component placement.
• DS_NONMATCHING_ATTRIBUTES_LE is optional. If it is not
defined, then DS_NONMATCHING_ATTRIBUTES will be used
during both the Label Edit and component placement operations.
• If DS_NONMATCHING_ATTRIBUTES_LE is defined, it is used
in place of DS_NONMATCHING_ATTRIBUTES in the Label
Edit operation.

Configuring to Prevent Matching on Specific Attributes
For example, suppose a user should be able to match the Spec attribute (from a
match component) when a component is placed, but should not be able to match
Spec when Label Edit is used. In that case,
DS_NONMATCHING_ATTRIBUTES_LE should be set to:
DS_NONMATCHING_ATTRIBUTES_LE > SPEC.
W When DS_NONMATCHING_ATTRIBUTES_LE is added or

removed, the change takes effect only when MicroStation is restarted.
➤ To configure DS_NONMATCHING_ATTRIBUTES
2. Locate DS_NONMATCHING_ATTRIBUTES to view its
attributes, as shown.
W It is strongly recommended that you not delete attributes from the

DS_NONMATCHING_ATTRIBUTES configuration variable.
However, you can add new attributes to the list if needed.
3. Add a new attribute by using the Greater Than operator (>) as
shown.
➤ To configure DS_NONMATCHING_ATTRIBUTES_LE
1. Open projvars.cfg in your ...\{ProjectName}\project directory.
2. To prevent users from matching the Spec name, type the following
at a blank line:
DS_NONMATCHING_ATTRIBUTES_LE =
$(DS_NONMATCHING_ATTRIBUTES);SPEC

Configuring to Prevent the Placement of Short Pipe

✍ This configuration involves the use of JSpace class libraries. For details, see
“Design Series Class Libraries, Ams.lib and Ams_user.lib” on page 2-5.
You can prevent the placement of pipe that is too short for the minimum length
required for your project. The definition of "too short" can be customized. In earlier
versions of Design Series, you could not check the length during the placement of
the pipe. A new code has been added in placement to check for minimum pipe
length.
➤ To prevent the placement of pipe that is too short

1. Open ams_user.lib in your ...\{ProjectName}\etc directory.
2. Edit the PIPE_PIPE_USER class.
Three new properties called LENGTH, LENGTH_OK, and
MIN_LENGTH have been added to make this functionality work.
3. Edit MIN_LENGTH.
✍ You do not need to edit LENGTH or LENGTH_OK.

Configuring to Prevent the Placement of Short Pipe
The Property Editor - MIN_LENGTH dialog box displayed.
4. Double-click the A= (fixed source) in the list box and edit the
JSpace expression to return the proper value for the minimum pipe
length.
For example, if you have a table called MIN_PIPE_LENGTH with
columns called NPD and LENGTH (both in millimeters) for a
metric or SI project, you would set the fixed source to be:
DB_QUERY("PS_CODES_DB","SELECT LENGTH FROM
MIN_PIPE_LENGTH
where NPD= " + SIZE_M
5. Click Apply.
6. Close all dialog boxes, and save and close ams_user.lib.
How This Functionality Works

When a user gives a second data point in placing a pipe, the value for LENGTH is
calculated from the SNAP_POINTS property, a PIPE_PIPE object is created to

Custom Piping, Equipment, and HVAC Component Tools
check the length of the pipe, and the value of LENGTH_OK is retrieved from the
object. Placement is prevented under the following conditions:
If Then
The value for LENGTH is less than LENGTH_OK = FALSE
the value for MIN_LENGTH,
LENGTH_OK = FALSE The pipe is not placed.

The following sections discuss ways to configure custom components.
Defining Attributes at Placement of a Custom Component

You can set a configuration variable to define the attributes of components as part
of placing them from the cell library.
➤ To configure DS_SPECIFY_ATTRIBUTES_FOR_CUSTOM
2. Locate DS_SPECIFY_ATTRIBUTES_FOR_CUSTOM and
define it as follows:
• If this variable is defined, the attributes dialog box is displayed before
the component is placed so that you can specify the attributes that you
want.
• If this variable is not defined, the attributes dialog box is not displayed.
Editing Commands That Configure Custom Components

The following commands are used to configure the custom piping, equipment, and
HVAC component tools. You need to open ps_menu.rul in the
...\Bentley\Program\DesignSeries\default directory and edit each command to suit
your project needs.

Editing Commands That Configure Custom Components
PS CREATE CELL Command
Declaration
PSCREATECELLlevelNumbercolorNumberbud_typedeletePoints
addPoints cellname
This command creates a component of type bud_type with MicroStation cell-name

of cellname. The graphics are changed to level number levelNumber and color
colorNumber.
• If deletePoints = 1, points inside the fence will be ignored.

• If addPoints = 1, then the user is prompted to define the location
and orientation of the connect points.
✍ It is recommended that deletePoints always = 1.
PS CREATE COMPCELL Command
Declaration
PS CREATE COMPCELL commodity levelNumber colorNumber
This command displays a dialog box with a list of the bud_types for the commodity
specified and, in effect, calls PS CREATE CELL with the selected bud_type. It also sets
deletePoints = 1 and addPoints = 1.
PS CREATE EQUIPMENT MECHELEC Command
Declaration
PS CREATE EQUIPMENT MECHELEC
✍ This command is specific to equipment.
This command allows the choice of EQUIP_MEQP (mechanical) or EQUIP_EEQP

(electrical) and, in effect, calls PS_CREATE_CELL with the selected bud_type, and
fixed values for cellname, levelNumber and colorNumber. It also sets
deletePoints = 1 and addPoints = 1.
Examples:
PIPEICON_CreatePipe = PS CREATE CELL PIPE_PVLV 11 3 1 1 Valve
EQPICON_CreateEquip = PS CREATE COMPCELL EQUIP 10 6

Default Settings from psmenu.rul

PIPEICON_CreatePipe = PS CREATE COMPCELL PIPE 11 3
EQPICON_CreateEquip = PS CREATE EQUIPMENT MECHELEC
PS CREATE CELL 12 4 HVAC_HSPL 1 1 PSHVAC

10 Configuring the Pipe Stress Interface
for Your Project
You can configure the way that users will create stress analysis
neutral files in the Pipe Stress Interface application.
This chapter explains how to configure the files that control the
creation of stress analysis neutral files.
Understanding the Pipe Stress Interface Configuration

The Pipe Stress Interface is a program that enables the user to take a JSM file
generated from PlantSpace and generate stress analysis neutral files in ASCII format
for CAESAR II or AutoPipe. In the current release, rule files and component lists
are no longer used for processing. A pipe class sheet file is also no longer needed.
✍ You, as the administrator or lead stress engineer, must review and edit the
stress files to match project criteria.
Internal Processes
Internally the Pipe Stress Interface program:
• Extracts the PlantSpace objects from the JSM based on a given

query (if any)
• Processes all objects and forms a piping network in memory
This piping network is then used to generate an output file with a file extension *.cii
for CAESAR II or *.ntl for AutoPipe.
How Users Create a Stress Analysis Neutral File

The process of creating stress neutral files involves the following stages:
1. Creating a JSM file by using the JSpace MicroStation Connection

program accessed through Design Series > Object Tools > Create
Object Model on the MicroStation menu bar

10 Configuring the Pipe Stress Interface for Your Project
Understanding the Pipe Stress Interface Configuration
2. Running the Pipe Stress Interface and selecting the JSM created in
stage 1 as the data source
Users can then use the output in a third-party stress analysis application such as
CAESAR II.
Pipe Stress Interface Data Files

The Pipe Stress Interface output is based on the information in the 3D model
component list and the engineering data related to stress analysis. Two types of
engineering data are related to stress analysis:
• Generic data files

Files that contain parameters from industry codes or manufacturers'
catalogs and are delivered with the PlantSpace Pipe Stress Interface
software
• Project-specific data files
Files that contain parameters that only a specific project uses
Both generic data files and project-specific data files are in your
...\{ProjectName}\dbload\data\pipe\stress directory.
These DAT files are loaded into the project database. All tables related to the Stress
Interface have table names starting with the prefix STRESS_ .
Generic Data Tables
The following tables contain generic data that is standard for the industry.
Generic Data Table Description

STRESS_MATERIAL Physical properties of the pipe material
✍ The following tables are created from the e.dat file in the ...\pipe\stress
\material directory.

STRESS_E_A Young's modulus for material type A
STRESS_E_B Young's modulus for material type B
STRESS_E_C Young's modulus for material type C

Configuring the Pipe Stress Interface for Your Project
Pipe Stress Interface Data Files

STRESS_E_D Young's modulus for material type D
STRESS_E_U Young's modulus user-defined material
You can modify the user-specified table in the files: e.dat (E_U table) or sh.dat
(SH_U table). The default values and the format of these tables are the same as
those in files: e_d.dat and sh_d.dat.
Project-Specific Data Tables
The project-specific data for insulation, such as insulation density and insulation
material, is in the STRESS_INSUL_MATERIAL table in the insulation.dat file in
the ...\pipe\stress\insulation directory.
✍ The following tables are created from the sh.dat file in the ...\pipe\stress
\material directory.
Project Data Table Description

STRESS_SH_A Allowable stress for material type A
STRESS_SH_B Allowable stress for material type B
STRESS_SH_C Allowable stress for material type C
STRESS_SH_D Allowable stress for material type D
STRESS_SH_U Allowable stress for user-defined material
Stress tables related to Young's Modulus (STRESS_E_X) and Allowable stress

(STRESS_SH_X) contain the respective data sampled at various temperatures.
If the material used is different from the material provided in the standard tables,
you can define the parameters of the new material in the respective tables:
STRESS_E_U and STRESS_SH_U.
The STRESS_MATERIAL_EXP table defines the conversion factor for each of the
STRESS_SH and STRESS_E tables to convert the values to PSI. The values in the
row with MATERIAL_TYPE are temperatures in degrees Fahrenheit.
The values for Young’s modulus and allowable stress are interpolated between
temperatures.
Because the number of columns in the user-defined table is a variable, a look-up

table called STRESS_ALPHA_LOOKUP in caesar2.dat is used to register the
number of columns.

10 Configuring the Pipe Stress Interface for Your Project
Procedure for Configuring Your Pipe Stress Interface Files
Procedure for Configuring Your Pipe Stress Interface Files
W Before users open the Pipe Stress Interface application, you need to
make sure that the following steps have been taken. You may need to be
familiar with the input requirements of CAESAR-II to configure some
of the data.
➤ To configure your Pipe Stress Interface files

1. Access the appropriate DAT files in your ...\{ProjectName}\dbload
\data\pipe\stress directory and subdirectories.
2. Set all data in the DAT files according to project standards.
✍ You may need to be familiar with pipe stress calculations.
3. Save and close the files.
✍ If any project specifications were changed, you no longer need to
re-create a pipe class sheet file in Specification Maker as you did
in previous versions of Design Series.
After all DAT files have been properly configured, the Pipe Stress Interface
application can be used. Procedures for this application are in the PlantSpace Design
Series User help on the MicroStation Help menu.

11 Configuring Report Output for Your
Project
You can configure the way that users generate report data.
This chapter explains how to configure the files that control the
creation of reports.
Understanding Report Output Configuration

Reports are created by using the Object Reporter program. The Object Reporter is
an icon in the PlantSpace Design Series program group. The application creates
reports in dBASE format and you can customize them by defining fields and filters.
You can also apply additional filters to multiple reports at the same time. Third-
party applications are available to apply headers, footers, and other presentation
features.
This application uses ams.lib, which you can customize by modifying ams_user.lib
and then synchronizing the changes with ams.lib. You can do this by using the
Database Setup Tool delivered with the Design Series software. More information
on how to customize and synchronize ams.lib is in the chapter "Configuring Your
Project" in this Administrator Guide.
Processing Report Data on Specific Areas of a Model

You can create a report on objects that are located within one or more specific areas
of a model. The areas are selected from a list of areas defined in a volume file.
Because certain linear objects, such as pipes, are likely to pass through several areas
of a model, you may want to report on a clipped length value (the length of the
object that exists inside one or more selected areas). The clipped length of an object
is stored in a special property called CLIP_LENGTH, which is defined in the
ams_user.lib class library. The Object Reporter re-evaluates the CLIP_LENGTH
property to represent the length of an object that is inside the selected area(s). The
clipped length is calculated only for objects that:
• Have two connect points

• Have the Input Property List as the first data source of the
CLIP_LENGTH property.
Example: CLIP_LENGTH=.CLIP_LENGTH;

11 Configuring Report Output for Your Project
Procedures for Customizing the Output
The system reports an object as being in an area if it meets the following criteria:
• If the center point of an objects’s SNAP_POINT range is inside the

area
• If an object has two connect points and has the Input Property List
as the first data source of the CLIP_LENGTH property (for
example, CLIP_LENGTH=.CLIP_LENGTH;), and the center
point of the clipped length is inside the area
A point is considered inside an area if it is greater than or equal to the minimum

planes of the area and less than the maximum planes of the area.

In the Object Reporter, you can customize the output by defining report filters and
report fields, and by grouping and summarizing data.
Defining Report Filters and Report Fields

You can customize a report by defining the filters and report fields that you want
used in the output. In defining the reports and report fields, you can add, modify, or
delete to suit your reporting needs.
➤ To define a report
1. On the Windows Start>Programs menu, locate the PlantSpace
Design Series program group and select the Object Reporter icon.

Configuring Report Output for Your Project
triforma (or whatever you as the administrator set up) in the User
field, select a project, and click OK, you can continue.
The PlantSpace Object Reporter window is displayed.

2. Click the Reports tab, displayed as shown.
3. Click the Define Reports button.

The Define Report dialog box is displayed. The reports listed are
the ones currently defined in the report_e.dat (imperial) or

report_m.dat (SI or metric) file. The report fields displayed pertain

to the selected report.
4. To define a new report:

a. Click the Add button.

The Define Report Filter dialog box is displayed.
b. Type the report name, as shown in the example.

c. At the File Name Base field, type a meaningful acronym or
abbreviation up to 3 characters for the type of report you are
running, as shown in the example.
This name becomes part of the full default report file name (as
defined at the bottom of the PlantSpace Object Reporter window).
d. Type a JSpace expression in the text box, as shown in the
example.
✍ The expression must be a valid JSpace expression that evaluates
to TRUE for the objects that you want to include in the report.
e. Click the OK button.
The new report is listed in the Reports list box. If you select it, the
fields of the report are displayed in the fields list box.
5. To modify a report:
a. Select the report and click the Modify button.
b. In the Define Report Filter dialog box, change the name or
JSpace expression and click OK.
6. To delete a report, select it, click the Delete button, and then click
the Yes button to confirm the deletion.

➤ To define the report fields

1. In the Define Report dialog box, to define a new report field,
perform the following operations in the Report Fields portion of
the dialog box:
a. Click the Add Field button.
The Define Report Field dialog box is displayed.
b. Type the field name and a JSpace expression.

✍ The expression must be a valid JSpace expression that evaluates
to the value that you want displayed in this field of the report.
c. Click the OK button.
The new field is listed in the Report Fields list box.
2. To modify a field, click the Modify button by the Report Fields list
box, and make your changes in the Define Report Field dialog box.
3. To delete a field, select the field, click the Delete button, and click
the Yes button to confirm the deletion.
4. To change the order of a field, select the field and click the
Promote button to move the field up, or click the Demote button
to move the field down.
5. Click the Done button.

Grouping and Summarizing Data

You can use a third party application to produce a particular layout, such as grouped
or summary data. Otherwise, you can use a JSpace grouping class for the same
purpose.
✍ You must use a JSpace grouping class to create summary data in the Object
Reporter. The grouping classes are stored in the PS_GROUP.LIB JSpace
library.
➤ To define filters for a grouping class

1. On the Reports tab of the PlantSpace Object Reporter window,
click the Define Groups button.

Grouping and Summarizing Data
The Groups dialog box displays the currently defined groups.
2. To add a new group definition, click the Add button.

The Define Groups dialog box is displayed.
3. In the Descriptive Group Name field, type a name that easily

identifies the group, as shown in the example.
4. In the Grouping Class Name field, type the name of a grouping
class.
✍ The grouping class must already exist in the PS_GROUP.LIB
library.
5. In the Include Objects field, type the object mask (criteria).
✍ The mask should be a JSpace logical expression that evaluates to
TRUE or FALSE.
6. In the Unique Values By field, type a JSpace expression.

✍ The result must be the same for all members of a given group.
You must delimit the expressions by using the backward single
quote (`).
7. Click OK.
The Groups dialog box is redisplayed.
8. To modify the group definition, select a group name in the list box,
and click the Modify button.
9. Make the changes in the Define Groups dialog box, and click OK.
10. To delete a group definition, select it in the list box, and click the
Delete button.
11. Click Yes to confirm the deletion.

12 Running Piping Drawing Extraction
Design Series provides the Piping Drawing Extraction utility to
resymbolize piping components as simplified symbols so that large
drawings are easier to read.
Understanding the Piping Drawing Extraction Utility

PlantSpace 3D models are used for collaborative design and interference detection.
The 3D models require an accurate representation of the volume of each
component. Orthographic drawings, on the other hand, must convey information
about the design through a plotted 2D drawing. For this reason the 3D model must
be adapted to produce a useful 2D drawing.
TriForma’s Drawing Extraction Manager features an extensible facility to provide

such a capability. Piping Drawing Extraction is an extension of TriForma's Drawing
Extraction Manager and produces 2D orthographic drawings that show single-line
representations of 3D Design Series components.
✍ For release V8 XM Edition, Piping Drawing Extraction applies only to piping

components.
Features of Piping Drawing Extraction

Piping Drawing Extraction can add visible centerlines to the 2D orthographic
drawing. In addition, as delivered, Piping Drawing Extraction includes 2D and
single-line representations of the most common piping components such as pipe,
elbows, valves, and tees. Through customization, these symbols can be changed,
and additional symbols can be added. You can produce the following types of
output.
Visible Centerlines
In a piping system, the centerline defines the routing of a collection of components
(for example, fittings). Because the 3D model uses full-size 3D solids to represent
these components, the centerline is visible and selectable.

However, when the 3D graphics are projected to the 2D orthographic drawing and
hidden lines are removed, the centerlines are obscured by the 3D graphics and are
therefore not visible on the drawing output. These centerlines are critical to the
accuracy and completeness of orthographics and are typically the items used to
dimension the piping or equipment components.
Therefore, Piping Drawing Extraction can optionally add visible centerlines in a

form that is suitable for 2D orthographic drawings.
Symbolic Representation of Valves

Valves are converted to double-line symbols. Different symbols are defined for each
type of valve (such as a gate valve or globe valve). You can redefine the symbol for a
valve to change its look.
Single-line Representation of Pipes and Fittings

Sometimes a piping drawing is more clearly presented using a single-line
representation for pipes and certain types of fittings. Typically this technique is used
to represent small bore piping or piping in congested areas. Piping Drawing
Extraction provides a configurable capability to resymbolize pipes and fittings with
single-line representations
✍ In the delivered configuration, not all components will have a single-line

representation.

Running Piping Drawing Extraction
Features of Piping Drawing Extraction
Example
Before: 3D Design Series Piping Model
After: 2D Representation

Piping Drawing Extraction uses configuration variables for storing settings between
design sessions, specifying cell libraries, specifying log files, and so on. They are
listed on the Workspace > Configuration menu under the Design Series
Resymbolization category.
The Piping Drawing Extraction configuration variables begin with "DS_RESYMB"

and can also be found under the All (Alphabetical) category.
Prerequisites
Knowledge required to use Piping Drawing Extraction:
• Because Piping Drawing Extraction is an extension of TriForma's

Drawing Extraction Manager, you need to know how to use
TriForma’s Drawing Extraction Manager. Refer to the TriForma
documentation for the full explanation.
• Piping Drawing Extraction requires PlantSpace Design Series V8
XM Edition. Drawings (3D models) that were created with previous

Customizing the Symbols
versions of Design Series can be symbolically represented as long as

Label Update or other conversion processes have been performed
to make the drawings compatible with Design Series V8 XM
Edition.
Knowledge required to configure and customize Piping Drawing Extraction:
• TriForma’s Drawing Extraction Manager

• Design Series project database
• MicroStation cell libraries
• MicroStation configuration variables

You can use Piping Drawing Extraction without any customization. As delivered,
Design Series can resymbolize the most common piping components as symbols.
However, if you want to have different symbols or additional symbols, then

customization is needed. Modifying the delivered symbols and adding new symbols
involves changes to:
• JSpace class library

• Your project database
• Cell libraries
Classification of Cells
Unscaled Cells
• Created using one cell for each size
• Easiest to create, but they require the largest number of cells
• Most flexible in graphical representation
• Easily created from existing cell libraries of single-line symbols.
Scaled Cells
• Scaled in size to fit the actual size of a Design Series component

• Must contain additional information (in the form of specially named

point cells) so that the system knows which points in the scaled cell
correspond to the connect points of the Design Series component
• Scaled equally in the X, Y, and Z directions
• Good choice for symbols that do not change their proportions as
their size changes.
Dimension-driven Cells
• Use MicroStation's dimension-driven design functionality
• Are the most difficult to create
• Are the most flexible of the three types
• Are created parametrically from the Design Series component's
connect points
• Are suitable for simple graphical representations
• Can become complex to create if the cell contains many graphical
elements
✍ Due to the level of complexity in creating dimension-driven cells, this topic is

covered only through Bentley Professional Consulting Services.
Cell Libraries
✍ The delivered cells are segregated into different cell libraries by type: unscaled,
scaled, and dimension driven. You may find it efficient to segregate your cells
as well to easily identify the type of cell.
As delivered, Piping Drawing Extraction includes three cell libraries used to

resymbolize Design Series components:
• Unscaled.cel
• Scaled.cel
• DimensionDriven.cel
Cells are also used for end-condition symbols, which can be customized as well.
✍ Customization of unscaled and scaled cells is covered in this chapter. Because

of the level of difficulty, customization of dimension-driven cells is offered
only through Bentley Professional Consulting Services.

How the Process of Cell Replacement Works
How the Process of Cell Replacement Works

Several parts of the Piping Drawing Extraction system work together to produce
resymbolized output. It will be helpful to understand how the parts work together.
Understanding the overall process will be helpful for both customization and for
troubleshooting customizations.
To start Piping Drawing Extraction, the user clicks the Calculate All button.
Processing starts and includes the following stages.
1. Read Design Series components

During the processing of the input model, each Design Series
component in the input drawing is read in turn.
2. Create a JSpace object
For each Design Series component, a corresponding JSpace object is
created by instantiating a class from the DrawResymb.lib class library.
This JSpace object contains the DRAW_RESYMB_CELL_INFO

property. This property is an array of three string values (Cell Name,

Cell Library, and Cell Type) that will be used in subsequent processing.
a. To instantiate a JSpace object, you first need to know which JSpace
class to instantiate. The component’s BUD_TYPE attribute is used to
determine this. For example, if the BUD_TYPE is PIPE_PBRN, then
the DRAWRESYMB_PIPE_PBRN class is instantiated.
The JSpace object is instantiated based on data in the Input Property
List that is passed to JSpace. The Input Property List includes the
component’s attributes, settings specified on the Design Series tab in
the Drawing Extraction Manager dialog box, and other information
(such as the component’s orientation).
b. Values for some of the JSpace object’s properties are determined by
querying the Bentley Plant project database. You can assign values to all
properties based solely on the JSpace class library. But for
customization purposes, it is convenient to put some of the required
data into the database and retrieve it through a query.
The DrawResymb table’s primary key is the combination of these
fields: Type, Orientation, Size_Min, Size_Max, and EndCondition.
W The combination of these fields must be unique for each row in the
DrawResymb table.
The value for Type is determined in the JSpace class library.
c. The database query retrieves three items:
• Cell Name - the name of a replacement cell
• Cell Library - the name of a cell library where the replacement cell can
be found
• Method - a single-letter code that indicates the type of replacement
cell (unscaled, scaled, or dimension-driven)
d. The JSpace object contains the DRAW_RESYMB_CELL_INFO
property, which is an array of three items: Cell Name, Cell Library, and
Method. Their values are put into this property.
The purpose of instantiating the JSpace object is to provide the Piping
Drawing Extraction application with the values in the
DRAW_RESYMB_CELL_INFO property.
✍ This view of instantiating the JSpace object is slightly simplified.
In addition to the DRAW_RESYMB_CELL_INFO property,
two additional properties are assigned values:

Customization Example: Mitered Elbows
DRAW_RESYMB_ENDCOND_CELL_INFO, and
HAS_CENTERLINES.
3. Read and process the replacement cell
Using the cell name and cell library name that were obtained from the
JSpace object, a cell is created.
Depending on the type of cell (unscaled, scaled, or dimension-driven),
further processing (such as scaling) is performed that is specific to that
type of cell.
Each replacement cell (unscaled, scaled, or dimension-driven) contains
placeholder end-condition cells that are each replaced by the actual
end-condition cells.
The DRAW_RESYMB_ENDCOND_CELL_INFO property of the
JSpace object is used as a source of data about the actual end-condition
cells. Like its counterpart for the cell as a whole
(DRAW_RESYMB_CELL_INFO), this property is an array of three
properties (Cell Name, Cell Library, and Method).
4. Output the replacement cell
After the replacement cell is created, it is fed into the drawing
extraction process in place of the Design Series component. Further
processing produces a hidden-line view, and the results are written to
the output file.

This example shows how the Piping Drawing Extraction utility can be customized
so that mitered elbows are resymbolized.
The stages in the process of customizing Piping Drawing Extraction include:
1. Adding or modifying a JSpace class

2. Adding or modifying records in the DrawResymb database table
3. Adding or modifying a replacement cell
✍ Depending on the type of customization, all three stages may or may not be
required. In the case of mitered elbows, all three stages are required. However
in customizing the graphical appearance of an existing replacement cell, all
three stages are not required.

➤ To add or modify a JSpace class
W PlantSpace Design Series should be closed.
1. Start JSpace Class Editor.

2. Type the user name and project for your project, and click OK.
3. Open the Drawresymb.lib and Drawresymb_User.lib class
libraries.
The location of the class libraries is project specific.
W Be sure not to modify Drawresymb.lib. Installing a later version of

Design Series will overwrite Drawresymb.lib and any changes you
made will be lost.
4. Create a new JSpace class in Drawresymb_User.lib.
In this case a new class named DRAWRESYMBUSER_PIPE_MTEL
is needed. Any classes you create will begin with
“DRAWRESYMBUSER_” and will be added to the
DrawResymb_User.lib class library.

Given a component, Piping Drawing Extraction searches for a

corresponding class first in Drawresymb_User.lib. The name of the
class that corresponds to a component is formed by concatenating
“DRAWRESYMBUSER_” and the component’s BUD_TYPE.
If a corresponding class is not found in DrawResymb_User.lib, then
DrawResymb.lib is searched. In Drawresymb.lib, the class name is
formed by concatenating “DRAWRESYMB_” with the component’s
BUD_TYPE.
✍ In some cases a new class is not needed. For example, both 90-
degree elbows and 45-degree elbows have the same BUD_TYPE,
PIPE_PELB. The class for both of these types of elbows is
DRAWRESYMB_PIPE_PELB.
To distinguish between 90-degree nd 45-degree elbows, the TYPE
property in DRAWRESYMB_PIPE_PELB incorporates
BEND_ANGLE. The result is that a PIPE_PELB elbow’s type can be
SL_ELBOW_90 or SL_ELBOW_45. Similarly, the TYPE property in
DRAWRESYMB_PIPE_PVLV uses VALVE_TYPE to discriminate
between different types of valves.
5. Click the Add button in the Class Browser to add the class
DRAWRESYMBUSER_PIPE_MTEL.
6. After creating the new class, set its parent class to
DRAWRESYMB_PIPE in Drawresymb.lib.
W This is required so that the new class inherits from

DRAWRESYMB_PIPE.
Optionally, you can also inherit from
DRAWRESYMBUSER_BASE_PIPE in Drawresymb_User.lib.
The class DRAWRESYSMB_PIPE inherits from both
DRAWRESYMB_BASE and DRAWRESYMB_DEBUG.
DRAWRESYMB_DEBUG contains properties:
• For some of the attributes on the Input Property List
• That are not attributes of the Design Series component but are added to
the Input Property List at run-time.
The properties in DRAWRESYMB_DEBUG can be useful for
debugging because these properties will be written to Drawresymb.jsm
along with the other properties. This enables you to see all of the values
that are used to create the JSpace objects.

✍ Although you should not modify a class in Drawresymb.lib, you

can achieve the same effect by overriding it. For example, to
override the TYPE property in DRAWRESYMB_PIPE_PELB,
create a new class in Drawresymb_User.lib named
DRAWRESYMBUSER_PIPE_PELB. Add
DRAWRESYMB_PIPE_PELB as the parent of
DRAWRESYMBUSER_PIPE_PELB. Edit the TYPE property
of DRAWRESYMBUSER_PIPE_PELB.
7. Double-click the DRAWRESYMBUSER_PIPE_MTEL class to
open it.
8. Modify the TYPE property by setting its property source to:
TYPE_PREFIX + "MITERED_ELBOW_" + .NUM_SEG
This will result in the TYPE, SL_MITERED_ELBOW_3, for a
3-segment mitered elbow.
W The value for the TYPE property must match the value in the Type
field in the Drawresymb table in the database.
9. Modify the HAS_CENTERLINE property.
For most components, the HAS_CENTERLINE property that is
inherited from DRAWRESYMB_PIPE is suitable. But for the mitered
elbow, the HAS_CENTERLINE property from the
DRAWRESYBM_PIPE_PELB class is more suitable:
IIF( SIZE <= .SINGLE_LINE_THRESHOLD && ( .ORIENTATION == "UP"
|| .ORIENTATION == "DOWN" ), FALSE, TRUE )
Suggestion: Examine the DRAW_RESYMB_CELL_INFO property.
In the Property Editor dialog box, when you double-click the "A="
text in the property source list box, the three expressions that are
shown correspond to the replacement cell's cell name, cell library name,
and method.
After reviewing these expressions, you can see that these expressions
use other JSpace properties such as SYMBOLIC_CELLNAME,
SYMBOLIC_CELL_LIBRARY, and SYMBOLIC_CELL_TYPE.
These properties get their values from queries on the Drawresymb
database table. Therefore, you do not need to modify the
DRAW_RESYMB_CELL_INFO property.
10. Save your changes and quit JSpace Class Editor.

➤ To add or modify a record in the DrawResymb database table

1. Exit PlantSpace Design Series, and start Microsoft Access
(assuming that your project database is in Microsoft Access).
2. Open your project database and double-click the Drawresymb
table to open it.
3. Create a new record by copying a record for a 90-degree elbow.

4. Set the TYPE field to SL_MITERED_ELBOW_3.
W 1. If the symbolic representation will be classified as a single-line

representation, the value in the TYPE field must begin with SL_.
2. The remainder of the type name is arbitrary, but the value in the
TYPE field must correspond to the TYPE property in the
component’s corresponding JSpace class (such as
DRAWRESYMB_PIPE_MTEL).

The classification of a replacement cell as "single-line" is used at run-

time together with the Single-Line toggle button on the Design Series
tab in the Edit Drawing Definition dialog box.
5. Set the ORIENTATION field to Planar.
The valid values that can be used for orientation depend on the nature
of the Design Series component (for example, the number of connect
points and whether it is axially symmetric). See the reference section at
the end of this chapter for component orientations.
6. Set values for the SIZE_MIN and SIZE_MAX fields.
A single record in the database can correspond to one size (same
minimum size and maximum size) or to a range of sizes.
7. For the END_COND field, add the pound sign (#).
The # character acts like a wildcard indicating that this record applies
to any end condition.
8. Add values for the following fields:
• CELL_NAME, the name of the resymbolization cell that you will create
• CELL_LIB_NAME, the name of the cell library where the
CELL_NAME cell can be found
• METHOD = U for unscaled cell or S for scaled cell
9. Optionally, add a description in the COMMENTS field.
10. Save the record, close the database, and exit Microsoft Access.
Modifying an Existing Record

In the above example, you added a new database record. But it can also be useful to
modify an existing record.
No Drawing Extraction
If you do not want to resymbolize a particular type of Design Series component
such as flanges, you can use TriForma's hidden-line processing to produce the
output in the extracted drawing.
In the Drawresymb database table, delete the record for the type of component that
you want to ignore. Alternatively, instead of deleting the record (which you might
want to re-use later), change the value in the record's TYPE field so that the record
will not be found when queried. For example, change "FLANGE" to "-FLANGE"
by adding a hyphen (-).

Suppressing the Output

You can exclude a Design Series component from the output of the Piping Drawing
Extraction process. For example, as delivered, gaskets do not appear in the results
of the process.
To suppress the output of a Design Series component, modify the Drawresymb

table so that the replacement cell name is: NoSymbol. The NoSymbol cell consists
of a single point, and no graphical representation of it will appear in the final output.
➤ To add or modify a replacement cell
W Any changes to replacement cells must be put into your own cell
libraries. Be sure not to modify the three cell libraries (unscaled.cel,
scaled.cel, and DimensionDriven.cel) that are delivered with Design
Series. Installing a later version of Design Series will overwrite these cell
libraries and any changes you made will be lost.
To continue with the mitered elbow example, you will create a new replacement cell.
To begin, you need to determine whether you need an unscaled or scaled cell. See
“Classification of Cells” on page 12-5. Then, use one of the following procedures.
✍ If you already have libraries of single-line cells, you may want to convert them
into replacement cells that can be used by Piping Drawing Extraction. For the
procedures, see “Resymbolizing Components from Legacy Cell Libraries” on page
12-18.
➤ To create unscaled cells

1. Start Design Series and open a DGN file where you will place
Design Series components and draw single-line graphics.
2. Open a Top view and do all the drawing in this view.
3. Check the current active angle with the keyin: aa=$, and if
necessary, set the active angle to 0 with the keyin: aa=0.
4. Check the active scale with the keyin: as=$, and if necessary, set the
active scale with the keyin: as=1.0,1.0,1.0.
5. Place a Design Series component in the desired orientation (UP,
DOWN, and so on).
✍ See “Replacement Cell Rotations” on page 12-27 in the Reference
section.

6. Draw single-line graphics on top of the Design Series component,

relative to the component's connect points.
7. Move the Design Series component away from the single-line
graphics.
8. Add placeholder end-condition cells to the single-line graphics.
The placeholder cell is named "EndCondition" and is located in the
DimensionDriven.cel cell library. The EndCondition cell has a
direction as well as a location. The cell consists of a short line and a
long line.
9. Place the EndCondition cell so that the long line points away from
the center of the cell.
10. Create a cell from the single-line graphics.
W The origin of the cell must correspond to point 0 in the Design Series
component.
11. Attach the cell library that will contain the unscaled cells, and add
the new cell to it.
➤ To create scaled cells

1. Start Design Series and open a DGN file where you will place
Design Series components and draw single-line graphics.
2. Open a Top view and do all the drawing in this view.
3. Check the current active angle with the keyin: aa=$ and, if
necessary, set the active angle to 0 with the keyin: aa=0.
4. Check the active scale with the keyin: as=$ and, if necessary, set the
active scale with the keyin: as=1.0,1.0,1.0.
5. Place a Design Series component in the desired orientation (UP,
DOWN, and so on).
✍ See “Replacement Cell Rotations” on page 12-27 in the Reference
section.
6. Draw single-line graphics on top of the Design Series component,
relative the component's connect points.
7. Move the Design Series component away from the single-line
graphics.

8. Place point cells at the locations on the single-line graphics that

correspond to the connect points (points 0,1,2,3, and 4) of the
Design Series component.
W The point cells are named POINT_0, POINT_1, ... . The names of
the point cells must match the values of the
DS_RESYMB_SCALING_PT0_CELL,
DS_RESYMB_SCALING_PT1_CELL, ... configuration variables.
The point cells are located in the scaled.cel cell library.
9. Add placeholder end-condition cells to the single-line graphics.
The placeholder cell is named "EndCondition" and is located in the
DimensionDriven.cel cell library. The EndCondition cell has a
direction as well as a location. The cell consists of a short line and a
long line.
10. Place the EndCondition cell so that the long line points away from
the center of the cell.
11. Create a cell from the single-line graphics.
W The origin of the cell must correspond to point 0 in the Design Series
component.
12. Attach the cell library that will contain the unscaled cells, and add
the new cell to it.
Modifying an Existing Replacement Cell

In some cases you may want to use an existing replacement cell and modify its
appearance. For example, you might want square elbow corners instead of round
ones. In such a case, it is possible to take an existing replacement cell and use it as
the basis for a new one. This is possible for unscaled and scaled cells, but it is not
feasible for dimension-driven cells.
➤ To modify an existing replacement cell

1. Move the replacement cell to one of your own cell libraries.
2. Open the cell library in MicroStation and open the model
containing the cell.
3. Edit the cell graphics.
✍ You can change any graphics except for the point cells
(POINT_0, POINT_1, ...), the EndCondtion cells (if any), the
NOMINAL_SIZE_CIRCLE cell, or the
NOMINAL_SIZE_RECTANGLE cell.

Resymbolizing Components from Legacy Cell Libraries

If you already have cell libraries, you can use them to resymbolize your components.
➤ To make unscaled cells from an existing symbol library

1. To change fixed-size cells to unscaled cells, ensure that the cells are
oriented in the way that is expected (as described in the “Replacement
Cell Rotations” on page 12-27).
2. Optionally, add EndCondition cells the unscaled cells to reduce the
number of required cells.
➤ To make scaled cells from an existing symbol library

1. to change fixed-size cells to scaled cells, select a cell from the fixed-
size symbol library that you want to change.
2. Ensure that the cell is oriented in the way that is expected (as
described in the “Replacement Cell Rotations” on page 12-27).
3. Add point cells (POINT_0, POINT_1, etc.) to the existing cell.
A convenient way to do that is to open the existing cell library in
MicroStation and change the graphics in the model that corresponds to
the cell.
4. Add EndCondition cells to the unscaled cell to reduce the number
of required cells.
✍ It is not necessary to add point cells in all circumstances. When
Piping Drawing Extraction needs to scale a scaled cell, it looks
first for point cells. If point cells are found, they are used to scale
the scaled cell. But if no point cells are found, the cell will be
scaled so that the X-extent of the unrotated cell matches the X-
extent of the unrotated Design Series component of the
unrotated Design Series component.

Reference Section
Reference Section
This section contains lookup information to help in configuring and customizing
the application.
• “Orientations” on page 12-19

• “Replacement Cell Rotations” on page 12-27
• “Troubleshooting” on page 12-29
Orientations
During drawing extraction, to find the name of a replacement cell, you query the
Drawresymb table. One of the fields in the Drawresymb table used in the query is
ORIENTATION. The orientation of a Design Series component is a function of
both:
• The position of the component in MicroStation's global coordinate

system
• The view specified in a drawing definition
Examples
When viewed from MicroStation's Top view, we call the orientation of this tee
Planar.
When viewed from MicroStation's Front view, the orientation of this tee is Planar.
In both cases in which the orientation is Planar, you would use the same single-line
symbol to represent the tee. That is what orientation means in the context of Piping
Drawing Extraction.

Reference Section
The values in the ORIENTATION field in the Drawresymb table are chosen from
a discrete set of orientations. For example, the orientation of a pipe is classified as
Planar, Up, Down, or Skewed.
✍ Not every orientation applies to every component. The set of orientations that
apply depends on the type of component and on the number of connect
points.
The following illustrations show examples of each orientation.
Two Snap Points, Not Axially Symmetric

Example: Valve with Operator
Orientation View Top View Iso View

Planar
Top
Bottom

Orientations

Up
Down
[2pts_ns_down_ISO.tif]
Skewed

Reference Section
Two Snap Points and Axially Symmetric

Example: Pipe

Planar
Up
Down
Skewed

Orientations
Three Snap Points

Example: 90° and 45° Elbows
Some of the following orientations distinguish between the two connect points. For
example, 90Up1 is the orientation for an up-facing 90 degree elbow with connect
point 1 facing up. Similarly, 90Up2 is the orientation for an up-facing 90 degree
elbow with connect point 2 facing up.
In most cases, these two orientations can be treated as equivalent. We distinguish

between these orientations so that reducing components can have single-line
representations that take into account the different sizes of the two ends.

Planar
90UP1
90UP2
90DOWN1

Reference Section

90DOWN2
45UP1
45UP2
45DOWN1
45DOWN2
UP1_45DOWN2
UP2_45DOWN1
DOWN1_45UP2

Orientations

DOWN2_45UP1
Skewed
Four Snap Points

Example: Tee

Planar
Up
Down
SideBranch
Skewed

Reference Section
Five Snap Points

Example: Crosses

Planar
Up1
Up2
Up3
Up4
Skewed

Replacement Cell Rotations
Replacement Cell Rotations
W When a replacement cell is created, the angle at which the cell graphics is
drawn is important. The replacement cell needs to be drawn so that its
unrotated orientation is the same as the unrotated orientation of the DS
component.
The following guidelines apply to all types of replacement cells (unscaled, scaled, or
dimension-driven).
• 2 points, and not axially symmetric

Example: valves with operators, eccentric reducers
Snap points are like this:
Vector from pt0 to pt1 points along the positive X axis
• 2 points, and axially symmetric

Example: reducers
• 3 points
Example: elbows, planar orientation
Vector from pt0 to pt1 points along the negative X axis

Reference Section
Example: elbows, up orientation

FortheUP,andDOWNorientations,thereplacementcellsaredrawnsothatthe
vectorfrompt0topt1(orpt0topt2)pointsalongthenegativeXaxis.Example:a
valid up-facing single-line elbow
• 4 points
Example: tees
• 5 points
Example: cross

Troubleshooting
Troubleshooting
If the output from Piping Drawing Extraction is not what you expect, then it may
be that an error condition was encountered during processing. If so, then it will be
necessary to diagnose the problem and fix it.
Problems can arise as a result of configuring or customizing Piping Drawing

Extraction. To diagnose a problem, look at the following sources of information:
• Error messages written to the MicroStation Message Center

• The Piping Drawing Extraction log file (resymb.log)
• A temporary *.dgn file that contains intermediate results
(drawResymbTemp.dgn)
• A JSpace model file that contains JSpace objects instantiated during
Piping Drawing Extraction (drawResymb.jsm)
With the error log, etc. in hand, you can use the following checklist to diagnose the
problem.
IstheTriformaDrawingExtractionManagerconfigurationcorrect?
Piping Drawing Extraction uses TriForma's drawing extraction functionality. The
first step in resolving problems with the drawing extraction process is to verify that
there are no problems with drawing extraction using Triforma by itself.
Start TriForma (without Design Series). Open the TriForma Drawing Extraction
Manager dialog box. Double-click a drawing definition to view (or edit) it.
Examine the Region tab. The settings on this tab define the clipping volume for
drawing extraction. The clipping volume is also displayed graphically in the drawing.
Verify that the clipping volume encompasses the graphics to be extracted.
Note that if a clipping plane passes through a Design Series component, the
resulting output will not be complete.
Run drawing extraction and verify that the desired graphics appear in the output.
Then close Triforma.
Is Piping Drawing Extraction loaded?

Open Design Series. Piping Drawing Extraction (drawresymb.ma) will automatically
be loaded. If there are no problems loading it, the message "DRAWRESYMB
loaded" will be displayed in the MicroStation Message Center.
Otherwise, there will be an error message in the Message Center.

Reference Section
Are the options in the user interface set correctly?

Open the Triforma Drawing Extraction Manager. Double-click a drawing definition
and look at the Design Series tab. Verify that the appropriate toggle buttons are
checked.
Resymbolize and Singleline
If Resymbolize is On and Singleline is Off, then only valves will be resymbolized. If
Singleline is turned On, then pipe, elbows, and the like will also be resymbolized.
Singleline if SIZE <=
Look at the "Singleline if SIZE <=" setting. A component whose nominal size is
larger than this setting will not be resymbolized as single-line graphics. To generate
single-line graphics, a component's nominal size must be less than or equal to this
setting. The units for this setting are subunits (inches or millimeters).
For example, if the setting is 10, then single-line graphics will be generated for a 10
inch or 8 inch elbow, but not for 12 inch elbow.
Suppress Display if SIZE <
Look at the "Suppress Display if SIZE <" setting. No graphics will appear in the
output for components whose nominal size is less than this setting.
Are the configuration variables set correctly?
Paths
JPATH - Piping Drawing Extraction uses a JSpace class library named
Drawresymb.lib. This file must be located in one of the paths specified by the
JPATH MicroStation configuration variable.
PS_TEMP - A log file, a temporary *.jsm file, and a temporary *.dgn file (all of
which can be useful for debugging) are written to the directory specified by
PS_TEMP.
Database
PS_CODES_DB - The JSpace class library requires a database connection. Verify
that the database connection information in PS_CODES_DB is valid.
Debugging
DS_RESYMB_CELL_INFO_SAVE_JSM - If this variable is defined and set to 1,
then JSpace will create a file named Drawresymb.jsm in %PS_TEMP%.
DS_RESYMB_LOG_FILE - path and name of a log file.
DS_RESYM_LOG_FILE_LEVEL - controls how detailed the log file is. Valid

values are 0, 1, 3, 7, 15, 31. The higher numbers produce more detailed output.

Troubleshooting
DS_RESYMB_WORKFILE - path and name of a temporary *.dgn useful for

debugging. The *.dgn file contains the output from Piping Drawing Extraction
before hidden-line removal has been performed and before mask elements have
been removed. This *.dgn file allows you to see exactly what the resymbolization
cells look like after they have been processed as Unscaled, Scaled or Dimension-
Driven cells.
Cells
DS_RESYM_CELL_LIB_DD,
DS_RESYM_CELL_LIB_SCALED
DS_RESYM_CELL_LIB_UNSCALED - These variables specify the location of

cell libraries.
The remaining DS_RESYMB_... configuration variables are used for persistent

settings or for other items that are not particularly useful for debugging.
Is the Class Library correct?

Piping Drawing Extraction uses the Drawresymb.lib JSpace class library to
determine the name of the resymbolization cell.
To see the JSpace objects that are instantiated by JSpace during Piping Drawing
Extraction, look at Drawresymb.jsm in the JSpace class editor. Look at a property
called DRAW_RESYMB_CELL_INFO. This property is an array of three values.
Double-click it in the class editor to see all three elements.
If Then
If one or more of these Look at the SYMBOLIC_CELLNAME,
three elements is Null SYMBOLIC_CELL_LIBRARY, and
SYMBOLIC_CELL_TYPE properties in
Drawresymb.jsm.
If these properties are You need to debug the property sources (in Drawre-
Null symb.lib) for these properties.
Is the Database correct?

The database contains a table named DrawResymb. This table specifies the cells that
will be used when Design Series components are resymbolized.
The DrawResymb table is used by the JSpace class library Drawresymb.lib.

Reference Section
A Design Series component will be resymbolized only if the required information

about the replacement cell can be successfully retrieved from the DrawResymb
table.
The primary key of DrawResymb is the concatenation of these fields:
• Type
• Orientation
• Size_Min
• Size_Max
• End_Cond
The other fields (Cell_Name, Cell_Lib_Name, and Method) contain the data that a
query returns to JSpace.
W 1. In the Drawresymb table, the combination of Type, Orientation,

Size_Min, Size_Max, and End_Cond must be unique. These fields
combined are used to query the table.
2. The query requires that exactly one row must be returned. If two rows
are returned that result in an error, resymbolization fails.
Field Descriptions in the Table
Field Description
Type The Type is an arbitrary descriptive string. The Type
must correspond to the Type property in a JSpace class
in DrawResymb.lib. If the Type field in the database
does not match the Type property in the corresponding
JSPace object, then resymbolization cannot be done.
Orientation The Orientation refers to the orientation of the Design
Series component in a given view. For example, if a
Drawing Definition uses a Front view, and an elbow is
planar (i.e., flat) when viewed in the Front view, then the
orientation for that component would be planar.
The set of orientation values must begin and end with a
semi-colon (;). You must separate multiple values with a
semi-colon (;).
The valid values for Orientation depend on the type of
component and how many connect points it has. See
“Orientations” on page 12-19 for a complete list of
orientations.

Troubleshooting
Field Description
Size_Min If a record in DrawResymb is intended to be used for a
Size_Max single size, then Size_Min and Size_Max should be equal.
Otherwise, Size_Min and Size_Max specify a range of
sizes (inclusive).
End_Cond End_Cond is not currently used and should contain a
value of "#".
Cell_Name This field contains the name of a resymbolization cell.
This cell must exist in the cell library specified by the
Cell_Lib_Name field.
Cell_Lib_Name This field specifies the name of the cell library that
contains the replacement cell. The value of this field can
be an explicit file and path specification, or it can be a
reference to a MicroStation configuration variable. If a
configuration variable is used, enclose the configuration
variable in $( ) for example,
$(DS_RESYMB_CELL_LIB_UNSCALED).
Note: Check the value of the configuration variable (in
MicroStation) so that you know which cell library is
being used.
Method The valid values for Method are:
• U = unscaled
• S = scaled
• D = dimension-driven
Comments The Comments field can contain a descriptive comment.
Are the End-Condition Cells being found?

Given a certain type of Design Series component (such as an elbow), it is possible to
have a separate resymbolization cell for each type of end condition (Butt Weld,
Socket Weld, etc.). But that would result in a large number of cells.
To avoid multiplying the number of cells, we provide a way to create one

resymbolization cell, and give it different end conditions.
We use a cell named EndCondition as a placeholder for end condition symbols. The
EndCondition cell specifies the location of an end condition, and its orientation/
direction.
For an elbow, for example, the resymbolization cell would contain two
EndCondition cells.

Reference Section
At runtime, Piping Drawing Extraction replaces EndCondtion cells that are inside
resymbolization cells with other cells. For example, for a Socket Weld elbow, the
EndCondition cells would be replaced by EndCond_SocketWeld cells.
Inference rules in drawresymb.lib determine the end-condition cell (such as

EndCond_SocketWeld) that will be used. This can be seen in drawresymb.jsm.
Look at the DRAW_RESYMB_ENDCOND_CELL_INFO property in
drawresymb.jsm. This property is an array of three values. Double-click on it in the
class editor to see all three elements.
If the process of finding a name for an end-condition cell fails, then the entire
component will not be resymbolized.

Appendix A: File Extensions in PlantSpace
Design Series
Introduction
This appendix serves as a quick reference to explain the different file formats by file
extension that you may find in using PlantSpace Design Series.
Alphabetized Listing
The following table lists the file extensions and describes the type of file that
contains each extension.
File
Description
Extension
*.all The output file from TriForma Drawing Extraction Manager and its
extension, Piping Drawing Extraction
*.alt ISOGEN file
*.blk Equipment property values file, which can be saved and loaded for
placing building block equipment
*.cel MicroStation cell library used in Design Series to create a unique
component or terminator cells
Example: symbol.cel
*.cfg Configuration variable file used to define configuration variables in
Design Series
Example: dslocal.cfg
*.dat Design Series data file used for a variety of purposes such as for
engineering specifications and settings
Example: rimref.dat (for storing component label data)
*.dbf dBASE IV (DBF) file created in the Design Series Object Reporter
to display formatted report data in a third-party application such as
Microsoft Access
Example: myreport.dbf
*.ddf ISOGEN file
August 11, 2008 PlantSpace Design Series Administrator Guide A-1

File
Description
Extension
*.dgn MicroStation design (DGN) file used in Design Series modeling
Example: ps_pipe.dgn
*.dgnlib MicroStation DGN library file, which has the same file format as a
DGN file, but by convention contains information that is shared
throughout files. In Design Series, used to specify the Design Series
menu and the menu items added to the Help menu.
Example: PSDS_menu.dgnlib
*.eps MicroStation plot (EPS) file used to print design files
*.eqp Equipment property values file, which can be saved and loaded for
placing parametric equipment
*.fls PlantSpace AutoISOGEN file containing a list of the files that
PlantSpace AutoISOGEN uses to format the isometric drawing
*.fnc JSpace system file containing the built-in functions used as part of
JSpace technology in all PlantSpace applications
Example: Jspace.fnc
.jsm JSpace object model (JSM) file, an intelligent 3D file used in Design
Series
Example: ps_pipe.jsm
*.lbl Obsolete.
Note: The annotation rule file called default.lbl was changed to a
class library (LIB) file in version 8.0.
*.lib JSpace class library file
Example: ams.lib and jclass.lib (sample library files delivered with
Design Series)
*.log Text file used for a variety of purposes to display results of
processing
Example: ps_dbrpt.log (log of the run data to create a DBF file when
you run Object Reporter from a command line)
*.ma MicroStation application file
Example: autotext.ma
*.mdb Microsoft Access database (MDB) file
*.opl ISOGEN file
*.pcf MicroStation project configuration file (PCF) used to define your
project configuration. Also an ISOGEN output file.
Example: {ProjectName}.pcf and ps_iso.pcf (in ISOGEN)
A-2 PlantSpace Design Series Administrator Guide June 8, 2007

File
Description
Extension
*.pdf Portable document format (PDF), the platform-independent
document file used to view and print electronic books
Example: PSDSadmin.pdf (Design Series Administrator Guide)
*.qry Query file created when you save a query in the MCS Check-out
operation
*.qtl Query file created when you save a query in Utilities>Query
*.r Design Series rule files that are loaded into the project database
during installation
Example: atdfn000.r
*.rdf Report definition file, a plain text file created in Specification Maker
to be added to the report_e.dat (imperial) file or report_m.dat (SI or
metric) file in the Object Reporter to generate a DBF file for reports
*.ref MicroStation reference file. The default naming convention is to give
the reference file the same name as the primary file and add the REF
extension.
Example: primaryfile.ref
*.res JSpace resource file with language-dependent strings used in
internalization/localization. See also *.rsc.
Example: ams.res
*.rgb Files used in color definitions when you load data from another
CAD application
Example: acad.rgb
*.rsc MicroStation resource file with language-dependent strings used in
internalization/localization. See also *.res.
Example: jlibmsg.rsc
*.rul Design Series rule files that are text files containing settings
Example: default.rul (sample pipe label file delivered with Design
Series)
*.run Report run file in the Object Reporter program used to save the
input required to process report data so that you can re-use the same
settings to get the same output at a later time
Example: reportrun.run
*.s71 File in Specification Maker that is compatible with PlantSpace
Design Series version 7.1x
*.scr Script file used to execute your own script commands through the
Database Setup tool
June 8, 2007 PlantSpace Design Series Administrator Guide A-3

File
Description
Extension
*.spe File in Specification Generator that the newer program, Specification
Maker, can convert to an S71 file
*.spt File in Specification Generator that the newer program, Specification
Maker, can convert to an S71 file
*.sql Structured Query Language (SQL) file used when you want to
execute your own SQL commands through the Database Setup tool
*.sup Interference detection suppression (SUP) rules file used to suppress
certain rules in checking interferences
Example: psdesign.sup
*.vol Master or discipline volume (VOL) definition file used to define
areas of a design file
Example: project.vol
*.txt ASCII (TXT) file in MicroStation and Design Series
Example: short.txt
*.ucf MicroStation user configuration file (UCF)
A-4 PlantSpace Design Series Administrator Guide June 8, 2007

B Using the Expert System in Design
Series
The underlying knowledge built into the Design Series software is
its expert system. This chapter explains the major features of this
system so that you can use these concepts to customize your system
to meet your business needs.
Understanding the Expert System in Design Series

The expert system in Design Series is a rule-based expert system. These expert rules
are the backbone of the Design Series software, and they control:
• The general behavior of the software

• The graphical representation of each component
• The attributes required to model a component
• The choices that the user can select
• The tools for the user to customize and configure the behavior of
the system
Design Series application programs, such as Annotation and the Stress Analysis
Interface, use the expert system to enable you to customize the applications by
adding specific knowledge to the rule files. In addition, expert rules in the
parametric modeling system create three-dimensional graphical representations of
the components.
How Knowledge Is Represented

A variety of trigonometric, mathematical and string-handling functions are available
in the knowledge base. Knowledge is represented by IF-THEN production rules.
These rules enable you to control the actions that the rule file takes based on
specific events or conditions. Each production rule represents a specific goal or
subgoal that the expert system must reach based on the analysis of the event. The
expert system uses a backward chaining inference mechanism to analyze and deduce
the steps required to reach the goal.
August 11, 2008 PlantSpace Design Series Administrator Guide B-1

B Using the Expert System in Design Series
Understanding the Expert System in Design Series
Backward Chaining
In addition to understanding the basic elements of the IF-THEN proposition, you
need to understand how the Inference Engine (a processing program) processes
these rules to obtain values for properties associated with a particular object. The
Inference Engine uses a mechanism called backward chaining inference (or simply,
backward chaining). Backward chaining determines the values for properties and
methods.
How Backward Chaining Works
Backward chaining is a process involving the following stages:
1. The Inference Engine receives the name of the goal variable or

property for which a value is needed.
2. The Inference Engine checks to see if a value has already been
assigned. Typically, this stage occurs when, in the process of getting
the value for a previous goal variable, the Inference Engine assigned
a value to the variable in question.
3. Once the Inference Engine assigns a value to a variable, it retains
that value until the operation being performed (such as generating a
graphic component) is complete or the value is explicitly cleared by
another rule.
4. Assuming a value is not already assigned to the goal variable, the
Inference Engine then searches the rule base for the first rule that
can assign a value to it. Here, the Inference Engine looks for the
first rule containing the variable in its conclusion. This search
proceeds through the rules in the order in which they were defined
in the rule file.
5. If the Inference Engine finds a rule, it checks to see if the premise
of the rule, if one exists, can be satisfied.
As a reminder, rules are structured as:
IF <Premise> THEN <Conclusion>
6. If the Inference Engine satisfies the premise of the rule, it makes
assertions (variable assignments) in the conclusion portion of the
rule. The process of assigning values to variables contained in the
conclusion portion of a rule is often referred to as “firing the rule.”
The Inference Engine checks to see if the user can override the
value.
B-2 PlantSpace Design Series Administrator Guide August 11, 2008

Using the Expert System in Design Series
Backward Chaining
If allowed, the user is asked to either accept the value assigned to

the variable or to enter a new value.
If the user is not allowed to override the value, the value currently
assigned is used.
7. If the Inference Engine does not satisfy the premise, it searches for
the next rule that can assign a value to the goal variable.
8. If the Inference Engine finds no rules or does not satisfy the
premises of the rules found, it terminates the inference.
Handling an Unknown Variable in Backward Chaining
In the process of evaluating the premise or conclusion portion of a rule, the

Inference Engine may encounter an unknown variable with a value that it must
determine before proceeding. In such a case, the stages in the following process
occur:
1. The Inference Engine treats the unknown variable as a subgoal

variable and tries to get a value for it in the same way that it does for
the goal variable, that is, by looking for the first rule that contains
the unknown variable in its conclusion.
2. Likewise, in the process of getting a value for the subgoal variable,
the Inference Engine may find other unknown variables. These
variables, in turn, become sub-subgoal variables. This pattern
continues until the Inference Engine assigns a value to the unknown
variable.
3. Once the Inference Engine assigns the value, it retraces its steps and
tests the rules that provided its original path. When a rule sends the
Inference Engine out to find a value for a variable contained in its
premise, the Inference Engine immediately returns to that rule once
it finds the value.
4. If the rule then fails (because the value found does not match the
value required to satisfy the condition in the premise), the Inference
Engine always goes immediately to the next rule (if one exists)
whose conclusion assigns a value to the same variable that is named
in the conclusion of the rule that just failed.
5. This pattern continues, assuming that the Inference Engine can get
values for all unknown variables, until the Inference Engine assigns
a value to the goal variable.

Knowledge Base
Layout of the Rule File

Expert system behavior is defined in text rule files. Each rule file contains a
knowledge base that structures the reasoning environment as a set of variables and
IF-THEN rules that operate with these variables.
Design Series uses the expert system for two different internal applications:
parametric modeling and annotation for each application. Different functions will
be referenced in the premise (IF) and conclusion (THEN) portions of the rules in
the knowledge base.
These concepts (knowledge base, parametric modeling, annotation) will be

discussed in greater detail in the following sections.
Knowledge Base
Three classes of statements can be found in the knowledge base:
• The first class of statements defines the variables and values to be

used in the reasoning. Variables must be defined before they are
referenced in the file.
• The second class of statements is the IF-THEN production rule,
which represents knowledge or reasoning based on relationships
between the defined variables.
• The final statement class controls which lines of the file are valid for
use by the expert system. This class includes Comments and the
End of Rule marker.
Variable Declarations
The declarations can consist of the variable name, variable type, default or initial
values, cardinal values, and prompted values as explained in the following sections.
Variable Name
These variables are similar to the variables used in a conventional C program. The
variable name can contain:
• Letters
• Digits
• The dollar sign ($) and underscore (_)

Variable names must be less than 64 characters in length. The first character of the
variable name must always be a letter. The name is NOT case sensitive. For example,
bandWidth_Z is the same as Bandwidth_z.
Certain keywords are considered reserved and cannot be used as variable names.
These are: IF, THEN, AND, OR, INT, INTEGER, REAL, DOUBLE, CHAR, TEXT.
Built-in function names contained in the Guide are also considered reserved words.
Examples of variable names that are valid:

pipe_od
line2
The following variable names are not valid:

$count
3rdstep
✍ It is to your advantage to use consistent and descriptive naming such as

bandLength_1 rather than b1.
Variable Type
The expert system supports the traditional integer, real, and character type variables.
You can declare variables by using the following variable types as keywords:
Type Description
INTEGER or INT Four (4) byte integer
REAL or DOUBLE Eight (8) byte floating point real
CHAR or TEXT Text string up to 32767 characters
You can make variable declarations by using C programming-like syntax and, for
backward compatibility, the original (TYPE) syntax.
The C programming-like syntax enables you to declare multiple variables of the

same type in a single statement. You must separate each variable by a comma and
end a declaration line with a semi-colon (;). For example:
INT a, b, c;
declares three integer variables a, b, and c.

Knowledge Base
The original syntax requires the (TYPE) keyword. Only one variable can be declared
in a single statement. For example:
(TYPE) spec CHAR
(TYPE) pipe_size REAL
declares a real variable pipe_size and a string variable spec.
A variable can also represent an array of values. Each individual array element can be
addressed using C programming-like syntax of referencing arrays. For example:
INT flags[5];
declares an array variable flags of size 5. You can address individual elements by
using flags[0], flags[1],..., flags[4].
Default or Initial Values
As in C programming, you can assign variables default or initial values. In interactive

applications, when the system prompts the user for values, the current value of the
variable is displayed. In non-interactive applications, the system automatically uses
the value assigned to the variable.
✍ If a variable (that is used in an inference rule) does not have a value assigned to
it by initialization or backward chaining, the expert system generates a prompt
for the value.
You can assign default values by using C programming-like syntax and, for backward
compatibility, the original (VALU) syntax.
The C programming-like syntax enables you to assign default values to an individual

variable or array. For example:
INT a, b, c[3] = {13, 17, 23}, d = 0;
declares three integer variables a, b, and d with d initialized to 0. In addition, a

three element integer array c has been declared and assigned initial values of 13,
17, and 23.
Real values assigned to INTEGERs will be automatically truncated. For example,

INT pi=3.14 gives pi a value of 3.
The original syntax requires the (VALU) keyword for initialization. For example:
(VALU) pipe_od 6.625

assigns the variable pipe_od a value of 6.625.
Cardinal Values and Ranges
Often it is necessary to limit the actual values assigned to variables to a range or to a

specific set of values. The term cardinality describes the set of limiting values. This
concept makes use of the (CARD) keyword.
For numeric (real or integer) variables, the syntax is as follows:

(CARD) name value1, value2
where means
name Variable name
value1 Lower limit of the range
value2 Upper limit of the range
For non-numeric (character or text) variables, cardinality establishes a list of

permissible values. The syntax is as follows:
(CARD) name "value1", "value2"[,...]
✍ The values must be surrounded by single or double quotes.
where means
name Variable name
value* Cardinal value for the string or text
For example:
(CARD) pipe_size 4.0, 12.0
(CARD) master_code "A", 'B', 'C', "D"
allows pipe_size to be assigned a value between 4.0 and 12.0 and

master_code to be assigned A, B, C or D.
Prompted Values
For interactive rules that are configured to do so, the expert system has the
capability to prompt users for input. Typically this prompt is displayed to the user in
MicroStation as:

Knowledge Base
Define <variable>
where means
variable Name of the variable
If the expert system needs to display more information about a variable, you can use
the (DESC) keyword. The syntax is:
(DESC) <variable> "<description> "
where means
description Description of the variable
For example:
(DESC) pipe_size "Pipe Diameter "
results in the display of the following message:

Define Pipe_Size Diameter
In many cases this description is not sufficient. You may need to provide a more
descriptive prompt, which you can do by using the (PROM) keyword. Valid syntax is
as follows:
(PROM) <variable> "<prompt> "
(PROM) <variable> '<prompt>'
where means
prompt Message prompt
For example:
(PROM) pipe_size "Enter diameter of pipe"
(PROM) pipe_size 'Enter diameter of pipe'
are both valid and have the same effect.

IF-THEN Production Rules
In cases where the data entered must be treated as working units, you can use a
special syntax to inform the expert system to interpret the value by using a working
unit format of MicroStation. For example:
(PROM) <variable> "@wu<prompt>"
(PROM) pipe_size "@wuEnter diameter of pipe"
In this case, if the user enters 2 as the value, the system treats it as 2:0:0, rather than
0:2:0.

Once you declare the variables and assign values and prompts, production rules use
these variables to encapsulate some kind of knowledge. The following sections
describe the fundamentals of writing such rules.
IF-THEN Syntax
The IF-THEN rules represent expertise or knowledge to solve a problem when

certain conditions are met or exist. To explain this with an example, suppose you
must incorporate the following statement as a rule:
If supporting steel is directly above the piping system and the

distance to the supporting steel is greater than 1 foot, then the type
of hanger used should be Type 1. Otherwise, the hanger should be
Type 2.
The appropriate IF-THEN rules would be as follows:

(RULE) IF support_location = 'above' AND
support_distance >= 1_ft
THEN hanger_type = '1'
(RULE) THEN hanger_type = '2'
Features of the Rule Syntax
The expert rule syntax supports several features including:
• AND and OR operators

• Relational operators such as > and =
• Arithmetic operators such as + and -

Knowledge Base
• Character operators
• Dollar sign ($) commands
• Numbers using working units and dimensional formats
• Standard built-in functions
AND and OR Operators
The rule syntax supports the use of AND and OR operators. These operators could
be used together with IF or THEN. The following rules are valid:
(RULE) IF A = 1 OR B = 1
THEN C = 4 AND D = 2
(RULE) IF (A = 1 AND B = 1) OR D=1
THEN C = 0
(RULE) IF A=0
THEN B=0 AND C=0 AND D=0
(RULE) IF A=1 AND B=1 AND C=1
THEN D=1
✍ The expert system evaluates expressions from left to right. However, an OR

operator forces all expressions in the statement to be evaluated.
For example:
IF A and (B or C)
requires the expert system to evaluate A, B and C even if B is TRUE.
Therefore, you must be careful to ensure that all variables A, B and
C have values assigned to them. If all variables do not have an
assigned valued, the system will request a value. On the other hand,
an AND results in the system stopping evaluations when it finds the
first expression that evaluates to FALSE.

Relational Operators
The expert system supports several relational operators including:
Operator Meaning
< Less than
<= Less than or equal to
= Equal to
!= Not equal to
<> Not equal to
> Greater than
>= Greater than or equal to
W You cannot use parenthesis ( ) to the left of the relational operator.
The following are examples of non-valid statements and valid equivalents:
Non-Valid Rule Valid Equivalent

(RULE) IF (a - b) * c > d (RULE) IF d < (a - b) * c
(RULE) IF (c > a) and (c*a) > b (RULE) IF (c > a) and (c*a > b)
Arithmetic Operators and Precedence Order
The expert system supports several arithmetic operators including:
Operator Meaning
+ Add
- Subtract
/ Divide
* Multiply
** Exponential
The expression is evaluated from left to right by using the following precedence
rules for the arithmetic operators in this order:
1. **
2. * or /

Knowledge Base
3. + or -
Using parentheses ( ) ensures that the expert system evaluates expressions in a

particular order. The system evaluates the contents inside the parentheses first, and
then the contents outside the parentheses.
The following are examples of expressions and results:
Expression Result
(2+3)*6-1 29
(2+3)*(6-1) 25
2+3*6-1 19
2+3*(6-1) 17
Character Operators
The only character operator that the expert system supports is the concatenation
operator (//). All white spaces are included in the result. For example:
TEXT A = "This is an example", B = "of the concatenation
operator", C;
(RULE) THEN C = A//B
results in the system assigning to C the statement

'This is an exampleof the concatenation operator'
Notice the omission of the IF clause in the RULE. The premise of this rule is true
by default and the rule will fire if a value for C is sought.
Directives
The expert system uses certain universal symbols. These include unit settings and
logic tracing, which you can specify in any rule file. Directives (beginning with the
dollar sign ($) symbol) are used to globally define expert system behavior for a rule
file.
✍ $Directives are reserved for internal use. You cannot define your own.

The $Directives are:
$Directive
Description
(and Parameter)
$DYNAMIC_ON Turns on the Design Series Dynamic Placement
Server. When on, the MicroStation system can call
special dynamic placement software. The default
condition is off. For details, see the DYNAMIC_ON
option in the function “CONTROL” on page 5-57
of the PlantSpace Design Series Reference Guide for
Administrators.
$MASTUN <unit_name> Defines the master units name. The default
unit_name is foot.
$MODUN <unit_name> Defines the modeling units that the expert system
uses to compute all of its values. The default
unit_name is inch.
$MUSU <value> Defines how many sub-units compose one Master
unit. The default value is 12.
$PRODUCT '<prod name>' The $PRODUCT directive sets the product to a
default value in a rule. This makes it easier to make
multiple BUD calls because the product name is not
required on the bud_type line.
$REASON_FILE <filename> Defines the name of the file where the log will be
written showing the processing of the rules,
including the variable currently being evaluated. If
the filename does not specify path information, the
output file is written to the path set by the
$PS_TEMP configuration variable. The default
path is {network drive}\Projects85\{ProjectName}
\temp.

Knowledge Base
$Directive
Description
(and Parameter)
$SHIP_CELL '<keyword>' One of the following keywords must be used with
the $SHIP_CELL directive:
'CONTINUOUS' cell placement displays the cells as
they are created.
'ONE_TIME' cell creation shows the creation of the
cells within the rule all at once when the rule ends.
'DEFAULT' creates the cell whenever the
CELL('END') command is executed.
Note: For an alternative method of shipping cells
to MicroStation, see the function “CONTROL” on
page 5-57 of the PlantSpace Design Series Reference
Guide for Administrators.
$SUBUN <unit_name> Defines the name of the sub-unit. The default value
for unit_name is inch.
$SUPU <value> Defines the number of positional units that make
up one sub-unit. The default value is 8000.
$UORS <value> Defines the number of positional units that make
up one modeling unit. The default value is 8000.
$UORS is similar to $SUPU.
Example 1
In the following example, this command instructs the rule to create the graphical
output as the cells are created.
$SHIP_CELL 'CONTINUOUS'
Example 2
In the following example, the expert system is directed to place a trace of the
inferencing in the specified text file.
$REASON_FILE "d:\bp5000.txt"
Numbers Using Working Units and Dimensional Formats
The expert system can recognize integer or real numbers in two formats:
• Working unit format (for example, MU:SU:PU)

• Unitized format (for example, 2.5_inch)
The expert system automatically converts data entered in either format into its
internal representation. This conversion provides greater flexibility to both the user
and the rule writer by enabling them to specify values in units that they are most
familiar with without regard to the current unit settings.
Working Unit Format
In the case of working unit format, the system recognizes the presence of a colon (:)
in the entry and takes appropriate conversion measures. Examples of such values are
2:6:4000, 2.5::, :10, ::1000.
For the expert system to interpret such values successfully, it must know the
relationships between the master units, positional units, and sub-units (from
MicroStation) that are used on the project. The expert system stores these
relationships internally by using expert system variables. These variables (called
EXWUNTS and UORS) are defined in the projdefe.rul file (imperial) or projdefm.rul
file (SI) in your ...\{ProjectName} directory. In addition, you can define them by using
the $Directives described earlier.
Unitized Format
In the case of unitized format, the system recognizes the presence of an underbar
(_), which concatenates a number and an allowed unit value. The following unit
values are valid:
centimeter in m ml
centimetre inch meter mm
cm inches metre y
feet kilometer mile yard
foot kilometre millimeter yrd
ft km millimetre
Examples of valid unitized values are:

12_in
1000_mm
Standard Built-In Functions
Each Design Series application typically includes standard functions and references
them through the production rules in the knowledge base. You can also write

Parametric Modeling System
functions and integrate them into the application so that you can tailor the system to
meet the needs of a specific application.
A list of the functions and their descriptions are in the chapter “Parametric Modeling
Functions” on page 5-1 in the PlantSpace Design Series Reference Guide for Administrators.
Comments and End Of Rule

The expert system enables you to add comments within the body of the rule by
using the exclamation mark (!). You as the rule writer should document what each
rule does. The expert system stops reading a line as soon as it encounters the
exclamation mark. C-style comments (/*...*/) are also recognized and are useful for
commenting out large blocks.
(END) marks the end of the rule file. It causes the expert system to ignore
everything in the file after it encounters these keywords. This feature is useful when
you want to debug a rule in question.
An example of a comment and an end of rule is:
TEXT A = ‘This is an example of a comment’, B; ! Declare and initialize text

(RULE) THEN B=A ! Set B to A
! End of Rule
(END)

The parametric modeling system is a general purpose 3D modeling system driven by
the expert system. It allows modeling of Design Series components as MicroStation
cells containing an intelligent label, connect points, and appropriate graphics. These
components are built as needed from a set of expert rules that define the parametric
definitions and placement information along with the knowledge of how and what
to model. Thus, parametric modeling provides an easy and quick way to create
complex components and allows a large number of variations for each component.
Parametric Definitions
The parametric definitions model the component. You can directly enter them,
compute them from other dimensions that you enter, or query and compute from
the modeling database that contains such parametric definitions and values.

Parametric Modeling Rules
For a simple example, consider the parameters that you might need to define a pipe.
These values are defined by using different sources:
Source Parameters
User Nominal diameter of the pipe
Line number and spool number for line
Location and orientation of pipe
Expert system Query outer diameter from database
All valid end preparations for pipe
You can handle even complex situations, such as the definition of semi-engineered
pipe supports, complex pieces of equipment, and so on, by using the concepts built
into the parametric modeling system.
The parametric modeling system contains a rich set of functions that enable you to
completely control the look and feel of every component that you want to create
and place by using the Design Series software. The important elements of the
parametric system are:
• Parametric Modeling Rules

The knowledge base
• Parametric Modeling functions
The functions specifically designed to perform graphical and non-
graphical tasks
• Parametric Modeling Primitives
Built-in graphical primitives for use with the PRIM parametric
modeling function
The following sections provide more details on each of these elements.
Parametric Modeling Rules

Parametric rules perform two different types of operations. Some rules create
graphic elements for the design file, whereas other rules perform logical reasoning
in support of the rules that create the graphics. For example, a rule that determines
the size of the bolt in a pipe hanger based on the diameter of the pipe that will be
supported is performing logical reasoning. The rule that creates graphic elements
for the bolts makes use of the previous rule to determine the geometry of the
graphical primitives.

UsingtheStepArrayVariabletoControltheOrderofProcessingand
Running Rules
The expert system runs and manipulates the knowledge stored in a rule file through
a series of backward chaining rules. One characteristic of such a system is that there
is no guarantee of performing the calculations and evaluations of variables in order.
Yet modeling applications require that graphic records be produced and combined
in a definite order. To ensure the correct order, you can use the step array variable
to control the order of processing and running rules. The step variable is a zero-
index integer array. The number of steps included in the rule controls its size.
W The array should always be equal to or greater than the number of steps
in the rules. You must use the step array variable indexes in order, and
you cannot skip them.
For example, consider the following statement:

step[i] = F1() + F2() F3() + ... + Fn()
During the course of evaluation of step[i], the expert system evaluates

functions F1 through Fn from left to right. The graphical records generated by
each one of them will be in the order that they appear. When the expert system
evaluates all these functions, it assigns a value to step[i]. This value itself, is
meaningless except to signify that this step is complete.
When the expert system evaluates a step array variable, the expert system never re-
evaluates it. The only way to ask the expert system to re-evaluate a step is by
clearing its value before the conclusion of the reasoning process. To clear a value,
you should call the CLEAR function, described on page 5-55 in the chapter
“Parameterized Modeling Functions” in the PlantSpace Design Series Reference Guide for
Administrators.
Understanding How To Debug Your Rules
The expert system is configured to prompt the user for the value of a variable only
when the expert system cannot establish the value by evaluating rules
However, when you write new rules, it may be desirable to print or confirm the
values to assign to variables. You can confirm the values by using the Confirm-
Always flag represented by a minus (-) sign. This flag is placed in front of the
variable name when you declare the variable. For example:
real -radius1, -thickness, width;

Parametric Modeling Functions
Each time that the expert system evaluates radius1 or thickness, the system
prints the new value and enables you to override it, if necessary.
In addition, you can use the $REASON_FILE directive to debug the execution of
the rule file by creating a log of the reasoning process. This log file, which you
define, contains detailed and important information of the reasoning process and
the path that the expert system chose in arriving at the goal.
Writing New Rules or Modifying or Enhancing Existing Rules
The system provides for a convenient way to develop new rules and to modify or
enhance existing rules locally, and to test them before loading them into the
database and exposing all other users to them.
The expert system can execute rules from a local directory or from the active
database. It enables you to declare a configuration variable PS_RULES to define a
local directory where you can locate rules.
When the system tries to execute a rule, it first looks in the rules directory for the
rule. The system searches by comparing the rule name with file names in the
directory. If it makes a match, then the system reads the rule file and interprets it as
it does a regular rule. If the system finds no match, it continues trying to locate the
rule in the database.
Parametric Modeling Functions

The expert system provides two types of modeling functions:
• Step
Functions that create graphics must be called within a rule that sets
the step variable. Additional functions, as noted, may also require
that the step variable be set.
• Non-step
Other functions that perform calculations, determine values,
perform queries, and so on, and return valid values should not be
part of the step statement. It is useful to use a flag[] array
variable, similar to step[] to control the execution of these rules.
Declaring the flag[] variable with the Confirm Always option,
gives the programmer an easy way to regularly monitor execution
while debugging.

✍ For a full description of these functions, see the chapter “Parametric Modeling
Functions” on page 5-1 in the PlantSpace Design Series Reference Guide for
Administrators.
Parametric Modeling Primitives

You must take care when designing the rules for basic components to ensure that
they are compatible with the requirements of the Design Series software.
Understanding How To Build A Valid Design Series Cell
Each cell must include:
• A valid intelligent label (created by using the BUILD_LABEL)

function
• Connect points for connectivity
• Appropriate graphics for visualization
Most importantly, you must build the component by using a valid set of local axes.
In the Design Series software, creating primitive graphics is viewed the same way as
subroutines in a C program. It is very useful to create a collection of building blocks
that you can combine together in a variety of ways by using the BUD function from
a higher level set of rules. Details on the BUD function are on page 5-36 in the
chapter “Parametric Modeling Functions” in the PlantSpace Design Series Reference Guide for
Administrators.
For a full description of these primitives and the building blocks available, see the
chapter “Parametric Modeling Primitives” on page 6-1 in the PlantSpace Design Series
Reference Guide for Administrators.

Introduction
This appendix shows the location of your directories and files in PlantSpace Design
Series.
New Locations Used for PSDS XM

• Application files
From {local drive}\Program Files\Bentley\Program\DesignSeries

To {local drive}\Program Files\Plant XM\DesignSeries
• User workfiles
From {local drive}\Program Files\Bentley\Home

To {local drive}\Bentley PlantXM Projects\DesignSeries
Workfiles\{project-name}
This includes delivered DGNs and other work files of the
sample projects.
• Sample projects
The project-specific files for the sample projects are delivered to:
{local drive}\Bentley PlantXM Projects\{project-name}.
The PCF files for the sample projects are delivered to the Projects\
Examples folder under the Workspace folder specified when
MicroStation was installed (by default, C:\Documents and Settings\
All Users\Application Data\Bentley\WorkSpace\Projects\
examples).
• Shared projects
From {network drive}\ProjPcfs

To {path you set with the Set Project Group tool}

...\Program Files\Bentley\Documentation Directory
• New in V8 XM is a project template used by Project Administrator

to create new projects. This is installed in {local drive}\Program
Files\Bentley\Plant XM\Base\options\psds\standards\psds.
✍ The Logs directory pertains only to MicroStation, and the Workspace directory
pertains only to TriForma. Because the modules for Design Series Structural
(steel and concrete with the related SDNF program), Ortho Drawing
Generation, and Hidden Line Creation have been replaced by Structural for
TriForma and Drawing Extraction Manager for TriForma, the directories and
files for these modules have been removed. Also, because SupportModeler,
IsoExtractor, and AutoISOGEN are delivered under separate license, the
directories and files for these products have been removed.
...\Program Files\Bentley\Documentation Directory

The Documentation directory contains the PDFs and CHMs (help files) of the
documentation for Design Series and TriForma. These are the same PDFs and
CHMs displayed on the MicroStation Help menu.
File Description Directory Location

Contains the following documentation for Design ...\Bentley\Documentation\
Series: DesignSeries
• desuser.chm (PlantSpace Design Series User help)
• DSadmin.pdf (PlantSpace Design Series
Administrator Guide)
• DSadminRef.pdf (PlantSpace Design Series Reference
Guide for Administrators)
• DStut.pdf (PlantSpace Design Series QuickStart
Guide)
• IntMgr.chm (Bentley Interference Manager User help) ...\Bentley\Documentation
• JSpaceClassEditor.chm (JSpace Class Editor User
help)
• JSspaceTechRef.chm (JSpace Concepts and
Technical Reference help)
• JSpaceMicroStationConnectionUserGuide.pdf
(JSpace MicroStation Connection User Guide)
• MCS_guide.pdf (Model Control System (MCS)
Guide for the Model Control System in
TriForma)
• triforma.chm (TriForma User help)
B-2 PlantSpace Design Series Administrator Guide June 8, 2007

…\Bentley PlantXM Projects\DesignSeries Workfiles Directory
…\BentleyPlantXMProjects\DesignSeriesWorkfilesDirectory
✍ The prefs directory is for MicroStation use only.
When you install Design Series on a local machine for users and add a new project,
the system displays each project in a separate subdirectory, such as Project1 and
Project2.

Contains sample tutorial files for use with the …\Bentley PlantXM Projects\
PlantSpace Design Series QuickStart Guide. DesignSeries Workfiles\
PSDS_Imperial or PSDS_SI
Contains a working copy on the local machine …\Bentley PlantXM Projects\
of the user-specific project files as specified by DesignSeries Workfiles\{ProjectName}
the variable %PS_USER% in projvars.cfg.
Note: These source files are located in the
{network drive}\Projects85\{ProjectName}\
userfile directory.
June 8, 2007 PlantSpace Design Series Administrator Guide B-3

…\Bentley PlantXM Projects\PSDS_Imperial or PSDS_SI Directory
…\Bentley PlantXM Projects\PSDS_Imperial or PSDS_SI

Directory
The PSDS_Imperial or PSDS_SI directory contains the sample tutorial files for use
with the PlantSpace Design Series QuickStart Guide.

shortcut.txt …\Bentley PlantXM Projects\
Notes: DesignSeries Workfiles\
• After opening Design Series, you can reset the PSDS_Imperial or PSDS_SI
workspace configuration variable
MS_ACCUDRAWKEYS in this file to assign
shortcut keys for AccuDraw.
• You should not edit the original MicroStation
shortcut.txt file that is located in the ...\Bentley\
Workspace\System\data directory.
ps_user.rul, sample.eqp, and the following …\Bentley PlantXM Projects\
configuration settings files: DesignSeries Workfiles\
• placeblk.ini PSDS_Imperial or PSDS_SI
• placeequ.ini
• stress.ini
Note: After you open Design Series, these files are
available.
dstutor.cfg …\Bentley PlantXM Projects\
Note: This configuration file is for the tutorial PSDS_Imperial or PSDS_SI\config
project.
Contains DGN, JSM, CFG, REF, XLS, BMP, and …\Bentley PlantXM Projects\
TXT files. DesignSeries Workfiles\
Note: These tutorial files are for use with the PSDS_Imperial or PSDS_SI\dgn
PlantSpace Design Series QuickStart Guide.
PSDS_Imperial.pcf or PSDS_SI.pcf {MS-Workspace}\Projects\examples
Note: This project configuration file is for the
tutorial project.


Contains the following sample tutorial files for use .…\Bentley PlantXM Projects \
with the PlantSpace Design Series QuickStart Guide: PSDS_Imperial or PSDS_SI\project
• ds_seede.dgn (imperial) or ds_seedm.dgn (SI)
— Note: These are project seed files.
• iljoin.txt — Note: This file contains the settings
for the Join IL command.
• pltspace.mdb — Note: This is a sample Access
database file.
• projdefe.rul (imperial) or projdefm.rul (SI) —
Note: These are project definition files defining
units (UORs).
• project.vol — Note: This is the project volume
definition file.
• projvars.cfg — Note: This configuration file is
for the project.
• rimref.dat (imperial), rimref20.dat, and
rimrefm.dat (SI) — Note: These label definition
files are used to convert labels from version 2.x.
• samplemapfile.txt — Note: This is a template
file for mapping.
• StatusControl.cfg — Note: This configuration
file controls the status of MCS.
• tutorial.vol (imperial) or m_tut.vol (SI) —
Note: These are default tutorial volume
definition files.
• v7.lvl — Note: This file contains the level
definitions for a DGN file so that its levels
match the v7 levels.
This empty directory is the default location for …\Bentley PlantXM Projects\
copies of files that have been checked into the PSDS_Imperial or PSDS_SI\
project database. project\archive
Note: After you open Design Series, this directory
is available.
piping.cel and symbol.cel .…\Bentley PlantXM Projects \
Note: These are cell library files. PSDS_Imperial or PSDS_SI\
project\cell


Contains the following DAT and SQL files: …\Program Files\Bentley\Plant
• cfgsite.dat XM\Base\Options\psds\standards\
• cretable.dat psds\dbload
• overlaps.dat
• addindex.sql Conceptually, these belong at
• language.sql …\Bentley PlantXM Projects \
PSDS_Imperial or PSDS_SI\ dbload,
• testtabs.sql
but we deliver to one location for
usage by the sample projects or a
newly-created project.
Contains SQL, CFG, ORA, SCR, BAT, and TXT …\Bentley PlantXM Projects \
files for Access, Oracle, and/or SQL Server PSDS_Imperial or PSDS_SI\
project\dbload\access or oracle or
sqlsrvr
R files …\Bentley PlantXM Projects \
Note: These AMS parametric rule files are PSDS_Imperial or PSDS_SI\
contained in the subdirectories of the data project\dbload\data
directory.
Contains TXT, SQL, and the following DAT files: …\Bentley PlantXM Projects \
• attrcdef.dat PSDS_Imperial or PSDS_SI\
• attrdefn.dat project\dbload\data
• beams.dat
• classes.dat
• limit300.dat
• rules.dat
• users.dat
Contains imperial and/or SI DAT files to load …\Bentley PlantXM Projects \
into the project database in the following PSDS_Imperial or PSDS_SI\
subdirectories: project\dbload\data
• cndt (Conduit)
• core (Core)
• ec (Engineering Configuration)
• equip (Equipment)
• hgr (Hanger)
• hgrpt (Hanger parts)
• hvac (HVAC)
• pipe (Pipe with subdirectories for each standard
or manufacturer)
• tray (Tray)


prjcfg_e.dat (imperial) or prjcfg_m.dat (SI) …\Bentley PlantXM Projects \
Note: These PROJ_CONFIG tables contain the PSDS_Imperial or PSDS_SI\
MicroStation global origin. project\dbload\data\core\english or
metric
eqpalias.dat …\Bentley PlantXM Projects \
Note: This DAT file contains the prefixes for the PSDS_Imperial or PSDS_SI\
naming conventions of equipment. project\equip
Contains JEX, CFG, TXT, and the following LIB …\Bentley PlantXM Projects \
files: PSDS_Imperial or PSDS_SI\
• ams.lib — Note: This is the sample Design project\etc
Series class library.
• ams_user.lib — Note: This is the sample
Design Series class library for users to modify
• annotatione.lib (imperial) or annotationm.lib
(SI) — Note: These are annotation definitions
class library files.
• Other JSpace class libraries
Note: jclass.lib is located in the ...\Bentley\
Program\TriForma\mdlapps directory.
This empty directory is the default location for …\Bentley PlantXM Projects \
copies of files containing information that is not PSDS_Imperial or PSDS_SI\
checked into the Model Control System (MCS). project\notInMCS
Notes:
• To ensure that you do not lose anything, the
system retains these files after removing the
items that you check in.
• After you open Design Series, this directory is
available.
This empty directory is the shared location where …\Bentley PlantXM Projects \
you can place query files that are used in the PSDS_Imperial or PSDS_SI\
project database check-out operation. project\qry
Note: After you open Design Series, this directory
is available.
Contains the following files: …\Bentley PlantXM Projects \
• filter_e.dat (imperial) or filter_m.dat (SI) PSDS_Imperial or PSDS_SI\
• group_e.dat (imperial) or group_m.dat (SI) project\reports
• ps_group.lib
• psreports.mdb
• report_e.dat (imperial) or report_m.dat (SI)

...\Program Files\Bentley\Program Directory

s71, INI, and MDB files …\Bentley PlantXM Projects \
Note: These are Spec Maker project specification PSDS_Imperial or PSDS_SI\
and configuration files. project\SpecMakr
This empty directory is the default location for the …\Bentley PlantXM Projects\
DBF files generated by the Object Reporter. DesignSeries Workfiles\
Note: After you open Design Series, this directory PSDS_Imperial or PSDS_SI\reports
is available.
Contains the following files: …\Bentley PlantXM Projects\
• LOG files — Note: These are log and error DesignSeries Workfiles\
files. PSDS_Imperial or PSDS_SI\temp
• ps_pref.rsc — Note: This resource file is the
user settings file.
• SOCKNM.DAT — Note: This DAT file is a
Design Series user connection information file.
• After you open Design Series, this directory is
available.
...\Program Files\Bentley\Program Directory

The Program directory contains the files that are used to run the products.

Contains the Design Series program files ...\Bentley\Program\DesignSeries
Contains the installation files. ...\Bentley\Program\Install
Note: The selection of files depends on the options
and programs selected during installation.
Contains the license (LIC) files for Design Series- ...\Bentley\Program\Licensing
related applications.
Contains the MicroStation program files including ...\Bentley\Program\MicroStation
ustation.exe.
Contains the TriForma program files. ...\Bentley\Program\TriForma
Includes jclass.lib. ...\Bentley\Program\TriForma\
Notes: mdlapps
• This class library is for Design Series.
• When a new project is added, ams.lib and
ams_user.lib are located in the {network drive}\
Projects85\{ProjectName}\etc directory.

...\Program Files\Bentley\Plant XM\DesignSeries Directory

ams.res and jcoreres.res ...\Bentley\Program\TriForma\
Note: These resource files contain reserved words mdlapps
and messages for Design Series.
EXE, DLL, MA, MSL, LPK, FNC, JEX, BAT, ...\Bentley\Program\TriForma\
TIF, CHM, and HTM files mdlapps
Note: These files are required to run Design
Series-related applications.
...\Program Files\Bentley\Plant XM\DesignSeries Directory

The DesignSeries directory contains the sample tutorial files for use with the
PlantSpace Design Series QuickStart Guide.

Contains settings text files, such as ...\Bentley\Program\DesignSeries\default
specchk.ini, which is the Spec Checker
configuration settings file.
MA, DLL, EXE, RSC, and TXT files. ...\Bentley\Program\DesignSeries\
Note: These files are required to run mdlapps
Design Series.
dslocal.cfg ...\Bentley\Program\DesignSeries\
Note: This is the local project configuration mdlapps\config
file.
bolt71.dll ...\Bentley\Program\DesignSeries\
mdlapps\plugins
DLL and EXE files ...\Bentley\Plant XM\DesignSeries\exe
Dgnlib ...\Bentley\Plant XM\DesignSeries\dgnlib

...\Projects85 Directory
...\Projects85 Directory
Although the Projects85 directory is installed on a network drive, the users should
work on the copy of these project files that they install on their hard drives in a
separate ...\Bentley\Home\{ProjectName} directory for each project.

The default project directory as specified by {network drive}\Projects85
%PS_PROJ% in {ProjectName}.pcf
Note: This directory structure is the same as the
...\Bentley\Home\PSDS_Imperial or PSDS_SI\
project directory except for a few files that are
specific to the tutorial project.
...\ProjPcfs Directory
The ProjPcfs directory is installed on a network drive.

<empty> {network drive}\ProjectGroup1
Note: You can make multiple folders that contain each
project’s PCF files (for example, a separate set of
projects for each client or each industry type).

Glossary
A
Advanced Modeling A Design Series program used during modeling to parametrically draw the
System 3D graphical components that you want in your design file. AMS takes the
data in your project database and applies rules that define the shape and
type of graphical cells to be placed.
AMS The acronym for the Advanced Modeling System. See expert system.
append (1) To add variable property values as in the Append operation in

equipment modeling used to add nozzles to parametric equipment. (2) For
administrators only, to add Design Series components from a MicroStation
design file to be utilized by MCS or to add new files to MCS.
area A 3D rectangular section of a master volume definition file or of a

discipline volume definition file that represents a part of the project. Also
see Master Volume Definition File and Discipline Volume Definition File.
attribute A characteristic of a component. The set of attributes for a component is

called a label.
attributedefinitionfile A text file that defines the attributes that are displayed for all Design Series
components.
B
basic data type The JSpace data types are logical, numeric, and character data types. The
logical data type defines values that are either TRUE or FALSE. The
numeric data type defines values that are numbers used in arithmetic or
mathematical calculations. The character data type defines individual text
characters or strings of textual character information. See also data types.
BUD The acronym for Basic Unit of Design.
August 11, 2008 PlantSpace Design Series Administrator Guide GL-1

Glossary
BUD Table The table that stores Design Series components in the database.
BUD_TYPE The type of component with the format of

DATABASE_COMPONENT-TYPE. DATABASE, which is limited to
five characters, is the discipline, such as PIPE or HVAC. COMPONENT-
TYPE, which is limited to four characters, is the type within the discipline,
such as rectangular elbow, HVLR, or mitered rectangular elbow, HSQR.
BUD_TYPE Class The class in ams_user that is defined for each BUD_TYPE, such as
PIPE_PIPE_USER or PIPE_PELB_USER. The format is
*****_****_USER where *****_**** is the BUD_TYPE of the
component.
built-in function A routine used in a JSpace expression to perform specific tasks or

computations.
C
catalog table A database table that contains component dimensions used in modeling.
child A class that has a parent class. The child class inherits the class definition
of the parent class.
class A user-defined grouping of objects by type. A class, also called an object

class, serves as a template for creating objects of the same type.
Class Editor The JSpace program that creates and manages class libraries and their
classes, and creates and browses object model files. The full name is JSpace
Class Editor.
Class Library A file for storing a set of class definitions. A class library contains classes
and is normally identified by the LIB file extension.
command An instruction that tells Design Series what to do. Commands are activated
by icons in tools boxes, pull down menus, settings in dialog boxes, and key-
ins.
August 2008 PlantSpace Design Series Administrator Guide GL-2

Glossary
comparisonoperator The class library operators that perform a comparison, the result of which
is TRUE or FALSE: Is Equal To (==), Is Greater Than (>), Is Less Than
(<), Is Greater Than or Equal To (>=), Is Less Than or Equal To (<=), Is
Not Equal To (!=).
Note: In parametric modeling, the result of comparisons and other
Boolean operations is ".TRUE." or ".FALSE." and the comparison
operator for Is Equal To is a single equals sign (=).
component An object used in a JSpace model file such as a pipe. Similar to an element
in MicroStation.
component-based A feature in Model Control System that stores design file components
storage modeled from the Design Series 3D applications in an ODBC-compliant
database such as Access, Oracle, or SQL Server. Contrast with file-based
storage.
compound data type A JSpace data type composed of multiple instances or occurrences of a
basic numeric data type. These are pre-defined and used for specific
purposes, such as storing the X, Y, and Z coordinates of a point in space
as a single data type called DPoint. See also data types.
configuration
variable A string consisting of environment information, such as a drive, path, or
file name, associated with a symbolic name that can be used by Design
Series. A value that is set to a default value during installation and can be
modified and that is used by the operating system and the application
programs.
connect point A point element located at the beginning of a cell before any other
MicroStation element. Any cell can optionally include any number of
connect points. Also, a point that enables Design Series components to
connect to each other at a logical location in the Design Series model.
D
data file A text file with a DAT extension containing attribute definitions or catalog
data for Design Series components to be loaded into the database.
data source A database that stores the data used in Design Series modeling Design
Series components.
GL-3 PlantSpace Design Series Administrator Guide August 11, 2008

Glossary
data type The kind of data values that can be assigned to a property. JSpace has basic
and compound data types. See also basic data types and compound data types.
Database Setup A Design Series program that sets up new project databases, and recreates
and maintains existing databases.
DBMS The acronym for database management system.
Design Series The product name for Jacobus software that is based on JSPACE object-
oriented technology providing a full range of intelligent 3D modeling
applications.
DGN The file extension that by convention identifies a MicroStation design file.
Discipline Volume The Design Series text file that consists of one or more areas representing
Definition File parts of a project. Multiple discipline volume definition files can be created
for each project for use with MCS for the designers’ work areas or for use
with other applications such as the Object Reporter or Hidden Line
Creation. Contrast with Master Volume Definition File.
DLM The acronym for PlantSpace Dynamic Link Module, which creates and
operates on objects from within the MicroStation environment.
dslocal.cfg The configuration file that defines the configuration variables in Design
Series.
E
environment
variable All environment variables in MicroStation as of version 7.1 are now called
configuration variables. See configuration variable.
expert rules A set of directions for creating geometric representations or text including
guidelines, calculations, and database values.
expert system A computer application that performs a task that would otherwise be
performed by a human expert. For example, when you select a 6-inch
standard gate valve, the expert system acquires the correct dimensions
based on the rules and creates the graphical representation.

Glossary
F
file-based storage The storage of component data directly into a MicroStation design file.
The file is then checked into MCS. Contrast with component-based storage.
G
GUI The acronym for Graphical User Interface.
I
INI The file extension that identifies an initialization file containing definitions
of configuration variables used within the product. For example, the
JSPACE.INI file is the initialization file for JSPACE and PlantSpace
programs.
instance (1) A term used to refer to an object that belongs to a particular class. For
example, an elbow is an instance of a class pipe. (2) A database table. (3) The
database instance is an empty database. In the same way that an object is
an instance of a class, a data source is an instance of a database
management system (DBMS) that contains one or more database tables.
IntelligentLineString In Design Series, a 3D graphical representation of pipe routing used for

preliminary or conceptual routing. An Intelligent Line String contains
attribute information.
iso The abbreviation for isometric.
Isometric (1) The standard view that shows top, left, and front facets of a design.
(2) A piping drawing created with 30 degree to 60 degree axes that is
sometimes called an "iso" drawing.
J
JSM The file extension that by convention identifies a JSpace object model file.
JSpace The name of the object-oriented technology developed by Jacobus

Technology, Inc. JSpace is the underlying architecture used to develop
JSpace programs and PlantSpace applications.

Glossary
JSPACE_OBJECT The basic class in the JCLASS.LIB file and the class at the root of the
parent-child hierarchy of classes. Other classes are based on the
JSPACE_OBJECT class or a class derived from this class.
L
label A text string within Design Series that stores the attributes for each Design
Series component.
LIB The file extension that by convention identifies a class library file. For
example, JSPACE.LIB is the standard JSpace class library that contains
over 100 predefined classes of objects used by PlantSpace applications.
M
Master Volume The Design Series text file that consists of one or more areas
Definition File encompassing the entire project and that is used with MCS for project
design. Only one Master Volume Definition File can be defined for each
project. After someone familiar with the project site sets up the Master
Volume Definition File, the administrator can load that file into the
database. Contrast with Discipline Volume Definition File.
material take-off A listing of components stating quantities.
MCS The acronym for the Model Control System (explained in the Model Control
System (MCS) Guide)
MDL The acronym for MicroStation Development Language, the C language

executed by MicroStation.
message The name for an object method in object-oriented programming, such as

DRAW, CREATE, and RELATE. A message is sent to an object to invoke
one of its methods.
MicroStation The language that enables programmers to execute C language code within
Development MicroStation. MDL applications are fully transportable across all
Language (MDL) platforms. Programs written in MDL use MicroStation as a CAD engine.
middleware Any software that resides between the application and the control program
that enables the application to run in different computer environments.

Glossary
ModelControlSystem The program that enables users to access Design Series components
stored in a database.
modeling tables The static database tables including CLASSES table, ATTRDEFN table,
EXPERT_RULES table, Catalog tables, and specification tables.
MTO The acronym for material take-off.
N
null value A special character used to indicate no value or that a value has not been
assigned. A NULL value is different from a value of zero (0) for numeric
data types or blank (" ") for character data.
O
object A self-contained entity consisting of data (properties) and software
(methods) which operate on that data.
object model file A file, normally identified by the JSM file extension, that contains objects
based on JSpace technology and that is used in PlantSpace applications.
object-oriented A flexible programming technology based on the concept that an object is

programming a self-contained module of data and processing. Formal rules allow objects
to be reused and interchanged between programs.
ODBC The acronym for Object Database Connectivity, a programming interface

from Microsoft that provides a common language for Windows
applications to access databases on a network.
P
parent A class used as the basis for creating a new class. The new class becomes a
child class and inherits the class definition of the parent class.
parametric driven See expert system.

modeling

Glossary
PlantSpace The family name of software application products developed by Jacobus

Technology, Inc. The PlantSpace family includes the Design Series, the
Engineering Series, and the Integration Series.
product data All information about a specific product, such as PlantSpace Piping.
product file A text file listing product data and expert rule files to be loaded into
database.
property The data fields and values stored in an object. Properties are one of the
categories of a class definition.
PSHOME The configuration variable defining the default name provided with the
product or the name of the PlantSpace home directory.
PSIM The acronym for PlantSpace Interference Manager.
R
RDBMS The acronym for relational database management system.
RimRef.Dat A text file that specifies the positions where attributes are stored in the
label. This information is used in post-processing functions.
rule See inference rule or suppression rules.
rule file A text file containing expert system rules to create 3D geometric
representation of Design Series components in the Design Series model.
S
snap point Former name for connect point. See connect point.
specification The definition or set of details about a component in a Design Series

model.

Glossary
specification table A database table that defines the acceptable component specifications for
a particular BUD_TYPE. The table name is *****_****_SPEC where
*****_**** is the BUD_TYPE of the component. For example,
PIPE_PIPE_SPEC or PIPE_PELB_SPEC.
SQL Query A Standard Query Language (SQL) expression that is used to access data
from a database table.
storage tables The dynamic database tables.
sub-object An object that is automatically created when a higher-order object is

created. A sub-object is automatically related as a child of that object.
V
Volume Definition See Master Volume Definition File And Discipline Volume Definition File.
File

GL-10 PlantSpace Design Series Administrator Guide August 2008
Index
Symbols B
$BUDTYPE property (for parametric equipment) 8-3 Batch Processing the Append JSM File operation 6-14
$DEFUNITS property (for parametric equipment) 8-3 Bolt Information
$DIAGRAM property (for parametric equipment) 8-3 Configuration variables used by the bolts engine
{ProjectName}.pcf 6-3 4-16
Enhancements in the Bolts Engine 4-2
Modifying Bolt Catalog Data 4-13
A Modifying the BOLTS Table Data 4-16
Accessing Data from the PlantSpace P&ID Applica- Tables inside the PlantSpace database 4-14
tion 2-46 Troubleshooting Problems Generating Bolt Data
Accessing Data from Third-Party Applications 2-52 4-18
Advanced Modeling System, description of 1-2 BOLT_ASSEMBLY Class 4-2, 4-9
AMS, description of 1-2 BOLT_ASSEMBLY object 4-2
ams.lib 2-5, 2-34, 11-1 BOLT_BASE_USER class 4-2
ams_user.lib 2-5, 11-1 BOLT_COMPONENT Class 4-2, 4-10
Annotation BOLT_MATERIAL Table 4-16
Configuring the content in Your Annotation BOLT_ORDER Class 4-2, 4-11
Class Library 9-8 BOLT_ORDER object 4-7
Configuring the Terminators 9-17 BOLTS Table 4-14
Configuring the Text Styles 9-16 bolts_util_v80.exe for troubleshooting problems in
Annotation utility 9-7 generating bolt data 4-18
annotation_types.dat 9-15 BOTH_SYMB table 2-43
annotatione.lib 9-10 BUD_TYPE classes (in the Specification Check Utili-
annotationm.lib 9-10 ty) 9-23
APP_FLAG attribute 2-19, 2-24, 9-30, 9-32
Append Object Model operation 6-14
Appending JSMs to the Database C
In batch mode 6-14 Catalog Tables 2-2
Individually 6-14 Catalog Tables, updating 2-37
ATTRDEFN Table 2-2 Cell Name Property (for parametric equipment) 8-2
Attribute Definitions Cell, building a valid Design Series cell B-20
Modifying 2-15–2-17 Centerlines 12-1
Attributes dialog box changes.txt file 1-6
Customizing the Value column 2-59 Check Design utility
Displaying the Component Type Name 2-58 Compatibility option 9-26
Attributes, prevent matching on 9-50 Duplicate ID option 9-27
Autotext. See Annotation utility. Gap Correction option 9-29
Overlap Correction option 9-29
Slope Direction option 9-25
Specification option 9-21
August 11, 2008 PlantSpace Design Series Administrator Guide IN-1

Index
Superimposed Components option 9-20 Rules for creating 8-13

Check Design Utility, description of 9-18 Digital Rights and Digital Signatures 6-8
Class definition, example of creating 8-5 Directory Structure
Class Definitions Changing 6-10
Parametric Equipment Definitions 8-1 Description and guidelines 2-3
Class definitions Drawing Extraction 12-1
Description 2-6 Drawing Extraction Manager 9-7
Class Libraries 2-5 DS_ANNOTATION_DEFINITIONS configuration
Classes 2-6 variable 9-8, 9-11
CLIP_LENGTH property 11-1 DS_ANNOTATION_TERMCELLIB configuration
Compatibility Checking, automatic 9-6 variable 9-18
Compatibility option 9-26 DS_ILCREATE_DELETE_SMARTLINE configu-
CompDefn.s71 7-3 ration variable 9-45
Component Labels DS_SYMBOLOGY_LIBRARY configuration vari-
Converting to the Current Version of Design Se- able 9-40, 9-45
ries 1-13 dslocal.cfg 6-3
Converting to the current version of the software Duplicate ID option 9-27
9-34
Creating a Summary of Label Utilization 6-21
Displaying 6-16 E
Mapping of Component Attributes Compared to e.dat 10-2
Label Positions 6-19 Editing Text Files, description 2-4
Component type name, displaying it in the attributes Eds-compdefn.s71 7-3
dialog box 2-58 Eds-specs.s71 7-3
Configuration Tables 2-2 Equipment Class Definition, concept of 8-1
Configuration, understanding 6-1 EXE_REPORT_ARGS Table 2-56
Configuring and Customizing Design Series, stages 1- EXE_REPORT_CRITERIA Table 2-53
15 EXE_REPORT_TYPES Table 2-55
Configuring Report Output for Your Project 11-1–11- Expert System
10 IF-THEN production rules
Configuring to Prevent Matching on Specific At- Features B-9
tributes 9-50 Expert system
Custom Keypoints 9-2 Backward chaining
Handling an unknown variable B-3
How it works B-2
D Cardinal values and ranges B-7
Data Storage 1-2 Comments and End Of Rule B-16
Database Setup Tool, description 2-5 Default or initial values B-6
Datum, configuring 8-17 How knowledge is represented B-1
Description Tables 2-2 IF-THEN Production Rules B-1
Design Series IF-THEN production rules B-9
Features AND and OR operators B-10
Current 1-2 Arithmetic operators and precedence order
New in this version 1-3 B-11
Product 1-1 Character operators B-12
Diagram cell Directives B-12
Example of creating 8-13 Numbers using working units and dimen-
Explanation of the example 8-14 sional formats B-14
IN-2 PlantSpace Design Series Administrator Guide August 11, 2008

Index
F
Relational operators B-11 M

Standard built-in functions B-15 Managing External Files and JSM Files 6-13
Syntax B-9 Modeling Tables 2-2
Prompted values B-7 ATTRDEFN Table 2-2
Rule file layout B-4 Catalog Tables 2-2
Understanding B-1 CLASSES Table 2-2
Variable declarations B-4 EXPERT_RULES Table 2-2
Variable names B-4 Specification Tables 2-2
Variable types B-5 moveuser.sql 2-31
Expert system in Design Series B-1–B-20 MS_DESIGN_SEED configuration variable 9-16
Expert system rule files, updating 2-39
EXPERT_RULES Table 2-2, 2-39
External files and JSM files, managing 6-13 N
Extraction. See Piping Drawing Extraction 12-1 Naming convention for the class name (in parametric
equipment) 8-2
Notes, reference for structural columns 9-3
F Nozzle Manager
Features Configuration procedures 8-17
Current 1-2 Nozzle Manager, configuring 8-17
New in this version 1-3 Nozzle Type Class Library, configuring 8-23
Nozzle Types Diagrams, configuring 8-23
NOZZLE_PARAMETERS Table 8-20
G NOZZLE_TYPES Table 8-21
Gap Correction option 9-29
O
I Object Reporter program 11-1
iljoin.txt 9-47 ODBC Data Source (in Spec Maker) 7-84
Overlap Correction option 9-29
J
JSpace 1-1 P
P&ID, accessing data from 2-46
Parametric Equipment Definitions
K
Creating 8-4
Keypoints, custom in Design Series 9-2
Parametric equipment, troubleshooting problems in
Knowledge Base B-4
placing building blocks 8-16
Parametric equipment, troubleshooting problems in
L placing parametric equipment 8-14
Parametric Modeling System B-16–B-20
Label Edit tool 9-31
Definitions B-16
Label Position Files, Creating 2-62
Functions B-19
Labels. See Component Labels
Primitives B-20
LBLCVT, how the utility converts a cell 9-34
Rules B-17
Level Symbology and Your V7 Files 9-44
Understanding How To Debug Your Rules
LIB file extension 2-6
B-18
LINEO_SYMB table 2-42
Using the STEP array variable to control
the order of processing and running rules

Index
B-18 To change the system of units used in a project 6-

Writing New Rules or Modifying or En- 13
hancing Existing Rules B-19 To check for errors in the ATTRDEFN table and
PID_COMPONENT Table 2-46 CLASSES table 2-31
PID_MAP Table 2-47 To clear all spec tables (in Spec Maker) 7-83
Pipe Stress Interface To configure a slope value of percent (%) in plac-
Configuring for Your Project 10-1–10-4 ing an IL 9-46
Generic Data Tables 10-2 To configure an equipment datum 8-18
Internal Processes 10-1 To configure
Pipe Stress Interface Data Files 10-2 DS_NONMATCHING_ATTRIBUTES 9-
Project-Specific Data Tables 10-3 51
Stress analysis neutral files, how users create them To configure
10-1 DS_NONMATCHING_ATTRIBUTES_L
Understanding configuration 10-1 E 9-51
Pipe too short, preventing placement of 9-52 To configure
Piping Drawing Extraction 12-1 DS_SPECIFY_ATTRIBUTES_FOR_CUS
Piping Specifications, creating and checking 7-1–7-86 TOM 9-54
PlantSpace 1-1 To configure equipment for superimposed com-
PlantSpace Equipment Modeler 8-1 ponent checking 9-21
Preferences field in the Join ILs tool 9-48 To configure nozzle type diagrams 8-23
prjcfg_e.dat related to imperial system of units 6-12 To configure the annotation text styles 9-16
prjcfg_m.dat related to metric system of units 6-12 To configure the ANNOTATION_TYPES table
Procedure for Configuring Your Pipe Stress Interface 9-15
Files 10-4 To configure the attributes to consider in compat-
Procedure for Converting Component Labels 9-34 ibility checking 9-27
Procedures To configure the class libraries for the Specifica-
To add a new terminator cell library 9-18 tion option 9-24
To add a rule to a database list (in Spec Maker) 7- To configure the content by using a different class
56 library 9-11
To add an SI (metric) lookup entry 7-45 To configure the content of the annotation text 9-
To add Fixed properties 8-11 10
To add material codes to the To configure the Label Edit tool 9-31
STRESS_MATERIAL database table 9-49 To configure the nozzle type class library 8-24
To add Prompt properties 8-7 To configure the NOZZLE_PARAMETERS ta-
To append individual JSMs to the database 6-14 ble 8-21
To append JSM files to the database in batch To configure the NOZZLE_TYPES table 8-22
mode 6-15 To configure the Preferences field in the Join ILs
To assign a password (in Spec Maker) 7-53 tool 9-48
To associate a spec with a component type (in To configure the slope option, From System 9-26
Spec Maker) 7-61 To configure the terminators 9-17
To change the behavior of the symbology in a To configure the TriForma Element Information
component 2-42 tool to display PlantSpace component infor-
To change the directory structure 6-10 mation 2-61
To change the ODBC data source (in Spec Mak- To configure the Update Symbology by Attribute
er) 7-84 utility 9-43
To change the password (in Spec Maker) 7-55 To configure which attributes make up a compo-
To change the SYSTEM names an symbologies nent ID 9-29
2-42 To configure your Pipe Stress Interface files 10-4

Index
P
To convert Spec Gen data 7-21 To delete a criterion (in Spec Maker) 7-78
To convert Spec Maker 2.0 data 7-28 To delete a rule in a database list (in Spec Maker)
To copy and paste a rule (in Spec Maker) 7-58 7-59
To copy common properties 8-5 To display a component label 6-17
To copy or move a component type (in Spec To display dimensions in imperial or SI (metric)
Maker) 7-63 units 7-48
To copy or move a criterion (in Spec Maker) 7-79 To display or hide the status bar (in Spec Maker)
To copy, edit, or delete an SI (metric) lookup en- 7-43
try 7-46 To display or hide the tool bars (in Spec Maker)
To create a label definition file 2-62 7-43
To create a mapping of component attributes To display the component type name 2-58
compared to label positions 6-19 To display the four panes of a project window 7-
To create a new component type (in Spec Maker) 42
7-59 To edit a rule in a database list (in Spec Maker) 7-
To create a new criterion (in Spec Maker) 7-65 58
To create a new specification file 7-50 To edit common properties 8-12
To create a project 2-11 To edit the fields (for attribute definitions) 2-20
To create a summary of label utilization 6-21 To edit the text file (for defining new compo-
To create and edit a user-defined Pidattr.dat file nents) 2-37
2-50 To enable scrolling on values in the attributes di-
To create multiple project schemas in one data- alog box 6-26
base instance 2-68 To enlarge the icons on the tool bars 7-44
To customize codes and descriptions in the Value To enter a password (in Spec Maker) 7-55
column 2-59 To execute your own script command 2-65
To customize the attributes of P&ID 2-49 To execute your own SQL commands 2-64
To customize the imperial or SI (metric) values in To globally update the names of specs, compo-
the Value column 2-59 nent types, and guidelines in the project tree
To customize the spc2spe.ini or spc2s71.ini file 7- structure 7-82
13 To manually save a project specification file 7-12
To customize the spc2spe.scr or spc2s71.scr file To modify grouping components that make up
7-17 the bolt assembly 4-12
To customize the spe2s71.scr file 7-25 To move the tool bars to a different location (in
To customize the units of measurement 6-11 Spec Maker) 7-44
To define a catalog table field criterion (in Spec To open and close a project specification file (in
Maker) 7-67 Spec Maker) 7-9
To define a database table field criterion (in Spec To open and close the application (in Spec Maker)
Maker) 7-68 7-8
To define a database table lookup criterion (in To permanently enable and disable custom key-
Spec Maker) 7-69 points 9-2
To define a JSpace expression criterion (in Spec To place components to confirm the attribute up-
Maker) 7-72 dates 2-35
To define a report 11-2 To place components to confirm the dimensions
To define a text input criterion (in Spec Maker) 7- 2-39
73 To populate the current Design Series database 1-
To define filters for a grouping class (for reports) 9
11-8 To prevent the placement of pipe that is too short
To define the report fields 11-7 9-52
To delete a component type (in Spec Maker) 7-62 To re-create the Rimref.dat file and build BUD ta-

Index
bles 2-33 To view the active component types associated

To rename a component type (in Spec Maker) 7- with a spec 7-33
64 To view the active specs associated with a compo-
To rename a criterion (in Spec Maker) 7-81 nent type 7-35
To reorder criteria (in Spec Maker) 7-74 To view the catalog selection criteria 7-36
To reorder rules (in Spec Maker) 7-59 To view the component definition 7-38
To reset the password check status (in Spec Mak- Procedures for Configuring Nozzle Manager 8-17
er) 7-55 Procedures for Configuring the Check Design Utility
To resize a project window and panes 7-41 9-19
To retain or delete the MicroStation SmartLine Procedures for Configuring the Text Styles, Content,
after IL creation 9-45 and Terminators 9-8
To retain the level symbology on your V7 files 9- Procedures for Configuring Your Project 2-14
45 Procedures for Customizing the Display of the Spec
To run LBLCVT to convert component labels 9- Maker Interface 7-42
36 Procedures for Customizing the Output 11-2
To save a project specification file under a differ- Procedures for Maintaining Specifications 7-82
ent name 7-12 Procedures for Opening and Closing the Application
To set the criteria properties (in Spec Maker) 7-75 and Files (in Spec Maker) 7-8
To set up bolts to be filtered with their Design Se- Procedures for Setting Up a Project Specification File
ries components (for output applications) 4- 7-49
13 Procedures for Using Spec Maker 2.0 Spec Files 7-23
To set up digital rights 6-24 Procedures for Viewing the Project Specification File
To set up digital signatures 6-25 7-30
To set up the access to data in third-party applica- Procedures for Working with Component Types 7-55
tions 2-57 Procedures for Working with Criteria 7-65
To synchronize the Ams.lib file with your project Procedures Involved in Managing a Project 6-9
database 2-35 Product Files, updating 2-43
To test your changes (to the edited Projdefe.rul file 6-12
Pidattr_user.dat file) 2-51 Projdefm.rul file 6-12
To troubleshoot problems generating bolt data 4- Project 6-1
18 Default configuration setup 6-2
To update a product file 2-43 Managing 6-1–6-26
To update an expert system rule file 2-39 Project Database
To update the catalog tables) 2-38 Modeling Tables 2-2
To update the edited Pidattr_user.dat file 2-51 Product Files 2-5
To upgrade the typical user’s machine from a pre- Rule Files 2-5
vious version of Design Series 1-14 Script Files 2-5
To upgrade your project database tables for cable Updating expert system rule files 2-39
tray components 1-13 Updating Product Files 2-43
To upgrade your project database tables for pip- Updating the Catalog Tables 2-37
ing components 1-10 Upgrading to the current version 1-9
To use Spec Maker 2.0 spec files 7-23 Project root directory 6-12
To view a spec definition 7-34 Project specification file 7-4
To view all component types in a project 7-32 Projvars.cfg 6-3
To view all specs in a project 7-31 Prompt Property (for parametric equipment) 8-2
To view database table fields 7-37 PS CREATE CELL 9-55
To view guidelines as a group 7-40 PS CREATE COMPCELL 9-55
To view guidelines individually 7-39 PS CREATE EQUIPMENT MECHELEC 9-55

Index
R
PS_GROUP.LIB 11-8, 11-9 Criteria 7-5

ps_menu.rul file 9-54 Customizing the INI File 7-13
PSDesign.s71 7-3 Customizing the interface 7-42
Customizing the Rules in Database Lists 7-56
Customizing the SCR File 7-17
R Data Files 7-2
Reference Notes for Structural Columns 9-3 Database Table Field Criterion 7-67
Report Configuration Database Table Lookup Criterion 7-68
Customizing the Output 11-2 Deleting Component Types 7-61
Defining Filters and Fields 11-2 Deleting Criteria 7-78
Grouping and Summarizing Data 11-8 Displaying Dimensions in Imperial or SI (Metric)
Processing Report Data on Specific Areas of a Units 7-44
Model 11-1 Displaying the Status Bar 7-43
Understanding 11-1 Features 7-1
report_e.dat or report_m.dat file 11-4 Globally Updating the Names of Specs, Compo-
Rights, digital 6-8 nent Types, and Guidelines in the Project
Rimref.dat file 2-33, 6-19, 6-21 Tree Structure 7-82
runmcs.bat file 6-15 Guidelines 7-5
Guidelines on Working with Spec Files and the
Database 7-50
S JSpace Expression Criterion 7-71
Script Commands, Executing 2-65 Maintaining specifications 7-82
Seed file, changing related to units of measurement 6- Objects as JSpace Objects 7-2
12 ODBC Data Source 7-84
setsymb.lib 9-40, 9-43 Password on the Project Specification File 7-53
setsymb_v7levels.lib 9-45 Project specification file, creating a new file 7-49
Setup and configuration, navigating through programs Project specification file, structure of 7-3
1-16 Project Windows 7-6
sh.dat 10-3 Renaming Component Types 7-64
Signatures, digital 6-8 Renaming Criteria 7-81
Single-line representation 12-1 Reordering Criteria 7-74
Single-line Representation of Pipes and Fittings 12-2 Seed files, efficient use 7-49
Slope Direction option 9-25 Seed files, files that can be used 7-49
Spec Checker. Changed. See Specification option. Selecting View Options on the Tool Bar, Menu
Spec Gen 2.0 Data, converting 7-13 Bar, Popup Menu, and Keyboard 7-31
Spec Maker Setting Criteria Properties 7-75
Associating a Spec with a Component Type 7-60 Setting up a project specification file 7-49
Auto-Save feature 7-12 Specifications 7-4
Catalog Table Field Criterion 7-67 Text Input Criterion 7-73
Clearing Spec Tables 7-83 Tool Bars 7-6
Component Types 7-5 Tree Structure 7-31
Converting Spec Gen 2.0 data 7-13 Understanding 7-1–7-8
Converting Spec Maker 2.0 Files into 7.1 Format Using Spec Maker 2.0 spec files 7-23
7-24 Viewing the project specification file 7-30
Copying and Moving Component Types 7-62 Working with Component Types 7-55
Copying and Moving Criteria 7-79 Working with Criteria 7-65
Creating a New Component Type 7-59 SPEC_NAMES (in the Specification Check Utility) 9-
Creating Criteria for a Component Type 7-65 23

Index
SPECCHK.INI file (in the Specification Check Utility) Volumes Tables, Updating 2-45
9-23
SPECCK_BASE class (in the Specification Check Util-
ity) 9-22
Specification option 9-21
Specification Tables 2-2
SQL Commands, Executing 2-63
STRESS_MATERIAL_EXP 10-3
Superimposed Components option 9-20
Symbolic Representation of Valves 12-2
Symbology by System, setting 2-41
Synchronizing the Ams.lib File with Your Project Da-
tabase 2-34
T
Tables
BOLT_MATERIAL 4-16
BOLTS 4-14
BOTH_SYMB 2-43
EXE_REPORT_ARGS 2-56
EXE_REPORT_CRITERIA 2-53
EXE_REPORT_TYPES 2-55
LINEO_SYMB 2-42
PID_COMPONENT 2-46
PID_MAP 2-47
Text Files
Editing 2-17
Third-party applications, accessing data from 2-52
TriForma Element Information Tool 2-60
U
Unit Names (in parametric equipment) 8-3
Units of measurement
Changing project units 6-12
Units of measurement, customizing
Imperial 6-10
Metric 6-10
Upgrading Legacy Data 1-5
Upgrading Your Project Database Tables to the cur-
rent version 1-9
V
Value column, customizing the display in the attributes
dialog box 2-59
Visible Centerlines 12-1

Ds Admin

Uploaded by

Copyright:

Available Formats

Ds Admin

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Ds Admin

Uploaded by

Copyright:

Available Formats

PlantSpace®

AutoCAD is a registered trademark of Autodesk, Inc.

August 11, 2008 PlantSpace Design Series Administrator Guide i

About This Administrator Guide

Who This Book Is For

• Oracle, Microsoft Access, or Microsoft SQL Server database

How This Book Is Organized

Chapter 2: Configuring Your Project the Traditional Way

Chapter 3: Configuring Your Project Using Bentley Project

✍ This method is an alternative to the traditional method in Chapter 2.

August 11, 2008 PlantSpace Design Series Administrator Guide iii

Chapter 4: Configuring Bolts

Chapter 5: Configuring Design Series for ProjectWise

Chapter 6: Managing Your Project

Chapter 7: Creating and Checking Piping Specifications

Chapter 8: Managing Component Types

Chapter 9: Configuring Equipment Modeler

Chapter 10: Configuring Additional Areas of the User Interface

Chapter 11: Using the Expert System in Design Series

iv PlantSpace Design Series Administrator Guide August 11, 2008

Chapter 13: Configuring Report Output for Your Project

Chapter 14: Running Piping Drawing Extraction

Appendix A: File Extensions in PlantSpace Design Series

Appendix B: Software Directory Structure

How to Use This Book

✍ For information on configuring applications for creating isometric drawings

August 11, 2008 PlantSpace Design Series Administrator Guide v

Bentley Interference Manager User Guide

JSpace Concepts and Technical Reference Help

JSpace Class Editor User Help

vi PlantSpace Design Series Administrator Guide August 11, 2008

JSpace MicroStation Connection User Guide

Model Control System (MCS) Guide

PlantSpace Design Series Reference Guide for Administrators

PlantSpace Design Series User Help

PlantSpace Design Series QuickStart Guide

August 11, 2008 PlantSpace Design Series Administrator Guide vii

(800) BENTLEY or (610) 458-5000

For requests to obtain license keys, contact Bentley Systems, Incorporated:

Americas headquarters, Fax (610) 458-1060

For more information about the Bentley family of software products:

For support, problems, and questions regarding Bentley software:

viii PlantSpace Design Series Administrator Guide August 11, 2008

About This Administrator Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-iii

About the PlantSpace Design Series Product . . . . . . . . . . . . . . . . . . . . . . 1-1

What Is New in V8 XM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

Upgrading Legacy Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

Stages in the Process of Configuring and Customizing Design Series. . . 1-15

August 11, 2008 PlantSpace Design Series Administrator Guide ix

2. Configuring Your Project the Traditional Way

Understanding Project Creation and Configuration . . . . . . . . . . . . . . . . . 2-1

Design Series Class Libraries, Ams.lib and Ams_user.lib . . . . . . . . . . . . . 2-5

Procedure for Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10

Procedures for Configuring Your Project . . . . . . . . . . . . . . . . . . . . . . . . . 2-14

3. Configuring Your Project Using Bentley Project Administrator

Understanding Bentley Project Administrator . . . . . . . . . . . . . . . . . . . . . 3-1

x PlantSpace Design Series Administrator Guide August 11, 2008

Creating a Design Series Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4

Stage 2. Edit the PlantSpace files . . . . . . . . . . . . . . . . . . . . . . . . 3-5

Maintaining Your Project Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7