Model Control System in Triforma: Mcs Guide

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 183

Model Control System

in TriForma®
V8 XM Edition

MCS Guide
DAA020460-1/0008
MCS Guide March 29, 2007
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-2006 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.

March 29, 2007 MCS Guide i


ii MCS Guide March 29, 2007
Table of Contents

Part I: For the Administrator

1. Defining MCS Configuration Variables and Setting Up


Your Data Source

Understanding the Configuration Variables for MCS and the


Database Setup Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Database Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Database Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
ODBC Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
ODBC Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

Procedures for Defining MCS Configuration Variables . . . . . . . . . . . . . . 1-2


For Design Series . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
For Architectural, Structural, and HVAC for Triforma . . . . . . . . . . 1-3

Procedures for Preparing to Use Your Project Database . . . . . . . . . . . . . 1-4


Preparing to Use the Default PlantSpace Database. . . . . . . . . . . . . . 1-4
Preparing to Use Oracle 8i or 9i . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Process of Creating a Project Database Using
Oracle 8i or 9i. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Preparing to Use SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-22
Process of Creating a Project Database Using
SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-22

Procedures for Installing Your ODBC Drivers and Defining


Your ODBC Data Source. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-33

2. Setting Up and Maintaining Your Project Database

Understanding the Model Control System . . . . . . . . . . . . . . . . . . . . . . . . 2-1


How MCS Uses Your Project Database . . . . . . . . . . . . . . . . . . . . . . 2-1
File-Based Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Component-Based Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2

March 1, 2007 MCS Guide iii


Table of Contents

Comparison of the Two Modes of Storage . . . . . . . . . . . . . . . . 2-4


Database Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4

MCS Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5


Special Attributes that Can Be Added to MCS Tables . . . . . . . . . . . 2-5
COMPLENG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
MCS Storage Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
<product>_BUD Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
DEL_<product>_BUD Tables . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
MCS Management Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
BUD_CATALOG Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
BUD_TABLE_ACCESS Table . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
CHECKOUT Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
CHECKOUT_HISTORY Table . . . . . . . . . . . . . . . . . . . . . . . . 2-8
DBSETUP_INFO Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
DEL_BUD_CATALOG Table . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
HISTORY Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
LEVEL_MAP table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
LEVEL_MAP_ACCESS table . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10
MODULES Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
PROBLEM_LOG Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
PROJECT_CONFIG Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
PROJECT_VOLUMES Table . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
SITE_CONFIG Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
STAND_ATTR Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13
MCS Sequence Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13
BUD_ID_SEQ Table or BUD_ID Sequence . . . . . . . . . . . . . . 2-13
CHECKOUT_ID_SEQ Table or
CHECKOUT_ID Sequence . . . . . . . . . . . . . . . . . . . . . . . . 2-14
LEVEL_ID_SEQ Table or LEVEL_ID Sequence . . . . . . . . . 2-14
MCS_LOCK_SEQ Table or MCS_LOCK_SEQ
Sequence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14
PRBM_ID_SEQ Table or PRBM_ID Sequence. . . . . . . . . . . . 2-14
MCS Access Control Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15
GROUP_CODE Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15
GROUP_USAGE Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15
USERS Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16
ROLE_STATUS Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16
STATUS_TRANSITIONS Table . . . . . . . . . . . . . . . . . . . . . . . 2-16
MCS Connectivity Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
BRANCH_CONN Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17
OPERATION_STATE Table . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18
BRANCH_CONN_ACCESS Table . . . . . . . . . . . . . . . . . . . . . 2-18
CONNECTORS Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-19

iv MCS Guide March 1, 2007


Table of Contents

Procedures for Setting Up and Maintaining Your Project Database . . . . 2-20


Starting the Database Setup Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-21
Populating an Empty Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23
Creating Multiple Projects in One Oracle Instance. . . . . . . . . . . . . . 2-25
Repairing a Corrupted Project Database . . . . . . . . . . . . . . . . . . . . . . 2-27
Restoring Deleted Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-30
Storage Tables for Deleted Components . . . . . . . . . . . . . . . . . . 2-30
Cleaning Up the Project Database . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-31
Tables That Can Be Emptied . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-31
Adding More Sites to Your Configuration. . . . . . . . . . . . . . . . . . . . . 2-32
Changing the SITE_CONFIG Table . . . . . . . . . . . . . . . . . . . . . 2-32
Changing the PROJECT_CONFIG Table . . . . . . . . . . . . . . . . 2-32
Generating Unique IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-33
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-34

3. Configuring Access Control

Understanding Access Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1


Access Control Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Access Control Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Access Control Configuration Variables . . . . . . . . . . . . . . . . . . . . . . 3-2
How Access Control Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Access Control at the Commodity Level . . . . . . . . . . . . . . . . . . 3-3
Access Control at the Component Level . . . . . . . . . . . . . . . . . . 3-3
How Access Control Works in MCS Operations . . . . . . . . . . . . . . . 3-4
Check-In, Append, and Update Database Operations . . . . . . . 3-4
Check-Out Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5

Procedures for Configuring Access Control . . . . . . . . . . . . . . . . . . . . . . . 3-6

4. Configuring Connectivity Processing

Understanding Connectivity Processing . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1


BRANCH_CONN Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Procedures for Configuring Connectivity Processing . . . . . . . . . . . . . . . . 4-2


Preliminary Setup for the Incremental Synchronization
of Pipeline Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Appending Your Existing Components. . . . . . . . . . . . . . . . . . . . . . . 4-2
Bypassing Connectivity Checking. . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Fixing the BRANCH_CONN Table . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Maintaining Connectivity Information. . . . . . . . . . . . . . . . . . . . . . . . 4-5

March 1, 2007 MCS Guide v


5. Configuring MCS and Related Programs

Understanding the MCS Interface and Programs Related


to MCS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Define Volume Utility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Database Setup Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
MCS Administrator Database Tool . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
MCS Change Status Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Work State Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Tasks Involved in Configuring MCS and Related
MCS Programs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3

Procedures for Defining Volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3


Master and Discipline Volume Definition Files. . . . . . . . . . . . . 5-3
Tasks Involved in Working with the Master Volume
Definition File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4
Creating the Master Volume Definition File . . . . . . . . . . . . . . . 5-4
Loading the Master Volume Definition File
into the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
Adding Areas to the Master Volume Definition File . . . . . . . . 5-7
Using the Database Setup Tool to Build MCS Storage Tables . . . . . 5-9
Building MCS Storage Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9

Procedure for Configuring Fields in Dialog Boxes. . . . . . . . . . . . . . . . . . 5-10

Procedures for Appending a Design File to Move from


File-Based Storage to Component-Based Storage . . . . . . . . . . . . . . . 5-11
Enabling Users to Perform the Append Operation . . . . . . . . . 5-11
Guidelines for the Append Operation . . . . . . . . . . . . . . . . . . . . 5-12

Procedures for Using the MCS Administrator Database


Tool to Manage Your Project Database . . . . . . . . . . . . . . . . . . . . . . 5-13
Accessing the MCS Administrator Database Tool If
Internet Explorer Is Not Your Default Browser. . . . . . . . . . . . 5-14
Viewing Components Checked Out by Users . . . . . . . . . . . . . . . . . . 5-16
Unlocking Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18
Adding Attributes to Product_BUD Tables . . . . . . . . . . . . . . . . . . . 5-19
Running Queries on Your Project Database . . . . . . . . . . . . . . . . . . . 5-19

Procedures for Configuring the MCS Change Status Tool. . . . . . . . . . . . 5-20

vi MCS Guide March 1, 2007


Table of Contents

Part II: For Users

6. Using the Model Control System

Understanding the Model Control System . . . . . . . . . . . . . . . . . . . . . . . . 6-1


How MCS Uses Your Project Database . . . . . . . . . . . . . . . . . . . . . . 6-1
Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Programs Related to MCS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Define Volume Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
MCS User Database Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
MCS Change Status Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3

Procedures for Working with Volume Definition Files . . . . . . . . . . . . . . 6-3


Creating a New Volume Definition File . . . . . . . . . . . . . . . . . . . . . . 6-4
Adding an Area to the File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
Viewing a Volume Definition File . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
Saving a File to a New File Name . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
Editing an Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7
Manipulating Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11

Procedures for Working with MCS and the MCS User


Database Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-14
Checking Out Components or Files. . . . . . . . . . . . . . . . . . . . . . . . . . 6-14
Options for Checking Out Components or Files . . . . . . . . . . . 6-15
Using Query Statements to Check Out Components . . . . . . . . 6-15
Query Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-15
Combining Query Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-16
Guidelines for the Check-out Operation . . . . . . . . . . . . . . . . . . 6-18
Key-in for the Check-Out Operation . . . . . . . . . . . . . . . . . . . . . 6-24
Saving a Query File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-24
Loading a Query File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-24
Checking In Components or Files . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-25
Guidelines for the Check-in Operation . . . . . . . . . . . . . . . . . . . 6-25
Updating the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-27
Updating a Reference File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-28
Taking a Model Snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-29
Batch Processing MCS Operations . . . . . . . . . . . . . . . . . . . . . . . . . . 6-30
Examples of Batch Processing . . . . . . . . . . . . . . . . . . . . . . . . . . 6-32
Appending a Design File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-32
Guidelines for the Append Operation . . . . . . . . . . . . . . . . . . . . 6-32
Viewing Components Checked Out by Other Users . . . . . . . . . . . . 6-33

Procedure for Using the MCS Change Status Tool . . . . . . . . . . . . . . . . . 6-37

March 1, 2007 MCS Guide vii


Table of Contents

Appendix: Navigating within MCS and Related Programs

The Model Control System (MCS) and Define Volume Utility . . . . . . . . A-1
MCS Design File Check-Out Dialog Box . . . . . . . . . . . . . . . . . . . . . A-2
Queries Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4
Options Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4
Open Volume File Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . A-5
Select Areas Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-6
Query Builder Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-6
MCS Design File Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-9
MCS Design File Snapshot Dialog Box . . . . . . . . . . . . . . . . . . . . . . . A-10
Navigating in the Define Volume Utility . . . . . . . . . . . . . . . . . . . . . . A-11
VolEdit Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-12
File Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-13
VolEdit Dialog Box Extension. . . . . . . . . . . . . . . . . . . . . . . . . . A-13

MCS Change Status Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-14

Index

viii MCS Guide March 1, 2007


Part I: For the Administrator

March 29, 2007MCS Guide


MCS Guide November 15, 2006
1 Defining MCS Configuration Variables
and Setting Up Your Data Source
After you installed TriForma EC, you were directed to this chapter of
this guide.

Understanding the Configuration Variables for MCS and the


Database Setup Tool
A configuration variable is an equivalence string with a particular meaning that a
program interprets. For example, you can define a configuration variable to indicate
where MicroStation is to look for certain files or classes of files. During installation, the
system sets some configuration variables to default values.

W If you are using MCS for your project, the configuration variables that pertain to
MCS and the Database Setup tool may need to be defined before you start
TriForma so that all components work properly. (Configuration variables for the
Database Setup tool are necessary because MCS requires a database.)

Database Setup

W If you are using Model Control System (MCS) with TriForma and any of the
applications that run on it, you must follow the directions in this chapter before
starting the applications.

For data, you can use the default imperial and SI (metric) databases that come with the
software or your own data from a database such as Oracle or Microsoft SQL Server.

For Design Series and other TriForma applications to efficiently access and use the
data, you need to set up the following:

1. Database instance
2. ODBC drivers
3. ODBC data source

March 1, 2007 MCS Guide 1-1


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

Database Instance
The database instance is an empty database.

In TriForma, the instance serves as a repository of all the project-related information


including graphic and non-graphic information associated with the components
modeled during the life cycle of the project.

Procedures for creating an instance of Oracle and SQL Server are given later in this
chapter. You may also need to refer to the corresponding database vendor’s
documentation for detailed information.

ODBC Drivers
ODBC drivers are sometimes referred to as middleware. Based on the ODBC
specifications, they provide a neutral or standard way for applications to access
database records.

ODBC drivers are available from third-party software developers such as Microsoft.
Drivers are available for commercial relational database management systems (RDBMS),
spreadsheets, and ASCII formats.

Before you define the ODBC data source, you must have the driver for that type of
database.

W Microsoft currently has available free ODBC drivers that you should use to ensure
the proper functionality of Oracle, or SQL Server. These drivers can be installed by
installing Microsoft Data Access Components available on the Internet at:

http://www.microsoft.com/data

After you install an ODBC driver, you must define an ODBC data source.

ODBC Data Source


After you install the ODBC drivers, you next define an ODBC data source in Data
Sources (ODBC) in Control Panel. Procedures for defining the ODBC data source for
your Oracle and SQL Server databases are given later in this chapter.

Procedures for Defining MCS Configuration Variables


Whether you need to define configuration variables or not depends on which
application you plan to install to run on TriForma and which workspace you plan to
use, as explained in the following sections.

1-2 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
For Design Series

For Design Series


For Design Series, the file that contains the configuration variables for MCS and the
Database Setup tool is projvars.cfg in your project directory. The projvars.cfg file
defines variables that are specific to the project.

➤ To define configuration variables for Design Series


1. After you install Design Series but before you open the application,
check the following conditions to determine if you need to define
configuration variables:

If Then
You plan to open Design You do not need to define any configuration variables for
Series in psdstut, the MCS and the Database Setup tool. During installation, they are
default project workspace automatically defined for Design Series, including the ODBC
data source.
You plan to open Design You do not need to define any configuration variables. The
Series in a project PS_CODES_DB configuration variable is already defined to
workspace other than the point to the database where your project data will be stored.
default project workspace You can, however, change any configuration variables
according to your project specifications. See the chapter
“Managing Your Project” in the PlantSpace Design Series
Administrator Guide.

2. Open projvars.cfg in your project directory.


3. Define the appropriate configuration variables based on the
conditions in step 1.
4. Save and close the file.

✍ Continue to the section on preparing to use your project database.

For Architectural, Structural, and HVAC for Triforma


For these applications, the file that contains the configuration variables for MCS and the
Database Setup tool is:

• {ProjectName}.pcf in the ...\Bentley\Workspace\projects\examples directory,


and
• mcs_imperial.cfg in the ...\Bentley\Workspace\projects\examples
\TriForma_Imperial\mcs directory, or
• mcs_si.cfg in the ...\Bentley\Workspace\projects\examples
\TriForma_SI\mcs directory

March 1, 2007 MCS Guide 1-3


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

➤ To define the configuration variables for ATF, STF, or HTF


1. After you install Architectural for TriForma (ATF), Structural for
TriForma (STF), or HVAC for TriForma (HTF), but before you open the
application, check the following conditions to determine if you need
to define configuration variables:

If Then
• You selected the MCS options during You do not need to define PS_CODES_DB.
the installation of TriForma EC, and
• You plan to open ATF, STF, or HTF in
the delivered default project workspace
(TriForma_Imperial or TriForma_SI)
• You selected the MCS options during You must define PS_CODES_DB to point to the
the installation of TriForma EC, and database where your project data will be
• You plan to open ATF, STF, or HTF in a stored. You must also define other
project workspace other than the configuration variables according to your
default project workspace project specifications. See information on
(TriForma_Imperial or TriForma_SI)
project configuration in the appropriate
application’s documentation.

2. Open your mcs_imperial.cfg or mcs_si.cfg file in the


...\Bentley\Workspace\Projects\Examples\TriForma_Imperial or
TriForma_SI\mcs directory.
3. Define the appropriate configuration variables based on the
conditions in step 1.
4. Save and close the file.

✍ Continue to the next section on preparing to use your project database.

Procedures for Preparing to Use Your Project Database


✍ Follow the procedures in the appropriate section on:

• The default PlantSpace database


• Oracle 8i or 9i
• SQL Server

Preparing to Use the Default PlantSpace Database

W Using Microsoft Access as your enterprise database is not recommended because of


its limitations on scalability and security.

1-4 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Preparing to Use Oracle 8i or 9i

If you want to use the delivered Access database for the Tutorial project (used with the
PlantSpace Design Series QuickStart Guide for users who are new to Design Series), the
ODBC data source is automatically defined so you can skip this section. Because this is
an Access database, you can use Access database tools to manage and view the data.

W You need a working knowledge of Design Series and Access to perform the
administrator tasks associated with selecting the data source. Because this Guide
does not address standard database management tasks such as backup, recovery,
tuning, and optimization, you also need to take the usual precautions to ensure the
integrity of the database.

➤ To define the data source for an Access database


1. Access Data Sources (ODBC) in Control Panel.
2. In the ODBC Data Source Administrator dialog box, click Add.
3. In the Create New Data Source dialog box, select a Microsoft Access
Driver (*.mdb) and click Finish.
4. In the ODBC Microsoft Access Setup dialog box, type a project name
such as PlantSpace Database for the data source name as shown.

Location of
Database on a
Network Drive

5. Click the Select button and select the default Access database file,
Pltspace.mdb, as shown.
✍ Depending on your operating system and version number, you may
need to navigate to the ...\Projects\psdstut directory on your
network drive.
6. Click OK.

Preparing to Use Oracle 8i or 9i

W You need to be familiar with Oracle database software to install and configure it.

March 1, 2007 MCS Guide 1-5


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

Process of Creating a Project Database Using Oracle 8i or 9i

W Creating your project database using Oracle 8i requires that you follow these tasks
in this order.

1. Setting up the file for the Oracle 8i or 9i database


2. Creating the instance and database
3. Creating and modifying Listener on the server
4. Creating an Oracle service on clients to access your project database
on the server

➤ To set up the file for the Oracle 8i or 9i database


1. Install Oracle 8i or 9i, stop when the configuration dialog box is displayed,
select the Default Configuration check box, and then click Exit.
2. Create a directory where your project database files will reside.
An example is c:\amse (for AMS english database).
3. Copy scripts and other files from the path specified by the
PS_DBLOAD configuration variable to the directory created in step 2.
✍ For example, for the delivered TriForma_imperial or TriForma_SI
project, the path is ...\Bentley\Workspace\Projects\Examples
\TriForma_imperial or TriForma_SI\mcs\dbload\oracle.
You would copy all of these files from this oracle subdirectory to
the c:\amse directory.
4. Edit initams8i.ora or initams9i.ora as follows:
✍ Set the correct instance and directory names according to your
setup by using the following examples as a guideline:
• db_name = amse
• instance_name = amse
• service_names = amse
• control_files = ("c:\amse\control01.ctl", "c:\amse\control02.ctl")

W 1. It is suggested but not required that two control files be on two different physical
drives to be able to recover the database in case a control file on one drive is lost.
2. It is suggested that you provide the same values for db_name, instance_name,
and service_name unless you know why you want them to be different.

1-6 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Preparing to Use Oracle 8i or 9i

➤ To create the instance and database


1. Perform either of the following operations:
a. From the Command Prompt, run createams8i or createams9i with the following
parameters, separated by a space, in the order shown:
-- Batch file name, createams8i or createams9i
-- Instance name (should be the same as the instance_name set in initams8i.ora or
initams9i.ora)
-- Path of the script files (for example, c:\amse)
-- Oracle directory

✍ Be sure to provide the path to the directory just above the \bin directory.
For example if your installation looks like c:\oracle\ora8i or ora9i\bin, then
provide c:\oracle\ora8i or ora9i as the Oracle directory.
Example: createams9i amse c:\amse c:\oracle\ora9i
b. Modify the settings in createams8i.bat or createams9i.bat according to your
setup by using the following examples as a guideline:
SET ORACLE_SID = amse
SET PS_ORACLE_HOME = c:\amse
SET ORACLE_HOME = c:\oracle\ora8i or ora9i

✍ In this case, run the batch without any parameter like: createams8i or
createams9i.

W This batch file will pause after initial processing, which might take one or two
minutes. At this pause, you should check for errors (if any) in the command
window. You should look for a message similar to "database created" before letting
the batch continue.

2. Verify that the instance is running by issuing net start from a


command line.

March 1, 2007 MCS Guide 1-7


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

The results should show OracleServiceamse as one service


running, shown at the arrow in the following example.

✍ If the results are not correct, then the createams8i.bat file or createams9i.bat file did not run
properly. Look at the command window (DOS) and also in the *.lst files in the scripts
directory (for example, under c:\amse).

➤ To create or modify Listener on the server


1. From the Windows Start>Programs>Oracle 8i or 9i program group, select
Network Administration>Net8assistant.
2. Select Local.

1-8 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Preparing to Use Oracle 8i or 9i

3. Expand the directory, select Listeners.


4. If no Listener is listed, click the + (Create) button.
✍ If a Listener is already listed, go directly to step 8.

5. Type a Listener name such as LISTENER as shown in the example,


and click OK.

6. Expand the Listerners directory and select LISTENER which you just
created, as shown.

March 1, 2007 MCS Guide 1-9


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

✍ Make sure that in the drop-down list on the right, Listening


Locations is selected.

7. Click the Add Address button and type or select the following:
• Protocol: TCP/IP
• Host: {machine name}

1-10 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Preparing to Use Oracle 8i or 9i

✍ For Port, leave the default setting shown.

8. In the drop-down list box on the right, select Database Services.

March 1, 2007 MCS Guide 1-11


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

9. Click the Add Database button and type the following as shown:
• Global Database Name: amse (same as INSTANCE_NAME)
• Oracle Home Directory: {drive:}\orant816 (same as ORACLE_HOME)
• SID: amse (same as INSTANCE_NAME).

1-12 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Preparing to Use Oracle 8i or 9i

10. From the menu bar, choose File>Save Network Configuration and
minimize the dialog box.

11. Open listener.ora in your ORACLE_HOME\network\Admin


directory.
The contents should look similar to the following example.

March 1, 2007 MCS Guide 1-13


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

12. Restart the Listener service by choosing Settings>Control Panel


>Services, or issuing the net start, net stop, and then
net start commands as shown.

1-14 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Preparing to Use Oracle 8i or 9i

➤ To create an Oracle service on clients to access your project database on the


server
1. Expand the Local directory, select Service Naming, and click the
+ (Create) button.

2. In the Net Service Name Wizard: Welcome dialog box, type the name
of this service (for example, amse) and click Next.

March 1, 2007 MCS Guide 1-15


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

3. In the next dialog box shown, select TCP/IP (Internet Protocol) and
click Next.

4. In the next dialog box shown, type the host (machine name), leave
the port number shown, and click Next.

5. In the next dialog box shown, type the service name.

1-16 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Preparing to Use Oracle 8i or 9i

✍ This name should be the same as instance_name in the


initams8i.ora file or initams9i.ora file.

6. Click Next and then click the Test button.

March 1, 2007 MCS Guide 1-17


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

7. If the connection is successful as indicated by the following message,


click Close.

8. If the connection fails, click the Change Login button.


9. In the Change Login dialog box, type the following and click OK:
• Username: system
• Password: manager.

10. Click Test again.

1-18 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Preparing to Use Oracle 8i or 9i

11. If the connection is successful as shown, click Close.

12. In the last dialog box, click Finish.

March 1, 2007 MCS Guide 1-19


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

The new service is displayed in the tree pane, as shown in the


example, amse.

✍ Leave the dialog box open and continue to the next procedure.

➤ To complete the creation of the service name

W Even though it appears that you have finished, you must complete the following
steps.

1. Select the new service in the tree pane, and click the Advanced
button on the right.
2. In the Advanced Service Options dialog box, type the instance name
(for example, amse) and click OK.

1-20 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Preparing to Use Oracle 8i or 9i

3. In the Net8 Assistant dialog box, choose File>Save Network


Configuration from the menu bar to save the new configuration.

4. Open the tnsnames.ora file in the ORACLE_HOME\network\Admin


directory.
The contents should look similar to the following example.

5. Close this file and close Net8Assistant.

✍ Continue to the “Procedures for Installing Your ODBC Drivers and Defining Your ODBC Data
Source”.

March 1, 2007 MCS Guide 1-21


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

Preparing to Use SQL Server

W You need to be familiar with SQL Server database software to install and configure
it.

If you have not yet installed Microsoft SQL Server, you should do so now. An example
is used to make this process of preparation more meaningful. In this example, the
server group SQL_SERVER has been created, registered, and started.

Process of Creating a Project Database Using SQL Server

W Creating a project database using SQL Server requires that you follow these tasks in
this order:

1. Creating a new database


2. Creating a new login
3. Adding new users to the database
4. Starting the server
5. Modifying permissions
6. Modifying permissions for users

✍ In the following procedures, the system assumes that the database instance name
is SQL_ENGLISH. The instance name is case sensitive. However, you can replace
SQL-ENGLISH with the name of your database instance in the names of the files
and directories.

➤ To create a new database

✍ You must have administrator privileges to log on to SQL Server on the server
machine to create a database instance.

1. From the Windows Start>Programs menu, locate the appropriate


Microsoft SQL Server program group for the version that you are
using, and select SQL Enterprise Manager.

1-22 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Preparing to Use SQL Server

The Console Root\Microsoft SQL Servers dialog box is displayed


within the SQL Server Enterprise Manager window.

✍ To view all of the SQL_SERVER options in this example, SQL Server


with the name HARP has been created under the group SQL
Server Group. The expanded directory is displayed.

March 1, 2007 MCS Guide 1-23


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

2. To view all of the options for server HARP, click the plus (+) sign by
HARP.

3. In the SQL_SERVER group, right-click Databases.


The Databases popup menu is displayed.

4. Select New Database.

1-24 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Preparing to Use SQL Server

The New Database - SQL_SERVER dialog box is displayed.

5. At the Name field, type SQL_ENGLISH, and use the default settings
shown in this example.
6. Click OK.
7. To verify that the new database SQL_ENGLISH was created, click the
plus sign (+) by the Databases directory and view the expanded
directory.

➤ To create a new login

✍ This procedure uses proj as a login example.

March 1, 2007 MCS Guide 1-25


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

1. In the SQL_SERVER directory, select the Security subdirectory and


right-click Logins.
The Logins popup menu is displayed.

2. Select New Login.

1-26 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Preparing to Use SQL Server

The SQL Server Login Properties - New Login dialog box is displayed.

3. In the General tab displayed, select or type values for the following
fields as shown in this example:

Field Sample Value


Name proj
Password none
Database SQL_ENGLISH
Language Default

4. Use the default settings shown and click OK.


5. To verify that the new login was created, click the plus sign (+) by the
Logins directory and view the expanded directory.

➤ To add a new user

✍ This procedure uses proj and sysadmin as user examples added to the
SQL_ENGLISH database.

March 1, 2007 MCS Guide 1-27


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

1. In SQL_SERVER >Databases>SQL_English, right-click Users.


The Users popup menu is displayed.

2. Select New Database User.


The Database User Properties - New User dialog box is displayed.

1-28 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Preparing to Use SQL Server

3. In the General tab, select or type the values for the following fields as
shown in the example:

Field Sample Value


Login name proj
User name proj
Group public

4. Use the default settings shown and click OK.


5. To verify that the new users were created, in the
SQL_SERVER>Databases>SQL_ENGLISH>Users directories, click the
plus sign (+) by Users and view the expanded directory.

✍ To create a system administrator as a new user, you must first create a login
named sysadmin with database administrator privileges, and then follow the
previous steps.

➤ To start the server using SQL Server

✍ You can start the server in two ways, by using SQL Server Enterprise Manager or
SQL Server Service Manager.

1. To start the server from SQL Enterprise Manager:


a. From the Windows Start>Programs menu, select the appropriate
Microsoft SQL Server program group for the version you are using.
b. In the SQL Server Enterprise Manager window, Console Root/
Microsoft SQL Servers dialog box, right-click the server HARP.

March 1, 2007 MCS Guide 1-29


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

The server popup menu is displayed.

c. Select Start.
2. To start the server from SQL Server Service Manager:
a. From Windows Start>Programs menu, select the appropriate
Microsoft SQL Server program group for the version you are using.
b. Select SQL Server Service Manager.
The SQL Server Service Manager dialog box is displayed.

c. Select Start/Continue.

1-30 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Preparing to Use SQL Server

➤ To modify permissions

✍ This procedure uses SQL_ENGLISH as a database example.

1. In the SQL Server Group>HARP>Databases directory, right-click


SQL_ENGLISH.
The database popup menu is displayed.

2. Select Properties, as shown in the example.

March 1, 2007 MCS Guide 1-31


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

The SQL_ENGLISH Properties dialog box is displayed.

3. In the General tab, select any of the settings for file growth and
maximum file size, or use the selections shown in this example.
4. Click Apply.

➤ To modify permissions for users


1. In the SQL_ENGLISH properties dialog box, click the Permissions tab.
The SQL_ENGLISH Properties dialog box is displayed.

1-32 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Procedures for Installing Your ODBC Drivers and Defining Your ODBC Data Source

2. Select the settings that you want, click Apply and then OK.

✍ Continue the next procedure to install your ODBC drivers and define your data
source.

Procedures for Installing Your ODBC Drivers and Defining


Your ODBC Data Source
You should install the driver and set up the data source in the following order:

1. Installing ODBC drivers for Oracle or SQL Server


2. Defining the ODBC data source for Oracle or SQL Server
3. Optionally, viewing information about a driver
4. Optionally, reconfiguring the driver

➤ To install ODBC drivers for Oracle or SQL Server

W Microsoft currently has available free ODBC drivers that you should use to ensure
the proper functionality of Oracle, or SQL Server.

1. On the Internet, access:


http://www.microsoft.com/data

2. Refer to the Readme file for the correct version of the Microsoft Data
Access Components to download and install.

➤ To define the ODBC data source for Oracle or SQL Server


1. Access Data Sources (ODBC) in Windows Control Panel.
2. In the ODBC Data Source Administrator dialog box, click the Add
button.

March 1, 2007 MCS Guide 1-33


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

The Create New Data Source dialog box is displayed listing the
installed ODBC drivers.

3. Scroll down and select Microsoft ODBC for Oracle or SQL Server
and click Finish.
4. For Oracle, complete the following fields in the setup dialog box
displayed and then click OK.

• Data Source Name: the name of your Oracle database such as the sample
name
• Description: the description to identify the purpose such as the sample
description
• User Name: (your system login, or your project login, or no name)
• Server: the net service name that you used in step 2, “In the Net Service Name Wizard:
Welcome dialog box, type the name of this service (for example, amse) and click Next.”
✍ The setup of the Oracle data source is finished.

1-34 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Procedures for Installing Your ODBC Drivers and Defining Your ODBC Data Source

5. For SQL Server, complete the following fields in the setup dialog box
displayed and then click Next:

• Name: the name of your SQL Server database such as the sample name
• Description: the description to identify the purpose such as the sample
description
• Server: the machine name where the database resides
✍ The remaining dialog boxes pertain to SQL Server.

March 1, 2007 MCS Guide 1-35


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

6. In the next dialog box, select the second radio button and the check
box shown.

7. Complete the following fields and then click Next:


• Login ID: your system login such as sa (the default system login) or your
project login if already created
• Password: a valid password

1-36 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Procedures for Installing Your ODBC Drivers and Defining Your ODBC Data Source

8. In the next dialog box, type SQL_ENGLISH in the first field, select the
check boxes shown, and then click Next.

9. In the next dialog box, select the check box shown and click Finish.

March 1, 2007 MCS Guide 1-37


1 Defining MCS Configuration Variables and Setting Up Your
Data Source

10. . In the next dialog box, click the Test Data Source button.

11. In the last dialog box, be sure that the message displayed indicates
that the test was successful, and then click OK.

✍ The setup of the SQL Server data source is finished.

1-38 MCS Guide March 1, 2007


Defining MCS Configuration Variables and Setting Up Your Data Source
Procedures for Installing Your ODBC Drivers and Defining Your ODBC Data Source

W If you are not using the following optional procedures, go directly to the next
chapter “Setting Up and Maintaining Your Project Database”.

➤ To view information about a driver


1. In the ODBC Data Source Administrator dialog box, select the Drivers
tab on the dialog box.
The Drivers dialog box is displayed.

2. View details about the driver.


3. Either continue to the next procedure to configure a data source, or
click the OK to close the dialog box.

➤ To configure a data source


1. In the ODBC Data Source Administrator dialog box, select the User
DSN tab.
2. Select the data source and click the Configure button.
The setup dialog box for the selected data source is displayed. This
dialog box varies with the selected data source.
3. Make appropriate changes to configure the data source.
4. Either select a different tab to perform a different task, or click the OK
to close the dialog box.

March 1, 2007 MCS Guide 1-39


1-40 MCS Guide March 1, 2007
2 Setting Up and Maintaining Your
Project Database
You can connect to a new project database, load files, and maintain
the database.

This chapter explains the tables of your project database, and the
tasks necessary to maintain your database over time.

Understanding the Model Control System


W Depending on the TriForma application(s) installed on your machine and user
machines, be sure that you have read Chapter 1 to determine if you need to define
certain configuration variables before starting any of these applications so that MCS
works properly. You may also need to set up a database instance, explained in
Chapter 1.
Model Control System (MCS) is a program that stores in a master repository database,
the components (including non-graphical values and representations) that you model.
MCS also enables you to extract and update the components. These components
include piping, pipe supports, equipment, raceways, structural, architectural, HVAC,
and any other TriForma components.

How MCS Uses Your Project Database


For data, you can use the default imperial and System International (metric) datasets
that come with the software, or you can use your own data from a database such as
Oracle or Microsoft SQL Server. Depending on the application running on the TriForma
EC, you can store and extract data from your project database in one of two modes:

• File-based storage
• Component-based storage

File-Based Storage

In file-based storage, MCS stores the DGN file. File-based storage mode is required for
applications that associate components to maintain the associations between
components within a model. You can extract the components by entering the name of
the design file.

March 29, 2007 MCS Guide 2-1


2 Setting Up and Maintaining Your Project Database
Understanding the Model Control System

W Where MicroStation V8 DGN files can contain multiple models, DGN files for use
in MCS can contain only one model.
You can store your design data modeled from the Design Series 3D applications in an
ODBC-compliant database such as:

• Microsoft Access for small datasets with limited users


• Microsoft SQL Server and Oracle for large datasets or advanced
databases

A designer using a laptop computer can:

• Check out a file from the project database


• Go to the job site and model components
• Return to the office and connect to the project database
• Check in the updated information

File-based storage also:

• Stores all design information in a central database


• Automatically creates a MicroStation design file when components are
checked out of the database
• Assigns a different color to read-only components when they are not
checked out
• Assigns a different color to locked components to indicate that
another user has checked them out for modification
• Updates the central database only when you submit changes

Component-Based Storage

In component-based storage, MCS stores the components. Component-based storage


mode is allowed for applications where all the components are independent of one
another, allowing for the creation of a model with any arbitrary set of components. You
can extract these components from your project database first by entering a query
based on component attributes, and then specifying an area name with the default
master volume definitions or area names with the discipline volume definition file
name and extension. With component-based storage, components are checked into
one project database during and after the initial design. You can store your design data
modeled from the Design Series 3D applications in an ODBC-compliant database such
as:

• Microsoft Access for small datasets with limited users

2-2 MCS Guide March 29, 2007


Setting Up and Maintaining Your Project Database
How MCS Uses Your Project Database

• Microsoft SQL Server and Oracle for large datasets or advanced


databases

When the components are in the database, all users have access. The initial design,
review, and revisions can be organized in many different ways (for example, by area,
individual system, or line number). These tasks are explained in the user chapter of
this Guide.

A designer using a laptop computer can:

• Check out a specified area, system, or line number from the project
database
• Go to the job site and model components
• Return to the office and connect to the project database
• Check in the updated information

Component-based storage also:

• Enables you to check in and check out components from project


areas. You can work with a single component or a complete project
including all disciplines.
• Handles large, multi-discipline projects where tight control is essential
• Stores all design information in a central database
• Automatically creates a MicroStation design file when components are
checked out of the database
• Assigns a different color to read-only components when they are not
checked out
• Assigns a different color to locked components to indicate that
another user has checked them out for modification
• Updates the central database only when you submit changes

March 29, 2007 MCS Guide 2-3


2 Setting Up and Maintaining Your Project Database
Understanding the Model Control System

Comparison of the Two Modes of Storage

The following diagram visually compares the processes involved in file-based storage
and component-based storage.

Modes of Storage in MCS


File-Based Storage Component-Based Storage

MCS
MCS(program
(programthat thatmanages
manages MCS
MCS(program
(programthat
thatmanages
manages
design
designfiles
filesininyour
yourdatabase)
database) components
componentsininyour
yourdatabase)
database)

Your Project Your Project


Database Database

MCS Check-out MCS Check-in MCS Check-out MCS check-in


and Append

DGNs DGNs
Components Components

DGNs Created Temporary DGN DGNs Created Temporary DGN


or Modified or Modified

Local User Local User

Database Tables
Applications use the tables of your project database to define the behavior of the
modeling software. The 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 and are
explained in the next section.
• Design Series modeling tables, which are static tables that change
minimally
✍ These tables are not used in MCS. They are exclusive to Design
Series. For details on these tables if you are using Design Series,
refer to the chapter "Design Series Modeling Tables" in the
PlantSpace Design Series Reference Guide for Administrators.

2-4 MCS Guide March 29, 2007


Setting Up and Maintaining Your Project Database
MCS Tables

MCS Tables
MCS tables in your project database can be grouped into the following categories:

• “MCS Storage Tables” on page 2-5


• “MCS Management Tables” on page 2-6
• “MCS Sequence Tables” on page 2-13
• “MCS Access Control Tables” on page 2-15
• “MCS Connectivity Tables” on page 2-17

Special Attributes that Can Be Added to MCS Tables


You can add an attribute as a column in an MCS table for a particular result (for example, for
reporting purposes).

COMPLENG

The length of linear components can be calculated automatically and stored in a column named
COMPLENG in any of the BUD_xxxx tables. Reports can then be generated directly from the
MCS tables.

This attribute is defined with the delivered configuration for pipes, trays, conduits, and ducts, and
can be added to other linear component types or removed from any component type. When this
attribute is present in the label, the length of the component is calculated from its two points and
is assigned at MCS Check-in, Append, or Update Database operations. The calculated length
value is in project units, which are either inches or millimeters.

MCS Storage Tables


MCS storage tables contain the graphical definition, attributes, relationship to other
components, and the MCS checkout identification number for each component.

A binary (BLOB) column called Graphics increases MCS checkout performance by reducing the
query time and amount of data to be transferred. This enhancement also enables Oracle
replication support using Microsoft ODBC drivers.

MCS uses the following storage tables:

• <product>_BUD tables
• DEL_<product>_BUD tables

March 29, 2007 MCS Guide 2-5


2 Setting Up and Maintaining Your Project Database
MCS Tables

<product>_BUD Tables

A <product>_BUD table holds the components for each product that has been checked
into the database. The <product>_BUD tables are:

• CNDT_BUD (Design Series Raceways table)


• CORE_BUD (Design Series Column Lines table)
• EQUIP_BUD (Design Series Equipment Modeler table)
• HGR_BUD (SupportModeler table)
• HGRPT_BUD (SupportModeler table)
• HTF_BUD (HVAC for TriForma table)
• HVAC_BUD (Design Series HVAC table)
• ILPIP_BUD (Design Series Intelligent Line String table)
• PIPE_BUD (Design Series Piping table)
• STF_BUD (Structural for TriForma table)
• TF_BUD (TriForma table including generic TriForma and Architectural
for TriForma)
• TRAY_BUD (Design Series Raceways table)

W If you change any component attributes, you must create or update these tables.
You can create or update these tables by using the Database Setup tool. For the
procedure, see “Building MCS Storage Tables”.

DEL_<product>_BUD Tables

The DEL_<product>_BUD tables contain the same information as the <product>_BUD


tables. However, the components stored in these tables were deleted from the model at
some point.

The names of the DEL_<product>_BUD tables are identical to the names of the
<product>_BUD tables, except that they begin with “DEL_”.

MCS Management Tables


W MCS Management tables should not be modified.
The following tables are used to manage MCS:

• BUD_CATALOG table
• BUD_TABLE_ACCESS table
• CHECKOUT table

2-6 MCS Guide March 29, 2007


Setting Up and Maintaining Your Project Database
MCS Management Tables

• CHECKOUT_HISTORY table
• DBSETUP_INFO table
• DEL_BUD_CATALOG table
• HISTORY table
• LEVEL_MAP table
• LEVEL_MAP_ACCESS table
• MODULES table
• PROBLEM_LOG table
• PROJECT_CONFIG table
• PROJECT_VOLUMES table
• SITE_CONFIG table
• STAND_ATTR table

BUD_CATALOG Table

This table contains a list of all the components that have been checked into the
database. It contains common data about all active components in the database, their
BUD_TYPE, the areas to which they belong, and one entry of range information for
each area.

Column Name Comment


BUD_ID Component identification number
ROOT_BUD_ID ID of parent component
BUD_TYPE BUD type
BUD_TABLE Storage table name
COMMODITY Commodity (such as PIPE, EQUIP)
VOLUME_ID Plant area name
MOD_ID Model ID
RANGE Component Range

March 29, 2007 MCS Guide 2-7


2 Setting Up and Maintaining Your Project Database
MCS Tables

BUD_TABLE_ACCESS Table

During the MCS process, this table controls access to the BUD_CATALOG tables. Two
users cannot access the table at the same time because this table is used to prevent
conflicts when users are checking out components at the same time.

Column Name Comment


CHECKOUT_ID Check-out identification number
BUD_TABLE Storage table name
SEQ_NUM Sequence number

CHECKOUT Table

This table contains a list of the checked out design files and related information created
by requests to lock components.

Column Name Comment


CHECKOUT_ID Check-out identification number
TYPE Transaction type
SYS_USERNAME System user name
USER_ID Database user name
Information NODE_NAME Node name
associated FILESPEC Name of file
with the
Check-out NUM_CHECKOUT Number of components checked-out
Operation COMPLETED Status
PID Process ID
CHECKOUT_TIME Time of transaction
MOD_QUERY Model file query
REF_QUERY Reference file query
VOLUME Volume definition file name
Information AREAS Plant area names
associated
with the CONTROL Control
Check-in DESCRIPTION User-entered description
Operation CHECKIN_COUNT Number of check-ins

2-8 MCS Guide March 29, 2007


Setting Up and Maintaining Your Project Database
MCS Management Tables

CHECKOUT_HISTORY Table
Information
This table contains a list of the transactions used on components (adding, locking, and
associated
with theupdating) after they have been checked out. The Append command is also included as
an add transaction.
Check-out
Operation
Column Name Comment
CHECKOUT_ID Check-out identification number, the unique
ID assigned to a Check-Out, Update Database,
and Append operation
BAD_CHECKOUT_ID Error ID
TYPE Transaction type
SYS_USERNAME System user name
USER_ID Database user name
NODE_NAME Node name
FILESPEC Name of file
NUM_CHECKOUT Number of components checked-out
CHECKOUT_TIME Time of transaction
CHECKIN_DESCRIPTION Comment
CHECKIN_SYS_USERNAME System user name
CHECKIN_USER_ID Database user name
CHECKIN_NODE_NAME Node name
CHECKIN_TIME Time and date of check-in
NUM_ADD Number of components added
NUM_COPY Number of components copied
NUM_DEL Number of components deleted
NUM_MOD Number of components modified
MOD_QUERY Model file query
REF_QUERY Reference file query
VOLUME Volume definition file name
AREAS Plant area names
CONTROL Control
DESCRIPTION User-entered description
PUB_TIME Time and date

March 29, 2007 MCS Guide 2-9


2 Setting Up and Maintaining Your Project Database
MCS Tables

DBSETUP_INFO Table

This table provides values that can be used to determine how the database was loaded.

Column Name Comment


PRODUCT_VERSION Version number of the Database Setup Tool
DB_VENDOR Vendor name derived from the configuration variable
DBSETUP_DB_VENDOR as defined by the project,
which created and loaded the database

DEL_BUD_CATALOG Table

This table contains a list of all the components that were a part of the database at one
point but were later deleted. This table contains a copy of the data that was stored in
the BUD_CATALOG table before the components were deleted.

Column Name Comment


BUD_ID Component identification number
ROOT_BUD_ID ID of parent component
BUD_TYPE BUD type
BUD_TABLE Storage table name
COMMODITY Commodity (such as PIPE, EQUIP)
VOLUME_ID Plant area name
MOD_ID Model ID
RANGE Component range

HISTORY Table

If you modify a component and check it back into the database rather than deleting it,
an entry is made in the HISTORY table to indicate any label or graphic-related changes.
If you change the label, the label attribute and old values are stored in the HISTORY
table with the session ID (UPDATE_ID column in this table) of the MCS operation.

Column Name Comment


BUD_ID Component ID
ATTR_NAME Attribute that was modified
PREV_VALUE Attribute’s value before modification
UPDATE_ID Check-out ID of the DGN where the attribute was modified

2-10 MCS Guide March 29, 2007


Setting Up and Maintaining Your Project Database
MCS Management Tables

LEVEL_MAP table

This table contains a mapping of level names and unique IDs that are used to restore
levels of components when they are checked out.

Column Name Comment


LEVEL_ID Unique ID generated from the LEVEL_ID sequence
LEVEL_NAME Level name of the component

LEVEL_MAP_ACCESS table

This table controls the access to the LEVEL_MAP table.

Column Name Comment


CHECKOUT_ID Check-out ID of a DGN being checked in, or the
generated unique ID of a DGN that is appended
TABLE_NAME The value in the LEVEL_MAP table

MODULES Table

This table controls the way that a commodity is handled in MCS. You can set the
descriptive name (ALIAS) of the commodity displayed in the MCS dialog boxes, and
whether the commodity is model based or file based. Shared cell instance and tag
elements require definitions. When MCS uses a file-based commodity, it writes these
definitions to the primary file being checked out. MCS does not write the definitions to
a reference file or snapshot file. Therefore, the definitions should be in the seed file
defined by MS_DESIGNSEED, in the directories defined by MS_SEEDFILES.

Column Name Comment


MODULE Discipline or commodity. MODULE matches the database
column in the CLASSES table
Example: PIPE
GRANULARITY How components in the module are checked out:
• C = component based
• M = model based (file based)
• 0 = cannot be locked
Note: The GRANULARITY column in the MODULES table must
be set to 0 (zero - same as HGR/HGRPT). Then Append and Update
Database operations will delete items with the same filename (in the
MOD_ID column) and then re-add the items from the file.

March 29, 2007 MCS Guide 2-11


2 Setting Up and Maintaining Your Project Database
MCS Tables

Column Name Comment


SAVEDGNELMS Name of table for non-components to be stored in
Example: PIPE_DGN_ELEMS
ALIAS Descriptive name for the commodity (visible to the user)
Example: Piping

PROBLEM_LOG Table

✍ This table is currently not being used.


This table contains a log of problems encountered during the operation of MCS.

Column Name Comment


ACTION MCS operation such as Append, Check-out, Check-in, and so on
PROBLEM_ID Problem ID
CHECKOUT_ID Check-out ID
PROBLEM Problem ID
BUD_ID Component ID
BUD_TABLE Storage table name
BUD_TYPE BUD type
COMMODITY Commodity (such as PIPE, EQUIP)
DESCRIPTION Description of the problem

PROJECT_CONFIG Table

This table contains the global settings of the project, including the units.

Column Name Comment


PROPERTY Property name
PROP_VAL Property value
APPLIC Application

PROJECT_VOLUMES Table

This table contains the set of master volumes.

Column Name Comment


AREA Plant area name
MINX Minimum X coordinate
MINY Minimum Y coordinate

2-12 MCS Guide March 29, 2007


Setting Up and Maintaining Your Project Database
MCS Sequence Tables

Column Name Comment


MINZ Minimum Z coordinate
MAXX Maximum X coordinate
MAXY Maximum Y coordinate
MAXZ Maximum Z coordinate
TYPE Volume type
DESCRIPTION Comment

SITE_CONFIG Table

This table contains information on sites.

Column Name Comment


SITE_ID Site identification number
SITE_NAME Site name
START_BUD_ID Lowest number for BUD_IDs
END_BUD_ID Highest number for BUD_IDs

STAND_ATTR Table

This table contains a list of standard attributes that are common to all components.
These attributes are added automatically to each <product>_BUD (storage) table and
are primarily related to MicroStation.

Column Name Comment


ATTR_NAME Attribute name
ATTR_TYPE Attribute type
COL_WIDTH Column width
DEC_PLACES Number of decimal places
ACTIVE_FLAG Flag

MCS Sequence Tables


MCS Sequence tables are used to get unique numbers when assigning identification
numbers or sequences for checkout IDs, BUD IDs, and so on. The following tables or
sequences are used in Access, SQL Server, and Oracle:

• BUD_ID_SEQ table or BUD_ID sequence


• CHECKOUT_ID_SEQ table or CHECKOUT_ID sequence
• LEVEL_ID_SEQ table or LEVEL_ID sequence

March 29, 2007 MCS Guide 2-13


2 Setting Up and Maintaining Your Project Database
MCS Tables

• MCS_LOCK_SEQ table or MCS_LOCK_SEQ sequence


• PRBM_ID_SEQ table or PRBM_ID sequence
✍ In Access and SQL Server, the tables are called tables. In Oracle, they are called
sequences, not tables, and do not contain "SEQ" in the table name. Exception:
the table MCS_LOCK_SEQ contains "SEQ" in Oracle, as well as in Access and SQL
Server.

BUD_ID_SEQ Table or BUD_ID Sequence

This table tracks the unique identification number (BUD_ID) assigned to each new
component checked into your project database.

Column Name Comment


CURRVAL Current value or value last assigned
INCR Value by which to increase the next value
NEXTVAL Next value resulting from the increase

CHECKOUT_ID_SEQ Table or CHECKOUT_ID Sequence

This table tracks the identification number assigned during each checkout transaction
performed within MCS.

Column Name Comment


CURRVAL Current value or value last assigned
INCR Value by which to increase the next value
NEXTVAL Next value resulting from the increase

LEVEL_ID_SEQ Table or LEVEL_ID Sequence

This table tracks the identification number assigned for different levels.

Column Name Comment


CURRVAL Current value or value last assigned
INCR Value by which to increase the next value
NEXTVAL Next value resulting from the increase

MCS_LOCK_SEQ Table or MCS_LOCK_SEQ Sequence

This table provides a unique ID to be used as a locking ID while placing locks on


component tables. An MCS checkout session creates one lock ID (provided by this
sequence or table) for each component that it needs to check out, and places the

2-14 MCS Guide March 29, 2007


Setting Up and Maintaining Your Project Database
MCS Access Control Tables

record in the BUD_TABLE_ACCESS table. (The ID from this sequence table goes to
column SEQ_NUM.).

Column Name Comment


CURRVAL Current value or value last assigned
INCR Value by which to increase the next value
NEXTVAL Next value resulting from the increase

PRBM_ID_SEQ Table or PRBM_ID Sequence

This table contains the next available unique ID to assign to a problem.

Column Name Comment


CURRVAL Current value or value last assigned
INCR Value by which to increase the next value
NEXTVAL Next value resulting from the increase

MCS Access Control Tables


The following tables are used to define permissions for users to access the disciplines
or commodities in TriForma applications:

• GROUP_CODE table
• GROUP_USAGE table
• USERS table
• ROLE_STATUS table
• STATUS_TRANSITION table
✍ For details on how these tables are used, see “Configuring Access Control”.

GROUP_CODE Table

This table is in the users.dat file in your ...\ProjectName\dbload\data directory. It


defines the commodity codes used in the GROUP_USAGE table that users are to be
restricted from accessing.

Column Name Comment


COMMODITY Commodity name
Example: PIPE
CODE Code for the commodity
Example: P

March 29, 2007 MCS Guide 2-15


GROUP_USAGE Table

This table is in the users.dat file in your ...\ProjectName\dbload\data directory. It


defines the commodities that are blocked from members of a group.

Column Name Comment


GROUP_ID Group name (from USERS table)
Example: ELEC
BLOCKED List of codes of commodities that members of a group are
restricted from accessing
Example: P
Meaning: Users with the GROUP_ID "ELEC" do not have
permissions for PIPE because "P" is the code for PIPE as defined
in the GROUP_CODE table.

USERS Table

This table is in the users.dat file in your ...\ProjectName\dbload\data directory. It


defines the group that a user is in.

Column Name Comment


USER_ID Operating system user name or the configuration variable,
MCS_USERNAME
Example: STANLEY
GROUP_ID Group name
Example: PIPERS
Name Your name (not used by MCS)
ROLE Role name. Different roles have access to specific statuses based
on the ROLE_STATUS table.
SUPER_USER Specifies if a user has access or not to components belonging to
all other users by selecting:
• Y= yes
• N = no

ROLE_STATUS Table

This table is in the users.dat file in your ...\ProjectName\dbload\data directory. Valid


statuses for a user are defined in ROLE_STATUS table. A valid status is an allowed
status for a given role. For example, based on this delivered example table (shown

2-16 MCS Guide March 29, 2007


Setting Up and Maintaining Your Project Database
MCS Connectivity Tables

below), a designer can check out components with the following statuses, STUDY and
PRELIMINARY.

Column Name Comment


ROLE The role of the user based on the person’s responsibilities
Example: DESIGNER, CHECKER, STRESSING, or ISOCOORD
VALID_STATUS The allowed statuses for the user based on his or her role
Example:
• PRELIMINARY
• STUDY
• CHECKED
• IN_STRESS
• IFC
• HOLD
• AS_BUILT

STATUS_TRANSITIONS Table

This table is in the users.dat file in your ...\ProjectName\dbload\data directory. The


STATUS_TRANSITIONS table defines the allowed statuses that component statuses
could be changed to. For example, based on the delivered example table (shown
below), a STUDY status can be changed to PRELIMINARY, and a PRELIMINARY status
can be changed to CHECKED.

FROM_STATUS TO_STATUS
STUDY PRELIMINARY
PRELIMINARY CHECKED
CHECKED IN_STRESS
IN_STRESS IFC
IFC HOLD
HOLD AS_BUILT

MCS Connectivity Tables


The following tables are used in piping connectivity processing.

✍ For details on how these tables are used, see “Configuring Connectivity Processing”.

BRANCH_CONN Table

The BRANCH_CONN table is in connectivity.dat in your ...\ProjectName\dbload


\data\core directory. This table maintains connectivity information for piping
components, as shown in the following sample.

March 29, 2007 MCS Guide 2-17


2 Setting Up and Maintaining Your Project Database
MCS Tables

✍ This sample does not display all of the rows and columns.

✍ The BUD_ID column is a foreign key and references the BUD_ID column of the
PIPE_BUD table.
This matching column means that this table is designed to have rows in
synchronization with the PIPE_BUD parent table. In other words, if a row is deleted
from PIPE_BUD, that action should automatically delete the corresponding row from
the BRANCH_CONN table. Additionally, the BRANCH_CONN table cannot contain a
row that does not exist in the PIPE_BUD table. Columns CONN_1, CONN_2, and so
on, can have "0"s or blanks to indicate no connection.

Other columns that are used by MCS are:

Column Name Description


SNAP_POINTS The snap points of components used to find connections.
NUM_SNAP_POINTS The number of snap points for a component
NUM_CONN_FOUND The total number of columns found at the end of
connectivity processing. Ideally it should be the same as the
number of connection columns (CONN_1, CONN_2, and so
on) populated with non-zero values for the component. In
other words, if a component is connected on CONN_1 and
CONN_2 with two other components, then
NUM_CONN_FOUND should be 2. However, if there are
duplicate and/or superimposed components, then this
column can contain a higher number and MCS may issue a
warning message to that effect. Also, in the case of
superimposed components, the behavior of connectivity
processing is undefined as it may pick up the first found
connections first. In other words, if 5 simple pipes are
superimposed, then for one of the pipes there are 10
connections available whereas only 2 connection columns
(CONN_1, CONN_2) will be populated for that pipe.

2-18 MCS Guide March 29, 2007


Setting Up and Maintaining Your Project Database
MCS Connectivity Tables

OPERATION_STATE Table

The OPERATION_STATE table is in connectivity.dat in your ...\ProjectName\dbload


\data\core directory. This table is the place where MCS places a record at the start of
the connectivity update operation

After the successful completion of connectivity synchronization, this record is removed.


MCS also places a record in this table when the administrator defines the
MCS_CONNECTIVITY_IGNORE configuration variable. For details, see “To bypass connectivity
checking”.

W The existence of any records in this table alarms MCS to warn the administrator
that the BRANCH_CONN table is unusable. For details, see “To fix the
BRANCH_CONN table”.

BRANCH_CONN_ACCESS Table

The BRANCH_CONN_ACCESS table is in connectivity.dat in your


...\ProjectName\dbload\data\core directory. This table is used to lock access to
BRANCH_CONN while a connectivity synchronization is going on so that any other
simultaneous synchronizations by other users do not corrupt the data.

The lock is removed when the synchronization operation ends. The locking-unlocking
mechanism is hidden from users. However, if the connectivity synchronization fails, the
administrator may need to manually delete any records from the
BRANCH_CONN_ACCESS table.

For example, if the Check-in, Update, or Append operation associated with above ID
(65780) fails, then the entry is not cleared from the BRANCH_CONN_ACCESS table.
This result causes any further connectivity update to wait in an infinite loop with a
warning (progress bar):

March 29, 2007 MCS Guide 2-19


2 Setting Up and Maintaining Your Project Database
Procedures for Setting Up and Maintaining Your Project Database

However, it could also be due to a large update by a user, in which case the entry will
eventually be cleared and the warning will go away automatically. So, if a user finds
that this warning is taking a long time to finish, the administrator should:
1. Get the ID from BRANCH_CONN_ACCESS table
2. Look for the corresponding entry in the CHECKOUT/CHECKOUT_HISTORY table
3. Determine if the entry is a live one and wait until it clears, or if it is a dead entry,
clear it manually.

CONNECTORS Table

The CONNECTORS Table is in connectivity.dat in your ...\ProjectName\dbload


\data\core directory. This table contains BUD_TYPEs of all components that are
considered for connectivity processing.

For example, if a BUD_TYPE is not included in this table and a component of that
BUD_TYPE is connected to a PIPE_PIPE, then that component will not be shown as
connected in the BRANCH_CONN table.

✍ The contents of this table are provided as an example and should be updated to
include all the valid connectors of a project.

Procedures for Setting Up and Maintaining Your Project


Database
W Before you can use the Database Setup tool, you should have created a database and
an ODBC link to that database. If you need to perform these tasks, see Chapter 1.

2-20 MCS Guide March 29, 2007


Setting Up and Maintaining Your Project Database
Starting the Database Setup Tool

The Database Setup Tool is used to populate your project database with MCS tables
and Design Series modeling tables. Setting up and maintaining your project database
involves the following operations:

• Starting the Database Setup tool


• Populating the project database, if necessary
• Creating multiple projects in one Oracle instance
• Repairing a corrupted database
• Restoring deleted components
• Cleaning up the project database
• Adding more sites to your configuration

Starting the Database Setup Tool


➤ To start the Database Setup tool
1. From the Start>Programs menu, locate the PlantSpace Design Series
V8 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
Project dialog box is displayed. After you select a project and click
OK, you can continue.

✍ If the database (that the configurations in the project setup point to)
is empty, then the following message is displayed, which is OK.
(The database may be empty because it has not yet been
populated.)

March 29, 2007 MCS Guide 2-21


The PlantSpace Database Setup window is displayed, as shown in this
example.

The Connect button is grayed out because you are automatically


connected to your project database, indicating that your project points
to a valid data source.

W If the Connect button is not grayed out, you need to check the project setting
because the activated button indicates that a connection to the specified data
source could not be established.

3. To customize settings in the Settings group:

W Generally, you should be customizing your project setup so that you do not need
to change anything in the Database Setup tool. However, regardless of your
project settings, you can customize the values of the settings in the Database
Setup Tool.

a. At the Data Source field, type a new name.


Note: Make sure that the name is identical to the data source name that
you specified on the DSN tab of the ODBC Data Source dialog box in
Control Panel.

2-22 MCS Guide March 29, 2007


Setting Up and Maintaining Your Project Database
Populating an Empty Database

b. Select the vendor and units of measurements.

c. At the Project User and Project Password fields, leave these fields blank or
complete them based on the following:
• If you are using MS Access as your project database, leave these fields blank
because they are not required.
• If you are using Oracle or SQL Server, fill in the project user and project
password according to your system requirements.

✍ The Connect button becomes enabled, which means that you are
not connected to your project database, and you need to follow the
next step to make the connection.
4. Click Connect to connect to the project database.
✍ If an error message is displayed when you click the Connect button,
you must correct the settings and then try again.
If the connection is successful, the Connect button is grayed out and
the rest of the buttons In the PlantSpace Database Setup window
become enabled.
✍ If you are using a SQL Server or Oracle database, continue to the next section to
populate the database.

Populating an Empty Database


W If you connected to the sample PlantSpace database (which is an Access database),
you do not need to populate the database. However, if you connected to Oracle or
SQL Server and you have not populated your project database yet, you must do so.

➤ To populate an empty database


✍ This operation can take up to 45 minutes.
1. In the PlantSpace Database Setup window, type a system user name
and password (if required) in the Database Load/Replace group.
2. Click the Load Database button.
The following warning message is displayed.

March 29, 2007 MCS Guide 2-23


2 Setting Up and Maintaining Your Project Database
Procedures for Setting Up and Maintaining Your Project Database

3. Click OK.
You will also see the following message. The last statement tells you
to ignore this message if you are performing a new installation or
replacement of a partial or damaged previous installation.

4. Click OK to continue the installation process, or Cancel to stop.


If you clicked OK, the system displays the progress of the installation.

W Cancelling the operation may leave the data source in an inconsistent or unusable
state.

2-24 MCS Guide March 29, 2007


Setting Up and Maintaining Your Project Database
Creating Multiple Projects in One Oracle Instance

When installation is complete, the Messages dialog box is displayed


for you to review.

✍ After reviewing the messages, further maintenance operations may


be required. You can save these messages to a file for reference
purposes by clicking the Save As button.
5. To exit the Messages dialog box, click OK.

✍ At this point, if you are using specs (instead of catalog data), continue to the
chapter "Creating and Checking Piping Specifications" in the PlantSpace Design
Series Administrator Guide and create specs.

Creating Multiple Projects in One Oracle Instance


✍ Creating multiple projects in one instance for SQL Server and MS Access is not supported.
By default, creating an Oracle instance, as described in “Preparing to Use Oracle 8i or 9i” on page
1-5, creates the following tablespaces:

• B3D_3DM
• B3D_BEAMS

Tablespaces are a kind of container where you create tables, views, and so on. As you load a
project (explained in “Starting the Database Setup Tool” on page 2-21), tables are created in one of
the two default tablespaces (B3D_3DM and B3D_BEAMS) based on the name specified in the

March 29, 2007 MCS Guide 2-25


2 Setting Up and Maintaining Your Project Database
Procedures for Setting Up and Maintaining Your Project Database

DAT files, which create the tables. The delivered configuration groups the catalog tables under
B3D_3DM and MCS tables under B3D_BEAMS.

For example:

CREATE_TABLE site_config TABLESPACE b3d_beams INDEXSPACE


b3d_beams

Creates the table SITE_CONFIG and any indexes under B3D_BEAMS.

However, if you want to load multiple projects with your own tablespaces, then you should use
the following procedure.

➤ To load multiple projects with your own tablespace


✍ Design Series does not require multiple tablespaces for multiple projects. In other words,
multiple projects can all share the same tablespace(s).
1. Create new tablespaces.
For example, assume that the Proj1 project is user specified in the
PS_CODES_DB configuration variable. If Proj1() needs to load its catalog
tables under tablespaces called PROJ1_CAT and MCS tables under
PROJ1_MCS, then these tablespace should be created.
2. Create tablespaces by using the following SQL statements (which should be
customized to suit a project):
CREATE TABLESPACE PROJ1_CAT DATAFILE 'yourDatFilesPath\
yourDatFilesPath\proj1_cat.dbf' SIZE 2M REUSE DEFAULT STORAGE (
INITIAL 50K NEXT 50K MINEXTENTS 1 MAXEXTENTS 121 PCTINCREASE 1);

ALTER DATABASE DATAFILE ' yourDatFilesPath\proj1_cat.dbf' AUTOEXTEND


ON;

CREATE TABLESPACE PROJ1_MCS DATAFILE 'yourDatFilesPath\


yourDatFilesPath\proj1_mcs.dbf' SIZE 2M REUSE DEFAULT STORAGE (
INITIAL 50K NEXT 50K MINEXTENTS 1 MAXEXTENTS 121 PCTINCREASE 1);

ALTER DATABASE DATAFILE ' yourDatFilesPath\proj1_mcs.dbf' AUTOEXTEND


ON;

3. Modify the following files to replace tablespace names with your project's
tablespace names:
• cfgsite.dat
• cretable.dat
• users.dat
• creusers.sql
• buildstoragetables.scr

2-26 MCS Guide March 29, 2007


Setting Up and Maintaining Your Project Database
Repairing a Corrupted Project Database

For example cfgsite.dat 's existing entry:


CREATE_TABLE site_config TABLESPACE b3d_beams INDEXSPACE b3d_beams

Should be replaced with


CREATE_TABLE site_config TABLESPACE proj1_mcs INDEXSPACE proj1_mcs

✍ Apart from changing all occurrences of B3D_BEAMS with PROJ1_MCS,


you can use any tablespace names for your DAT files as well. The fact that
we are using two tablespace names in this example is also not a requirement.
Instead, you can have one tablespace for all the tables in your project, both
catalog tables as well as MCS tables.
4. After the DAT files have been modified to refer to new tablespaces, use the
Database Setup tool to load the project.

Repairing a Corrupted Project Database


You can reload the project database, which essentially removes the existing contents
and then populates all the tables. However, this operation also removes all contents
from your BUD tables and Spec tables. If you know that the data in these tables is not
damaged, you can save the data. You can save the specs through the Spec Maker
program.

W You should perform this operation with extreme care because it empties all
contents from the BUD tables and Spec tables.

➤ To repair a corrupted project database


✍ If you are starting the Database Setup tool, see steps 2 through 5 of the
procedure, “To start the Database Setup tool”.
1. If you want to save the components you had placed and then checked
into the BUD tables, check them out.
They will automatically be placed in DGN files.
2. In the PlantSpace Database Setup window, type a system user name
and password (if required) in the Database Load/Replace group.
3. Click the Load Database button.

March 29, 2007 MCS Guide 2-27


2 Setting Up and Maintaining Your Project Database
Procedures for Setting Up and Maintaining Your Project Database

The following warning message is displayed.

4. Click OK to replace the contents of the database, or Cancel to cancel


this operation.
If you clicked OK, the system displays the progress of the installation.

W Cancelling the operation may leave the data source in an inconsistent or unusable
state.

2-28 MCS Guide March 29, 2007


Setting Up and Maintaining Your Project Database
Repairing a Corrupted Project Database

When installation is complete, the Messages dialog box is displayed


for you to review.

✍ After reviewing the messages, further maintenance operations may


be required. You can save these messages to a file for reference
purposes by clicking the Save As button.
5. Click OK in the Messages dialog box.
✍ You now need to reload the project specs.
6. Open the project specifications (SPE) file in Spec Maker,
unsynchronize all of the specs, and then resynchronize the spec file
and close Spec Maker.
For the detailed procedures, see the chapter "Creating and Checking
Piping Specifications" in the PlantSpace Design Series Administrator
Guide.
7. In Design Series, append the DGN file (created in step 1) into the
database.
✍ If you need to recall how to append, see the procedure for this
operation in the administrator chapter of the Model Control System
(MCS) Guide.

March 29, 2007 MCS Guide 2-29


2 Setting Up and Maintaining Your Project Database
Procedures for Setting Up and Maintaining Your Project Database

Restoring Deleted Components


During the design process some components may accidentally be deleted. This
situation is usually discovered when a user tries to check out a component and cannot
get it from the database.

Within the project database is a group of tables that store all the deleted components,
as shown in the following section. As the database administrator, you can query these
tables to retrieve the lost data. This feature works in the same way as the Windows
Recycle Bin. Deleted objects are stored there until you empty the bin.

Storage Tables for Deleted Components

When you delete a component, it is not actually deleted from the system. All deleted
component data is stored in the following tables.

Table Name Comment


DEL_BUD_CATALOG Stores all the BUD information of the deleted components
DEL_CNDT_BUD Stores all the graphical information of the deleted conduit
components
DEL_CORE_BUD Stores all the graphical information of the deleted core
components
DEL_EQUIP_BUD Stores all the graphical information of the deleted equipment
components
DEL_HGR_BUD Because of the current interface with SupportModeler, this
table is never populated.
DEL_HGRPT_BUD Because of the current interface with SupportModeler, this
table is never populated.
DEL_HVAC_BUD Stores all the graphical information of the deleted HVAC
components
DEL_ILPIP_BUD Stores all the graphical information of the deleted intelligent
pipe lines
DEL_PIPE_BUD Stores all the graphical information of the deleted pipe
components
DEL_TRAY_BUD Stores all the graphical information of the deleted cable tray
components

➤ To restore a deleted component


1. Get from the user all information about the component, such as the
line number, size, spec, and system.
2. Use this component attribute information to query the
DEL_<PRODUCT>_BUD table that contains that component.

2-30 MCS Guide March 29, 2007


Setting Up and Maintaining Your Project Database
Cleaning Up the Project Database

You will need to search for the BUD IDs that match those attributes.
For example, if the missing component is a tank, you would need to
query the DEL_EQUIP_BUD table.
3. Make a note of the BUD IDs found.
4. Move the component found in the DEL_<PRODUCT>_BUD table to its
corresponding BUD table.
For example, if you queried the DEL_EQUIP_BUD table and found a
tank, you will need to return that tank to the EQUIP_BUD table.
5. If any records in the DEL_BUD_CATALOG table match BUD IDs found
in the DEL_<PRODUCT>_BUD table, move those records from the
DEL_BUD_CATALOG table to the BUD_CATALOG table.

Cleaning Up the Project Database


As a project progresses, components will be deleted because of modifications,
interferences, and so on. As the database administrator, you may find it efficient to
empty the
DEL_*** _BUD table data from time to time. You are not required to clean out these
tables but you should be aware that the
DEL_***_ BUD tables will become quite large as a project progresses. Therefore, it is up
to you to determine when the DEL_***_BUD tables are to be emptied.

Tables That Can Be Emptied

✍ These are the only tables that can be emptied.

Table Name Comment


DEL_BUD_CATALOG Stores all the BUD information of the deleted components
DEL_CNDT_BUD Stores all the graphical information of the deleted conduit
components
DEL_CORE_BUD Stores all the graphical information of the deleted core
components
DEL_EQUIP_BUD Stores all the graphical information of the deleted equipment
components
DEL_HGR_BUD Because of the current interface with SupportModeler, this
table is never populated.
DEL_HGRPT_BUD Because of the current interface with SupportModeler, this
table is never populated.
DEL_HVAC_BUD Stores all the graphical information of the deleted HVAC
components
DEL_ILPIP_BUD Stores all the graphical information of the deleted intelligent
pipe lines

March 29, 2007 MCS Guide 2-31


2 Setting Up and Maintaining Your Project Database
Procedures for Setting Up and Maintaining Your Project Database

Table Name Comment


DEL_PIPE_BUD Stores all the graphical information of the deleted pipe
components
DEL_TRAY_BUD Stores all the graphical information of the deleted cable tray
components

✍ You can clean out the DEL_***_ BUD tables manually or create an SQL script file to do
so. The procedures for cleaning out the tables depend on the database used by the project.

W If you installed Design Series, continue to the Design Series Administrator Guide to
configure the modeling tables that are exclusive to Design Series. See the chapter
"Configuring Your Project Database" on p. 2-1.

Adding More Sites to Your Configuration


The process of adding more sites involves the following stages:

1. Changing the SITE_CONFIG table to include new sites


2. Changing the PROJECT_CONFIG table to include the site ID for the new
site
3. Generating unique IDs

Each of these stages is detailed in the following sections.

Changing the SITE_CONFIG Table

The Cfgsite.dat file creates the SITE_CONFIG table, which stores information related to the
sites in your project database. The Cfgsite.dat file is in the directory defined by the
PS_DB_LOAD configuration variable.

The SITE_CONFIG table contains one row for each site, and all the SITE_CONFIG tables
must be identical across physically distributed databases. By default, the SITE_CONFIG table is
initialized, as shown:

SITE_ID SITE_NAME START_BUD_ID END_BUD_ID


1 PROJECT_SITE 1 1000000

Changing the PROJECT_CONFIG Table

✍ Global origin is no longer set in the PROJECT_CONFIG table.

2-32 MCS Guide March 29, 2007


Setting Up and Maintaining Your Project Database
Adding More Sites to Your Configuration

To change the site ID, you must modify one of the files in the following table, and load it by
opening the Database Setup tool and clicking the Data File button. The PROJ_CONFIG table is
loaded from one of the following files:

System of Units File Name


Imperial Prjcfg_e.dat
SI (metric) Prjcfg_m.dat

The imperial or System International (SI, formerly metric) file is in the directory defined by the
PS_DB_LOAD configuration variable.

Generating Unique IDs

Various DBMS systems use different mechanisms to generate unique identifiers. To make the
variations in DBMS systems manageable, MCS implements a reliable and consistent mechanism
to generate unique IDs.

✍ In most databases, the sequence is implemented with a table. In in other databases (such as
Oracle), the sequence is implemented with a built-in sequence that has the same name as
the table in the first type of database.
Currently, MCS uses the following identifier (ID) keys in your project database:

✍ For databases that use table names, A = Access, S = SQL Server.


For databases that use sequence names, O = Oracle.

ID Table or Sequence Purpose


BUD_ID BUD_ID_SEQ (A and S) Uses a unique ID to identify a
BUD_ID (O) component created by the MCS server
CHECKOUT_ID CHECKOUT_ID_SEQ (A and S) Identifies a checkout sequence.
CHECKOUT_ID (O) Each MCS operation is associated
with one CHECKOUT_ID
LEVEL_ID LEVEL_ID_SEQ (A and S) Tracks the identification number
LEVEL_ID (O) assigned for different levels
MCS_LOCK MCS_LOCK_SEQ (A and S) Identifies a lock on a component
MCS_LOCK_SEQ (O) table.
An MCS checkout session creates one
lock for each component table that it
needs to access.
PRBM_ID PRBM_ID_SEQ Creates a log of problems identified
PRBM_ID during operation in MCS

The sequence table for each key has three columns:

March 29, 2007 MCS Guide 2-33


2 Setting Up and Maintaining Your Project Database
Procedures for Setting Up and Maintaining Your Project Database

• CURRVAL
• INCR
• NEXTVAL

The next value (NEXTVAL) equals the current value (CURRVAL) plus the increment (INCR).
The INCR value is a default value. The relationship between the variables should always be
NEXTVAL = CURRVAL + INCR.

In a multiple-site distribution system, BUD_IDs and CHECKOUT_IDs must be unique across


the databases. To make them unique, you should set the BUD_ID and CHECKOUT_ID range
when you initialize the project.

Example

You may decide to keep BUD_IDs in the range of 1 to 100000 for site 1, and 100001 to 200000
for site 2. This assumes that 100000 components would be an adequate representation of the
number of components modeled at a given site.

The BUD_ID_SEQ table at site 1 should be displayed as shown:

CURRVAL INCR NEXTVAL


1 1 2

Based on the table at site 1, the BUD_ID_SEQ table at site 2 should be set as shown:

CURRVAL INCR NEXTVAL


100001 1 100002

You can modify the CHECKOUT_ID_SEQ table, much like the BUD_ID_SEQ table, to
allocate ranges for the CHECKOUT_ID sequence.

2-34 MCS Guide March 29, 2007


3 Configuring Access Control

Understanding Access Control


MCS enables project administrators to enforce access controls to check components
into the project database and check them out of the project database. This access
control is configurable and is based on the following:

• Access control tables


• Access control attributes
• Access control configuration variables

Access Control Tables


The following tables (described in detail in Chapter 2) are used to define permissions
for users to access the components in TriForma applications as well as Design Series:

• GROUP_CODE table
• GROUP_USAGE table
• USERS table
• ROLE_STATUS table
• STATUS_TRANSITIONS table

Access Control Attributes


The following attributes are defined in the delivered attrdefn.dat file in your
...\{ProjectName}\dbload\data directory:

• ORIG_DES to track the originator

March 1, 2007 MCS Guide 3-1


3 Configuring Access Control
Understanding Access Control

ORIG_DES is the originator attribute. ENVVAR(USERNAME) is an input


method that evaluates the configuration variable USERNAME (defined by
Windows). In this way, components get the Windows login name
automatically assigned to the originator attribute. This attribute
controls the check-out access.
• D_STATUS to track the status
D_STATUS is the status code attribute. When a component is created
the first time, it gets a default status of STUDY. As the work
progresses, the MCS Change Status tool should be used to change the
status of components. For details, see “Procedure for Using the MCS Change Status
Tool”.
• DB_BUILD to track the database build ID
DB_BUILD is used to validate components before check-in. When a
component is created, it gets the default value 2003, which can be
configured. For component-based commodities, you can modify this
value in the attrdefn.dat file. For TriForma file-based commodities, you
can modify this value in the StatusControl.cfg file.

Access Control Configuration Variables


A sample configuration for all the necessary configuration variables is delivered ready
to use in the StatusControl.cfg file in the ...Program\TriForma\config\appl directory.

✍ If you modify configuration variables, it is strongly suggested that you add


comment lines to document their purpose for future reference.

How Access Control Works


Let us consider user PIPE1_DESIGNER as an example to show how access control
works. User PIPE1_DESIGNER is defined in the USERS table. In the USERS table, we
see that the user PIPE1_DESIGNER belongs to group PIPE and has the role of
DESIGNER.
USERS Table

In the following sections, we will see how permissions for this user are controlled at
the commodity level and component level.

3-2 MCS Guide March 1, 2007


Configuring Access Control
How Access Control Works

Access Control at the Commodity Level

In the GROUP_USAGE table and GROUP_CODE table, we see the corresponding rows
that determine access control at the commodity level. The user's GROUP_ID controls
access at the commodity level.
GROUP_USAGE Table GROUP_CODE Table

As shown in the tables, our user belonging to the PIPE group has permissions for the
PIPE commodity only. (All other commodities are blocked.) That means that user
PIPE1_DESIGNER can perform MCS operations using piping components only.

Access Control at the Component Level

The user's role (DESIGNER) controls access at the component level. Let us see the
corresponding rows in the tables that determine access control at the component level.
In the ROLE_STATUS table, we see that our user with the role DESIGNER has the
following valid statuses: STUDY and PRELIMINARY. In this example, these are valid
check-out statuses.

ROLE_STATUS Table STATUS_TRANSITIONS Table

In the STATUS_TRANSITIONS table, we see that a component with the status STUDY
can be changed to the status PRELIMINARY and similarly, a component with the status
PRELIMINARY can be changed to IN_CHECKING. So our user PIPE1_DESIGNER1 who
has the role of DESIGNER has permissions to change the status to PRELIMINARY and
to IN_CHECKING upon checking in a component. This user would then be unable to
check the component out again because only STUDY and PRELIMINARY are valid

March 1, 2007 MCS Guide 3-3


3 Configuring Access Control
Understanding Access Control

statuses for MCS Check-out. Presumably, the STATUS_TRANSITIONS table would have
another row going from IN_CHECKING back to PRELIMINARY in case the checking
process rejects the component.

How Access Control Works in MCS Operations


Check-In, Append, and Update Database Operations

This section applies if users are able to change the status while modeling within
TriForma.

✍ In the delivered project configuration, users cannot change the status through the
Label Edit utility. The only way to change the status of a set of components is by
using the Change Status tool.
If this workflow does not suit your project’s needs, then by setting the appropriate
APP_FLAGS value in the ATTRDEFN table, a user can be allowed to use the Label Edit
utility to change the status, presumably just before the check-in. The disadvantages of
this action are:

• Inconsistency of status codes between each component in a set


• (If you are not using the Change Status tool) the necessity of having
TriForma and MCS installed even if the person who is changing the
status (for example, the checker) does not need the modeling tools

Users can check in and append only those components that have valid check-in
statuses, as previously explained. If the status is not valid, the following message is
displayed:

✍ Valid check-in statuses include a status that is not valid for the Check-Out
operation (status IN_CHECKING is not a valid status for a designer for check-
out).
The idea is that a user can check out a component and then after working on it the
component's status might change. That should not stop the user from checking in the
component as long as the changed status was a valid status as defined in the
STATUS_TRANSITIONS table. However, when the user checks in the modified

3-4 MCS Guide March 1, 2007


Configuring Access Control
How Access Control Works in MCS Operations

component with status changed to IN_CHECKING, this user has no more permission to
work on it as the component moves on to the next step, and a user with another role
(in this case a CHECKER) can work on it. Because the designer will not be able to
check out this component, MCS displays the following confirmation message:

The system can also apply a check-in filter to a user-defined attribute and reject
(meaning archive) all components with a non-valid value for this attribute. For
example in the delivered project, attribute DB_BUILD should have the value 2003 as
defined by configurations:

MCS_USER_VERIFY_ELEMENT_ATTRIB_NAME=DB_BUILD

MCS_USER_VERIFY_ELEMENT_ATTRIB_VAL=2003

In other words, if the component has the attribute DB_BUILD with values other than
2003, then that component will not be checked in. This feature can be used to guard
against checking in unintended components.

Check-Out Operation

Users can check out only those components:

• That belong to them


✍ The attribute ORIG_DES automatically gets the Windows login
name assigned to the components as they are placed and is used to
track the "owner" or "originator" of the components.
For example user PIPE1_DESIGNER can check out only those
components that have ORIG_DES = "PIPE1_DESIGNER".
✍ One exception is that super users can check out components
belonging to other users. For example user PROJ1 as defined in the
USERS table is a super user.
USERS Table

March 1, 2007 MCS Guide 3-5


3 Configuring Access Control
Procedures for Configuring Access Control

• And, that have valid check-out statuses, as previously explained.


For example, user PIPE1_DESIGNER can check out only those
components that have STUDY or PRELIMINARY statuses.

Procedures for Configuring Access Control


Configuring access control is a two-part operation, at the commodity level and
component level. Then you activate the access controls.

➤ To configure access control at the commodity level


1. Edit users.dat in your ...\{ProjectName}\dbload\data directory.
2. Define groups in the GROUP_USAGE section.
3. Add users to the USERS section and set which group that each user
belongs to.
4. If a new commodity is added to the application that you use and you
want to restrict user access, add the new commodity to the
GROUP_CODE table.
5. Save and close the file.
6. Load the file into your database by using the Database Setup tool.

➤ To configure access control at the component level


1. Edit users.dat in your ...\{ProjectName}\dbload\data directory.
2. Modify the USERS, ROLE_STATUS, and STATUS_TRANSITIONS tables
to suit your project needs.
3. Save and close the file.
4. Load the file into your database by using the Database Setup tool.

➤ To activate the access controls


✍ In the delivered project configuration, users by default have access to all
commodities and all components. You need to activate the access controls by
following this procedure.
1. Edit users.dat in your ...\{ProjectName}\dbload\data directory.
2. Modify the entry for "Default" in the group_usage section as explained
in this DAT file.
3. Save and close the file.
4. Edit StatusControl.cfg in the ...\Program\TriForma\config\appl
directory.

3-6 MCS Guide March 1, 2007


Configuring Access Control
Procedures for Configuring Access Control

5. Enable the definitions of the following configuration variables:


• STATUS_TOOL_STATUS_NAME
• MCS_USER_CHECKOUT_CLAUSE
• MCS_USER_VERIFY_ELEMENT_ATTRIB_NAME
• MCS_USER_VERIFY_ELEMENT_ATTRIB_VAL
6. Save and close the file.

March 1, 2007 MCS Guide 3-7


3-8 MCS Guide March 1, 2007
4 Configuring Connectivity Processing

Understanding Connectivity Processing


MCS maintains all piping connectivity information in a new table called
BRANCH_CONN. When users check in components, update the database, or append
components, MCS synchronizes the connectivity data automatically.

BRANCH_CONN Table
For example, a sample BRANCH_CONN table looks like this:

This data shows that a component with BUD_ID 3 is connected to BUD_ID 2 on its
second snap point. Similarly, a component with BUD_ID 2 is connected to a
component with BUD_ID 3 on its second snap point. The component with BUD_ID 1
is not connected to any other component.

✍ The delivered BRANCH_CONN table uses the BUD_ID for efficiency because this
is a primary field that links other tables in your project database. A simple SQL
query can be used to get the line numbers or other information corresponding to
the BUD_IDs.

November 15, 2006 MCS Guide 4-1


4 Configuring Connectivity Processing
Procedures for Configuring Connectivity Processing

When users perform the standard MCS operations, the connectivity data in the
BRANCH_CONN table will be updated automatically. Therefore, no user procedures
apply to this feature.

Procedures for Configuring Connectivity Processing


✍ The MCS connectivity tables are described in Chapter 2.

Preliminary Setup for the Incremental Synchronization of


Pipeline Connectivity

W This tool assumes that no components are currently checked into the Model
Control System. If you have piping components checked in, you must follow the
next procedure to remove them.

➤ To remove all piping components from the database


1. In MCS, create a model snapshot file of all the piping components in
your database.

W Make sure you get all of the piping components.

2. Check out all the piping components in the database.


3. Delete all the piping components in the checked out file.
4. Check the file into MCS.
Now, no piping components should be left in the database.

Appending Your Existing Components


After you finish this setup, you need to repopulate the database with your existing
components stored in your model snapshot file.

➤ To append your model snapshot file


1. Open MCS and access your model snapshot file (mentioned in step 1
of the previous procedure).
2. Append the piping data.

4-2 MCS Guide November 15, 2006


Configuring Connectivity Processing
Bypassing Connectivity Checking

W If you see error messages in the following text window, chances are that all piping
components were not deleted in the previous procedure.

✍ At the end of this process, the BRANCH_CONN table should have been
populated with connectivity information for all the existing piping components.

Bypassing Connectivity Checking


Because connectivity checking can be time-consuming for users depending upon the
number of components in the file and in the database, the administrator can define the
MCS_CONNECTIVITY_IGNORE configuration variable to bypass this process.

W Bypassing connectivity checking is not recommended because when you do this, the
data in your BRANCH_CONN table is not up to date. You then need to fix this
table using MCS, as explained in the next topic after this procedure.

➤ To bypass connectivity checking


1. Open projvars.cfg in your ...\{ProjectName}\project directory and
define the following configuration variable:
MCS_CONNECTIVITY_IGNORE=1

2. Save and close the file.


3. Run MCS and perform a Check-in, Append, or Update operation.
MCS displays a message that this action will make the
BRANCH_CONN table unusable.

MCS places a record in the OPERATION_STATE table for the current


CHECKOUT_ID.

November 15, 2006 MCS Guide 4-3


4 Configuring Connectivity Processing
Procedures for Configuring Connectivity Processing

The contents of this table alert MCS if the BRANCH_CONN table is


usable or not. BRANCH_CONN remains unusable as long as this entry
remains. For example, if you try a Check-in operation after the
MCS_CONNECTIVITY_IGNORE configuration variable is removed, the
following message is displayed:

✍ See the next section to find out how to fix the BRANCH_CONN table.

Fixing the BRANCH_CONN Table

W The connectivity processing has been optimized for incremental synchronization of


the BRANCH_CONN table. However, processing of all the existing components
in the database (by setting
MCS_CONNECTIVITY_FIX_CONNECTION_TABLE) will be considerably
less efficient and may take a long time (and a large amount of memory) to finish
depending upon the number of components in the database. Preferably this should
be done on a high-end workstation with sufficient RAM and virtual memory.

Even though incremental-synchronizations should be less resource demanding, it is still


suggested that virtual memory be increased to the order of at least 2 GB with a
moderately good amount of RAM.

The BRANCH_CONN table data can become unusable due to one of the following
reasons:

• A user runs the MCS Check-in and Update operations with


MCS_CONNECTIVITY_IGNORE=1 (explained in the section Bypassing
Connectivity Checking).
• The connectivity synchronization fails, or is cancelled or killed.

➤ To fix the BRANCH_CONN table


1. Open projvars.cfg, and define the following configuration variable:
MCS_CONNECTIVITY_FIX_CONNECTION_TABLE=1

2. Save and close the file.


3. Run MCS and perform a Check-in, Append, or Update operation.

4-4 MCS Guide November 15, 2006


Configuring Connectivity Processing
Maintaining Connectivity Information

The following warning message is displayed.

MCS then performs complete connectivity processing.

Maintaining Connectivity Information


The BRANCH_CONN table contains one row for each row in the PIPE_BUD table.

W You should perform periodic checks to verify that the data is consistent between
these two tables.

November 15, 2006 MCS Guide 4-5


4-6 MCS Guide November 15, 2006
5 Configuring MCS and Related
Programs
MCS includes not only the project database but also related programs:
the Define Volume Utility, Database Setup Tool, MCS Administrator
Database Tool, and MCS Change Status Tool.

This chapter explains how to configure these programs for users.

Understanding the MCS Interface and Programs Related to MCS


Some dialog boxes in the interface in MCS contain fields that are customizable. Currently, you
can customize a check box to enable or prevent users from creating reference files.

✍ See “Procedure for Configuring Fields in Dialog Boxes” on page 5-10.

The following programs are related to MCS and are used to customize MCS:

• Define Volume Utility


• Database Setup Tool
• MCS Administrator Database Tool
• MCS Change Status Tool

Define Volume Utility


The Define Volume Utility enables you (and your users) to define and contain
rectangular areas of a project model and store them in a file called a volume definition
file. This capability enables a project to process portions of the model by the
predefined areas. For example, if an area of the plant is defined for the first floor
turbine building, you can perform piping isometrics, prepare material take off sheets,
design orthographic drawings, and perform 3D design and layout within this area of
the model. For more information about defining volume definition files and associated
areas, see “Creating a New Volume Definition File”.

✍ For details, see “Procedures for Defining Volumes” on page 5-3.

March 1, 2007 MCS Guide 5-1


5 Configuring MCS and Related Programs
Understanding the MCS Interface and Programs Related to MCS

Database Setup Tool


The Database Setup tool is used for maintenance purposes to update the volume table
and build the MCS storage tables.

✍ For the configuration procedures, see “Using the Database Setup Tool to Build MCS Storage
Tables” on page 5-9.

MCS Administrator Database Tool


The MCS Administrator Database Tool program is used to perform administrator or
management tasks. The program is a browser-based tool that consists of an HTML
page, which can reside locally or on a server, enabling you to manage the database
remotely if necessary. These tools enable you to view components checked out by
users, unlock components, add attributes to product BUD tables, and run queries on
your project database.

✍ See “Procedures for Using the MCS Administrator Database Tool to Manage Your Project Database”
on page 5-13.

MCS Change Status Tool


The Change Status tool is a workflow enhancement tool that enables users with the
appropriate permissions to change the status of a set of components. By the same
token, the Change Status tool will prevent users without the appropriate permissions
from changing the status. Permissions are determined by queries to tables (in the
delivered example) specifying the role of the user, the current status of the
components in the set, and valid status transitions.

These permissions are configurable because they can be specified using SQL
statements in the configuration variables.

This tool uses the query file saved during the MCS Check-out operation to get the set
of components to operate on.

W The Change Status tool does not filter the components based on volumes and areas,
only on the queries for each commodity.

Work State Controls

This enhancement provides work state controls so that when users commit a status
change, they cannot edit the data after the status has been changed. These controls
apply to file-based storage used by TriForma applications, as well as component-based
storage used by PlantSpace Design Series. The controls are in effect at each change in
status in the workflow from one user to the next.

5-2 MCS Guide March 1, 2007


Configuring MCS and Related Programs
Tasks Involved in Configuring MCS and Related MCS Programs

✍ See “Procedures for Configuring the MCS Change Status Tool” on page 5-20.

Tasks Involved in Configuring MCS and Related MCS Programs

W You should perform the following tasks early in your project life cycle when you are
setting up your database:

• “Procedures for Defining Volumes” on page 5-3


• “Using the Database Setup Tool to Build MCS Storage Tables” on page 5-9

✍ You can perform the following tasks as needed anytime throughout the project life cycle:

• “Procedure for Configuring Fields in Dialog Boxes” on page 5-10


• “Procedures for Appending a Design File to Move from File-Based Storage to Component-
Based Storage” on page 5-11
• “Procedures for Using the MCS Administrator Database Tool to Manage Your Project
Database” on page 5-13
• “Procedures for Configuring the MCS Change Status Tool” on page 5-20

Each of these tasks is explained in the following sections.

Procedures for Defining Volumes


TriForma enables you to define and contain rectangular areas of a project model in a
volume definition file. All users can access predefined areas of the model using MCS.

For example, if an area of the plant is defined for the first floor turbine building, you
can perform piping isometrics, prepare material take off sheets, design orthographic
drawings, and perform 3D design and layout within this area of the model. For more
information about defining volume definition files and associated areas, see “Creating a New
Volume Definition File” in the section for users.

Master and Discipline Volume Definition Files

TriForma provides two types of volume definition files:

• Master volume definition file


The master volume definition file contains one or more areas that
define the project model work area. This file is loaded into your
project database during database setup or after database setup.

March 1, 2007 MCS Guide 5-3


5 Configuring MCS and Related Programs
Procedures for Defining Volumes

✍ Because the master volume definition file should be generated only


once, you should add areas to the master volume definition file
before modeling components in those areas.
• Discipline volume definition files
The discipline volume definition files define specific work areas that
the designers frequently access during the project life cycle. These
files are not loaded into the database. Designers can create these
discipline volume definition files and keep them for their own
personal use or share them with other designers. Discipline volume
definition files can also be used to set up and define orthographic
drawing extraction areas.

Tasks Involved in Working with the Master Volume Definition File

Working with the master volume definition file involves the following tasks:

• Creating the master volume definition file


• Loading the master volume definition file into the database
• Adding areas to the master volume definition file

Creating the Master Volume Definition File

Using the master volume definition file, MCS enables you to assign an area to each
component. When you create the areas in the master volume definition file, you must
use the following rules:

• Area boundaries must not overlap.


• All area names must be unique.
• All areas together should form a rectangular cube without any holes.
For example, the volumes shown are properly defined.

5-4 MCS Guide March 1, 2007


Configuring MCS and Related Programs
Procedures for Defining Volumes

Whereas, the volumes shown are not properly defined.

Usually someone familiar with the plant site assists in creating the master volume
definition file.

W After the master volume definition file is created, it must be loaded into the
database.

✍ The master volume definition file and the discipline volume definition files are created the
same way. For the procedure on creating a volume definition file, see “Creating a New
Volume Definition File” in the section for users.

Loading the Master Volume Definition File into the Database

To enable users to check in and check out project components through MCS, you must
load the master volume definition file into your project database by using the Database
Setup tool.

✍ Before you can load the master volume definition file, you must create a project database by
“loading” the project files into it.

➤ To load the master volume definition file into the database


1. From the Windows Start>Programs menu, locate the TriForma
program group and 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
Project dialog box is displayed. The delivered default projects are:
When you select a project and click OK, you can continue.

March 1, 2007 MCS Guide 5-5


5 Configuring MCS and Related Programs
Procedures for Defining Volumes

The PlantSpace Database Setup window is displayed.

✍ The settings for the data source, vendor, units, project user, and
project password are displayed from the default project
configuration. An initialization (INI) file is, therefore, no longer
required. The Connect button is grayed out because you are
connected to the project database.
2. Click the Load Volume File button.
The Load Volume Definitions dialog box is displayed.

3. Type the name of the file containing the master volume definition file,
or click the Browse button to locate the file.
4. Select the Clear Existing check box if it is not already selected.

5-6 MCS Guide March 1, 2007


Configuring MCS and Related Programs
Procedures for Defining Volumes

This command removes the existing master volume definition file


from the database and loads the new or updated one.
5. Click OK.
Status messages are displayed to inform you of progress, and a
successful completion message box is displayed.

Adding Areas to the Master Volume Definition File

Although you can add areas to the master volume definition file at any time during a
project, new areas should be added to the master volume definition file before
modeling components in those areas. The additional areas must follow the same
constraints as described earlier in this chapter.

➤ To add areas to the master volume definition file


1. From the Windows Start>Programs menu, locate the TriForma
program group and click the MicroStation TriForma icon.
2. In the MicroStation Manager dialog box, select a project and a design
file and click OK.

W At the Project field, do not select New to add a new project. This field applies to
MicroStation applications only, not to TriForma applications.
3. From the MicroStation menu bar, choose MCS>Define Volume.
4. Create a new file and define the additional areas.
✍ For the procedure on creating a volume definition file, see “Creating a New
Volume Definition File” in the section for users.
5. In the TriForma program group, click the Database Setup icon.
✍ To refresh your memory, “From the Windows Start>Programs menu, locate the
TriForma program group and click the Database Setup icon.”
6. In the Database Setup window, click the Volume File button.

March 1, 2007 MCS Guide 5-7


5 Configuring MCS and Related Programs
Procedures for Defining Volumes

The Load Volume Definitions dialog box is displayed.

7. Type the name of the master volume definition file, or click the
Browse button to locate the file.
8. Deselect the Clear Existing check box.

W The Clear Existing check box should be deselected to retain the existing volume
definition files in the database while you add the new areas.
9. Click OK.
• If the volumes are overlapping and the load is not successful, a warning
message is displayed:

W Overlapping volumes will not work properly with MCS.

5-8 MCS Guide March 1, 2007


Configuring MCS and Related Programs
Using the Database Setup Tool to Build MCS Storage Tables

You can click Yes to load volume definitions into the table, or
click No to cancel the operation.
• If volumes overlap and you click NO, the following message is displayed.

• If the load is successful, the system displays a message indicating that the
table was successfully loaded.

10. Click OK in the success message.

Using the Database Setup Tool to Build MCS Storage Tables

W You must build the MCS storage tables before using MCS.

Building MCS Storage Tables

W If any changes were made to the component attribute definitions, you must build
the MCS storage tables before implementing MCS. The MCS storage tables are
<product>_BUD tables and DEL_<product>_BUD tables. If any modeled
components have been stored in MCS, these tables cannot be rebuilt with this menu
item.

Typically, you must rebuild the MCS storage tables when the component label attribute
definitions, such as contents of the ATTRDEFN table, are changed. The Build Storage
Tables operation in the Database Setup tool creates the set of <product>_BUD and
DEL_<product>_BUD tables, one set of tables for each distinct BUD_TABLE entry in
the CLASSES table. The columns of these storage tables correspond to the attributes as
defined in the STAND_ATTR table and ATTRDEFN table.

March 1, 2007 MCS Guide 5-9


5 Configuring MCS and Related Programs
Procedure for Configuring Fields in Dialog Boxes

➤ To build MCS storage tables

✍ If you are starting the Database Setup tool, see steps 2 through 5 of the procedure, “To start
the Database Setup tool”.

1. In the Database Setup window, click the Build Storage Tables


button.
If the build is successful, the following message is displayed.

2. Click OK.

Procedure for Configuring Fields in Dialog Boxes


Currently, one field can be configured in the MCS Design File Check-out dialog box.

5-10 MCS Guide March 1, 2007


Configuring MCS and Related Programs
Procedures for Appending a Design File to Move from File-Based Storage to Component-

If reference file creationg is needed on your project, you can set a configuration variable so that
the Create check box in the Reference Files group is always enabled. Then, users cannot deselect
it to prevent creating reference files.

The user procedure where this setting pertains is “To check out components” on page 6-19.

➤ To set up permanent reference file creation


1. On the MicroStation menu bar, choose Workspace > Configuration.
2. Double-click the configuration variable
MCS_BLOCK_REFERENCE_ON_CHECKOUT to open the Edit
Configuration Variable dialog box.
3. To permanently enable the creation of reference files, set the value = 0 (zero).
✍ A value of 0 means that the reference files will be created on checkout and
this check box will be grayed out so that it cannot be deselected.
A value of 1 means that the reference files will not be created on checkout.
If no value is defined, users can select or deselect the Create check box as
they want.
4. Click OK to save the setting.

ProceduresforAppendingaDesignFiletoMovefromFile-Based
Storage to Component-Based Storage
As your project grows, the Append tool enables you to move from a file-based storage system to
a component-based storage system. The Append operation adds your TriForma components
(stored in MicroStation design files) to your project database so that you can manage them with
MCS. The Append operation is also used to add files to MCS that were never checked in before.

Later, you can append or add other design files to your project database. For example,
you can upload a steel file (created from the SDNF import operation) into your project
database to enable MCS to control the use of the file and to provide users with a steel
model for design purposes.

Enabling Users to Perform the Append Operation

W Only you as the administrator or another user under your guidance should use the
Append operation. Appending the same file repeatedly can result in putting
duplicate information into the database. You should also verify that the correct
master volume definition file has been loaded before appending a file.

March 1, 2007 MCS Guide 5-11


5 Configuring MCS and Related Programs
Procedures for Appending a Design File to Move from File-Based Storage to

➤ To enable a user to perform the Append operation

✍ You can define a configuration variable to enable this operation on a temporary or long-
term basis.

1. On the user machine, access the ...\Program\TriForma\config\appl


directory and open the tfmcs.cfg file.
2. Define the following configuration variable:
MCS_ADMIN=1

✍ To enable a user on a temporary basis, you can delete the


configuration variable whenever you want to disable the capability.
3. Save and close the file.

Guidelines for the Append Operation

Be aware of the following guidelines:

• To append a file from a particular application, you do not need to


have that application running. However, you cannot edit the file.
• In the Append operation, you can include components from multiple
disciplines in a single design file.

➤ To append a design file


1. From the Windows Start>Programs menu, locate the TriForma
program group and click the MicroStation TriForma icon.
2. In the MicroStation Manager dialog box, select a project and a design
file and click OK.
3. From the MicroStation menu bar, choose MCS>Append.
The MCS Design File dialog box is displayed. The default file name
displayed is the name of the current design file, as shown in this
example.

5-12 MCS Guide March 1, 2007


Configuring MCS and Related Programs
Procedures for Using the MCS Administrator Database Tool to Manage Your Project

4. If you are using a commodity that can be edited only on a design file
basis (such as Structural for TriForma, HVAC for TriForma, or
Architectural for TriForma), either:
• If you want all of the graphics stored, select the All Graphics check box.
• If you want just the items placed with an application, including the
TriForma EC, leave the check box blank.
5. Perform one of the following operations:
• To append the default file displayed to your project database, click OK.
• To append components from another file to your project database, click
the browse (<-) button, select the file from the Select File dialog box, and
click OK.

Procedures for Using the MCS Administrator Database Tool


to Manage Your Project Database
After you configure your project database to meet your project needs, you will have to
manage the database periodically. Management involves the following operations:

• Accessing the MCS Administrator Database Tool if Internet Explorer is


not your default browser
• Viewing components checked out by users
• Unlocking components
• Adding attributes to product BUD tables
• Running SQL queries

March 1, 2007 MCS Guide 5-13


5 Configuring MCS and Related Programs
Procedures for Using the MCS Administrator Database Tool to Manage Your

✍ Currently, Windows Internet Explorer 4.0 or above is required to use the MCS
Administrator Database Tool program because some of the features used are not
supported in Netscape.

W Before you begin, you should have installed Microsoft Data Access Components
(MDAC) version 2.1 or higher on your machine. It is available on the Internet at:

http://www.microsoft.com/data

Accessing the MCS Administrator Database Tool If Internet


Explorer Is Not Your Default Browser
✍ You can access the Administrator Database Tools program manually or automatically as
explained in the following procedure.

➤ To access the MCS Administrator Database Tools if the Internet Explorer is


not your default browser
1. To manually access the program, open Microsoft Internet Explorer,
type the following command in the address field, and press <Enter>:
...\Bentley\Program\triforma\mdlapps

2. To set up automatic access to the program, locate the


...\Start\Programs\TriForma directory on your hard drive.
✍ In Windows NT, the path is c:\WINNT\Profiles\All Users. In
Windows 98, the path is c:\Windows.

5-14 MCS Guide March 1, 2007


Configuring MCS and Related Programs
Accessing the MCS Administrator Database Tool If Internet Explorer Is Not Your Default

3. Right-click MCS Admin Database Tool to display the popup menu,


as shown, and select Properties.

March 1, 2007 MCS Guide 5-15


5 Configuring MCS and Related Programs
Procedures for Using the MCS Administrator Database Tool to Manage Your

4. Select the Shortcut tab in the MCS Administrator Database Tool


Properties dialog box.

5. At the Target field, place the cursor in front of the path displayed and
type the path to your Internet Explorer executable file (iexplore.exe).
✍ Use quotation marks to avoid an error message for spaces.
For example in Windows NT, your path might be:
“C:\Program Files\Plus!\Microsoft Internet\iexplore.exe”

✍ Be sure to leave a space between the end quotation marks and the
path displayed.
6. Click OK.
The default icon for the program changes to the Internet Explorer
icon.

Viewing Components Checked Out by Users


Being able to view which components are checked out by users enables you to
monitor what is going on in your project and to provide other users the name of the
user who checked out a particular component that they need to work with.

5-16 MCS Guide March 1, 2007


Configuring MCS and Related Programs
Viewing Components Checked Out by Users

➤ To view components checked out by users


1. Locate the MicroStation TriForma program group on the Windows
Start>Programs menu and click the MCS Administrator Database
Tool icon.
The Internet Explorer automatically runs and the Remote MCS Admin
Page is displayed.

March 1, 2007 MCS Guide 5-17


5 Configuring MCS and Related Programs
Procedures for Using the MCS Administrator Database Tool to Manage Your

2. To log in, type or select options for the following fields:

Field Description
Data Source The name of the data source for your project database
Database The database vendor (Access, Oracle or SQL Server)
User ID Your login ID for this data source
Password Your password if required for the user ID

3. To view checked out information, click the CheckoutInfo button.


The Results text box displays checked out, related information (such
as who has checked out which components with what Checkout_ID).
This information comes from the CHECKOUT table.

Unlocking Components
If a user has checked out a file and is not available to check it in, you can unlock the
file so that other users can check out the components that they had in the file.

➤ To unlock components
1. If the checked out information is not already displayed, follow the
steps in the previous procedure to display it.
2. Select the checkout_ID, which needs to be cleared from the drop-
down list.
3. Click the Clear Checkout button.

W Use caution because this operation cannot be undone.


This will clear all the checked out information associated with the
selected CHECKOUT_ID. (Internally it clears the corresponding row
from the CHECKOUT table and clears the CHECKOUT_ID column
from all the BUD tables).

5-18 MCS Guide March 1, 2007


Configuring MCS and Related Programs
Adding Attributes to Product_BUD Tables

Adding Attributes to Product_BUD Tables


✍ This operation is used only in the following situation.

An attribute has been added to the ATTRDEFN table in the database after the
components were checked into the database. No column exists in the product BUD
table for that attribute. The MCS Administrator Database Tool adds a column to the
product BUD table to accommodate the new attribute.

➤ To add attributes to BUD tables


1. Log into your project database if you have not already done so.
2. In the Insert Attribute into BUD Table group, type or select
information in the following fields:

Field Description
Name The name of the new attribute, which will become the column
name in the BUD table
Data Type The data type such as text, character, or number
Precision The column layout in the BUD table, as follows using Oracle as
an example:
• If the Data Type field is set to CHAR, the precision is the number
of characters needed for the attribute name (for example, 10).
• If the Data Type field is set to NUMBER, the precision is the total
number of digits in the number, a comma(,) for the decimal
point, and the number of digits after the decimal point. (For
example, 3,2 would mean n.nn or the total number digits is 3, of
which 2 follow the decimal point.)
Note: The Precision setting is required only for certain data
types such as CHAR or NUMBER.
Commodity The name of the BUD table for the commodity (such as
PIPE_BUD or STEEL_BUD) where the attribute will be added

3. Click the Insert button.


The program adds a new column to the associated product BUD table
and DEL_BUD table.

Running Queries on Your Project Database


You may find it necessary to query your project database for various reasons. For
example, if a user checks in a component and then cannot find it, you could run a
query to locate it. If the component was accidentally deleted, the program would
locate it in a DEL_BUD table. Other examples are to find out what the project setup is,
or what components are checked into a particular BUD table.

March 1, 2007 MCS Guide 5-19


5 Configuring MCS and Related Programs
Procedures for Configuring the MCS Change Status Tool

➤ To run a query on your project database


1. Log into your project database if you have not already done so.
2. Type the SQL query in the Query edit box.
3. Click the Run Query button.
If the type of query you entered produces results, they are displayed
in the Results edit box. For example, a SELECT query statement will
produce results.

Procedures for Configuring the MCS Change Status Tool


You will need to set up the tables that determine the groups, users, permissions, and
valid statuses.

➤ To configure the STATUS_TRANSITIONS table


1. Edit users.dat in your ...\{ProjectName}\dbload\data directory.
The delivered definitions in this file (together with the SQL queries in
the delivered example) will display the following values to users in
the From and To fields of the Change Status dialog box. Depending
on the permissions set up, the value displayed in the From field will
display a list of valid values for the To field.

5-20 MCS Guide March 1, 2007


Configuring MCS and Related Programs
Procedures for Configuring the MCS Change Status Tool

After this table is loaded into the database, the formatted table will look like
this:

FROM_STATUS TO_STATUS
IN_STUDY IN_PRELIMINARY
IN_PRELIMINARY IN_CHECKING
IN_CHECKING IN_ANALYSIS
IN_ANALYSIS IFC
IFC IN_PROCUREMENT
IN_PROCUREMENT IN_CONSTRUCTION
IN_CONSTRUCTION AS_BUILT

2. Change the definitions of any of the rows to suit your project needs:
• Each row refers to a valid from-to status transition. The first entry in the data
section of the file is the current status or FROM_STATUS (for example,
IN_STUDY). The second entry is the changed status or TO_STATUS (for
example, IN_PRELIMINARY).
✍ You can add more rows of paired status transitions depending on your
project needs. For example, if for IN_STUDY, you want more changed
statuses besides IN_PRELIMINARY, you can add a second row specifying
IN_STUDY and a second new status.
• The delivered example queries this table to obtain all the valid status transitions, but
you can redesign this table and data entries as you want.

W If you use the delivered example, this table should contain all possible status
transitions that you need for your project. This table does not have to have all of
the possible transitions for the ISOCOORD role in the example. The columns
from different tables that will be joined in the SQL queries should have the same
character length (15 in the example).

W If the user is a Super User (set to Y (yes) in the USERS table), the Change Status
tool bypasses the "valid" transitions in this table and allows the Super User to
change the status of the current components even if the current status is not the
same for all the components.
3. Save and close the file.
4. Use the Database Setup tool to load the file into the database.

➤ To configure the ROLE_STATUS and USERS tables


1. Edit users.dat in your ...\{ProjectName}\dbload\data directory.
2. Change any of the fields and values in the ROLE_STATUS section to suit
your project needs.
3. Save and close the file.

March 1, 2007 MCS Guide 5-21


5 Configuring MCS and Related Programs
Procedures for Configuring the MCS Change Status Tool

4. Use the Database Setup tool to load the file into the database.

➤ To configure the status change permissions


1. Open StatusControl.cfg in the ...\Program\TriForma\config\appl directory.
2. Edit the code for the following configuration variables.
(The descriptions explaining them are in the file.)
• STATUS_TOOL_STATUS_NAME
• STATUS_TOOL_FROM_STATUSES
• STATUS_TOOL_PRIVILEGED_USER
• STATUS_TOOL_TO_ALLLOWED_STATUSES
• STATUS_TOOL_LOG
• STATUS_TOOL_DEBUG
The Change Status tool looks for query files that are stored in the directory
specified by the configuration variable:
PS_PROJ_MCS_QUERY= $(PSPROJ)qry
3. Save and close the file.

5-22 MCS Guide March 1, 2007


Part II: For Users

March 29, 2007MCS Guide


MCS Guide November 15, 2006
6 Using the Model Control System
This chapter explains, from the user’s viewpoint, what the Model Control
System (MCS) is and how to use it and its related programs, the Define
Volume utility and User Database tool.

Understanding the Model Control System


W Before you begin, be sure that your administrator has defined any necessary
configuration variables for MCS explained in Chapter 1 of this Guide. Certain
configuration variables may need to be defined before starting any of the
applications that run on TriForma.
Model Control System (MCS) is a program that stores in a master repository database, the
components that you model. These components include piping, pipe supports, equipment,
raceways, structural, architectural, HVAC, and any other TriForma components.

How MCS Uses Your Project Database


Depending on the application running on TriForma, you can store and extract data from your
project database in one of two modes:

• File-based storage
In file-based storage, MCS stores the DGN file. File-based storage mode is
required for applications that associate components to maintain the
associations between components within a model. You can extract the
components by entering the name of the design file.
• Component-based storage
In component-based storage, MCS stores the components. Component-based
storage mode is allowed for applications where all the components are
independent of one another, allowing for the creation of a model with any
arbitrary set of components.
✍ For details on these two modes of storage, see the chapter "Setting Up and Maintaining Your
Project Database" in this Guide.

March 1, 2007 MCS Guide 6-1


6 Using the Model Control System
Understanding the Model Control System

Features
MCS enables you to:

• Check out model files from storage


• Check in modified models to storage
• Add new models to storage
• Save the state of the settings to reload them at a later time
• Obtain reports on the state of the model
• Update the database
• Update reference files
• Create a read-only model file (called a snapshot)
• View components checked out by other users
• Change the status of components
• Create connectivity information for pipelines

Programs Related to MCS


The following programs are related to MCS:

• Define Volume Utility


• MCS User Database Tool
• MCS Change Status Tool

Define Volume Utility

The Define Volume Utility enables you to define rectangular areas of a project model and store
them in a file called a volume definition file. This capability enables a project to process portions
of the model by the predefined areas. For example, if an area of a plant is defined for the first
floor turbine building, then you can perform piping isometrics, material lists, orthographic
drawings, model access, and so on, on components within this area of the model. The area
coordinates are stored in files referred to as volume definition files. Two types of volume
definition files are used, master and discipline:

• Master Volume Definition File


The master volume definition file contains one or more areas that define the
extent of a project model’s working area. You should generate a master volume
definition file only one time because the master file is loaded into the project
database by the administrator.

6-2 MCS Guide March 1, 2007


Using the Model Control System
Procedures for Working with Volume Definition Files

W The administrator must be notified if the master volume definition file is to be


modified.
• Discipline Volume Definition File
Discipline volume definition files also contain one or more areas that you, as a
designer, can use on a project to define areas that you want to access
frequently. You can create these files and share them with other designers.

MCS User Database Tool

If you need to work with a particular component, the MCS User Database Tool enables you to
view which components are checked out by which users. You can then either contact the user to
see when the component will be checked in, or contact your administrator to unlock the
component if the user is not available to check it in.

MCS Change Status Tool

The Change Status tool is a workflow enhancement tool that enables you (with the appropriate
permissions) to change the status of a set of components. By the same token, the Change Status
tool will also prevent you from changing the status without the appropriate permissions.

✍ This tool uses the query file saved during the MCS Check-out operation to get the set of
components to operate on.

Procedures for Working with Volume Definition Files


Working with volume definition files involves the following operations:

• Creating a new volume definition file


• Adding an area to the file
• Viewing a volume definition file
• Saving a file to a new file name
• Editing an area graphically and in a text editor
• Manipulating areas
✍ If you want a visual overview of the way this program works before you start the
procedures, see “Navigating in the Define Volume Utility” in Appendix A. Included is a
description of the fields and buttons in each dialog box.

March 1, 2007 MCS Guide 6-3


6 Using the Model Control System
Procedures for Working with Volume Definition Files

Creating a New Volume Definition File


The procedure for creating a master volume definition file and a discipline volume definition file
is the same. The file can be either a master or discipline file. When the administrator loads this file
into the project database, it becomes the master file. Any copies of this file become the discipline
files on the designers’ machines.

✍ For details on setting up a master file, see the chapter “Creating the Master Volume Definition
File”.

➤ To create a new volume definition file


1. From the MicroStation menu bar, choose MCS>Define Volume.
The VolEdit dialog box is displayed.

2. Choose File>New from the menu bar, or click the New File tool.
The Create New Volume File dialog box is displayed.

3. Type a file name with a VOL extension, and specify the directory where you
want the file to reside.
4. Click OK.
The new file is opened in the VolEdit dialog box, and the file name is displayed
in the title bar.

6-4 MCS Guide March 1, 2007


Using the Model Control System
Adding an Area to the File

Adding an Area to the File


Once you create a volume definition file, you can then define areas to add to the file.

➤ To add an area
1. With the volume definition file open in the VolEdit dialog box, click the Add
Area tool.
2. Place a data point for the first point in your design file.
3. Define the opposite corner of the area with a data point.
An extension to the VolEdit dialog box is displayed with the coordinates, as
shown in the example.

Extension

4. At the Name field, type a name for the area.


The default name NEW is displayed until you enter an area name.
✍ When you type a name, it must start with a letter and contain only letters,
numbers, or an underscore (_). The maximum length is 12 characters.
5. Choose File>Save from the menu bar or click the Save File tool to save the
new area definition to the volume definition file.
The extension closes.
6. To add another area, repeat steps 2 through 5.
The file remains open until you choose either:
• File>Open to open another volume definition file (which automatically closes the
current file)
• Close from the control bar menu to close the VolEdit dialog box

March 1, 2007 MCS Guide 6-5


6 Using the Model Control System
Procedures for Working with Volume Definition Files

Viewing a Volume Definition File


➤ To view a volume definition file
1. Choose File>Open from the menu bar, or click the Open File tool.
The Open Volume File dialog box is displayed.

2. Select the file and directory, and click OK.


The VolEdit dialog box is redisplayed with the file name in the title bar. Any
areas you defined are displayed in the list box.
3. To view an area, select it.
The area is displayed in the design file.
4. To view the area coordinates, double-click the area.
The extension is displayed with the coordinate values.

Saving a File to a New File Name


You can save a volume definition file to new file name. This operation is useful if you want to save
the master file to another file name as a discipline file.

6-6 MCS Guide March 1, 2007


Using the Model Control System
Editing an Area

➤ To save a file to a new file name


1. With a file open in the VolEdit dialog box, choose File>Save As from the
menu bar or click the Save to New Volume File tool.
The Save To New Volume File dialog box is displayed.

2. To save the file to a new file name, specify the file name and directory.
3. Click OK.

Editing an Area
You can edit an area in two ways:

• Graphically in your design file and the VolEdit dialog box


• In a text editor

March 1, 2007 MCS Guide 6-7


6 Using the Model Control System
Procedures for Working with Volume Definition Files

➤ To edit an area graphically


1. With a file open in the VolEdit dialog box, double-click an area in the list box
that you want to edit.
The extension to the VolEdit dialog box is displayed.

Low Button High Button

2. To change the area name, at the Name field, type the new area name.
3. To type a new coordinate value, at the coordinate field(s), type the new
coordinate in working units.
4. To dynamically redefine the area, check the box next to the coordinate you
want to lock, and click the Low or High button to move the selection.
You can move specific points of the volume to create the size you want.

➤ To edit an area in a text editor


1. With a file open in the VolEdit dialog box, choose File>Edit from the menu
bar or click the Edit File tool.

6-8 MCS Guide March 1, 2007


Using the Model Control System
Editing an Area

The information is displayed in a text editor, such as Notepad as shown in the


example.

Name of the Volume File


Low X Y Z in UORs
High X Y Z in UORs
(UOR = unit of resolution)
Shape of the volume, as in
rectangle in this example

✍ If your configuration is not set up to use a text editor, the following message
is displayed. After you click OK, you will need to follow the next procedure
on selecting a text editor.

2. In the text editor, type the information you want to update.


3. Save the changes and close the text editor to return to the VolEdit dialog box.

March 1, 2007 MCS Guide 6-9


6 Using the Model Control System
Procedures for Working with Volume Definition Files

➤ To select a text editor


1. From the MicroStation menu bar, choose Workspace
>Configuration.
The Configuration dialog box is displayed.

2. Click the New tool.


The New Configuration Variable dialog box is displayed.

3. At the Variable field, type PS_Editor, as shown.


4. At the New Value field, type the name and path of the text editor that you
want to use.
Example: c:\winnt\notepad.exe
5. Click OK.
The Configuration dialog box is redisplayed.
6. Click OK, and choose File>Edit again in the VolEdit dialog box.
7. Type the changes in the text editor.
8. Save the changes and close the text editor to return to the VolEdit dialog box.

6-10 MCS Guide March 1, 2007


Using the Model Control System
Manipulating Areas

Manipulating Areas
Manipulating areas is useful for you, as a designer, because you can use a copy of the master file as
your discipline file and work with only those areas that pertain to your part of the project. The
tool bar in the VolEdit dialog box contains all the manipulation tools. Manipulating areas involves
the following operations:

• Redrawing the views


• Splitting an area
• Fitting an area to the view
• Toggling between two areas
• Joining areas
• Deleting an area
• Moving an area
• Copying an area

(The Add Area operation is not listed here because it was covered earlier in the procedure on
adding an area.)

✍ For the procedures for these operations, make sure you have a volume definition file open
with the areas displayed in the list box.

W You must save the changes (from these operations) to the volume definition file or
they will be lost.

➤ To redraw the views


1. Select one or more areas in the list box.
2. Click the Normal Draw tool.
The system redraws all the views.
3. Click the Save File tool.

➤ To split an area
1. Select an area in the list box.
2. Click the Split Volume tool.
3. Select a corner from which to begin the split by snapping to the point and
accepting it with a data point.

March 1, 2007 MCS Guide 6-11


6 Using the Model Control System
Procedures for Working with Volume Definition Files

The area is highlighted and a cross-hair is displayed, as shown.

4. Move the cursor horizontally or vertically to select a cross section along which
to make the split.
✍ The split cannot be diagonal.
5. Snap to the point, and accept it with a data point.
The area is split into two rectangular areas.
6. Click the Save File tool.

➤ To fit an area to the view


1. Select one area in the list box.
2. To select more than one area, use the following standard Windows operations:
• To select multiple areas that are together, hold down the <Shift> key and select the
areas, or click and drag across the area names.
• To select multiple areas that are apart, hold down the <Ctrl> key and select the
areas.
3. To deselect the selected areas and start again, click the highlighting.
4. Click the Display Clip tool.
The area or areas that you selected are fit to the view.

➤ To toggle between selected and non-selected areas


1. Select one or more areas in the list box.
2. Click the Invert Selection tool.
The selected areas are unhighlighted and the areas that were not selected are
highlighted.

➤ To join areas
1. Select the areas in the list box that you want to join.
2. Click the Join Area tool.
The selected areas merge together and become one area.

6-12 MCS Guide March 1, 2007


Using the Model Control System
Manipulating Areas

3. Click the Save File tool.

➤ To delete an area
1. Select the area in the list box that you want to delete.
2. Click the Delete Area tool.
The area is deleted from the opened file.
3. Click the Save File tool.

➤ To move an area
1. Select the area in the list box that you want to move.
2. Click the Move Area tool.
3. Drag the area to a new position.
4. Click the mouse button to set the position.
5. Click the Save File tool.

➤ To copy an area
1. Select the area in the list box that you want to copy.
2. Click the Copy Area tool.
3. Use the mouse to position the copied area and click the mouse button to set
the position.
An extension to the VolEdit dialog box is displayed.

4. At the Name field, type the name for the copied area over the NEW default
name.

March 1, 2007 MCS Guide 6-13


6 Using the Model Control System
Procedures for Working with MCS and the MCS User Database Tool

5. Click the list box and the copied area is displayed.

6. Click the Save File tool.

Procedures for Working with MCS and the MCS User Database
Tool
✍ If you want a visual overview of the way this program works before you start the
procedures, see “Appendix: Navigating within MCS and Related Programs”. Included is a
description of the fields and buttons in each dialog box.
Working with MCS and the MCS User Database Tool involves the following operations:

• Checking out components or files


• Checking in components or files
• Updating the database
• Updating a reference file
• Taking a model snapshot
• Batch processing the Check-Out and Snapshot operations
• Appending a design file
• Viewing components checked out by other users

Checking Out Components or Files


The Check-out operation on the Model Control menu is used to extract TriForma components
from the master model. You can:

• Extract the components to edit or view them


• Extract into a reference file, the background components (for example, those
that are not selected for the primary file)
✍ These components are read only and cannot be edited.

6-14 MCS Guide March 1, 2007


Using the Model Control System
Checking Out Components or Files

• Select which components to extract by using the label attributes of each


component
• Use a query builder to set up your query statement with ease
• Save your query options to a file
• Load the query file when you need it

Options for Checking Out Components or Files

Before you check out components, you can choose to apply several component coloring options
or not to include volume indicators, or both, in the extracted model file(s).

Using Query Statements to Check Out Components

W Queries can be performed only on component-based storage files, not file-based


storage files.
When requesting a component-based file from MCS, you can use a query statement. Simply, a
query statement tells MCS exactly what you would like in a particular file by identifying certain
attributes from the label.

Query Syntax

The query statement must have the following syntax:

ATTRIBUTE OPERATOR VALUE

where means
ATTRIBUTE A valid attribute name
Note: The valid attributes come from the customizable attribute definitions. The
attribute name is displayed in the list box in the attributes dialog box for the Place,
Edit, and Read operations when the attribute is selected in the list box. The
attribute names are also in the attribute definition files and in the rimref.dat file.
OPERATOR A logical (Boolean) operator:
• EQ = EQUALS
• LT = LESS THAN
• LE = LESS THAN OR EQUAL
• GT = GREATER THAN
• GE = GREATER THAN OR EQUAL
• NE = NOT EQUAL
VALUE A numeric or string value

For example: The query statement

COMPTYPE EQ PELB

March 1, 2007 MCS Guide 6-15


6 Using the Model Control System
Procedures for Working with MCS and the MCS User Database Tool

selects all elements whose label attribute COMPTYPE is equal to the string value PELB. Note that
elements with a COMPTYPE of PELB are piping elbows.

Similarly the query statement

LINENO GT 5

selects all elements whose label attribute LINENO is greater than the numeric value 5.

Combining Query Statements

You can combine query statements by using the Boolean operators, OR and AND, to more
precisely select the elements.

For example: The query statement

COMPTYPE EQ PELB AND LINENO GT 5

selects only elements whose LINENO is greater than 5 among all the elements whose
COMPTYPE equals PELB.

W Remember that as a result of your query, you also affect what other people can
query from the model. Because of this affect, you should keep your query as precise
and small as possible.
One situation where this warning is important occurs in retrieving equipment. The equipment
database contains both mechanical and electrical equipment. Therefore:

• The electrical designer should make a query such as Comptype EQ EEQP


to allow access to the mechanical equipment for the mechanical designer.
• Likewise, the mechanical designer should make a query such as Comptype
EQ MEQP to allow access to the electrical equipment for the electrical
designer.

➤ To set options on checking out components or files


1. From the Windows Start>Programs menu, locate the TriForma program
group and click the MicroStation TriForma icon.
2. In the MicroStation Manager dialog box, select a design file and project, and
click OK.
3. From the MicroStation menu bar, choose MCS>Check out.

6-16 MCS Guide March 1, 2007


Using the Model Control System
Checking Out Components or Files

The MCS Design File Check-out dialog box is displayed.

MCS dynamically creates:


• The primary design file containing the selected components that you checked out of
your project database for write access. These components are locked in the database
so that they cannot be accessed by other users. When you finish modeling, you must
check this design file into the database.
• Reference design files containing all of the other components within the given
volumes that:
-- You did not select with your active design file query or that were already locked
-- Satisfy any reference design file queries specified
4. Choose Options from the menu bar.
The Options menu is displayed. By the default settings, all options are inactive.

March 1, 2007 MCS Guide 6-17


6 Using the Model Control System
Procedures for Working with MCS and the MCS User Database Tool

Selecting an option marks the option as being active, as shown in the option
No Locked Coloring.

You can inactivate an option by selecting it again to remove the marker.


5. Select the No Volume Boxes option to specify that the visual areas
boundaries are not to be included in the reference file.
6. Select the No Checked Out Coloring option to specify that components
extracted to the primary file are to be colored with their standard color, not the
checked-out color.
✍ Your administrator can specify that the checked-out color be different from
the standard color.
7. Select the No Locked Coloring option to specify that components extracted
to the reference file are to be colored with their standard color, not the locked
color.

Guidelines for the Check-out Operation

W Be aware of the following guidelines:


• When you check out an area, what you actually get depends on whether you
are using a file-based storage file or a component-based storage file. Because
you cannot partition a file-based storage file, the volumes do not apply to the
primary file when you check out a file-based storage commodity.
• To check out a file from a particular application, you do not need to have that
application running. However, you cannot edit the file.
• In the Check-out operation, you can include components from multiple
disciplines in a single design file.
• If TriForma commodities are selected for reference, then shared cell
definitions will be missing from the reference files. You may see a warning
message to this effect.

6-18 MCS Guide March 1, 2007


Using the Model Control System
Checking Out Components or Files

➤ To check out components


1. In the MCS Design File Check-out dialog box, leave the Use check box
selected or deselected based on the following information:

• The Use check box is selected by the default setting. When it is selected, the system
assumes that you want to check out an area and will require you to do so when you
try to click OK.
• When the Use check box is deselected, the system assumes that you want to check
out all volumes and areas with your primary file.
• Two read-only check boxes inform users about the area being applied to the
primary file, reference files, or both. In checking out file-based storage commodities
(generic TriForma, ATF, STF, or HTF), the area filters are applied to the reference
files only. This is because these components need only one design file. In creating a
snapshot, the area filters are applied to the primary file as well. Behavior can be
summarized as follows:

Commodity Create reference files Do not create reference files

March 1, 2007 MCS Guide 6-19


6 Using the Model Control System
Procedures for Working with MCS and the MCS User Database Tool

Model based Area filters are applied to The Use (Areas) check box should
(generic TriForma, reference files only. be deselected.
ATF, STF, or HTF)
Component based Area filters are applied to Area filters are applied to primary
both primary files and files only.
reference files.

2. To specify a discipline volume definition file name, type the file name in the
File field of the Areas group or click the browse (<-) button to select a file.
✍ This step is not necessary for the master volume definition file. If the master
volume definition file has been loaded into the database (for use with
component storage), then this file is automatically selected and need not be
specified.
3. To specify one or more areas, either:
• At the Areas field, type the area(s) contained within the master or disciple volume
definition file selected, separated by a space or a comma.
• Click the browse (<-) button and select the areas.
4. In the Primary File group, type a file name or click the browse (<-) button to
select one.
✍ When you check out a primary file, the components are locked to prevent
other users from editing the components that you check out. The
commodities displayed in the list box are the only commodities that you are
allowed to lock based on your user name entered to connect to your project
database (in the MicroStation Connection dialog box).

When you take a snapshot, the components are not locked, which means
that other users can edit them. However, you will not be able to check in any
components that were edited.
If the selected commodity is a file-based commodity, a list of previously
checked-in file names is created. You can select one of these files or type the
name of a new file.
5. In the Primary File list box, select a commodity that you want.
You can select all the commodities in the list box by clicking the All button.
Every commodity that you select is marked with an X. You can also deselect all
of the selected commodities by clicking the None button, leaving all check
boxes blank.
6. To add a query to a commodity to further specify the type of components that
you want, perform the following operations.

W Queries can be performed only on component-based storage, not file-based


storage. You cannot perform queries on some of the commodities because the
capability to check out individual components is not available. You must check

6-20 MCS Guide March 1, 2007


Using the Model Control System
Checking Out Components or Files

out all of the components in the design file. If you select such a commodity, no
query field is displayed for it.

a. Click the space to the right of the commodity.


A query field is displayed with a browse button.
b. Either type the query or use the Query Builder wizard in the next step.
Note: To recall how to set up a query statement, refer to the section “Using Query
Statements to Check Out Components”.
c. To use the Query Builder wizard, click the browse button.
The Query Builder dialog box is displayed.

.
d. To build the query, select an attribute (for example, LINENO) and click the Next
button.
The system builds the query in a text box as shown by the example LINENO in the
next step.
e. Continue by specifying the following parameters and clicking Next:
• An operator

March 1, 2007 MCS Guide 6-21


6 Using the Model Control System
Procedures for Working with MCS and the MCS User Database Tool

• One or more values

• A logical operator (if needed)

f. Click Finish.

6-22 MCS Guide March 1, 2007


Using the Model Control System
Checking Out Components or Files

The finished query is redisplayed next to the commodity.

7. Add queries to other commodities in the primary or reference files list boxes.
8. In the Reference Files group, leave the Create check box selected to create
reference files from the selected files, or deselect it to avoid creating reference
files.
You can select all the commodities in the list box by clicking the All button.
Every commodity that you select is marked with an X. You can also deselect all
of the selected commodities by clicking the None button, leaving all check
boxes blank.
9. At the Comment field, type any details to explain the check-out.
For example, your name, phone number, and purpose for the check-out. The
comments are saved in the HISTORY table for record keeping purposes.
10. Perform one of the following operations:
• Before clicking OK, if you want to save these check-out specifications, go to the
next procedure on saving a query file.
• If you do not want to save the check-out specifications, click OK.

March 1, 2007 MCS Guide 6-23


6 Using the Model Control System
Procedures for Working with MCS and the MCS User Database Tool

Key-in for the Check-Out Operation

As an alternative to using the graphical interface, you can use the following key-in from within
MicroStation to perform the Check-out operation:

MCS START CHECKOUT myqryfile.qry

Where myqryfile.qry is the query file saved from a Check-out operation.

Saving a Query File


The entire Check-out operation can be saved as a query file. Saving a query file is helpful in case
you need to access the same (or similar) components in the future and want to use the same
check-out options, selected or deselected check boxes, selected components, and queries on
commodities.

➤ To save a query file


1. In the MCS Design File Check-out dialog box, choose Queries>Save from
the menu bar.
The Select Query File dialog box is displayed.

2. For a query file, specify the file name with a QRY extension.
3. Specify the directory where you want the file to reside, and click OK.

Loading a Query File


You can load the query file to automatically populate the appropriate fields in the MCS Design
File Check-out dialog box.

6-24 MCS Guide March 1, 2007


Using the Model Control System
Checking In Components or Files

➤ To load a query file


1. From the MicroStation menu bar, choose MCS>Check out.
The MCS Design File Check-out dialog box is displayed.
2. Choose Queries>Load from the menu bar.
The Select Query File dialog box is displayed.

3. Select the directory and query file that you want to load, and click OK.
The query information populates the fields in the MCS Design File Check-out
dialog box.

Checking In Components or Files


You can return newly created or edited model components to the master model in your project
database by using the Check-in Files operation. This operation also enables you to add new
components to the master model from TriForma modeling tools.

Guidelines for the Check-in Operation

W Be aware of the following guidelines:


• To check in a file from a particular application, you do not need to have that
application running. However, you cannot edit the file.
• In the Check-in operation, you can include components from multiple
disciplines in a single design file.
• For generic TriForma, Architecture for TriForma, Structural for TriForma, and
HVAC for TriForma, only entire design files can be checked in, although
components within the design file will be stored and categorized by that
application’s component attributes.

March 1, 2007 MCS Guide 6-25


6 Using the Model Control System
Procedures for Working with MCS and the MCS User Database Tool

• For TriForma file-based storage, any graphics can be checked in as long as they
are in the primary model. To check in graphics, as well as the components, you
can select the "Retain Graphics that are not Forms" check box in the MCS
Design File dialog box.
• Drawing extraction files in TriForma and Structural for TriForma with the
extensions *.d, *.s, *.f, *.r, *.m, and *.e will not be checked in.
• Supplemental files in TriForma and Structural for TriForma with the
extensions *.tfb, *.hst, *.bak, *.log, and so on will not be checked in.
• Although you are encouraged to use sheet models (produced from Design
Series project models in version 8.0 or 8.1), they are treated as temp files in
component-based storage and will not be checked into MCS.
• Although you are encouraged to use Design History, the history file is treated
as a temporary file in component-based storage and will not be checked into
MCS.

➤ To check in design components or files


1. From the MicroStation menu bar, choose MCS>Check in.
The MCS Design File dialog box is displayed. Check-in is the default operation
displayed in the Operation drop-down list box.
✍ You can switch to any of the other operations without having to return to
the Model Control menu.
The default file name displayed is the name of the current design file, as shown
in this example.

2. If you are using a commodity that can be edited only on a design file basis
(such as Structural for TriForma, HVAC for TriForma, or Architectural for
TriForma), either:
• If you want all of the graphics stored, select the Retain Graphics that are not
Forms check box.
• If you want just the items placed with an application, including TriForma, leave the
check box blank.
3. Accept the file name displayed, type a different file name and path, or click the
browse (<-) button to select a file.
4. Click OK.

6-26 MCS Guide March 1, 2007


Using the Model Control System
Updating the Database

W If you are checking in components, MCS displays a warning that sheet model files
will be lost.
✍ If the components (elements) that you are checking in are not compliant
with those in your project database (for example, if they are not TriForma
components), or if you do not have permission to check in all the contents
of a design file, a message is displayed indicating the items that were not
checked in. So that you do not lose your data, the items are saved in a file in
a specified directory (for example, the default {network
drive}\projects\{ProjectName}
\notInAMS directory in Design Series). If you prefer not to save such files,
notify your administrator to remove the definition for the
PS_NOT_CHECKED_IN configuration variable in your application’s
project configuration file (for example, projvars.cfg file for Design Series in
the default directory, {network drive}\Projects).

Updating the Database


You can bring the master model up-to-date with respect to the components in a currently
checked-out design file.

➤ To update the database

W Whenever you perform the Update Database operation in MCS, the Undo buffer in
MicroStation is cleared. This means that you will not be able to undo commands
executed in MicroStation prior to the Update Database operation.
1. From the MicroStation menu bar, choose MCS>Update Database.
The MCS Design File dialog box is displayed. Update Database is the default
operation displayed in the Operation drop-down list box.
✍ You can switch to any of the other operations without having to return to
the Model Control menu.
The default file name displayed is the name of the current design file, as shown
in this example.

March 1, 2007 MCS Guide 6-27


6 Using the Model Control System
Procedures for Working with MCS and the MCS User Database Tool

2. If you are using a commodity that can be edited only on a design file basis
(such as Structural for TriForma, HVAC for TriForma, or Architectural for
TriForma), either:
• If you want all of the graphics stored, select the Retain Graphics that are not
Forms check box.
• If you want just the items placed with an application, including the TriForma EC,
leave the check box blank.
3. Accept the file name displayed, type a different file name and path, or click the
browse (<-) button to select a file.
4. Click OK.

Updating a Reference File


You can bring your reference file up to date with the master model in a currently checked-out
design file.

➤ To update a reference file


1. From the MicroStation menu bar, choose MCS>Update Reference.
The MCS Design File dialog box is displayed. Update Reference is the default
operation displayed in the Operation drop-down list box.
✍ You can switch to any of the other operations without having to return to
the Model Control menu.
The default file name displayed is the name of the current design file, as shown
in this example.

✍ The Retain Graphics that are not Forms check box does not apply in the
Update Reference operation.
2. Accept the file name displayed, type a different file name and path, or click the
browse (<-) button to select a file.
3. Click OK.

6-28 MCS Guide March 1, 2007


Using the Model Control System
Taking a Model Snapshot

Taking a Model Snapshot


The Model Snapshot operation extracts components from the master model database without
checking out or locking components from other users. This feature can be used to review the
status of a project at any given point in time. You can also use it to extract the components from
one project and then modify and append them to a new project as needed. This feature is helpful
when you have similar projects for proposal and estimating purposes.

W Snapshot file creation does not involve commodity check-outs from your project
database. These files cannot be checked in to the model. They are throw-away files
and must be deleted by the user when they are no longer needed.

➤ To take a model snapshot


1. From the MicroStation menu bar, choose MCS>Model Snapshot.
The MCS Design File Snapshot dialog box is displayed.
✍ This is the same dialog box used for the Check-Out operation. However, in
snapshot mode, all commodities are available in both primary files and
reference files. No restrictions apply.
You can select specific options from the Options menu to narrow your search.
See the earlier procedure “To set options on checking out components or files”.

2. Because the procedure for taking a model snapshot is the same for the Check-
Out operation, follow the steps in the procedure “To check out components”.

March 1, 2007 MCS Guide 6-29


6 Using the Model Control System
Procedures for Working with MCS and the MCS User Database Tool

W If TriForma commodities are selected for snapshot, then shared cell definitions
will be missing from the snapshot. You may see a warning message to this effect.
✍ In model snapshot mode, you can use the same additional operations that you use in check-
out mode. For these operations, see “Saving a Query File” and “Loading a Query File”.

Batch Processing MCS Operations


You can process all operations in batch mode in MCS. These processes are run 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 Edit > Notepad from the popup menu displayed.

➤ To batch process MCS operations

W Before you can get data from the database in batch mode, your query criteria should
be saved in the MCS Checkout dialog box. Make sure that your query file works
properly on your design file using this dialog box.
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: Leave no space between the parameter and the path.
-wp The flag for your project name. The delivered default project name
is psdstut.
Note: Leave no space between the parameter and the project name.
file The flag indicated by -i, followed by a capital letter, which the
specification system reads to include the files immediately following the capital
flags 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+filename) in quotation marks (").
2. Using the following table, add each file specification flag consisting of
-i+capital letter+file name (with no spaces), and press <Enter>.
You can add multiple files after the first file by separating each with a space.
See the examples that follow this procedure.

6-30 MCS Guide March 1, 2007


Using the Model Control System
Batch Processing MCS Operations

W You must use these valid file specification flags.

Flag Description
-iQ<query-file> Q to define the name of the query file generated from the MCS
Checkout or Snapshot operation. MCS performs a checkout or
snapshot depending upon the query file. The location for the file
is specified by the configuration variable, {PS_PROJ}qry. The
default location is ...\{ProjectName}\qry.
-iD<database-to-use> D to define the data source (as alternatively defined by the
PS_CODES_DB configuration variable).
Format:"dsn-name;user;password"
-iJ<jsm-file> J to define the name of the JSpace object model file to:
• Import (with -iI explained below)
• Create from the MCS Checkout or Snapshot operation (with -IQ
explained above). The file will be created in the directory
specified by {PS_OUT}.
-iS<script-file> S to define the name of the script file containing additional
criteria (used by C++ applications)
-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}.
-iM<dgn-name> M to define the name of the design file to check in, append, or
use in the update database operation. The design file should be
in directory specified by {PS_OUT}. This flag is used with one
of the Check-in, Append or Update Database commands as
explained below.
-iC C to perform a Check-in on the model name provided by -iM
-iN N to perform an Append on the model name provided by -iM
-iU U to perform an Update Database on the model name provided
by -iM
-iP P to assume as if SupportModeler is active (loaded)

3. To edit the runmcs.bat file, access the ...\Bentley\Program\triforma\mdlapps


directory, right-click runmcs.bat, and select Edit from the popup menu.
4. Change the file names following the capital letters, then save and close the file.

W You must use only the valid capital letters explained in step 2.

March 1, 2007 MCS Guide 6-31


6 Using the Model Control System
Procedures for Working with MCS and the MCS User Database Tool

Examples of Batch Processing

• The following command runs the Checkout or Snapshot operation on the


myquery.qry file.
runmcs -wc"C:\Program
Files\Bentley\Home\psdstut\config\dstutor.cfg"
-wppsdstut -iQmyQuery.qry
• The following command runs the Checkout or Snapshot operation on three
query files.
runmcs -wc"C:\Program
Files\Bentley\Home\psdstut\config\dstutor.cfg"
-wppsdstut -iQq3.qry q4.qry q5.qry
• The following command runs the Checkout or Snapshot operation on the
q2.qry file and creates the new.jsm file from the DGN created by q2.qry.
runmcs -wc"C:\Program
Files\Bentley\Home\psdstut\config\dstutor.cfg"
-wppsdstut -iQq2.qry -iJnew.jsm

Appending a Design File


✍ The Append operation is usually reserved for administrators. However, if your company
allows users to append design files, your administrator can enable the Append operation on
your machine.

Guidelines for the Append Operation

W Be aware of the following guidelines:


• To append a file from a particular application, you do not need to have that
application running. However, you cannot edit the file.
• In the Append operation, you can include components from multiple
disciplines in a single design file.
• If you are appending components, sheet model files are regarded as temporary
files and will not be appended.

➤ To append a design file


1. From the Windows Start>Programs menu, locate the TriForma program
group and click the MicroStation TriForma icon.
2. In the MicroStation Manager dialog box, select a project and a design file and
click OK.
3. From the MicroStation menu bar, choose MCS>Append.

6-32 MCS Guide March 1, 2007


Using the Model Control System
Viewing Components Checked Out by Other Users

The MCS Design File dialog box is displayed. The default file name displayed
is the name of the current design file.

4. If you want all of the graphics stored, select the Retain Graphics that are not
Forms check box.
5. Perform one of the following operations:

W If you are appending components, MCS displays a warning that sheet model files
will be lost.
• To append the default file displayed to your project database, click OK.
• To append components from another file to your project database, click the browse
(<-) button, select the file from the Select File dialog box, and click OK.

Viewing Components Checked Out by Other Users


W This operation works only with component-based storage applications such as
Design Series, not file-based storage applications.
✍ Currently, Windows Internet Explorer 4.0 or above is required to use the MCS User
Database Tool program to view components because some of the features used are not
supported in Netscape.

March 1, 2007 MCS Guide 6-33


6 Using the Model Control System
Procedures for Working with MCS and the MCS User Database Tool

➤ To access the MCS User Database Tool if the Internet Explorer is not your default
browser
✍ You can access the MCS User Database Tool program manually or automatically as follows.
1. To manually access the program, open Microsoft Internet Explorer, type the
following command in the address field, and press <Enter>:
...\Bentley\Program\triforma\mdlapps\admin.htm

✍ If \Bentley is not at the root of your hard drive, use the appropriate path to
this directory.
2. To set up automatic access to the program, locate the
...\Start Menu\Programs\MicroStation TriForma directory on your hard
drive.
✍ In Windows NT, the path is c:\WINNT\Profiles\All Users. In Windows
98, the path is c:\Windows.
3. Right-click MCS User Database Tool to display the popup menu, as shown,
and select Properties.

6-34 MCS Guide March 1, 2007


Using the Model Control System
Viewing Components Checked Out by Other Users

4. Select the Shortcut tab in the MCS User Database Tool Properties dialog box.

5. At the Target field, place the cursor in front of the path displayed and type the
path to your Internet Explorer executable file (iexplore.exe).
✍ Use quotation marks to avoid an error message for spaces.
For example in Windows NT, your path might be:
“C:\Program Files\Plus!\Microsoft Internet\iexplore.exe”

✍ Be sure to leave a space between the end quotation marks and the path
displayed.
6. Click OK.
The default icon for the program changes to the Internet Explorer icon, as
shown.

➤ To view components checked out by other users


1. In the Windows Start>Programs menu, locate the MicroStation TriForma
program group and click the MCS User Database Tool icon.
The Internet Explorer automatically runs and the Remote MCS View Page is

March 1, 2007 MCS Guide 6-35


6 Using the Model Control System
Procedures for Working with MCS and the MCS User Database Tool

displayed.

2. To log in, type or select options for the following fields:

Field Description
Data Source The name of the data source for your project database
User ID Your login ID for this data source
Password Your password if required for the user ID

3. To view checked out information, click the CheckoutInfo button.

6-36 MCS Guide March 1, 2007


Using the Model Control System
Procedure for Using the MCS Change Status Tool

The Results text box displays checked out, related information (such as who
has checked out which components with what Checkout_ID). This
information comes from the CHECKOUT table.

Procedure for Using the MCS Change Status Tool


You can check and change the status of components for use with Model Control System,
Interference Manager, or other applications where the status needs to be checked. You do not
need to have Model Control System or PlantSpace Design Series installed to use this tool.

✍ The Change Status tool does not filter the components based on volumes and areas. It
filters components based on queries saved for each commodity.

➤ To change the status of components

W You need to start with a saved query file. Refer to the section “Saving a Query File”.
1. On the Windows Start > Programs > PlantSpace Design Series V8 XM
Edition menu, select the Status Tool icon.
✍ If you have more than one project, the Select Project dialog box is displayed.
After you select the project and click OK, you can continue.

March 1, 2007 MCS Guide 6-37


6 Using the Model Control System
Procedure for Using the MCS Change Status Tool

The Change Status dialog box is displayed.

2. At the Query File list box, select the appropriate query file.
As soon as a query file is selected, the system checks the components to make
sure that they can be updated. If all checks are successful:
• The From field will contain the current status of the components in the set.
• The To field will be populated with allowable new status values. After you select a
value from the list box in the To field, the Update button will become enabled.
The queries contained in the file are displayed in the Criteria text box.
✍ If any checks fail or a problem occurs with the update, appropriate error
messages will explain what happened. You will have to start this procedure
from step 4 after any problems are corrected.
3. At the To field, select the new status and click the Update button.
4. Perform either step:
• To re-use the same file, re-select the file from the drop-down list box (or press the
F8 key) and continue at step 3.
• To select another query file, select the file in the drop-down list box and continue at
step 3.
✍ If a new query file is created after the Change Status tool is started, you will need to refresh
the Query File field by closing and restarting the tool, clicking the refresh button, or
pressing the F5 function key.

6-38 MCS Guide March 1, 2007


Using the Model Control System
Procedure for Using the MCS Change Status Tool

March 1, 2007 MCS Guide 6-39


6-40 MCS Guide March 1, 2007
Appendix: Navigating within MCS and
Related Programs

The Model Control System (MCS) and Define Volume Utility


This appendix shows the navigation through MCS and related programs and describes
the fields and buttons of each dialog box.

MCS Design File Check-Out Dialog Box

March 29, 2007 MCS Guide A-1


Appendix: Navigating within MCS and Related Programs
The Model Control System (MCS) and Define Volume Utility

MCS Design File Check-Out Dialog Box


The MCS Design File Check-Out dialog box identifies the parameters for the check-out
operation.

Field or Button Description


Use The Use check box is selected by the default setting. When it
is selected, the system assumes that you want to check out an
area and will require you to do so when you try to click OK.
File The volume definition file. This field can be left blank, in
which case the available volumes (or areas) are limited to
those described by the master volume definition file. When
highlighted, the browse button is enabled, and you can select
a volume file name in the dialog box displayed.
Areas A list of area names (separated by a comma or space). These
are used to qualify which components in the master model
are considered for the extracted file(s). The area name(s)
listed must be defined in the volume file named in the File
field (or the master volume definition file if that field is
blank).

A-2 MCS Guide November 15, 2006


Appendix: Navigating within MCS and Related Programs
MCS Design File Check-Out Dialog Box

Field or Button Description


Area Filters Applied Area filters will be applied to the read-only files:
To • Primary File
• Reference Files
Primary File group
(commodities list The name of each commodity, such as “pipe.” You must
box) identify at least one commodity for extraction to the primary
file. Clicking the ALL button in the Primary File group
extracts all components or model files from TriForma
products into the primary file. When you select a file, it is
marked with an “X.” Clicking the NONE button deselects all
entries containing an “X.” If the selected commodity is a file-
based commodity, a list is displayed showing the files
currently checked into the database.
Note: When you check out a primary file, the components
are locked to prevent other users from editing the
components that you check out. The commodities displayed
in the list box are the only commodities that you are allowed
to lock based on your user name entered to connect to your
project database (in the MicroStation Connection dialog box)
(query expression For component-based files only:
field to the right of a When you click the space to the right of a commodity in the
commodity) list box, a query expression field and browse (>) button are
displayed. Clicking the browse button displays the Query
Builder dialog box. See the section Query Builder Dialog Box
for its description. If the Query expression field is left blank,
all the components of that commodity are extracted.
File Name The name used for the extracted primary file. If the file
named already exists, the system notifies you that you will be
overwriting the file. Otherwise, if you do not want to
overwrite the file, you should select a new file name.
Reference Files group
Create The Create check box is selected by the default setting.
• If selected, this option creates a reference file. The components
written to a reference file are always read-only. They are never
locked. Any components that you request for the primary file, but
are already locked by another user will also be placed in the
reference file.
• If deselected, this option does not create a reference file. When
the file type is Design Files, the reference file is attached to the
primary file as a reference.

November 15, 2006 MCS Guide A-3


Appendix: Navigating within MCS and Related Programs
The Model Control System (MCS) and Define Volume Utility

Field or Button Description


(commodities list The name of the commodity, such as STEEL.
box) Clicking the ALL button in the Reference Files group extracts
all components or model files from TriForma products into
the reference file. When you select a file, it is marked with an
“X.” Clicking the NONE button deselects all entries
containing an “X.”
(query expression For component-based files only:
field to the right of a When you click the space to the right of a commodity in the
commodity) list box, a query expression field and browse (>) button are
displayed. Clicking the browse button displays the Query
Builder dialog box. See the section Query Builder Dialog Box
for its description. If the Query expression field is left blank,
all the components of that commodity are extracted.
Comments (Optional) Description of the check-out operation. The
comment is stored with other check-out details and is
normally displayed as part of the show-locks report.

Queries Menu

The Queries menu on the dialog box menu bar enables you to save the current state of
the dialog box settings or load a previously saved state.

Options Menu

The Options menu on the dialog box menu bar enables you to customize specific
features of extracted files.

Selecting an option makes that option active, as shown by the filled in radio button.

Menu Option Description


No Volume Boxes The option to signify that the visual areas boundaries are not to
be included in the secondary file
No Checked Out The option to signify that components extracted to the primary
Coloring file are colored with their standard color, not the checked-out
color
No Locked The option to signify that components extracted to the
Coloring secondary file are colored with their standard color, not the
locked color

A-4 MCS Guide November 15, 2006


Appendix: Navigating within MCS and Related Programs
MCS Design File Check-Out Dialog Box

Open Volume File Dialog Box

When you click the browse (<-) button by the Volume field in the Checkout Model
dialog box, the Open Volume File dialog box is displayed.

Field or Button Description


File name The name of the volume file that you want to use in the
drawing
Files of Type The file type to select. The file typically has a VOL extension.

November 15, 2006 MCS Guide A-5


Appendix: Navigating within MCS and Related Programs
The Model Control System (MCS) and Define Volume Utility

Select Areas Dialog Box

When you click the browse (<-) button by the Areas field in the Checkout Model dialog
box, the Select Areas dialog box is displayed.

Field or Button Description


Available Areas List of areas that you can specify to check out
Selected Areas The areas displayed in the list box that will be used
All Moves all the available areas to the Selected Areas list box
>> Adds selected available areas to the Selected Areas list box
<< Removes selected areas from the Selected Areas list box
None Removes all areas from the Selected Areas list box

Query Builder Dialog Box

✍ This feature can be used only on component-based files.


When you click the browse (<-) button to the right of a commodity in the list box, the
Query Builder dialog box is displayed. A query enables you to further specify the type

A-6 MCS Guide November 15, 2006


Appendix: Navigating within MCS and Related Programs
MCS Design File Check-Out Dialog Box

of information that you want for that commodity. Clicking the Next button displays a
dialog box each for entering an operator, values, and a logical operator.

November 15, 2006 MCS Guide A-7


Appendix: Navigating within MCS and Related Programs
The Model Control System (MCS) and Define Volume Utility

MCS Design File Dialog Box for the Operations:


Checkin
Update Database
Update Reference
Model Snapshot

A-8 MCS Guide November 15, 2006


Appendix: Navigating within MCS and Related Programs
MCS Design File Dialog Box

MCS Design File Dialog Box


When you choose MCS>Check In from the menu bar, the MCS Design File dialog box
is displayed. This dialog box is used to perform the Check-in, Update Database,
Update Reference, and Append operations.

Field or Button Description


Operation The operations to perform, as follows:
• Checkin
The operation for returning a previously checked-out model to
the master model. Any modified components in the design file
replace those previously in the master model. Deleted
components in the design file are deleted in the master model.
The design file and reference file (if used) are deleted from the
user’s directory to prevent reloading of the same file into the
master model.
• Update Database
The operation for bringing the master model up to date with respect to
the components in a currently checked-out model. Any modified
components in a design file replace those previously in the master
model. Deleted components in the design file are removed from the
master mode, and any new components in the design file are added to
the master model. Unlike Check-in, the design file and reference file (if
used) are not deleted from the user’s directory.
• Update Reference
The operation for bringing the reference file up to date with respect to
the components in the master model. Any changes made to the master
model since the reference file was created are seen in the newly created
reference file.
Operation • Append
(continued) The operation is typically for administrators but can be enabled for
users. The Append operation adds your TriForma components (stored
in MicroStation design files) to your project database that you can
manage with MCS. The Append operation also adds TriForma
components from a MicroStation design file to be utilized by MCS. The
Append operation is also used to add files to MCS that were never
checked in before.

November 15, 2006 MCS Guide A-9


Appendix: Navigating within MCS and Related Programs
The Model Control System (MCS) and Define Volume Utility

Field or Button Description


All Graphics • If the All Graphics check box is selected, all of the graphics will be
stored.
• If the All Graphics check box is deselected, only the items placed
with an application, including the TriForma EC, will be stored.
Note: This check box applies only if you are using a commodity that
can be edited only on a design file basis (such as Structural for
TriForma, HVAC for TriForma, or Architectural for TriForma).
File The name of the design file to process. When highlighted, the
Browse button is enabled, and you can select a file name in the
dialog box displayed.

✍ If an error occurs during the execution of any of the Put Files operations, a copy
of the model file is left in a temporary directory. Periodically, you should examine
this directory and delete any files that you no longer need.

MCS Design File Snapshot Dialog Box


The fields are the same as those for the MCS Design File Check-Out dialog box.

A-10 MCS Guide November 15, 2006


Appendix: Navigating within MCS and Related Programs
Navigating in the Define Volume Utility

Navigating in the Define Volume Utility


The following illustration shows you how to navigate within the Define Volume utility
when you choose MCS>Define Volume from the MicroStation menu bar. The sections
that follow describe the fields and buttons.

If no text editor is specified

November 15, 2006 MCS Guide A-11


Appendix: Navigating within MCS and Related Programs
The Model Control System (MCS) and Define Volume Utility

VolEdit Dialog Box


The VolEdit dialog box is used to set up the master and discipline volume definition
files. Each volume definition file contains one or more areas that make up the extent of
the volume definition files.

Button Name Description


New File Creates a new volume definition file

Open File Opens an existing volume definition file

Save File Saves volume definition file or newly added areas to a


current file
Save To New Saves a file to a new volume definition file name
Volume File
Edit File Edits a volume definition file in a text file editor

Normal Draw Redraws the views

Display Clip Fits the view to the highlighted area(s)

Invert Toggles between selected areas


Selection
Join Area Joins two areas

Add Area Add a new area to a volume definition file. For more
information, see the section VolEdit Extension Dialog
Box.
Delete Area Deletes an area

Move Area Moves an area

Copy Area Copies an area. For more information, see the section
Voledit Extension Dialog Box.

A-12 MCS Guide November 15, 2006


Appendix: Navigating within MCS and Related Programs
VolEdit Dialog Box

File Menu

The File Menu contains the same commands as those described in the previous table.

VolEdit Dialog Box Extension

When you click the Add Area or Copy Area button in the VolEdit dialog box, the
following extension box is displayed.

Extension

Field or Button Description


Name The name that you want to give the area
Low X The low horizontal coordinate (along x-axis)
Low Y The low vertical coordinate (along y-axis)
Low Z The low depth coordinate (along z-axis)
High X The high horizontal coordinate (along x-axis)
High Y The high vertical coordinate (along y-axis)
High Z The high depth coordinate (along z-axis)

November 15, 2006 MCS Guide A-13


Appendix: Navigating within MCS and Related Programs
MCS Change Status Tool

MCS Change Status Tool


Clicking the Change Status tool on your desktop, opens the Change Status dialog box to change
the status of components. You can check and change the status of components for use with
Model Control System, Interference Manager, or other applications where the status needs to be
checked.

Field or Button Description


Components group
Query File The query file to use. As soon as a query file is selected from the
drop-down list box, the system checks the components to make
sure that they can be updated. If all checks are successful, you can
continue the operation.
Note: Instead of re-selecting a file that you want to re-use, you can
click the refresh button or press the F5 function key.
Criteria All queries contained in the query file
Status group
From The current status of the components in the set
To Field that will be populated with allowable new status
values
Update (Enabled after you select a value from the list box in the To
field) updates the status of the components in the set

A-14 MCS Guide November 15, 2006


Index

A D
Access database 1-5 D_STATUS configuration variable 3-2
Append Operation Database Instance 1-2
Appending a design file to move from file-based Database Setup Tool 5-2
storage to component-based storage 5-11 Using to Build MCS Storage Tables 5-9
Guidelines 5-12 Database. See Project Database
ATTRDEFN Table 5-9 DB_BUILD configuration variable 3-2
DBSETUP_INFO Table 2-9
Define Volume Utility 5-1
B Navigating in A-1
Batch Processing in MCS 6-30 Understanding 6-2
BRANCH_CONN Table 2-17 DEL_BUD_CATALOG Table 2-9
BRANCH_CONN Table, description of 4-1 DEL_product_BUD Tables 2-6
BRANCH_CONN Table, fixing 4-4 Deleted Components, restoring 2-30
BRANCH_CONN_ACCESS Table 2-18 Discipline files. See Volume Definition Files.
BUD_CATALOG Table 2-7
BUD_ID Sequence 2-13, 2-33
BUD_ID_SEQ Table 2-13, 2-33 E
BUD_TABLE_ACCESS Table 2-7 EQUIP_BUD Table 2-6

C F
Cfgsite.dat file 2-32 File-based storage, moving to component-based stor-
Change Status Tool 5-2 age 5-11
Change Status tool 3-2, 3-4, 5-20, 6-3, 6-37
Change Status Tool, procedure 6-37
CHECK_OUT_ID Sequence 2-14 G
CHECKOUT Table 2-8, 5-18, 6-37 GROUP_CODE Table 2-15
CHECKOUT_HISTORY Table 2-8 GROUP_USAGE Table 2-15
CHECKOUT_ID Sequence 2-33 Guidelines
CHECKOUT_ID_SEQ Table 2-14, 2-33, 2-34 For the Append Operation 6-32
CLASSES Table 5-9 For the Check-in Operation 6-25
CNDT_BUD Table 2-6 For the Check-out Operation 6-18
COMPLENG attribute 2-5
Component-based storage, moving from file-based
storage 5-11 H
Configuration Variables in MCS 1-2 HGR_BUD Table 2-6
CONNECTORS Table 2-19 HGRPT_BUD Table 2-6
CORE_BUD Table 2-6 HISTORY Table 2-10, 6-23
HTF_BUD Table 2-6

March 29, 2007 MCS Guide IN-1


Index

HVAC_BUD Table 2-6 BUD_ID_SEQ Table or BUD_ID Sequence 2-


13
CHECKOUT_ID_SEQ Table or
I CHECKOUT_ID Sequence 2-14
ILPIP_BUD Table 2-6 LEVEL_ID_SEQ Table or LEVEL_ID Se-
quence 2-14
MCS_LOCK_SEQ Table or MCS_LOCK_SEQ
K Sequence 2-14
Key-in for the Check-Out Operation 6-24 PRBM_ID_SEQ Table or PRBM_ID Sequence
2-14
MCS Storage Tables 2-5
L Building 5-9
LEVEL_ID Sequence 2-14, 2-33 CNDT_BUD Table 2-6
LEVEL_ID_SEQ Table 2-14, 2-33 CORE_BUD Table 2-6
LEVEL_MAP Table 2-10 DEL_product_BUD Tables 2-6
LEVEL_MAP_ACCESS Table 2-10 EQUIP_BUD Table 2-6
HGR_BUD Table 2-6
HGRPT_BUD Table 2-6
M HTF_BUD Table 2-6
Master volume definition file HVAC_BUD Table 2-6
Adding volumes 5-7 ILPIP_BUD Table 2-6
Comparing master and discipline files 5-3 PIPE_BUD Table 2-6
Creating 5-4 Product_BUD Tables 2-5
Defining 5-3 STF_BUD Table 2-6
Loading 5-5 TF_BUD Table 2-6
MCS Access Control Tables 2-15 TRAY_BUD Table 2-6
MCS Administrator Database Tool 5-2 MCS User Database Tool 6-3
Accessing the program 5-14 MCS_BLOCK_REFERENCE_ON_CHECKOUT
Unlocking components 5-18 5-11
Viewing components checked out by users 5-16 MCS_LOCK_SEQ Sequence 2-14, 2-33
MCS Connectivity Tables 2-17 MCS_LOCK_SEQ Table 2-14, 2-33
MCS Management Tables 2-6 Model Control System
BUD_CATALOG Table 2-7 Batch processing 6-30
BUD_TABLE_ACCESS Table 2-7 Checking In Components or Files 6-25
CHECKOUT Table 2-8 Checking Out Components or Files 6-14
CHECKOUT_HISTORY Table 2-8 Combining Query Statements 6-16
DBSETUP_INFO Table 2-9 Configuration variables 1-2
DEL_BUD_CATALOG Table 2-9 Features 6-2
HISTORY Table 2-10 How MCS uses your project database 2-1, 6-1
LEVEL_MAP Table 2-10 Loading a Query File 6-24
LEVEL_MAP_ACCESS Table 2-10 navigating in A-1
MODULES Table 2-11 Primary design file 6-17
PROBLEM_LOG Table 2-11 Query Syntax 6-15
PROJECT_CONFIG Table 2-12 Reference design files 6-17
PROJECT_VOLUMES Table 2-12 Requesting a File
SITE_CONFIG Table 2-12 Query statement 6-15
STAND_ATTR Table 2-13 Saving a Query File 6-24
MCS Sequence Tables 2-13 Taking a Model Snapshot 6-29

IN-2 MCS Guide March 1, 2007


Index
O

Understanding the related programs 5-1 To check out components 6-19


Updating a Reference File 6-28 To configure a data source 1-39
Updating the Database 6-27 To configure access control at the commodity
Viewing Components Checked Out by Other Us- level 3-6
ers 6-33 To configure access control at the component
MODULES Table 2-11 level 3-6
To configure the ROLE_STATUS and USERS
tables 5-21
O To configure the status change permissions 5-22
ODBC To configure the STATUS_TRANSITIONS ta-
Drivers 1-2 ble 5-20
OPERATION_STATE Table 2-18 To copy an area 6-13
Oracle To create a new database (SQL Server) 1-22
Creating Multiple Projects in One Oracle In- To create a new login (SQL Server) 1-25
stance 2-25 To create a new volume definition file 6-4
Preparing to use version 8i or 9i 1-5 To create an instance and database (Oracle 8i) 1-7
Process of creating a project database using Ora- To create or modify Listener on the server (Ora-
cle 8i or 9i 1-6 cle 8i) 1-8
ORIG_DES configuration variable 3-1 To creating an Oracle service on clients to access
your project database on the server (Oracle
8i) 1-15
P To define configuration variables for Design Se-
PIPE_BUD Table 2-6 ries 1-3
PlantSpace Database, preparing to use the default 1-4 To define the configuration variables for ATF,
PRBM_ID Sequence 2-14, 2-33 STF, or HTF 1-4
PRBM_ID_SEQ Table 2-14, 2-33 To define the data source for the tutorial Access
PROBLEM_LOG Table 2-11 database 1-5
Procedure for Using the MCS Change Status Tool 6-37 To define the ODBC data source for Oracle or
Procedures SQL Server 1-33
To access the MCS Administrator Database Tool To delete an area 6-13
if the Internet Explorer is not your default To edit an area graphically 6-8
browser 5-14 To edit an area in a text editor 6-8
To access the MCS User Database Tool if the In- To fit an area to the view in a volume definition
ternet Explorer is not your default browser file 6-12
6-34 To fix the BRANCH_CONN table 4-4
To activate the access controls 3-6 To install ODBC drivers for Oracle or SQL Serv-
To add a new user (SQL Server) 1-27 er 1-33
To add an area 6-5 To join areas 6-12
To add areas to the master volume definition file To load a query file 6-25
5-7 To load multiple projects with your own ta-
To add attributes to BUD tables 5-19 blespace 2-26
To append a design file 5-12, 6-32 To load the master volume definition file into the
To append your model snapshot file 4-2 database 5-5
To batch process operations in MCS 6-30 To modify permissions (SQL Server) 1-31
To build MCS storage tables 5-10 To modify permissions for users (SQL Server) 1-
To bypass connectivity checking 4-3 32
To change the status of components 6-37 To move an area 6-13
To check in design components or files 6-26 To populate an empty database 2-23

March 1, 2007 MCS Guide IN-3


Index

To redraw the views in volume definition files 6- Database Setup 1-1


11 Populating an Empty Database 2-23
To remove all piping components from the data- Repairing a Corrupted Project Database 2-27
base 4-2 Restoring Deleted Components 2-30
To repair a corrupted project database 2-27 Running queries 5-19
To restore a deleted component 2-30 Setting Up and Maintaining 2-1–2-34
To run a query on your project database 5-20 Starting Database Setup tool 2-21
To save a file to a new file name 6-7 Storage Tables for Deleted Components 2-30
To save a query file 6-24 Tables That Can Be Emptied 2-31
To select a text editor 6-10 PROJECT_CONFIG Table 2-12, 2-32
To set options on checking out components or PROJECT_VOLUMES Table 2-12
files 6-16
To set up the file for the Oracle database (Oracle
8i or 9i) 1-6 Q
To split an area in a volume definition file 6-11 Query
To start the Database Setup tool 2-21 Running queries on your project database 5-19
To start the server using SQL Server 1-29 Statements to check out components 6-15
To take a model snapshot 6-29 Statements, combining 6-16
To toggle between selected and unselected areas Syntax 6-15
in volume definition files 6-12
To unlock components 5-18
To update a reference file 6-28 R
To update the database 6-27 ROLE_STATUS Table 2-16
To view a volume definition file 6-6
To view components checked out by other users
6-35 S
To view components checked out by users 5-17 Sequences (in Oracle)
To view information about a driver 1-39 BUD_ID 2-13, 2-33
Procedures for Appending a Design File to Move from CHECKOUT_ID 2-14, 2-33
File-Based Storage to Component-Based Storage LEVEL_ID 2-14, 2-33
5-11 MCS_LOCK_SEQ 2-14, 2-33
Procedures for Configuring Connectivity Processing PRBM_ID 2-14, 2-33
4-2 Site ID, changing 2-32
Procedures for Defining Volumes 5-3 SITE_CONFIG Table 2-12, 2-32
Procedures for Preparing to Use Your Project Data- Sites, adding more to your configuration 2-32
base 1-4 SQL Server
Procedures for Setting Up and Maintaining Your Preparing to use 1-22
Project Database 2-20 Process of Creating a Project Database 1-22
Procedures for Using the MCS Administrator Data- STAND_ATTR Table 2-13
base Tool to Manage Your Project Database 5-13 STATUS_TRANSITIONS Table 2-16
Procedures for Working with MCS and the MCS User STF_BUD Table 2-6
Database Tool 6-14
Procedures for Working with Volume Definition Files
6-3
T
Product_BUD Tables 2-5 Tables
Adding attributes 5-19 ATTRDEFN 5-9
Project Database BRANCH_CONN 2-17
Cleaning Up the Project Database 2-31 BRANCH_CONN_ACCESS 2-18

IN-4 MCS Guide March 1, 2007


Index
U

BUD_CATALOG 2-7 TF_BUD Table 2-6


BUD_ID_SEQ 2-13, 2-33 TRAY_BUD Table 2-6
BUD_TABLE_ACCESS 2-7
CHECKOUT 5-18, 6-37
CHECKOUT_HISTORY 2-8 U
CHECKOUT_ID_SEQ 2-14, 2-33, 2-34 Unique IDs, generating 2-33
CLASSES 5-9 Unlocking Components 5-18
CNDT_BUD 2-6 USERS Table 2-16
CONNECTORS 2-19
CORE_BUD 2-6
DBSETUP_INFO 2-9 V
DEL_BUD_CATALOG 2-9 Viewing Components Checked Out by Users 5-16
DEL_product_BUD 2-6 VOL extension 6-4
EQUIP_BUD 2-6 Volume Definition Files
GROUP_CODE 2-15 Adding an Area to the File 6-5
GROUP_USAGE 2-15 Creating a new file 6-4
HECKOUT 2-8 Discipline files 5-4, 6-3
HGR_BUD 2-6 Editing an Area 6-7
HGRPT_BUD 2-6 Manipulating Areas 6-11
HISTORY 2-10, 6-23 Master file 6-2
HTF_BUD 2-6 Saving a File to a New File Name 6-6
HVAC_BUD 2-6 Viewing a Volume Definition File 6-6
ILPIP_BUD 2-6
LEVEL_ID_SEQ 2-14, 2-33
LEVEL_MAP 2-10
LEVEL_MAP_ACCESS 2-10
MCS Access Control 2-15
MCS Connectivity Tables 2-17
MCS Management Tables 2-6
MCS Sequence Tables 2-13
MCS Storage Tables 2-5
MCS_LOCK_SEQ 2-14, 2-33
MODULES 2-11
OPERATION_STATE 2-18
PIPE_BUD 2-6
PRBM_ID_SEQ 2-14, 2-33
PROBLEM_LOG 2-11
Product_BUD 2-5
PROJECT_CONFIG 2-12, 2-32
PROJECT_VOLUMES 2-12
ROLE_STATUS 2-16
SITE_CONFIG 2-12, 2-32
STAND_ATTR Table 2-13
STATUS_TRANSITIONS 2-16
STF_BUD 2-6
TF_BUD 2-6
TRAY_BUD 2-6
USERS 2-16

March 1, 2007 MCS Guide IN-5

You might also like