MicroStation V8
2004 Edition
Administrator Guide
DAA035130-1/0001
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.
Copyrights
©2000-2004 Bentley Systems, Incorporated.
MicroStation ©1998-2004 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.
lcc ©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 international treaties. All rights reserved.
MicroStation Administrator Guide i
ii MicroStation Administrator Guide
Table of Contents
Part I: Workspaces
1. Workspace Fundamentals
Workspace Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1
Setting up the workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–2
Locating the components of the Workspace option menus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3
User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–3
Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4
Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4
Creating your own user interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–5
Selecting workspace components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–5
Sharing an existing MicroStation V8 workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–11
Supplied Sample Workspace Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–12
2. Workspace Configuration
Configuration Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–1
How MicroStation processes configuration variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–2
Start-up. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–2
Determining configuration variable settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–3
Levels of configuration variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–4
Types of configuration variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–4
User Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–5
Project Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–5
Modules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–6
Working with Configuration Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–7
General Procedure — To Modify User-level Configuration Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . 2–7
User configuration variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–12
Using configuration variables in key-ins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–52
User Interface Modification Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–52
User Preference Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–53
Configuration Variable Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–54
The Main Configuration Variable File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–54
Configuration Variable File Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–55
MicroStation Administrator Guide iii
Table of Contents
Variable definition references. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–57
MicroStation-defined variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–58
Preprocessor directives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–59
Debugging Variable Definition Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–60
3. Customizing the User Interface
Tool Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–2
General Procedure — To customize parent tool frames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–2
Rearranging child tool boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–8
Inserting child tool boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–8
Expanding menus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–9
Rearranging tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–9
Inserting tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–10
Modifying tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–13
General Procedure — To modify a tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–13
Pull-Down Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–15
General Procedure — To Customize the Main Menu Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–15
Rearranging menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–16
Modifying menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–18
Inserting menus and menu items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–21
View Control Bars. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–22
General Procedure — To Customize View Control Bars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–23
View Control Pop-up Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–24
User Interface Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–27
AccuDraw Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–28
Function Key Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–30
Capturing MicroStation Screen Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–32
General Procedure — To Capture Part or All of a Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–33
Digitizing Tablet Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–36
Attaching and activating tablet menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–37
Selecting menu items. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–38
Deactivating menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–38
Supplied menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–39
Customizing tablet menus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–39
Action Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–40
Action types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–40
Action type options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–42
Entering multiple action strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–42
iv MicroStation Administrator Guide
Table of Contents
4. V7 File Migration
Options for Saving V8 DGN Files as V7 Design Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–1
Setting Up and Using V7 Workmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–2
Batch Migration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4–3
5. Building Custom Projects
Designing a Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–1
Sample modules delivered with MicroStation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–2
Module design goals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–4
Creation, maintenance, and removal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–4
File duplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–4
DGN Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–4
Assembling Module Data Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–6
Seed Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–6
General Procedure — To create a seed file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–6
Cell Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–7
Using multiple cell libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–7
Dimension-driven Cells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–9
Concepts and terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–9
Important terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–9
Constraints. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–10
Diagnosing an ambiguous dimension-driven cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–11
Equation syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–12
Algebraic expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–13
White space and comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–14
Arithmetic operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–14
Built-in numerical constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–15
Numbers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–15
Variable names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–15
Level Libraries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–57
Color Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–58
Balanced colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–58
General Procedure — To customize a color table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–59
Line Style Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–62
Copying Line Style Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–62
Line style components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–64
Stroke pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–64
Point symbol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–65
Compound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–66
General Procedure — To define a line style. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–67
Working with stroke pattern components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–68
MicroStation Administrator Guide v
Table of Contents
Working with point symbol components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–73
Working with compound components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–77
Technical background . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–80
Dimension Style Libraries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–80
Multi-line Style Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–81
Settings Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–81
Creating settings files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–82
General Procedure — To create a settings group “from scratch” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–84
General Procedure — To define a drawing component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–86
Cell scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–88
Defining multi-line styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–89
Text Style Libraries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–90
Modifying the Project Configuration File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–90
Packaging Module Data Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–92
Part II: Digital Rights Technologies
6. File Protection
What is File Protection?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–1
General Procedure — Protecting a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–1
Author and user distinction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–2
Levels of security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–2
Enabling protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–2
Encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–4
Rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–4
Unlimited rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–5
Authorizing Users and Assigning Rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–5
Authenticating users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–5
Protecting a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–6
Protecting with certificate or password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–7
Creating licenses to authorize users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–11
Obtaining a person’s certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–15
Receive the certificate from the intended recipient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–15
Search for the certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–17
Verifying a certificate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–17
References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–18
Using protected files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–18
URL authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–20
Opening a file in an unsecure environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–20
Opening a file in secure mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–21
URL authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–22
vi MicroStation Administrator Guide
Table of Contents
Digital Rights-Compliant Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–22
Signing applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–23
Identifying signed applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–26
VBA macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–28
7. Digital Signatures
MicroStation Digital Signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–2
Model scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–2
File scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–3
Signature scope not restricted to view and level display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–4
Signature excludes external resources, databases and user preferences . . . . . . . . . . . . . . . . . . . . . . . . . . 7–5
Changes inside file that do not invalidate signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–5
Changes outside file that do not invalidate signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–5
Signatures and design history. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–6
Signatures and other signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–6
Digital signatures and references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–6
Including references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–7
Reference attachment data included . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–7
DWG reference included. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–7
Signatures not restricted by clip boundaries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–7
Signatures in references. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–8
Status display of signatures in references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–8
File signatures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–8
Model signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–8
Signature cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–9
Signature decoration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–12
Spoofing and trust . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–12
Signature integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–13
Multiple signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–13
Signature hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–13
Multi-user support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–14
Customization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–14
Digital Signatures dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–15
Add File Signature dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–18
Place Signature Cell dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–20
Add Hidden Digital Model Signature dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–22
Signature Properties dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–24
Tools for Signing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–27
Signing an entire file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–27
Signing multiple files via batch command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–28
Signing a model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–29
Adding a model signature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–30
MicroStation Administrator Guide vii
Table of Contents
Creating additional signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–31
Hierarchical signing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–31
Removing a signature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–32
Re-validating a signature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–33
Digital Signatures tool box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–33
Digital Signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–34
Place Signature Cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–35
Part III: Internet Technologies
8. Engineering Links
E(ngineering)-Links tool box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–1
Show Engineering Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–3
Attach Engineering Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–4
Edit Engineering Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–6
Follow Engineering Link. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–7
Connect to/Disconnect from Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–8
Delete Engineering Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–9
Remote Open/Attach . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–10
Entering the URL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8–10
9. Publishing Data to the Internet
Using HTML Author . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9–1
Part IV: Using Software Extensions
10. Scripts and Macros
Key-in Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–1
MicroStation BASIC Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–2
Running macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–2
VBA Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–4
Running VBA macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–4
viii MicroStation Administrator Guide
Table of Contents
11. MDL Applications
Loading and Unloading MDL Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–2
Loading MDL Applications Automatically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11–4
12. Batch Process Utility
Setting up and running a batch process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12–1
General Procedure — To set up and run a batch process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12–1
Saving and recalling batch process jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12–6
Part V: External Database Interface
13. MicroStation and Non-graphical Data
Associating Elements to Non-graphical Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13–1
Tag to Database Converter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13–2
What is the Database Interface? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13–2
Why Use the Database Interface? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13–3
What is a Relational Database? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13–4
Why Use a Relational Database? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13–4
Database Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13–4
Choosing a Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13–5
Selection Factors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13–5
Database Product Families . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13–6
Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13–6
Product descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13–7
ODBC Database Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13–8
OLE DB Database Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13–8
14. Connecting to Databases
Setting Up the Database Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14–1
Connecting to ODBC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14–1
Connecting to Oracle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14–3
General Procedure — Setting Up Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14–4
Windows Notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14–6
Connecting to an OLE DB data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14–6
General Procedure — Setting Up OLE DB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14–6
MicroStation Administrator Guide ix
Table of Contents
MS_LINKTYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14–9
OLEDB configuration variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14–9
Copying elements with attached linkages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14–10
Troubleshooting Database Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14–11
15. Linking Database Rows to Elements
Database Tools Available in MicroStation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–1
Visual SQL Query Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–1
Visual SQL Query Builder dialog box overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–2
Building simple SELECT statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–3
Joining tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–7
Creating linkages using the Visual SQL Query Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–14
Reviewing database attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–17
Database form dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–17
Locating linked elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–19
Opening, editing and saving form dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–21
Using SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–24
Opening and saving query statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–24
SQL statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–25
SELECT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–26
UPDATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–26
DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–26
INSERT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–26
CREATE TABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–27
DROP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–27
COMMIT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–27
ROLLBACK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–27
Specific SQL Window key-ins. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–28
CONNECT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–28
DISCONNECT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–28
RELOAD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–28
Using the SQL Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–28
Command files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–30
Manually committing SQL statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–31
Creating Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–32
mslink column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–34
Key index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–34
MSCATALOG Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–34
mscatalog structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–34
tablename column. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–35
entitynum column. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–35
screenform column. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–35
x MicroStation Administrator Guide
Table of Contents
reporttable column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–36
sqlreview column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–36
fencefilter column. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–36
dastable column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–37
Creating and maintaining MSCATALOG. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–37
Database Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–40
Creating Linkages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–40
Defining the Active Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–41
Editing the Active Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–42
Setting Linkage Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–43
New linkage mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–43
Duplicate linkage mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–43
Information linkage mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–44
Attaching linkages to cell libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–44
16. Querying and Maintaining the Database
Reviewing Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16–1
Displaying Database Attributes in the DGN File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16–3
General Procedure — Displaying Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16–3
Detaching Linkages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16–5
Verifying Linkages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16–5
17. Generating Reports
Report Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17–1
Naming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17–2
Fence Filters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17–3
Report Formatting and Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17–5
Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17–5
Microsoft Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17–5
18. Database Application Software
Existing Database Application Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18–1
Developing MDL Database Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18–2
MicroStation Administrator Guide xi
Table of Contents
Part VI: Design History
19. Recording and Browsing Design History
What is Design History? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19–1
Using Design History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19–3
20. Restoring Recorded Changes
Restoring a Design History from a specific revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20–1
Restoring to a Revision with a Fence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20–2
Restoring Multiple Revisions (Undoing Historical Changes). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20–2
Undoing Historical Changes from Multiple Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20–3
Revision Level Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20–4
21. Using Design History in Projects
Using Design History in Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21–1
Conflicts in Design History. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21–2
Revision Level Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21–2
Element Level Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21–3
Finding Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21–4
Truncating Design History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21–7
Controlling Design History Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21–8
22. Design History Reference
Design History tool box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22–1
Commit Changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22–2
Restore Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22–3
Show Design History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22–5
Design History dialog box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22–6
Element Changes dialog box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22–10
Initialize Design History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22–12
HISTORY SETVERSION. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22–13
Design History Configuration Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22–13
Revision Number Display Format configuration variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22–15
Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22–16
Examples of Revision Number Display Format values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22–17
xii MicroStation Administrator Guide
Table of Contents
AA and AB rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22–18
Part VII: Ensuring Standards Compliance
23. Introduction to the Standards Checker
24. Using the Standards Checker
General Procedure — To set up and run a standards check on an individual file . . . . . . . . . . . . . . . . . 24–1
Defining Standards Checker Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24–1
Running the Standards Checker Interactively . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24–3
Generating Standards Checker Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24–5
Running Standards Checks as a Batch Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24–6
General Procedure — To set up and run a standards check as a batch process . . . . . . . . . . . . . . . . . . . 24–6
Syntax for running standards checks in the Batch Process utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24–7
MicroStation Administrator Guide xiii
xiv MicroStation Administrator Guide
Part I: Workspaces
Workspace Fundamentals
This chapter explains the concept of workspaces.
• The parts of a workspace and basic procedures for selecting them
are covered in Workspace Components.
• The nature of the sample workspaces delivered MicroStation is covered
in Supplied Sample Workspace Components.
A workspace is a custom MicroStation environment or configuration. By selecting
a workspace, you customize MicroStation for a specific discipline, project, or task.
For example, MicroStation is delivered with a sample example workspace. When
the example workspace is active, the files and tools you need to perform designing
and drafting are available by default. In addition, the tools and tool boxes that are
unrelated to that discipline are removed from the interface to avoid confusion.
You can also create your own MicroStation environments and
save them as workspaces.
Workspace Components
Workspace components are stored in Bentley’s “Workspace” and “Home”
directories. The following is a list of workspace components:
1. User — This component in effect points to the active workspace’s Project
and Interface components. The user name identifies the user configuration
file (.ucf) in Bentley’s “Workspace\users” directory.
2. Project — A project consists of customized data files, such as cell libraries
and line style libraries, identified by configuration variables in the
MicroStation Administrator Guide 1–1
Workspace Fundamentals
Setting up the workspace
project configuration file. The data files in the sample projects provided
with MicroStation are delivered as modules, subdirectory trees under
Bentley’s “Workspace\projects\examples” directory.
3. Interface — A customized user interface (defined in
modification resource files in subdirectories under Bentley’s
“Workspace\interfaces\MicroStation” directory).
4 . (User) Preferences — Customized user preferences defined in a user preference
resource file (<user_name>.upf) in Bentley’s “Home\prefs” directory.
You can select any available project, user interface, and style as the
components of the active workspace. The active workspace components
are identified by the user configuration file.
The name of the user configuration file is used as the name of the workspace. Its
suffix is “.ucf,” and it is stored in Bentley’s “Workspace\users” directory.
Setting up the workspace
Workspaces are set up in MicroStation Manager. The MicroStation
Manager dialog box has option menus that allow you to select a
specific User, Project, and Interface.
1–2 MicroStation Administrator Guide
Workspace Fundamentals
Setting up the workspace
Locating the components of the Workspace option menus
All of the options shown on the User, Interface, and Project option
menus are controlled by the contents of specific subdirectories located
under Bentley’s “Workspace” directory. By default, the following
filenames control what you see on these menus:
Option menu Files associated with the option menus
User ".\workspace\users\*.ucf"
Project ".\projects\*.pcf"
".\projects\examples\*.pcf"
Interface “.\interfaces\MicroStation\” (list of subdirectories)
User
The User option menu sets the path for saving and loading an environment
MicroStation Administrator Guide 1–3
Workspace Fundamentals
Setting up the workspace
or configuration for later DGN file sessions. Selecting a user from the list
reconfigures MicroStation to use that workspace’s components. Selecting a user
also resets the search path to a corresponding subdirectory for loading DGN files.
User option menu
A workspace can contain only one project and one interface. These components are
attached to a workspace. So, to use two different projects with the same interface
or two interfaces for one project, you would need to create additional workspaces.
Project
A project is one component that can be associated with any workspace. It is used
to set the location and names of data files associated with a specific design project.
Project option
menu
Interface
Another component of the workspace, the Interface option menu allows
you to select a specific look and feel of MicroStation’s tools and general
on-screen operation. In addition to the default interface, additional sample
interfaces are delivered with MicroStation.
1–4 MicroStation Administrator Guide
Workspace Fundamentals
Setting up the workspace
Interface option
menu
Interface: newuser
This option provides a subset of the default graphical interface to
aid the new MicroStation user.
Creating your own user interface
In addition to activating an existing interface, the Interface option menu
can also be used to create an entirely new interface. Choosing New from the
Interface option menu opens the Create User Interface dialog box.
After entering a name and description for your new interface, MicroStation
creates an interface directory under the “Workspace\interfaces\MicroStation”
subdirectory. This new interface uses the default interface as its
starting point. Any changes you make while using this new interface
will be written only to the new interface.
Selecting workspace components
When the workspace user is changed in the MicroStation Manager dialog box, the
MicroStation Administrator Guide 1–5
Workspace Fundamentals
Setting up the workspace
active workspace’s project component is automatically changed.
Do not delete the examples files and directories. If you do delete them, use the
MicroStation installer to reinstall them, with a custom installation.
To change the workspace user
1. From the User option menu in the MicroStation Manager dialog
box, choose the desired user.
The project associated with that user is automatically chosen.
MicroStation
Manager
dialog box with
the User option
menu displayed
To change to a different project
1. From the Project option menu in the MicroStation Manager dialog
box, choose the desired project.
1–6 MicroStation Administrator Guide
Workspace Fundamentals
Setting up the workspace
To change to a different interface
1. From the Interface option menu in the MicroStation Manager
dialog box, choose the desired interface.
To create a user configuration file
1. From the User option menu in the MicroStation Manager
dialog box, choose New.
The Create User Configuration File dialog box opens.
2. In the Create User Configuration File dialog box’s Name field, enter the
name of the new workspace (the name for the new user configuration
MicroStation Administrator Guide 1–7
Workspace Fundamentals
Setting up the workspace
file). The suffix “.ucf” is automatically added to the name.
3. Click OK.
A Create User Configuration File (workspace name) dialog box opens.
Create User
Configuration
File dialog box,
after naming
the workspace
4. (Optional) — In the Create User Configuration File dialog box’s Description
field, enter a workspace description of up to 32 characters in length.
5. (Optional) — Select additional workspace components. See “To
select a new workspace’s project component” and “To select a new
workspace’s user interface component”.
6. Click OK.
The user configuration file is saved and is automatically chosen in the
User option menu in the MicroStation Manager dialog box.
To select a new workspace’s project component
1. In the secondary Create User Configuration File dialog box
(with the workspace name specified), click the Select button
to the right of the Project field.
The Select Project Configuration File dialog box opens. The available
1–8 MicroStation Administrator Guide
Workspace Fundamentals
Setting up the workspace
project configuration files are displayed in the list box.
2. Select a project and click OK.
To select a new workspace’s user interface component
1. In the secondary Create User Configuration File dialog box (with
the workspace name specified), click the Select button to the
right of the User Interface field.
The User Interface dialog box opens. The available user
interfaces display in the list box.
2. Select a user interface and click OK.
MicroStation Administrator Guide 1–9
Workspace Fundamentals
Setting up the workspace
To create a new project component
1. From the Project option menu in the MicroStation Manager
dialog box, choose New.
The Create New Project dialog box opens.
2. In the Name field, key in the name of the new project. The name
may be up to 32 characters in length.
3. (Optional) — In the Description field, enter a project description
of up to 32 characters in length.
4. Click OK.
The project configuration directory is created, and the project is automatically
chosen in the MicroStation Manager dialog box’s Project option menu.
To create a new user interface component
1. From the Interface option menu in the MicroStation Manager
dialog box, choose New.
The Create User Interface dialog box opens.
1–10 MicroStation Administrator Guide
Workspace Fundamentals
Sharing an existing MicroStation V8 workspace
2. In the Name field, key in the name of the new interface. The
name may be up to 32 characters in length. The list box displays
the names of existing interfaces.
3. (Optional) — In the Description field, enter a workspace description
of up to 32 characters in length.
4. Click OK.
The interface directory is created, and the interface is automatically chosen
in the MicroStation Manager dialog box’s Interface option menu.
Sharing an existing MicroStation V8 workspace
A MicroStation V8 workspace can be set up on a server and shared out to
multiple installations of MicroStation. Once the MicroStation directory and .UCF
files are copied to the shared workspace, any MicroStation user can access
this workspace by pointing to it in there MicroStation shortcut.
To access a shared MicroStation V8 workspace
1. From your MicroStation installation, copy /workspace/interface/MicroStation
folder to the /workspace/interface directory of the shared
MicroStation V8 directory.
2. From your MicroStation installation, copy the contents (specifically
the existing .UCF files) of the //workspace/users/ directory to the
/workspace/users directory of the shared MicroStation V8 directory.
3. Right click on your MicroStation shortcut and select Properties
from the popup menu.
The MicroStation V8 Properties dialog box opens.
4. Select the Shortcut tab.
5. In the Target field, append —wr and the full path of the shared MicroStation
V8 workspace to the existing path to the MicroStation executable.
For example, “C:\Program Files\Bentley\Program\MicroStation\ustation.exe
-wrE:\V8_Shared_Workspace\workspace\”.
In this example, MicroStation V8 is installed on your C drive and is
MicroStation Administrator Guide 1–11
Workspace Fundamentals
Supplied Sample Workspace Components
pointing to a shared workspace on an external drive (E:).
6. Click OK to accept the shortcut change.
7. Double click on the MicroStation and select a user and project
from the shared workspace.
If there are spaces in your shared MicroStation V8 workspace path name,
the shortcut appendage to your icon might not work.
Supplied Sample Workspace Components
Sample project, user interface, and user preference components
are supplied with MicroStation.
• Each sample project component has its own subdirectory tree, within
Bentley’s “Workspace\projects” directory tree, that contains subdirectories
for DGN files, seed files, cell libraries, symbology resources, and so on.
• Each sample interface component has its own subdirectory in
Bentley’s “Workspace\interfaces” directory.
This makes it easy to maintain and customize projects.
For more information about customizing workspace components, see “Building
Custom Projects” on page 5-1, “Customizing the User Interface” on page
3-1, and “Setting User Preferences” in the QuickStart Guide.
1–12 MicroStation Administrator Guide
Workspace Configuration
This chapter covers configuration variables and the four types of
files that define workspaces:
• Basic concepts of configuration variables are covered in Configuration
Variables (see page 2-1).
• The User Configuration File (see page 2-5) determines which workspace
(project, user interface, and user preference file) is active; it can also contain
a user’s overrides of settings in the project configuration file. The user
configuration file consists of configuration variable definitions.
• The Project Configuration File (see page 2-5) contains configuration
variable settings for a particular project. The project configuration file
consists of configuration variable definitions.
• The User Interface Modification Files (see page 2-52) contain modifications
to MicroStation’s default user interface.
• The User Preference Files (see page 2-53) contain user preference settings.
Before discussing how the user configuration file and project configuration files
are used, some background information about configuration variables is required.
Configuration Variables
The User Configuration File (see page 2-5) and the Project Configuration
File (see page 2-5) use configuration variables to select a workspace
and to affect MicroStation’s behavior.
MicroStation’s configuration consists of:
MicroStation Administrator Guide 2–1
Workspace Configuration
How MicroStation processes configuration variables
• The directories in which it finds or stores various types of files
• The names of special-purpose files
• Certain default settings
• Other information about the system on which it runs
This information is stored in configuration variable definitions.
How MicroStation processes configuration variables
Start-up
When MicroStation is started, it processes a set of files that contain
configuration variables in this order:
1. All system-level configuration variable files (in MicroStation’s
“config\system” directory).
2. All application-level configuration variable files (in MicroStation’s
“config\appl” directory).
3. All site-level configuration variable files (in Bentley’s
“Workspace\standards” directory).
4. The user-level configuration variables (in Bentley’s
“Workspace\users” directory).
5 . The project-level configuration variables (in Bentley’s
“Workspace\projects” directory tree).
As each level is processed, its settings are stored in memory. MicroStation
keeps all settings, segregated by level, in memory.
2–2 MicroStation Administrator Guide
Workspace Configuration
How MicroStation processes configuration variables
Determining configuration variable settings
When MicroStation needs to determine (resolve) a configuration variable
setting, it looks for the setting in the various levels in this order:
1. The user level
2. The project level
3. The site level
4. The application level
5 . The system level
If the configuration variable is not set at any level, MicroStation
looks for an operating system environment variable of the same name.
MicroStation uses the value of the configuration variable at the highest
level it is set (the first place it finds it).
If you compare the order in which the files are processed to the hierarchy of
the level settings, you see that the later the level is processed, the higher its
priority, with one exception: In order of priority, the project-level configuration
variables are on a lower level than the user-level configuration variables, but
MicroStation processes the user-level configuration variables first.
MicroStation processes the user-level configuration variables first because
the user configuration file determines which project configuration file is
to be processed. The user configuration file specifies and reads (includes)
the settings in the appropriate Project Configuration File (see page 2-5),
which specifies configuration variable settings for a project component of the
workspace. Therefore, although the project configuration file is the last in time
to be processed, the user configuration file has the last word.
In examples of configuration variable definitions in this chapter, unless
otherwise noted, the workspace user is assumed to be “examples” — that
is, the user configuration file is "examples.ucf".
MicroStation Administrator Guide 2–3
Workspace Configuration
Levels of configuration variables
Levels of configuration variables
There are five levels of configuration variables, all of which
MicroStation maintains in memory:
• System-level configuration variables are the first to be processed by
MicroStation when it is started. They are set by MicroStation itself. Settings
made at this level can be overridden by settings at any higher level.
• Application-level configuration variables are the second to be processed
by MicroStation when it is started. They are usually set by MicroStation
related application programs. Settings made at this level can be
overridden by settings at any higher level.
• Site-level configuration variables are the third to be processed by
MicroStation when it is started. They are usually set by a system or site
manager to facilitate using MicroStation in workgroups. Settings made
at this level can be overridden by settings at any higher level.
• Project-level configuration variables are the fifth to be processed
(after user-level configuration variables) by MicroStation when it is
started. They are usually set by a site or project manager to facilitate
using MicroStation in workgroups. Settings made at this level can
be overridden by settings at the user level.
• User-level configuration variables are the fourth to be processed by
MicroStation when it is started. The user configuration file determines
which project configuration file is processed. User-level configuration
variable settings take precedence over all other level settings.
The first four levels in this list are meant to be set by system, site, and
project managers using a text editor (see “Configuration Variable File
Syntax” on page 2-55). The user-level configuration variables may freely
be changed by each user with the Configuration dialog box without fear
of disturbing any other user’s configuration. Since the user configuration
variables are highest in precedence, there is no need for a user to modify
configuration variable definitions at any other level.
Types of configuration variables
The types of configuration variables are as follows:
2–4 MicroStation Administrator Guide
Workspace Configuration
User Configuration File
• Path configuration variables tell MicroStation where (in what
directory) to find files.
For example, if you specify a DGN file to open when starting
MicroStation, it searches for the DGN file in the directory or directories
specified by the MS_DEF configuration variable. The first time you
choose Open from the File menu, the first directory specified by
MS_DEF displays in the Open dialog box.
• Directory configuration variables tell MicroStation where to save files. For
example, MS_PLTFILES tells MicroStation where to save print files. The first
time you click the OK button in the Print dialog box, the directory specified by
MS_PLTFILES displays in the Save Print Configuration File As dialog box.
• Filename configuration variables specify a file to use for a particular purpose.
For example, MS_DESIGNSEED specifies the seed file MicroStation copies
to create a new DGN file (if you do not select a different seed file).
• Keyword configuration variables specify certain default settings.
For example, MS_LINKTYPE specifies the user data linkage types
recognized by the database server. The possible values or keywords
are “XBASE,” “DMRS,” “IX,” and “ORACLE.”
For more information about configuration variables, see “Working with
Configuration Variables” on page 2-7.
User Configuration File
The user configuration file has two basic workspace functions. First, it
contains values for any configuration variables set by you, the user, to
control MicroStation’s behavior. Second, it specifies the active workspace
components. For example, the MS_USERPREF configuration variable
setting points to the user preference resource file that defines the active user
preferences component. (The user configuration file is the file that opens
when you choose Configuration from the Workspace menu.)
User configuration files have the suffix “.ucf” and are stored in
Bentley’s “Workspace\users” directory.
Project Configuration File
A user working alone with MicroStation could conveniently set every
configuration variable at the user level. Project configuration files exist in
order to facilitate sharing of configurations among users in a workgroup. The
MicroStation Administrator Guide 2–5
Workspace Configuration
Modules
settings in each user’s user configuration file allow each user in a workgroup to
customize MicroStation, while the shared settings of the project configuration
file provide uniformity within the workgroup. The project configuration
file is the file that is selected when you select the project component of a
workspace in the MicroStation Manager dialog box.
The role of the project configuration file in a workspace is to specify the data
files in a particular module that are used in the workspace.
Modules
The module data for the sample workspace project components
provided with MicroStation are stored in subdirectories of Bentley’s
“Workspace\projects\examples” directory.
For example, the architectural module comprises:
• Sample architectural DGN files in Bentley’s “Workspace\projects\ex-
amples\Architectural\dgn” directory
• Sample architectural seed files in Bentley’s “Workspace\projects\ex-
amples\Architectural\seed” directory
• Sample architectural cell libraries in Bentley’s “Workspace\projects\ex-
amples\Architectural\cell” directory
• Sample architectural level structure files in Bentley’s
“Workspace\projects\examples\Architectural\data” directory
• Sample line style libraries in Bentley’s “Workspace\projects\exam-
ples\Architectural\dgnlib” directory
These modules are just examples, and you can use configuration variables to point
to various files throughout the modules. The advantage of creating modules this
way is that you can place the “Workspace\projects” directory and subdirectories on
a network and make them read-only with the exception of the “dgn” subdirectories.
Everyone in a workgroup can use the data, but the data’s integrity is assured.
2–6 MicroStation Administrator Guide
Workspace Configuration
Working with Configuration Variables
Working with Configuration Variables
User-level configuration variables can be set in dialog boxes, as
described in this section.
System-, application-, site-, and project-level configuration variables must
be edited with a text editor using the syntax explained in Configuration
Variable File Syntax (see page 2-55).
General Procedure — To Modify User-level
Configuration Variables
1. From the Workspace menu, choose Configuration.
The Configuration dialog box opens.
2. In the Category list box, select the category that contains the configuration
variable you wish to modify. For a list of all configuration variables by
category, see “User configuration variables” on page 2-12.
or
In the Category list box, select All (Alphabetical) or All (By Level),
MicroStation Administrator Guide 2–7
Workspace Configuration
Working with Configuration Variables
scroll through the configuration variables in the list box to the
right, and select the desired variable.
The controls for setting the definitions of that category of configuration
variables are displayed. In the Expansion field, the expansion of
the variable is shown. In the Description field, a description of
the variable and its name are shown.
3. Use the controls to modify the definition. The procedure varies
for the different Types of configuration variables (see page
2-4). See one of the following:
To set a path configuration variable (see page 2-8).
To set a directory configuration variable (see page 2-9).
To set a filename configuration variable (see page 2-10).
To set a keyword configuration variable (see page 2-11).
(Experienced users familiar with configuration variable syntax: See
also “To edit a configuration variable” on page 2-12.)
4. Click OK.
If you modified any configuration variable definitions, an alert
box opens, asking whether you want to save the changes in the
user configuration file, save the changes only in memory for the
current session, or cancel the changes.
5. In the alert box, click Yes to save the changes to the user configuration
file, click No to save the changes only in memory for the current
session, or click Cancel to cancel the changes.
If you use a text editor to look at the definition of a configuration variable
in a configuration file, you may find that the definition contains other
configuration variables and conditional syntax. The definition is often text
that must be expanded into the actual names of directories, paths, files, and
so on. When you select a configuration variable in the Configuration dialog
box, the Expansion field shows the expansion of the variable.
To set a path configuration variable
1. With the path configuration variable selected in the Configuration
dialog box, click the Select button.
The Select Path dialog box opens. In the Directory List, directories, if any,
2–8 MicroStation Administrator Guide
Workspace Configuration
Working with Configuration Variables
already included in the configuration variable’s expansion are shown.
Select Path
dialog box
2. To add a directory to the configuration variable’s definition, select the
directory from the Directories list box (or key in the directory specification
in the Directory field), then click the Add button.
3. To remove a directory from the configuration variable’s definition, select
it in the Directory List and click the Remove button.
4. Click the Done button.
To set a directory configuration variable
1. With the directory configuration variable selected in the Configuration
dialog box, click the Select button.
The Select Directory dialog box opens. In the field above the
Directories list box, the directory (if any) already included in the
MicroStation Administrator Guide 2–9
Workspace Configuration
Working with Configuration Variables
configuration variable’s expansion is shown.
Select Direc-
tory dialog box
2. To change the directory in the configuration variable’s definition,
select the desired directory in the Directories list box (or key in the
directory specification in the Directory field).
3. Click OK.
To set a filename configuration variable
1. With the filename configuration variable selected in the Configuration
dialog box, click the Select button.
The Select File dialog box opens. In the Files list box, the file (if any)
2–10 MicroStation Administrator Guide
Workspace Configuration
Working with Configuration Variables
already included in the configuration variable’s expansion is shown.
Select File
dialog box
2. To change the file in the configuration variable’s definition, select the
desired file in the Files list box or key in the filename in the Files field. (If
necessary, use the Directories list box to select the proper directory.)
3. Click OK.
To set a keyword configuration variable
1. With the configuration variable selected in the Configuration
dialog box, click the Edit button.
(The Select button is dimmed because keywords cannot be selected.)
The Edit Configuration Variable dialog box opens.
2. In the Edit Configuration Variable dialog box’s New Value field, enter
MicroStation Administrator Guide 2–11
Workspace Configuration
User configuration variables
the desired keyword. (Although keywords are not case sensitive,
uppercase letters are used by convention.)
The keyword is also shown in the Expansion field.
3. Click OK.
To edit a configuration variable
1. With the configuration variable selected in the Configuration
dialog box, click the Edit button.
The Edit Configuration Variable dialog box opens.
2. In the Edit Configuration Variable dialog box’s New Value field, edit
the configuration variable definition. (Although keywords are not case
sensitive, uppercase letters are used by convention.)
The Expansion field shows the expansion of the definition
in the New Value field.
3. Click OK.
User configuration variables
This table lists user configuration variables by category.
Category Variable Short name Description
Archive MS_ARCHIVE "Archive Search Search path for archive files.
Path"
MS_ARCHIVE- "Archive Class Search path for archive class files.
CLASS Search Path"
MS_KEY- "KeyPair File Digital signature KeyPair file list.
PAIRLIST List"
2–12 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Category Variable Short name Description
Cells MS_CELL "Cell Library Search path(s) for cell libraries.
Directories"
MS_CELLLIST "Cell Library List of cell libraries to be searched for
List" cells not found in the current library.
MS_CELLSE- "Cell Selector Directory for Cell Selector button
LECTORDIR Directory" configuration (.csf) files.
MS_CELLSE- "Cell Selector Default Cell Selector button
LECTOR File" configuration file.
MS_CELLOUT "Output Cell Default directory for newly created
Libraries" cell libraries.
MS_MENU "Menu Cells" Cell library file containing menu cells.
Colors MS_DEFCTBL "Default Color Default color table if DGN file
Table" has none.
MS_RMENCTBL "Right Menu Default menu colors (dialog boxes,
Color Table" borders, etc.) for right screen —
specifies a color table (.tbl) file.
MS_LMENCTBL "Left Menu Default menu colors (dialog boxes,
Color Table" borders, etc.) for left screen —
specifies a color table (.tbl) file.
MicroStation Administrator Guide 2–13
Workspace Configuration
User configuration variables
Category Variable Short name Description
Database MS_UDLDIR "Universal Data Points to the directory that contains
Link directory" the Universal Data Link (UDL) files.
The UDL files contain the connection
strings to a particular data source.
The default directory is ..Bentley\Pro-
gram\PowerDraft\database\oledb\udl.
MS_ORA- "Oracle Home" Used to set the path to the Oracle
CLE_HOME client files required for connecting to
the database server. If this variable
is not set, MicroStation looks at the
system registry and path to determine
the Oracle Home directory.
MS_DBASE "Database Files" Search path(s) for database files.
MS_SERVER "Server Loader" MDL application to load the database
interface software.
MS_DBEXT "Database The database interface “server”
Server" application.
MS_LINKTYPE "Database User data linkage types recognized by
Linkages" the database interface software.
2–14 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Category Variable Short name Description
Data Files MS_CUS- "Sheet Size Defines the location of the sheetsizes
TOMSHEET- Definitions" definition file that can be used when
SIZEDEF creating sheet models.
MS_CUSTOM- "Scales Defines the location of the scales
SCALEDEF Definitions" definition file that can be used
when creating models.
MS_CUSTO- "Unit Defines the location of the unit
MUNITDEF Definitions for definition file that can be used
Upgrading" when upgrading pre-V8 files to
V8 DGN files.
MS_HTML "HTML Directory containing template DGN
DGNDIR Template files used to generate cell images
Directory" for HTML documents.
MS_SETTINGS "Settings Open settings file.
Resource"
MS_SETTING- "Settings Output Directory for newly created
SOUTDIR Directory" settings files.
MS_SET- "Settings Directory containing settings files.
TINGSDIR Directory"
MS_REMAP_ "Remap CSV If this variable points to a remapping
CSVFILE File" comma separated value (CSV) file,
the remap filter defaults to that
file for the remapping during the
Save As operation.
MicroStation Administrator Guide 2–15
Workspace Configuration
User configuration variables
Category Variable Short name Description
DWG/DXF MS_DWG_COM- "DWG This variable can be set to a character
MANDPREFIX Command or string of characters that can be used
Prefix" as a shortcut to the AutoCAD key-in
commands. See “Using a Command
Prefix” in the online Guide to Using
DWG and Other Formats.
MS_DWG_PGP- "PGP Command This variable points to a PGP file
FILE Alias File" that contains shortcuts, or aliases, for
AutoCAD commands. See “Using
a PGP File” in the online Guide to
Using DWG and Other Formats.
MS_DWG- "DWG Data Local directory to store DWG settings
DATA Directory" file. For details, see “DWG-related
Configuration Variables” in the
online Guide to Using DWG and
Other Formats.
MS_BLOCK- "AutoCAD List of DWG/DXF files to be searched
LIST Block List" for AutoCAD blocks.
MS_DWG- "AutoCAD SHX Path(s) that contain AutoCAD SHX
FONTPATH Font Directory" fonts. For details, see “DWG-related
Configuration Variables” in the
online Guide to Using DWG and
Other Formats.
MS_ACADDIR "“AutoCAD Directory containing AutoCAD. This
Program is used to find the DWG support
Directory" files such as fonts. For details,
see “DWG-related Configuration
Variables” in the online Guide to
Using DWG and Other Formats.
Design MS_DGNAPPS N/A List of MDL applications to
Applica- load automatically when a DGN
tions file is opened.
2–16 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Category Variable Short name Description
Design MS_DESIGN_ "Design History Allows users to create, delete, commit,
History HISTORY capabilities" and browse Design History.
MS_DESIGN_ "Colors" Specifies the colors to use when
HISTORY_ identifying changed elements.
COLORS
MS_DESIGN_ "Commit before Specifies whether changes are
HISTORY_ close" committed to Design History before
COM- the file is closed.
MIT_ON_CLOSE
MS_DESIGN_ "Commit on Specifies whether changes are
HISTORY_ save" committed to Design History when
COMMIT_ the file is saved.
ON_SAVE
MS_DESIGN_ "Confirm Specifies whether you are prompted to
HISTORY_ when taking confirm that you will take ownership
WARNING ownership" of all uncommitted changes.
MS_DESIGN_ "Revision Allows you to change the appearance
HISTORY_ number display of the revision numbers. For details,
REVISION_ format" see Revision Number Display
NUMBER_ Format Configuration Variable
FORMAT (see page 22-13).
MicroStation Administrator Guide 2–17
Workspace Configuration
User configuration variables
Category Variable Short name Description
Engineer- MS_WE- "Weblib history" History file for the Weblib
ing Links BLIB_HIS- shared library.
TORY
MS_BOOK- "Image Bookmark file for remote images.
MARKS_ IM- bookmarks"
AGE
MS_BOOK- "Resource Bookmark file for remote
MARKS_RSC bookmarks" resource files.
MS_BOOK- "Archive Bookmark file for remote archives.
MARKS_ bookmarks"
ARCHIVE
MS_BOOK- "Cell library Bookmark file for remote cell libraries.
MARKS_CELL bookmarks"
MS_BOOK- "DGN Bookmark file for remote DGN files.
MARKS_DGN bookmarks"
MS_REFA- "RefAgent data File containing URL information
GENTDATA file" for the Reference Agent.
MS_WE- "Kiosk mode" Set to 1 to turn on kiosk mode.
BKIOSKMODE
MS_WEB- "Special filetype Specifies a file that contains
TYPESFILE handling" special handling instructions for
various file types.
MS_WEB- "Weblib local Directory in which copies of remote
FILES_DIR storage" files are stored.
MS_WEB- "Download Sets the directory in which WWW
DOWNLOAD- directory" downloads are stored.
DIR
MS_BROWSER- "Reparent When set to 1, the current browser is
MAKECHILD- browser" reparented inside of the MicroStation
WINDOW main window, allowing the viewer
to always be seen.
MS_USEEX- "External Sets an external browser.
TERNAL- browser name"
BROWSER
2–18 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Category Variable Short name Description
Extensions MS_FEATURE n/a Path to directory that contains MDL
applications for Feature Modeling.
MS_MODELER n/a Path to directory that contains the
MDL application MSMODELER
which implements base functionality
for Feature Modeling.
MS_SELECT n/a URL of Bentley SELECTservices
SERVICES homepage.
HOME
MS_ACIS "ACIS Directory containing the ACIS
Directory" subsystem.
File MS_DGNAU- "Design File Determines the frequency, in seconds,
Saving TOSAVE Auto-Save" of the auto-save timer.
MS_V7AU- "V7 Design File Determines the frequency, in
TOSAVE Auto-Save" seconds, of the auto-save timer
for V7 format files.
MS_V7AU- "V7 Auto-Save Automatically saves the V7 format
TOSAVE_ Dialog" files and skips the dialog box to defer
NODIALOG the auto-save operation.
MS_V7BACK- "V7 create Automatically creates a backup of
UPV8 backup in V8 a V7 file in the V8 format. If set
format" to true, a file is created in the same
directory with the extension .v8.
MS_DWGAU- "DWG/DXF File Determines the frequency, in seconds,
TOSAVE Auto-Save" of the auto-save timer for DWG
and DXF format files.
MS_DWGAU- "DWG/DXF Automatically saves the DWG and
TOSAVE_ Auto-Save DXF format files and skips the dialog
NODIALOG Dialog" box to defer the auto-save operation.
MicroStation Administrator Guide 2–19
Workspace Configuration
User configuration variables
Category Variable Short name Description
Levels MS_LEVEL_ "Level Library Defines the default directory to
LIB_DIR Path" look for when exporting levels or
importing levels to/from a .csv,
.dgn or .dgnlib file.
MS_LEVEL_ "Edit Nested If set, lets you edit the attributes of
EDIT_ Attachment levels in nested reference attachments.
NESTED_ AT- Levels"
TACHMENT_
LEVELS
MS_V7_LEVEL_ "V7 to V8 Level Defines the prefix to apply to unnamed
NAME_ Name Prefix" levels when a V7 design file is
PREFIX upgraded to a V8 DGN file.
MS_V7TOV8_ "V7 to V8 Level Defines the .csv file, which controls
CSVNAME CSV File" how levels are mapped when a
V7 design file is upgraded to
a V8 DGN file.
MS_V7TOV8_ "V7 to V8 Delete If set to 1, then all unused levels
DELETE_ Unused Levels" are deleted when a V7 design file is
UNUSED_ upgraded to a V8 DGN file. This
LEVELS variable is ignored if the "V7 to V8
Level CSV File" variable is set.
MS_LEVEL_ "Seed Level Can be set to the name of a seed
SEED_LEVEL_ Name" level. This can be a level in the master
NAME file, or a level in a DGNLIB library
file. If the variable is not set, the
default level is the seed level. When
a new level is create, it takes the
attributes of the seed level.
2–20 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Category Variable Short name Description
Levels MS_LEVEL_ "Load If defined, then level-filters of
LOAD_ AT- Attachment reference attachments are loaded.
TACHMENT_ Level Filters"
FILTER
MS_LEVEL_ "Seed Level Controls the set of attributes of
CREATE_ Attributes to the seed level that are copied to
FROM_SEED_ use" the new level. Attributes can
ATTRIBUTE_ be one or more of the following
LIST attributes as a comma separated list:
OverrideSymbology, OverrideColor,
OverrideStyle, OverrideWeight,
ByLevelSymbology, ByLevelColor,
ByLevelStyle, ByLevelWeight,
GlobalFreeze, Lock, Plot
MS_LEVEL_ "Control Level Controls which level attributes can be
EDIT_ Attributes Edit" edited or overridden (instead of using
ATTRIBUTE_ operating system privileges for the
LIST entire level library). The attributes to
be edited can be one or more of the
following as a comma separated list:
Override Symbology (OverrideColor,
OverrideStyle, OverrideWeight),
ByLevel Symbology, (ByLevelColor,
ByLevelStyle, ByLevelWeight),
GlobalDisplay, GlobalFreeze, Lock
and Plot. OverrideSymbology
encompasses OverrideColor,
OverrideStyle and OverrideWeight.
ByLevelSymbology encompasses
ByLevelColor, ByLevelStyle and
ByLevelWeight. Each attribute
accepts a "Library" or "Reference"
prefix. Without the prefix, the
attribute will be editable for both
references and library levels.
MicroStation Administrator Guide 2–21
Workspace Configuration
User configuration variables
Category Variable Short name Description
Levels MS_LEVEL_ "Control Level Affects the dgnlib update levels
SYNC_ Attributes Sync" custom and reference synchronize
ATTRIBUTE_ levels default key-ins. This variable
LIST controls the list of level attributes
that will sync when any of the
above key-ins is executed. The
attributes can be one or more
of the following as a comma
separated list: OverideSymbology,
OverrideColor, OverrideStyle,
OverrideWeight, ByLevelSymbology,
ByLevelColor, ByLevelStyle,
ByLevelWeight, GlobalDisplay,
GlobalFreeze, Lock, Plot.
MS_LEVEL_ "Level Attribute This variable controls the list of level
AUTO_SYNC_ Auto Sync" attributes that will automatically
ATTRIBUTE_ synchronize when a file is opened. The
LIST attributes can be one or more of the
following as a comma separated list:
OverideSymbology, OverrideColor,
OverrideStyle, OverrideWeight,
ByLevelSymbology, ByLevelColor,
ByLevelStyle, ByLevelWeight,
GlobalDisplay, GlobalFreeze, Lock,
Plot. Each of the above attributes
can take a “Reference” or “Library”
prefix. If the prefix is not used, both
reference and level library levels
will be synchronized.
2–22 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Category Variable Short name Description
Levels MS_REF_ "Ref. Reattach Specifies the list of level attributes
REATTACH_ Level that will sync when a reference is
LEVEL_SYNC_ Attributes" reattached. The attributes can be one
ATTRIBUTE_ or more of the following as a comma
LIST separated list: OverideSymbology,
OverrideColor, OverrideStyle,
OverrideWeight, ByLevelSymbology,
ByLevelColor, ByLevelStyle,
ByLevelWeight, GlobalDisplay,
GlobalFreeze, Lock, Plot.
MS_UP- "Keep Unused If set to 1, keying in DGNLIB
DATE_KEEP_ Library Levels" UPDATE LEVELS will not delete
UNUSED_ LI- all unused library levels.
BRARY_ LEV-
ELS
MDL De- MS_RDE_SYS- "Runtime Text to be inserted at the beginning
velopment INC resource of the command line by the resource
compiler" compiler DLM. Generally used to
specify the location of include files.
MS_DBG- "MDL Source" Location of source code for MDL
SOURCE applications (used by MDL debugger).
MS_MDL- "MDL Trace" If set, additional debugging print
TRACE statements are provided when
debugging MDL applications.
MS_AS- "Assertion Format of assertion messages. The
SERT_MES- Failure default is Assertion Failure
SAGE Message" %s %s(%d).
MicroStation Administrator Guide 2–23
Workspace Configuration
User configuration variables
Category Variable Short name Description
MDL De- MS_AS- "Assertion Specifies handling of assertion failure:
velopment SERT_HAN- Failure
• 0 (default) — display error
DLING Handling"
message
• 1 — log error message
• 2 — stop in debugger
MS_DEBUG- "Debug Fault" If set, automatically invoke the
FAULT debugger when a fault is detected
while an MDL application is active.
MS_DEBUG "Time Out" If set to an integer with bit 1 on,
do not time out.
MS_TRAP "Exception Exception handling flag — “ALL”
Handling" (default), “MDL,” or “NONE.”
OLE MS_OLE- "Embed If set, references are embedded along
SERVE_EM- References" with the master DGN file.
BED_REF-
FILES
2–24 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Category Variable Short name Description
Operation MS_DGN "Design File Determines the frequency, in seconds,
AUTOSAVE Auto-Save" of the auto-save timer.
MS_AUTO RE- "Auto-restore If set to 1, the status bar is restored
STORESTA- Status Bar" to its default appearance whenever
TUSBAR the pointer is moved within.
MS_FKEYMNU "Function Key Open function key menu file.
Menu"
MS_ACCUD- "AccuDraw Text file listing AccuDraw
RAWKEYS Shortcuts" shortcut keys.
MS_SAVE- "Attached File containing information about
MENU Menus" attached menus.
MS_APPMEN "Application Location of application and
Menus" sidebar menus.
MS_WORK "Workspace Sets how MicroStation Manager
SPACEOPTS Options" displays workspace options: 0 or not
set (default) = workspace remains
same; 1 = workspace options visible
but disabled; 2 = workspace options
hidden, MM resized.
MS_USECOM- "Use Command If set, 0 sets the status bar interface,
MANDWIN- Window" and 1 sets the Command Window
DOW interface. If not set, the Style setting
in MicroStation Manager determines
the interface style.
MicroStation Administrator Guide 2–25
Workspace Configuration
User configuration variables
Category Variable Short name Description
Operation MS_FILEHIS- "File History" If set, MicroStation saves the last four
TORY files and directories for each file type.
MS_READ- "Read Only" If set, the active DGN file is read-only.
ONLY
MS_WORK- "Work Mode" Workmode activates/disables certain
MODE functions in order to produce a more
compatible design at the end. Setting
this variable to DWG will disable
some creation tools that may result in
elements that are incompatible with
the DWG file format. Setting it to
DGN (default) will gain full functional
capacity in creating elements. You
must restart MicroStation to see the
effect of a changed value.
MS_IMMEDIA- "Window If set, view windows will immediately
TEUPDATE Immediate update when other windows are
Update" moved or resized over them..
MS_OPENV7 "Open V7 Files" Controls MicroStation’s behavior
when opening V7-format design files.
If not set or set to 0, the file opens
with an alert dialog that provides an
option to upgrade the file to V8 DGN
format. If set to 1, the file is upgraded
to V8 DGN format and opened. If set
to 2, the file is opened in read-only
mode. If set to 3, the file is opened in
V7 workmode (see page 4-2).
MS_DISABLE_ "Disable File If set, the Show File Icons check
FILE_ICONS Open Icons" box is not shown in the MicroStation
Manager, New, and Open dialog
boxes. Also, the setting is turned off
thereby preventing the display of file
list icons. The effect is not evident
until you restart MicroStation.
2–26 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Category Variable Short name Description
Printing MS_PLTR "Default Printer Name of printer driver file.
Driver File"
MS_PLOT- "Force Default Name of printer driver file that loads,
DLG_ Printer Driver" rather than last used printer driver.
DEF_PLTFILE
MS_PLT_ "Default Name of printer driver file that is used
SYSPRT_ Windows Printer when Windows Printers is selected.
PLTFILE Driver"
MS_PLT_ "Default Name of printer that is used when a
SYSPRT_ Windows Printer default system printer opens.
DEFAULT_ Name"
PRINTER
MS_PLT_ "Default Name of form that is used when a
SYSPRT_ Windows Form default system printer opens.
DEFAULT_ Name"
FORM
MS_PLT_ "Default Name of tray that is used when a
SYSPRT_ Windows Tray default system printer opens.
DEFAULT_ Name"
TRAY
MS_PLTFILES "Default Output Directory for printing output files.
Directory"
MS_POLT- "Force Output Directory for plot files; overrides
DLG_FORCE- Directory" user preference file.
OUTDIR
MS_PLOTINI "Print Config Directory for print configuration files.
Search Path"
MS_PENTABLE "Pen Table Search path for pen table files.
Search Path"
MS_BATCH- "Batch Print Name of the file that contains the
PLT_SPECS Specifications" batch plotting specifications.
MS_BATCH- "Batch Print Job Directory containing batch
PLT_JOB- Directory" printing job files.
SET_DIR
MS_BATCH- "Batch Print Name of batch printing log file.
PRINT_LOG- Log File"
FILE
MicroStation Administrator Guide 2–27
Workspace Configuration
User configuration variables
Category Variable Short name Description
Printing MS_BATCH- "Batch Print Add If set to 1, only adds sheet models to
PRINT_ Sheet Models" the job set when a design file is added.
ADD_ONLY_
SHEET_MOD-
ELS
MS_BATCH- "Batch Print Add If set to 0, does not add multiple
PRINT_ADD_ All Models" entries, one per model, to the job set
ALL_MODELS when a design file is added.
MS_BATCH- "Batch Controls the behavior of the
PRINT_SETUP- Print Setup Batch Print Setup System Printer
SYSPRT Sysprinter" dialog. PRNSELECT invokes the
Windows printer selection dialog.
PAGESETUP invokes the Windows
page setup dialog.
MS_PLT_USE_ "Enable “Last Enables or disables the use of
MRU_DE- Used” Defaults" most-recently-used default files
FAULTS and directories.
MS_PLT- "Enable Print Reverses the X and Y values of
DLG_EN- Orientation" the paper size without having to
ABLE_ORI- edit the .plt file.
ENTATION
MS_PLT- "Preview Manipulates the orientation of the
DLG_PRE- Orientation" design and paper size definition.
VIEW_ORI-
ENTATION
2–28 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Category Variable Short name Description
Printing MS_PLT_PRE- "Preview Usable Specifies the color of the usable area
VIEW_US- Area Color" rectangle in the preview window.
ABLEAREA-
COLOR
MS_PLT_PRE- "Preview Specifies the color of the printer
VIEW_PRINT- Printable Area driver’s printable area rectangle in
ABLEAREA- Color" the preview window.
COLOR
MS_PLT_PRE- "Preview Plot Specifies the color of the print
VIEW_PLOT- Rectangle bounding box rectangle in the
BOXCOLOR Color" preview window.
MS_PLT_PRE- "Preview Plot Specifies the color of the print fence
VIEW_PLOT- Fence Color" shape in the preview window.
FENCECOLOR
MS_PLT- "Unload Plot Controls the load/unload of the Plot
DLG_UN- Dialog on Close" dialog box on closing.
LOADON-
CLOSE
MS_PLT_EN- "Enable Scale If set to 0, does not reduce the plot
ABLE_SCALE_ Clipping" fence or sheet size to accommodate
CLIPPING the specified scale factor.
MicroStation Administrator Guide 2–29
Workspace Configuration
User configuration variables
Category Variable Short name Description
Printing MS_PLT_EN- "Enable Preserve If set to 0, does not preserve the
ABLE_PRE- Clipping" current plot scale when a new view,
SERVE_SCALE fence or paper size is selected.
MS_PLT_EN- "Enable If set to 0, does not manipulate the plot
ABLE_AUTO_ Automatic rotation in order to achieve the best fit.
ROTATE Rotation"
MS_PLT_EN- "Enable If set to 0, does not manipulate
ABLE_AUTO_ Automatic the paper orientation in order to
ORIENT Orientation" achieve the best fit.
MS_PLT_ "Honor Sheet If set to 0, operates as if no sheet
HONOR_ Definitions" attributes are set.
SHEET_INFO
MS_PLT_AREA_ "Print Area If set to 1, sheet definitions in the model
PRIORITY Priority" take priority over the active fence.
MS_PLT_FORM_ "Form Scale If set to 1, the default form scale
SCALE_ Priority" is reapplied whenever the paper
PRIORITY size changes.
MS_PLT_MAX_ "Maximize on If set to 1, the print size is maximized
ON_NEW_AREA New Print Area" automatically when the print
area changes.
MS_PLT_FIT_ "Fit with Raster If set to 1, raster references are
RASTER_REFS Refs" included when computing the design
range for the Fit print area modes.
MS_PLT_AUTO_ "Automatically Controls the setting for the print
FIT_VIEW Fit View" area mode.
MS_PLTDLG_ "Keep View When a new fence is placed, controls
KEEP- Flags on New the setting for resetting or preserving
VIEWFLAG- Fence" current print attributes.
SON-
FENCECHANGE
MS_PLTDLG_ "Print Dialog Sets the weight print attribute.
WEIGHTOVER- Weight
RIDE Override"
MS_PLOT- "Default Pen Defines the default pen table
DLG_ Table" that is loaded.
DEF_PENTABLE
2–30 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Category Variable Short name Description
Printing MS_PLT- "Setup Controls the behavior of the Configure
DLG_SETUP- Sysprinter Icon Windows Printer icon on the Print
SYSPRTICON Mode" dialog box. PRNSELECT invokes
the Windows printer selection dialog.
PAGESETUP invokes the Windows
page setup dialog.
MS_PLT_EN- "Enable Page If defined, margins are enabled on the
ABLE_PAGE- Setup Margins" Windows Page Setup dialog box.
SETUP_ MAR-
GINS
MS_PLT- "Enable Setup Controls the print behavior of the
DLG_SETUP- Sysprinter Print" Configure Windows Printer icon.
SYSPRT_EN-
ABLE_PRINT
MS_PLT- "Enable Save Disables the Print dialog Save
DLG_EN- Configuration" Configuration menu items.
ABLE_SAVE_
CONFIG
MS_PLT_SCALE "Scale Method" Determines how the print scale
_METHOD displays in the Print dialog.
MS_PENTABLE_ "Import Empty During AutoCAD plot style table
IMPORT Pen Table imports, ignores pen table sections
EMPTY Section" that have no effect. If set to 1,
SECTIONS empty sections are created.
MS_PENTABLE "Pen Table Controls the color of a disabled section
_DISABLE Disable Color" in a pen table; default is medium gray.
COLOR
MS_PENTABLE_ "Pen Table If defined, when comparing level
REGEX_LEVEL RegEx Level names in the pen table, regular
_COMPARE Compare" expressions are evaluated.
MicroStation Administrator Guide 2–31
Workspace Configuration
User configuration variables
Category Variable Short name Description
Printing MS_PENTABLE "Pen Table Slot Controls how the pen table reference
_SLOTNUM_ Number Match" slot number match applies to the
MATCH_ parent reference and its children.
APPLIES_TO_
CHILD
MS_PENTABLE "Pen Table When importing CTB files, allows the
_IMPORTCTB_ Import Pen proper color-to-width resymbolization
NOPENMAP Maps" of multi-colored elements.
MS_PLT- "Plot Driver Name of text editor to be used when
FILE_EDITOR Editor" Edit Printer Driver is activated.
MS_PLNON- "Exclude DGN Enables/disables the insertion of the
AME Name from Plot" DGN name in the output file.
MS_PLT_VIEW "View Weight Allows the minimum line thickness
FLAGOFF_ Off Line Width" to be set in millimeters.
LINEWIDTHMM
MS_PLT_ "Invert Allows you to override the colors
INVERT_ White-to-Black that are automatically inverted
WHITE_ Colors" from white to black.
COLORS
MS_PLT_OLE_ "Maximum OLE Allows for sharper plotted OLE objects
MAX_MFB_ Plot Buffer" at the expense of memory usage,
SIZE processing time and plot file size.
MS_PLT_ "Force Hardware Text that otherwise would be stroked
FORCE_ Text" in software is sent to the printer
HARDWARE_ driver as hardware text.
TEXT
2–32 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Category Variable Short name Description
Protection MS_PRO- "Control license
• Set to 0 to disable license
TECTION_LI- creation"
creation
CENSE_EN-
ABLE • Set to 1 to enable password
licenses
• Set to 2 to enable certificate
licenses
• Set to 4 to enable Everyone
licenses
• Set to 7 to enable all types
of licenses (default)
Add individual values together to
enable two or more license types.
MS_PROTEC- "Enable file
• Set to 0 to disable file
TION_ENABLE protection"
protection (default)
• Set to 1 to enable password or
certificate protection
• Set to 2 to enable password
protection
• Set to 3 to enable certificate
protection
MS_PROTEC- "Password A password containing a mixture
TION_PASS- letters and of letters and numbers.
WORD_MIXED numbers"
MS_PROTEC- "Minimum Sets the minimum length of a file
TION_PASS- length of protection password. The default is 5.
WORD_MIM- password"
IMUM
MS_PROTEC- "Do not encrypt The thumbnail is an image of the last
TION_NOEN- file thumbnail" used view of the design file. The
CRYPT_ image is displayed by Windows File
THUMBNAIL Explorer and MicroStation Manager.
MS_PROTEC- "Do not encrypt Set to 1, tells the Protect command
TION_NOEN- file properties" to leave file properties unencrypted
CRYPT_ PROP- or set to 0 to allow Protect encrypt
ERTIES file properties.
MicroStation Administrator Guide 2–33
Workspace Configuration
User configuration variables
Category Variable Short name Description
Primary MS_DGNLI- "DGN Library List of DGN libraries.
Search BLIST List"
Paths
MS_DEF "Design Files" Search path(s) for DGN files.
MS_RFDIR "References" Search path(s) for references.
MS_MDLAPPS "Visible MDL Search path(s) for MDL applications
Applications" displayed in the MDL dialog box.
MS_MDL "MDL Search path(s) for MDL applications
Applications" or external programs loaded by
MDL applications.
MS_MACRO "Macros" Search path for macros.
MS_RSRC- "Resource Files" Search path(s) for resource files
PATH loaded by MDL applications.
MS_LI- "Library Path" Search path for dynamic link libraries.
BRARY_PATH
RDL_DIR "Redline Location and/or extension of the
Location" Bentley Redline-generated redline
file. Defaults to the name of the
open DGN file but with the suffix
“.rdl,” instead of “.dgn,” in the same
directory as the open DGN file.
DWGRDL_DIR "DWG Redline Location and/or extension of the
Location" Bentley Redline-generated DWG
redline file. Defaults to the name of
the open DWG file with “_redline”
inserted before “.dwg.” in the same
directory as the open DWG file.
MS_FIL- "Filter Library Directory containing filter data files.
TER_LIB_DIR Path"
2–34 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Category Variable Short name Description
Reference MS_REF_DE- "Default If set, the Attach Reference dialog box
FAULTAT- Attachment defaults to this directory, rather than the
TACHDIREC- Directory" directory of the last attached reference.
TORY
MS_REF_DE- "Default Controls the default settings for refer-
FAULTSET- Attachment ence attachments. This variable is set
TINGS Settings" to a comma-separated list of key=value
pairs — for example: snap=1,lo-
cate=0,trueScale=1,scale-
LineStyles=0.
Recognized keys and values in-
clude: display=0|1, snap=0|1,
locate=0|1, useLights=0|1, saveRel-
ativePath=0|1, scaleLineStyles=0|1,
ignoreWhenNesting=0|1, dis-
playRasterRefs=0|1, displayBound-
ary=0|1, nestMode=live|copy|nest,
nestDepth=<value>.
Also, to store the complete path to V7
files for newly attached references, set
the variable to completepathv7=1.
MS_DISAL- "Disallow Full If set, MicroStation does not save
LOWFULL- Ref Path" the full path to references. By
REFPATH default, MicroStation stores both
an abbreviated (portable) path and
the full path to references.
MicroStation Administrator Guide 2–35
Workspace Configuration
User configuration variables
Category Variable Short name Description
Reference MS_REF_ "New Level If set, MicroStation displays newly
NEWLEVEL Display" created levels in references. By
DISPLAY default, when new levels are created in
a model that is referenced by another
model, the new levels are not displayed
when the referencing model is opened.
Newly created models are considered
until “Save settings” is performed.
This functionality only works when
both the master file and referenced
files are in the V8 file format.
MS_NEST_ "Nested If set to any value, the nested reference
COLOR Reference Color color adjustments at each level are
ADJUSTMENT Adjustment" multiplied by this value. If not set,
the color adjustment for the top level
reference controls the color adjustment
for all nested references.
MS_REF_ "Hiliting By default, MicroStation highlights
DONTHILITE References for all elements in a reference file when
FORMANIP Manipulation" the reference is manipulated. If this
variable is set to any value, this
highlighting is disabled. Disabling
speeds up the reference manipulations
but makes it more difficult to see which
references are being manipulated.
2–36 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Category Variable Short name Description
Render- MS_MTBL "Material Search path(s) for material tables.
ing/Im- Tables"
ages
MS_MATE- "Material Search path(s) for material palettes.
RIAL Palettes"
MS_PATTERN "Pattern Maps" Search path(s) for pattern maps.
MS_BUMP "Bump Maps" Search path(s) for bump maps.
MS_IMAGE "Images" Search path(s) for images.
MS_IMAGE- "Image Output" Directory in which image files created
OUT with Utilities > Image > Save and
Utilities > Image > Capture (see
page 3-32) are stored.
MS_SHAD- "Shadow Maps" Directory where shadow maps will
OWMAP be read from and written to.
MS_LIGHTING "IES Lighting Directory where IES lighting
Files" data will be stored.
MS_LIGHTLIST "Pre-defined Directory that lists the location
Light Sources" of predefined lights.
MS_RENDER- "Rendering File in which rendering statistics
LOG statistics log" are logged.
MS_PTDIR "Particle Tracing Working directory for temporary
Work Dir" Particle Tracing files.
MS_IM- "Image Editor" Default program to be used to edit an
AGE_EDITOR image file. The program is activated
by double-clicking in the preview area
of the Map Editor dialog box.
MS_MATE- "Material Image to be used for the background
RIAL_PRE- Preview of material previews in the
VIEW_BACK- Background" Material Editor.
GROUND
MS_REN- "V7 Material If set to 1, materials are rendered as
DERV7MA- Compatibility" they were in V7. Most affected are
TERIALS translucency, transparency, specularity,
and diffuse as applied to pattern maps.
MicroStation Administrator Guide 2–37
Workspace Configuration
User configuration variables
Category Variable Short name Description
Security MS_SECU- "Security level" Security level for loading and running
RITY_LEVEL applications in MicroStation.
MS_SECU- "Software Path where MicroStation can find
RITY_SPC Publishing the Software Publishing Certificates
Certs" used to digitally sign the applications
that can be loaded in MEDIUM
security mode.
Seed Files MS_VIEW- "View Group Name of file containing seed view
GROUPSEED Seed File" group for models without a view group.
MS_VIEW- "View Group Name of seed view group for models
GROUPSEED- Seed" without a view group.
NAME
MS_DWGSEED "DWG Seed Seed file used to create DWG file.
File"
MS_SEED- "Seed File Search path(s) for all seed files.
FILES Location"
MS_DE- "Default Design Default seed file.
SIGNSEED File Seed"
MS_TRANSEED "Default Default seed file for DWG, CGM,
Translation and IGES translations.
Seed"
MS_CELL_ "Cell Library Seed file used when creating or
SEEDFILE Seed File" upgrading cell libraries.
MS_SHEET- "Drawing Sheet Seed file used when creating
SEED Seed File" drawing sheets.
MS_USER- "User Preference Name of seed file used to create user
PREFSEED Seed" preference resource file.
MS_DESIGN- "Design Model Name of file containing the seed model
MODELSEED Seed File" for the new design models.
MS_DESIGN- "Design Model Name of seed model for new
MODELSEED- Seed" design models.
NAME
2–38 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Category Variable Short name Description
Seed Files MS_SHEET- "Sheet Model Name of file containing seed model
MODELSEED Seed File" for new sheet models.
MS_SHEET- "Sheet Model Name of seed model for new sheet
MODELSEED- Seed"
NAME
MS_DWG "DWG Sheet Name of file containing seed model
SHEETMODEL Model Seed for new sheet models in DWG files.
SEED File"
MS_DWG "DWG Sheet Name of seed model for new sheet
SHEETMODEL Model Seed" models in DWG files.
SEEDNAME
Spelling MS_SPELLING "Spelling User Specifies the user dictionary.
USER Dictionary"
DICTIONARY
MS_SPELLING "Spelling Specifies the language. Valid
LANGUAGE Language" languages are: AmericanEnglish,
BritishEnglish, Brazilian (Brazilian
Portuguese), Danish, Dutch,
Finnish, French, German, Italian,
Norwegian, Spanish.
MS_SPELLING "Spelling Specifies the directory to search
DICTIONARY Dictionaries" for core dictionaries.
PATH
MicroStation Administrator Guide 2–39
Workspace Configuration
User configuration variables
Category Variable Short name Description
Standards MS_STAN- "Required Sets the *.dgnlib file used for standards
Checker DARD- Standards checking. If this variable is set, the
SCHECKER_ Checker Set" specified file is always used for
SETTINGSFILE standards checking.
MS_STAN- "Required Sets the name of the settings to
DARD- Standards use (within the file specified by
SCHECKER_ Checker Name" MS_STANDARDSCHECKER_SET-
SET- TINGSFILE). If this variable is set, you
TINGSNAME cannot select different named settings.
MS_STAN- "Standards Default directory for standards
DARDS Checker Report checker reports.
CHECKER Directory"
_OUT
MS_STAN- "Standards If this variable is set, it specifies the
DARD- Checker Style XML style sheet that is used to view
SCHECKER_ Sheet" the Standards Checker XML report.
STYLESHEET This variable can be either a file or a
URI (Universal Resource Identifier)
that can be used by the browser to
locate the style sheet. If this variable
is not set, the XML style sheet in
$(_USTN_WORKSPACEROOT)sys-
tem/data/standardschecker.xsl is used.
MS_STAN- "Standards The list of MDL applications that
DARD- Checker are loaded when the Standards
SCHECKER_ Applications" Checker utility is started.
APPS
Symbol- MS_SYM- "Symbology List of symbology resource files —
ogy BRSRC Resources" last one in list has highest priority.
2–40 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Category Variable Short name Description
System MS_CONFIG "Main Main MicroStation configuration file
Env(iron- Configuration — sets up all configuration variables.
ment) File"
RSC_COMP "Resource Text string to be inserted at the
Compiler beginning of the command line by
Command Line" the resource compiler (used to specify
where to search for include files).
MDL_COMP "MDL Compiler Text string to be inserted at the
Command Line" beginning of the command line by
the MDL compiler (used to specify
where to search for include files).
BMAKE_OPT "BMAKE Command line options for BMAKE.
Options" Used to search for bmake include
(.mki) files.
MS_DEBUG- "Extended If set (to the base name of an MDL
MDLHEAP Malloc" application or “ALL), use extended
malloc for debugging.
Tags MS_TAGOUT- "Tag Output" Output directory for tag data.
PUT
MS_TAGRE- "Tag Reports" Output directory for tag reports.
PORTS
MS_TAGTEM- "Tag Templates" Directory containing tag report
PLATES templates.
Temp and MS_BACKUP "Backup Files" Default directory for backup files.
Backup
MS_DWG_ "Directory for Directory for DWG backup (.bak)
Files
BACKUP DWG backup files. If this variable is not set,
files" the files are placed in the same
directory as the DWG file.
MS_NO_DWG_ "Turn off DWG If set, a .bak file is not created when
BACKUP .bak files" a DWG or DXF file is edited.
MS_TMP "Temporary Directory for temporary files created
Files" and deleted by MicroStation.
MS_SCR "Scratch Files" Directory for scratch files created
by MicroStation.
MicroStation Administrator Guide 2–41
Workspace Configuration
User configuration variables
Category Variable Short name Description
Transla- MS_CGMIN "CGM Input Input directory for CGM translations.
tion — Directory"
CGM
MS_CGMOUT "CGM Output Output directory for CGM translations.
Directory"
MS_CGMLOG "CGM Log Output directory for CGM log files.
Files"
MS_CGMTA- "CGM Directory containing the CGM
BLES Configuration translation tables.
Tables"
MS_CGMIN- "CGMIN Settings file for the CGMIN
SET Settings File" application.
MS_CGMOUT- "CGMOUT Settings file for the CGMOUT
SET Settings File" application.
Transla- MS_IGESIN "IGES Input Input directory for IGES translations.
tion — Directory"
IGES
MS_IGESOUT "IGES Output Output directory for IGES translations.
Directory"
MS_IGESLOG "IGES Log Output directory for IGES log files.
Files"
MS_IGESIN- "IGESIN Settings file for IGES import.
SET Settings File"
MS_IGESOUT- "IGESOUT Settings file for IGES export.
SET Settings File"
Transla- MS_STEPOUT "Step Output Output directory for Step translations.
tion — Directory."
Step
MS_STEPLOG "Step Log Files." Output directory for Step log files.
MS_ROSEDB "Rose database Rose database directory.
directory."
2–42 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Category Variable Short name Description
User Com- MS_UCM "User Search path(s) for user commands
mands Commands" (UCMs).
MS_INIT "Startup User Name of a user command to
Command" executed at startup
MS_EXIT "Exit User Name of a user command to
Command" executed at exit
MS_NEWFILE "New File User Name of a user command to executed
Command" when a DGN file is opened
MS_APP "Apps from Search path(s) of applications started
’TSK’ from “TSK” statements.
statements"
Visual Ba- MS_VBA_ "Automatically If set to 1, MicroStation automatically
sic for Ap- SAVEONRUN save VBA saves modified VBA projects every
plications project" time it starts running a VBA program.
MS_VBA "Names of Names of the projects that are opened
AUTOLOAD standard when the VBA dialog box is opened.
PROJECTS projects"
MS_VBA "Directories to Directories that are searched when
SEARCH search for VBA opening an existing VBA project.
DIRECTORIES projects"
MS_VBA "Directory for Directory that is used when a new
NEWPROJECT new projects" project is created.
DIRECTORY
This table lists uncategorized configuration variables:
Variable Description
CLASSPATH Path to Java/JMDL classes.
HISTORY_MAX_MINOR_VERSIONS The number of minor versions for the
Limit History command to preserve
in the history file.
MSDIR MicroStation root installation directory.
MSLOCAL Specifies the base directory path for
where the required writable portions (that
is, local for a network installation) of
MicroStation are installed.
MicroStation Administrator Guide 2–43
Workspace Configuration
User configuration variables
Variable Description
MS_80TRUETYPESCALE If set to 1, True Type fonts using nonstandard
True Type definitions will display as
they did prior to V8.
MS_81TEXTNODEMIRRORING If set, MicroStation uses the V8.1
method for mirroring a selection with
Mirror Text turned off.
When this option is on, two problems
can occur:
• some style runs (collections of
characters with the same text styles
applied) may be reversed when
mirrored about the Y axis (vertical)
• line order is reversed in multi-line
text when the element is mirrored
about the X axis (horizontal)
MS_ASPECTRATIO Specifies the correct aspect ratio of the
display screen. This variable should
be set to the ratio of the width to the
height of the display area.
MicroStation automatically detects the aspect
ratio of the display screens on most systems.
In some configuration (including dual screen
Windows displays), the video driver returns
incorrect display size information, causing
elements to appear stretched in either the
horizontal or vertical direction. Use this
variable to correct the aspect ratio.
MS_BASICEXT_LOAD List of MDL applications that implement
extensions to the BASIC language
(MS_BASIC_LOAD).
MS_CMDTABLE_LOAD List of MDL applications that will have
their key-in tables auto-loaded.
MS_CMDWINDRSC Command Window resource file. Default
is used if undefined.
MS_CODESET MDL application for handling multi-byte
character sets.
MS_DATA Directory for data files created or used
by MicroStation.
2–44 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Variable Description
MS_DEFCHARTRAN Default character translation table.
MS_DEFAULTSHEETRGB Allows you to specify a different background
color, which is used when you create
the first sheet model. Expects an RGB
triplet separated by commas.
MS_DESIGNFILTER Default file filter for the MicroStation
Manager, Open, and Save As dialog boxes.
If MS_DESIGNFILTER is not defined,
the default filter is “*.dgn”.
MS_DGNOUT Directory containing DGN files created
as a result of “on the fly” translation
from other file formats.
MS_DISALLOWRELATIVEREFPATH When set to 1, you cannot save a relative
path for a reference. The Save Relative
Path check box is removed from the
Attach Reference dialog box.
MS_DWGINSERTLAYER Specifies the layer to which normal
(unshared) cells and reference attachments
are assigned when saving the open DGN
file in DWG format. If this configuration
variable is not defined, layer 0 is used.
MS_DWGOMITUNIQUEEXTENSION If more than one file with the same name is
present in the same directory, appends the
extension to the output filename when saving
the file. For details, see “DWG-related
Configuration Variables” in the online Guide
to Using DWG and Other Formats.
MS_DWGPATFILE Filename containing AutoCAD Pattern
Definitions.
MS_DWGREF_ALLOWMASTER- Defines how MicroStation uses color tables
COLORS for DWG/DXF files attached as references.
For details, see “DWG-related Configuration
Variables” in the online Guide to Using
DWG and Other Formats.
MicroStation Administrator Guide 2–45
Workspace Configuration
User configuration variables
Variable Description
MS_DWGSYSTEMDATA Identifies the directory containing the DWG
settings file “Dwgsettings.rsc.” Overrides the
directory specified by MS_DWGDATA.
The display and plotting color
tables (“DwgDisplayColor.tbl” and
“DwgPlotColors.tbl”) can also be controlled
by placing them in this directory.
MS_GUIHAND Identifies auxiliary handlers.
MS_HELPLOAD_APPLICATION Determines which application help is based
on. Current options are HTMLHelp (default),
or StaticWeb. StaticWeb refers to static
HTML pages on a website.
MS_HELPLOAD_SERVER Specifies the root location of
the help content. Defaults to
$(USTN_DOCUMENTATIONROOT),
but can be set to a file server or URL.
This variable does not determine if
you are using uncompiled HTMLHelp
content. If you set this variable, the value
of MS_HELPLOAD_SERVER should
be the location containing the product
directory (i.e., MicroStation)
MS_HELPPATH Path to help resource files.
MS_INGRFILE_REGISTRATION User defined.
Sets File Georeference priority over
attachment location for Intergraph raster
formats, essentially CIT, C29, C30, C31,
COT, RLE, TG4 and RGB raster formats.
If undefined or set to 0, there is no effect.
If set to 1, enables File Georeference
priority for rasters.
MS_INITAPPS List of initial start-up MDL applications.
MS_OLDUSERLICENSE File that contains old user license
information. Required for when installing
a product upgrade.
MS_OPENDESIGNFILEFILTER Initial file filter list for the MicroStation
Manager and Open dialog boxes.
2–46 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Variable Description
MS_OPENREFFILEFILTER Initial file filter for the Attach Reference
File dialog box.
MS_ORACLEPREFETCH Specifies the number of rows pre-fetched
from the database, maximum 65535. For
example if MS_ORACLEPREFETCH
is set to 1000, there will be 1000 rows
of data returned to the client and cached.
If this configuration variable is not
set, one row is pre-fetched. Setting
MS_ORACLEPREFETCH can result
in improved query performance over
high latency networks, such as Wide
Area Networks (WANs).
MS_PLOTBORDER_TIME_FORMAT Changes the date and time format for
printed outputs from Windows Regional
Settings to another format. Set to v7.0
to use the v7.0 format.
For a detailed list of formatting strings for
date and time, see Data and Time Format.
MS_PLT_NORASTERTRANSPARENCY User defined.
If defined, disables raster transparency
settings when generating print files with
drivers that do not support transparency
(mainly postscript drivers). This prevents
inflating the size of printed output, thus
improving printing speeds.
MS_PLTMODELNAME Displays the name of the model from
which the print is produced.
MS_RASTER_ INTERACTIVE_MODIFY If undefined or set to any value other than 1,
will not enter the Raster Modify command
after interactively attaching a raster.
If defined and set to 1, enters the Raster
Modify command after interactively
attaching a raster.
MicroStation Administrator Guide 2–47
Workspace Configuration
User configuration variables
Variable Description
MS_RASTER_1BIT_WORKMODE If set to 1, harmonizes monochrome
raster display so they are handled like
Raster Reference attachments (Raster
Reference was the default module provided
with MicroStation/J that handled raster
display, previous to Raster Manager
for MicroStation v8).
If undefined or set to 0, has no effect.
MS_RASTER_DEFAULTSCALE If defined and set to 1, a raster without
georeference which is attached without
the use of the “Place interactively” toggle
has the following scale assigned:
scale factor = MS_RASTER_DE-
FAULTSCALE
The pixel size is deduced from the
scale factor and dpi.
If undefined, a raster without georeference
which is attached without the use of
the “Place interactively” toggle has the
following scale assigned:
1 pixel = 1 sub-unit. The scale factor is
deduced from pixel size and dpi.
If defined and set to any other
value, the value is invalid and
MS_RASTER_DEFAULTSCALE is
ignored (same behavior as undefined).
MS_RASTER_DEFAULTSISTER If set to 0 or 1, the default sister
file will be HGR.
If set to 2, the default sister file will
be WorldFile.
2–48 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Variable Description
MS_RASTER_EPSGTABLE_PATH User defined.
Enables geotiff positioning using the
location parameters found in ASCII
files provided on request.
The required ASCII files are:
• “CoordSysData.txt”
• “ProjectionData.txt”
• “UnitsData.txt”
If undefined or set to 0, hard coded tables
are used for Geotiff positioning.
If set to 1, ASCII files are used for
Geotiff positioning.
MS_RASTER_NO_DETACH_CONFIRM If defined and set to 0, display an alert dialog
asking to confirm the raster detachment(s).
If undefined or set to 1, do not display
an alert dialog asking to confirm the
raster detachment(s).
MS_RASTER_NOSHARING User defined.
Manages the automatic creation of
.sharing.tmp files required for the concurrent
access of the same raster file by various
instances of the MicroStation application.
If undefined or set to 0, .sharing.tmp
files are always generated.
If set to 1, .sharing.tmp file generation
is disabled.
MS_RASTER_OPTIONAL_HTTPPORT This variable allows to add another port.
For example, if the variable is set to
"MS_RASTER_OPTIONAL_HTTP-
PORT_8085", Raster Manager will try this
port first. If it is not successful, Raster
Manager will try the default port.
MicroStation Administrator Guide 2–49
Workspace Configuration
User configuration variables
Variable Description
MS_RASTER_SAVEAUTO Enables Raster Manager Automatic Save
mode, which means the user will not be
prompted to update rasters for changes made
to the location info of the file when closing
the DGN or when detaching the raster.
If undefined or set to 0, SaveAuto is disabled.
If set to 1, SaveAuto is enabled.
MS_RASTER_TIFFINVERT If defined and set to a value other than 0,
inverts the foreground/background color
allocation of monochrome tiff files as
soon as the raster is attached.
MS_REFCOLORTABLE If defined and set to 1, MicroStation
always uses the reference’s color table. If
defined and set to any value other than 1,
MicroStation never uses the reference’s color
table. If not defined, MicroStation uses the
user preference to determine whether or not
to use the reference’s color table.
MS_REF_CYCLECHECK If set to 0, MicroStation skips the circular
reference check for DGN files. This variable
does not affect DWG files.
MS_RIGHTLOGICKB If set to 1, keyboard input is right to left.
MS_RSRC Main MicroStation resource file. Typically
set to “ustation.rsc.”
MS_SESSION_DEBUG Used to start session debug prior to the
loading of the database server. By setting
this configuration variable, you can receive
immediate debug information from the
consumer DLL. MS_SESSION_DEBUG
can be used with all the database servers.
A value of 1 enables receipt of debug
information from the database server and the
corresponding DLL — ORACLE, ODBC,
or OLEDB. A value of 0 enables receipt of
debug information only from the DLL.
2–50 MicroStation Administrator Guide
Workspace Configuration
User configuration variables
Variable Description
MS_TEXT_AUTOSTACKFRAC- Sets the alignment for stacked fractions,
TIONS_ALIGNMENT when the Fractions advanced text style
setting is on. Values are:
1 = Top
2 = Center (Normal for DWG files. The
default if the configuration variable
is not defined.)
3 = Bottom
MS_TEXT_AUTOSTACKFRAC- Sets the type for stacked fractions,
TIONS_TYPE when the Fractions advanced text style
setting is on. Values are:
1 = Normal
2 = Diagonal (Normal for DWG files. The
default if the configuration variable
is not defined.)
Normal Center
MS_TEXT_STACKFRACTIONS_SCALE The value is the percentage scale factor for
stacked fractions. (70 is normal for DWG
files, and is the default if this configuration
variable is not defined.)
MS_THUMBNAIL Stores a thumbnail image in each DGN file
that can be seen in the MicroStation file
open dialog boxes, as well as Windows
Explorer. Can be used to control the
behavior of thumbnail generation.
MS_USERPREF User preference resource file.
MS_USERPREF_APPS Set by application configuration files to add
user preferences to standard dialogs.
MS_VBAV8TOV7DIALOG Specifies the name of a VBA macro that
opens a dialog to collect information
to be used in translating a DGN file
from V8 to V7 format.
MS_VBAV8TOV7FILTER Specifies the name of a VBA macro that
sets up a translation filter.
PZIP_OUT Specifies default directory for creation
of Packager files.
MicroStation Administrator Guide 2–51
Workspace Configuration
Using configuration variables in key-ins
Using configuration variables in key-ins
As an alternative to using the Configuration dialog box (Workspace >
Configuration), you can define a configuration variable from the Key-in window
using the key-in EXPAND SET. For example, to create a configuration variable
MYFILE having as its value the name of the open DGN file, key in EXPAND SET
MYFILE = $(_dgnfile) — note that there must be a space both before and after =.
You can also use configuration variables as parameters in key-ins. For example,
to create a cell whose name is the name of the open DGN file (without the
extension), key in $ CREATE CELL $(basename(_dgnfile)). In this example
the first $ is an alias for the key-in EXPAND KEYIN. In other words, the key-in
EXPAND KEYIN CREATE CELL $(basename(_dgnfile)) is equivalent.
The second $ indicates what follows in parentheses is a configuration variable.
To check the value of a configuration variable, key in EXPAND ECHO
$(<configuration_variable>) — for example, EXPAND ECHO
$(MS_DESIGNSEED). The value is displayed in Message Center.
User Interface Modification Files
Customizations of MicroStation’s user interface are stored in user interface
modification files. In the sample workspaces provided with MicroStation, the
user interface modification files are grouped in the various subdirectories under
Bentley’s “Workspace\interfaces\MicroStation” directory. When you choose a
user interface in the MicroStation Manager dialog box, you are specifying a
directory from which all user interface modification files are read.
Each time you modify the user interface, a user interface
modification file is created.
If the part of the interface modified is part of MicroStation’s core, then
the filename of the user interface modification file created is “ustn.” If
the tool box or dialog box modified is provided by an MDL application,
the filename of the user interface modification file is the filename of the
MDL application. Examples of filenames of MDL applications that provide
parts of the user interface are “igen” and “userpref.”
2–52 MicroStation Administrator Guide
Workspace Configuration
User Preference Files
The suffix of each user modification resource filename is an
“m” followed by a number.
There are three other levels of modification resource files in addition to user
level: project, site, and system. Like user configuration files, each category of
modification resource file has an associated priority and a unique filename suffix.
The table below shows each category, its file suffix, and the associated priority.
Level Filename suffix Priority
User .m01 1 (highest)
Project .p01 2
Site .s01 3
System .r01 4 (lowest)
When you create an interface workspace component, all the modifications you
have made to the default user interface are inherited by the new interface. That is
because MicroStation first processes any user, project, site, and system interface
modification files specific to the new interface before processing any user interface
modification files in Bentley’s “Workspace\interfaces\MicroStation\default”
directory. Where the default modification files are different, the files in the
active user interface’s subdirectory override them.
For information about modifying MicroStation’s user interface (and creating user
interface modification files), see “Customizing the User Interface” on page 3-1.
User Preference Files
When you choose Preferences from the Workspace menu, the settings in
the active user preference file are displayed in the Preferences dialog box.
Generally, user preferences reflect what they are named for, the personal
preferences of a user in operating MicroStation, rather than settings that
are important to maintain across a workgroup.
For information about using the Preferences dialog box, see "Setting User
Preferences" in the User Preferences chapter of the QuickStart Guide.
MicroStation Administrator Guide 2–53
Workspace Configuration
Configuration Variable Files
Configuration Variable Files
MicroStation uses configuration variable files to get values for settings that
vary from system to system and from user to user. From a development
standpoint, MicroStation configuration variables are simply a mechanism
for expanding, or translating, one text string into another.
For example, MicroStation needs to find its main resource file. Rather than
always looking for a file named "ustation.rsc" in a specific directory, it expands
the configuration variable MS_RSRC (defined in the configuration variable file)
to get a filename and location. That way (assuming the configuration variable file
is correct) MicroStation finds the file regardless of its name and location.
Each configuration variable has two parts — its name and its definition.
Variable definitions can be literal strings or combinations of strings
and references to other variables.
When MicroStation needs the value of a variable, it looks in the variables
table (kept in memory) to find the definition. If the variable is found, it then
expands any nested variable references in the definition. If the variable cannot
be found, it then attempts to find a system-level environment variable of the
same name. If a system-level environment variable is defined, MicroStation
uses that value as if it were defined in the variables table.
In the Windows operating system, the system-level environment variables are
defined using the System utility in the Control Panel or the SET command.
The Main Configuration Variable File
The system-level environment variable MS_CONFIG should point to
"mslocal.cfg", which sets installation specific values and then processes
the main configuration variable file:
Level Defined By
System MicroStation
Application Third-party applications
Site System manager
2–54 MicroStation Administrator Guide
Workspace Configuration
Configuration Variable File Syntax
Level Defined By
Project Project manager
User Users
It begins by assigning these configuration variables, which define directories in
which additional configuration variables files may be located: _USTN_SYSTEM,
_USTN_APPL, _USTN_SITE, _USTN_PROJECT, and _USTN_USER.
By default, these _USTN_xxx configuration variables point to subdirectories of
Bentley’s “MicroStation\config” directory. However, they can be overridden
with operating system environment variables with the same names.
The "msconfig.cfg" file processes all of the configuration variable files in each
of the system, application, and site directories, in that order. Within each
directory, it includes all of the configuration variable files (*.cfg) in alphabetical
order. Because the variable files are included in this order, application level
configuration variables can override system-level ones, site level configuration
variables can override application level ones, and so on.
After processing all of those files, the "msconfig.cfg" file includes a single user
configuration variable file. You can designate the name of your user configuration
variable file with the _USTN_USERNAME system-level environment variable.
The project configuration variable file is typically included by reference in the
user configuration variable file as a means of implementing workspaces.
For more detailed information, see the comments in "msconfig.cfg", which
is installed in Bentley’s “MicroStation\config” directory.
Configuration Variable File Syntax
Configuration variable files are text files that consist of a series of lines. Each line
contains a configuration variable name and definition in the following syntax:
<VARIABLENAME> <operator> <new_value> # comment
or a preprocessor directive in this syntax:
%<preprocessor directive>
MicroStation Administrator Guide 2–55
Workspace Configuration
Configuration Variable File Syntax
VARIABLENAME is the name of the configuration variable defined.
Nearly all variable names used by MicroStation begin with “MS_” or
“_USTN_.” Variables whose names begin with an underbar ( _ ) are not
displayed in the Configuration dialog box.
Variable names can contain only alphanumeric characters (A-Z, 0-9) and must
be at least two characters long. Although variable names are not case sensitive,
uppercase letters are used by convention. There is no limit on the length of a
variable name, but as a practical matter it should be kept under 32 characters.
White space (space or tab characters) before and after the variable name is ignored.
Available values for operator are as follows:
Operator Meaning
= Assign new_value to VARIABLENAME.
: Assign new_value to VARIABLENAME only if
that variable does not already exist.
+ Append new_value to current value of
VARIABLENAME. Uses a space as a separator.1
>2 Append directory or file lists defined by new_value
to a variable definition that defines a path. If no current
value for VARIABLENAME exists, this is equivalent to
the = operator. Otherwise, it appends a path separator
character, a semicolon (;), and then new_value.
<3 “Prepend” directory or file lists defined by new_value
(to the beginning of) a variable definition that defines
a path. If no current value for VARIABLENAME
exists, this is equivalent to the = operator. Otherwise,
it prepends new_value followed by a path separator
character, a semicolon (;).
1 This operator could be useful for building a string, but it
should not be used for directory or file lists.
2 This character points towards the end of the existing directory
of file lists, where the new value is added.
3 This character points to the beginning of the existing directory
of file lists, where the new value is added.
Anything after a # on a line is treated as a comment and is ignored.
2–56 MicroStation Administrator Guide
Workspace Configuration
Variable definition references
File path names should be entered using the forward slash (/). Windows
converts all forward slashes (/) in new_value to backslashes (\). Also, all
directory definitions should end with a trailing forward slash.
This is an example of a valid directory definition:
MS_DEF = /network/dgn/
These definitions are not valid:
MS_DEF = /network/dgn #no trailing slash
MS_DEF = \network\dgn\ #backslashes
Variable definition references
A variable definition can contain references to other variables. References
to other variables are made with the following syntax:
Reference Meaning
$(VARIABLEREF) Expand VARIABLEREF when this variable is used.
${VARIABLEREF} Expand to current value of VARIABLEREF.
MicroStation recognizes the following kinds of variable definition references:
Reference Returns
dev() device
dir() directory
devdir() device and directory
parentdir() parent directory
parentdevdir() device and parent directory
basename() filename without extension
filename() filename with extension
ext() file extension
noext() Complete file specification
without extension
first() first path from a list of paths
MicroStation Administrator Guide 2–57
Workspace Configuration
MicroStation-defined variables
Reference Returns
concat() concatenated string
build() constructs a definition from
pieces of variables
For example, consider configuration variable MS_EXAMPLE_FILE with
the definition "d:\Bentley\Workspace\MyProject\3dcells.cel".
• $(dev (MS_EXAMPLE_FILE)) expands to "d: "
• $(parentdir (MS_EXAMPLE_FILE)) expands to
“\Bentley\Workspace”
• $(filename (MS_EXAMPLE_FILE)) expands to "3dcells.cel"
Now consider configuration variable MS_EXAMPLE_PATH with the
definition "d:\cell\mycells\;c:\cell\;g:\mycells\".
• $(first (MS_EXAMPLE_PATH)) expands to "d:\cell\mycells\"
• $(build (“c:”,first (MS_EXAMPLE_PATH),”patterns”,
ext ( (MS_EXAMPLE_FILE)) expands to "c:\cell\mycells\patterns.cel"
MicroStation-defined variables
MicroStation defines one of the following configuration variables to
indicate which software is running:
Variable name Defined when
_MICROSTATION MicroStation is running.
_MSDRAFT Bentley PowerDraft is running.
_MSVIEWRDL Bentley Redline is running.
_PRJREVIEW Project Review is running.
_MS_POWERMAP Bentley PowerMap is running.
2–58 MicroStation Administrator Guide
Workspace Configuration
Preprocessor directives
Preprocessor directives
Preprocessor directives control the way that MicroStation processes
configuration variable files. Preprocessor directives always begin with %.
The following preprocessor directives are available:
Directive Meaning
%include<file- Include (process) another configuration variable
name> file. filename can contain variable references.
In addition, it can contain the wildcard character
(*), in which case all files that satisfy the
wildcard specification are included.
%if <expression> Execute the following lines if expression
is true. Expressions can be composed of
Boolean combinations of:
• defined () - true if variable is defined.
• exists () - true if file exists.
• || - logical OR.
• && - logical AND.
• ! - negate.
• ( ) - grouping.
%else Execute the following lines if the last %if was false.
%elif <expres- Execute the following lines if the last %if was
sion> false and expression is true.
%endif End of conditional block.
%error <string> Print string and exit MicroStation.
%undef <varName> Undefines and deletes the configuration
variable varName. (To keep the variable
defined with a translation of NULL, use
varName = <space>).
%lock <varName> Locks the configuration variable to its current value.
For example, assume the following system-level environment variables
are defined before MicroStation starts:
MicroStation Administrator Guide 2–59
Workspace Configuration
Debugging Variable Definition Files
Variable name Current value
MS_DEF "c:\dgn\"
PROJDIR "\project33\"
When started, MicroStation processes this configuration variable file:
# make sure the project directory is set up
PROJDIR:/noproj/ # if no project is active
# define my DGN file directories
MS_OLDDEF = ${MS_DEF}
%if defined (TRAINING)
MS_DEF = c:/ustation/dgn/
%endif
MS_DEF < f:/usr2/dgn/ # a network drive
PROJDGN : $(PROJDIR)dgn/ # set up accounting
information
ACCNTFILE = $(PROJDIR)accnt.dat
The variables table (stored in memory by MicroStation) contains the
information in the first two columns of the following chart. When
MicroStation expands a variable definition, it will have the value of
the corresponding item in the third column:
Variable name Definition Expands to
MS_DEF "c:/Program Files/Bent- "c:\Program Files\Bent-
ley/Workspace/stan- ley\Workspace\stan-
dards/dgn/" dards\dgn\"
PROJDIR “/project33/” “\project33\”
MS_OLDDEF "c:/dgn/" "c:\dgn\"
PROJDGN “$(PROJDIR)dgn/” “\project33\dgn\”
ACCNTFILE "$(PROJDIR)ac- "\project33\accnt.dat"
cnt.dat"
Debugging Variable Definition Files
To determine whether your configuration variable files are being processed
2–60 MicroStation Administrator Guide
Workspace Configuration
Debugging Variable Definition Files
properly, start MicroStation with the -debug=n command line switch.
• At a command prompt, enter: ustation -debug=n
or append -debug=n to the Target field in the MicroStation program
item’s properties dialog box (Shortcut tab).
where n is a value from 1 to 5.
MicroStation displays the names of all of the configuration variable
files it processes and the names and values for all variable definitions.
Then MicroStation exits.
Use one of the following values for n:
Value of n Type of report
1 Brief report that shows the current string value of each
configuration variable as it is processed.
2 In addition, shows the current translation of each
configuration variable as it is processed.
3 In addition, shows conditional break information
by displaying the line number when each if
preprocessor directive is processed.
4 In addition, prints final translations of all configuration
variables at the end of the report. This is the default setting.
5 In addition, shows final values of all configuration variables
at each level (system, application, site, project, user).
For most purposes, the value 4 (the default setting) gives the most
meaningful report: It shows the values of the configuration variables
as they exist while MicroStation is running.
The information in the report is saved as ASCII text in the file
“msdebug.txt” in to the current directory.
MicroStation Administrator Guide 2–61
2–62 MicroStation Administrator Guide
Customizing the User Interface
Perhaps the most noticeable way of customizing a workspace is to
modify its user interface component. You can customize any or all of
the parts of the active workspace user interface:
1. tool boxes (see page 3-2)
2. pull-down menus (see page 3-15)
3. view control bars — 2D and 3D (see page 3-22)
4 . view control pop-up menu (see page 3-24)
The Workspace Components dialog box is used to select and activate user
interfaces and other types of workspace components.
The following aspects of the MicroStation user interface are not parts of the
workspace user interface, but you can also customize them:
• AccuDraw Keyboard Shortcuts (see page 3-28)
• Function Key Menus (see page 3-30)
It is important to document your user interface customizations, particularly
if you will be sharing the customizations with other users. To help with
this documentation task, MicroStation provides a screen capture utility
(see page 3-32). This utility is useful, in general, for communicating the
software’s appearance and behavior to others.
This chapter also covers digitizing tablet menus (see page 3-36).
MicroStation Administrator Guide 3–1
Customizing the User Interface
Tool Boxes
Tool Boxes
The Customize dialog box (Workspace > Customize) is used to customize tool
boxes — both parent tool boxes (referred to as tool frames in the software) like
the Main tool frame, and other, normal tool boxes. It is also used to customize
menu bars, view borders and interface settings, and to convert palettes.
General Procedure — To customize parent tool frames
1. From the Workspace menu, choose Customize.
The Customize dialog box opens. The following tabs are on the
dialog box: Tool Boxes, Tool Frames, Menu Bar, View Border, View
Pop-up, Interface Settings, Convert Palettes.
2. From the tab menu, choose Tool Frames.
3. From the Edit Tool Frame option menu, select Main.
or
Once the option menu is selected, type the name of the tool frame, Main.
The destination list box lists the child tool boxes in the Main tool frame
(and any tools added during previous customizations).
Customize
dialog box
with the Tool
Frames tab
displayed
4. If you are not customizing the Main tool frame, create a “parent” frame box.
See “To create and open a tool box or tool frame” on page 3-5.
3–2 MicroStation Administrator Guide
Customizing the User Interface
Tool Boxes
5. Make the desired modifications to the tool box:
Modification type
Rearranging child tool boxes (see page 3-8)
Inserting child tool boxes (see page 3-8)
Rearranging tools (see page 3-9)
Inserting tools (see page 3-10)
Modifying tools (see page 3-13)
Most modification procedures are simple drag-and-drop operations.
As you drag the entry for a tool or tool box, a square outline pointer
indicates the tentative position of the entry.
6. Click the Save button.
The tool frame (if not already open, opens and) blinks to indicate
the effect of the modification.
7. Repeat steps 4–6 for each additional parent tool frame you
want to create or modify.
If you created any tool frames, they are listed in the Tool Boxes dialog
box (Tools > Tool Boxes). You can open them using that dialog
box. Also you can identify user-created tool frames by using a bolder
font than appears in the regular tool boxes.
To customize normal tool boxes
1. From the Workspace menu, choose Customize.
The Customize dialog box opens.
2. From the tab menu, choose Tool Boxes (if not already chosen).
MicroStation Administrator Guide 3–3
Customizing the User Interface
Tool Boxes
Customize dialog box
with the Tool Boxes
tab displayed
3. From the Edit Tool Box option menu, select an existing tool box. See “To
select and open an existing tool box for customization” on page 3-5.
or
Once the option menu is selected, type the name of the tool box.
or
Create a tool box. See “To create and open a tool box or
tool frame” on page 3-5.
4. Make the desired modifications to the tool box.
Modification type
Rearranging tools (see page 3-9)
Inserting tools (see page 3-10)
Modifying tools (see page 3-13)
Most modification procedures are simple drag-and-drop operations.
As you drag the entry for a tool, a square outline pointer indicates
the tentative position of the entry.
5. Click the Save button.
The tool box (if not already open, opens) blinks to indicate
the effect of the modification.
6. (Optional) — Repeat steps 4–6 for each additional tool box
you want to create or modify.
If you created any tool boxes, they are listed in the Tool Boxes dialog box
3–4 MicroStation Administrator Guide
Customizing the User Interface
Tool Boxes
(Tools > Tool Boxes). You can open them using that dialog box.
The Customize dialog box lets you choose between a number of techniques for
manipulating the list box entries that represent tools. The following procedures
cover only the most intuitive technique — drag-and-drop.
To select and open an existing tool box for customization
1. From the Edit Tool Box option menu, choose the tool box
you want to customize.
The tools in the selected tool box are listed in the destination list box
in the order that corresponds to their slots in the tool box.
2. From the source list box, select the desired tool.
A triangle under the tool box name in the source list box indicates
that there are tools listed under the tool box name; double-clicking
displays the available tools. The tools are listed in the order that
corresponds to their slots in the tool box.
To restore a delivered tool box or tool frame to its original state
1. From the Tools menu, choose Tool Boxes.
The Tool Boxes dialog box opens.
2. In the list box, select the desired tool box.
3. Click the Restore button.
4. Click the OK button.
To create and open a tool box or tool frame
1. From the Edit Tool Box or Edit Tool Frame option menu, choose
Create Tool Box or Create Tool Frame.
The Create Tool Box or Create Tool Frame dialog box opens.
2. In the Name field, key in a name for the new tool box; this is the text
MicroStation Administrator Guide 3–5
Customizing the User Interface
Tool Boxes
that will appear in the title bar of the tool box.
3. Click the OK button.
In the Customize dialog box, the tool box name is automatically chosen in the
Edit Tool Box or Edit Tool Frame option menu. This means the new tool box
is ready to have tools (or child tool boxes if it is a tool frame) inserted in it.
To import MicroStation Version 5 palettes
1. Create a new user interface.
See “To create a new user interface component”.
2. Exit MicroStation.
3. Locate your MicroStation version 5 modification resource files.
These files are stored in subdirectories whose name matches the
desired user interface. For example, if the user interface you use is
called “Roads,” there will be a subdirectory in the operating system
named “Roads”. By default these subdirectories are located under
the “Workspace\interfaces\MicroStation” directory.
4. From the operating system copy your MicroStation version 5
modification files into the subdirectory that corresponds with the
new interface name you create in step 1.
By default this subdirectory will be located under the
“Workspace\interfaces\MicroStation” directory.
5. Start your current version of MicroStation, and then select from
the MicroStation Manager dialog box Interface option menu the
new user interface you created in step 1.
6. Enter a DGN file as you normally would.
To import MicroStation Version 5 menus
1. Follow steps 1-5 for To import MicroStation Version 5 palettes (see page 3-6).
The MicroStation Version 5 menu displays across the top of the
screen, replacing the current MicroStation menu.
2. Load customize to incorporate the current MicroStation menu items using
3–6 MicroStation Administrator Guide
Customizing the User Interface
Tool Boxes
Workspace > Customize if that portion of the menu is available
or
Use User > Workspace > Modify User Interface if the
Version 5.0 menu is available
or
Key in MDL LOAD CUSTOMIZ;CUSTOMIZ DIALOG if neither
of the previous options are available.
3. In the Customize dialog box, select the Menu bar tab.
The active menu appears in a list box on the right side of the Customize
dialog box and the Version 5.0 menu appears on the left side in a list box.
4. Drag and drop the desired menu items.
To convert a custom palette created with MicroStation
Version 5.0 or earlier to a tool box and open it
1. From the Workspace menu, choose Customize.
The Customize dialog box opens.
2. Select the Convert Palettes tab.
3. In the list box, select the name of the palette you want to convert to a tool box.
4. Turn on the Convert to Tool Box check box. You can also turn
on the Delete Palette Resource check box if you want to delete
the original palette after converting it.
5. Click OK.
After processing, your custom tool boxes will be available
from the Tool Boxes dialog box.
The items in the Convert Palettes tab are identical to those in the Convert
Palettes dialog box (previously accessed by choosing Import Custom
Palette from the Tool Box option button). If no custom palettes exist
in the current user interface, the items are hidden and the “No custom
palettes exist in this interface” message displays.
If you customized one of MicroStation’s delivered palettes, importing it
will not replace the corresponding delivered tool box. If it did you might
accidentally eliminate enhancements and new functionality.
If you created a custom icon in Version 5.0, a tool tip and description is
MicroStation Administrator Guide 3–7
Customizing the User Interface
Rearranging child tool boxes
generated for the icon. If the icon contains a MicroStation command, the
tool tip and description corresponding to that command is used. If the icon
contains a user-defined, key-in string, the tool tip reads the User-defined
tool and the description will be the key-in string.
While MicroStation supports palettes, including Version 5.0 custom palettes,
this palette support does not include docking, resizing, or tool tips.
Rearranging child tool boxes
To move a child tool box from one slot to another
1. In the destination list box (in the Customize dialog box), drag the
entry for the tool box to the desired slot.
The destination slot is determined by the position of the pointer relative
to other entries when you drop the entry by releasing the Data button.
If the pointer is in the top half of an entry, the destination slot is
directly above that entry; if the pointer is in the bottom half of an entry,
the destination slot is directly below that entry.
To delete a child tool box
1. Drag the destination list box entry for the tool off the list box.
or
Select the destination list box entry and click the Remove button.
Inserting child tool boxes
To insert a child tool box
1. In the Customize dialog box, select the Tool Boxes tab and
turn on List Tools By Tool Box.
The source list box lists all MicroStation and custom tool
boxes in alphabetical order.
2. Drag the entry for the tool from the source list box to the desired
3–8 MicroStation Administrator Guide
Customizing the User Interface
Expanding menus
slot in the destination list box.
Expanding menus
To expand/contract the source (Available Tools From) list box
1. Double-click anywhere in a highlight bar that contains a
triangle below the tool name.
A triangle indicates that there is a list that can roll up or down.
Rearranging tools
To move a tool from one slot to another
1. Drag the tool to the desired slot.
The destination slot is determined by the position of the pointer relative
to other entries when you drop the entry (release the Data button). If
the pointer is in the top half of an entry, the destination slot is directly
above that entry; if the pointer is in the bottom half of an entry, the
destination slot is directly below that entry.
To delete a tool
1. Drag the destination list box entry for the tool off the list box.
or
Select the destination list box entry for the tool and click the Remove button.
The above procedures also apply to view controls (see “View
Control Bars” on page 3-22).
MicroStation Administrator Guide 3–9
Customizing the User Interface
Inserting tools
Inserting tools
To insert an existing tool
1. In the Customize dialog box, select the Tool Boxes tab and
turn on List Tools Alphabetically.
The source list box lists all MicroStation tools in alphabetical order.
2. Drag the entry for the tool from the source list box to the desired
slot in the destination list box.
Alternative method — To insert an existing tool
1. In the Customize tool box, select the Tool Boxes tab and turn
on List Tools By Tool Box.
The source list box lists all MicroStation and custom tool
boxes in alphabetical order.
2. Double-click the source list box entry for the tool box that
contains the desired tool.
The source list box lists the member tools immediately below
the list box entry for the tool box.
3. Drag the entry for the tool from the source list box to the desired
slot in the destination list box.
Only the drag-and-drop portion of the procedure applies to view controls.
The above procedure also applies to view controls (see “View Control Bars”
on page 3-22). View controls cannot be modified, however.
To create and insert a tool
1. In the destination list box, select the entry for the tool before
which you want to insert the new tool.
2. Click the Insert button.
The Insert Tool dialog box opens. The pixel grid is the canvas
3–10 MicroStation Administrator Guide
Customizing the User Interface
Inserting tools
on which you will draw the icon.
3. In the dialog box’s Options menu, turn on Draw Both Icons.
4. To draw a single-color icon, choose Mono Colors from the option
menu underneath the tool palette.
or
To draw a multi-color icon, choose Fixed Colors from the option menu.
5. Draw the tool icon using the graphical tools in the tool palette to the left of
the pixel grid and the color palette to the right. To draw in the background
color (gray), turn off Use Foreground Color in the Options menu.
6. Make sure Parse key-in into MicroStation command is on.
7. In the Tool Tip field, key in the Tool Tip text for the tool.
8. In the Description field, key in the text for the tool’s status bar description.
9. In the Key-in field, key in the action string (see page 3-40) to
be associated with the tool. If a multiple key-in action string is
specified, the key-ins must be separated by semicolons (;) — for
example, co=red;wt=2;lv=3;place smartline.
10. Click the OK button.
MicroStation Administrator Guide 3–11
Customizing the User Interface
Inserting tools
If you make a mistake while drawing the icon and want to start over,
click the Reset button in the Insert Tool dialog box.
To use a drawing tool
1. Select a drawing tool from the Tool palette.
2. Position the pointer where you want to begin drawing.
3. Drag the pointer in any direction while holding down the Data button. This
extends a line or shape, depending on the tool you have selected.
4. Release the Data button when the object is displayed with the
size and shape you desire.
To move a contiguous section of the icon
1. Select the Selection tool from the Tool palette.
2. Drag a selection rectangle around the section you want to move.
3. Position the pointer in the selection rectangle.
4. Drag the section to its destination.
To clear (apply the background color to) a contiguous
section of the icon
1. Select the Selection tool from the Tool palette.
2. Drag a selection rectangle around the section you want to clear.
3. From the Edit menu, choose Clear.
3–12 MicroStation Administrator Guide
Customizing the User Interface
Modifying tools
To clear the entire pixel grid
1. From the Edit menu, choose Clear All.
or
Click the Reset button.
Modifying tools
You can:
• Modify a tool icon’s graphical label. An icon is composed of
dots called pixels. Each icon has a small version (23×23 pixels)
and a large version (31×31 pixels).
• Change the tool’s description as it appears in the status bar, tool tip text, or
associated key-in. The Key-in value must be an action string (see page
3-40). Both single and multiple key-in action strings are valid.
By modifying existing tools, you can in effect create power tools — tools
that start multiple key-in action strings. For example, a power tool for
drawing electrical wiring might do the following:
ACTIVE COLOR=red;ACTIVE WEIGHT=2;ACTIVE
LEVEL=elec;PLACE SMARTLINE
This tool would set the Active Color to red, set the Active Line Weight to 2,
set the Active Level to elec(trical), and select the Place SmartLine tool. You
might want to modify the Tool Tip text to read “Place Wiring.”
General Procedure — To modify a tool
1. In the destination list box, select the entry for the tool and
click the Modify button.
or
In the destination list box, double-click the entry for the tool.
The Insert Tool dialog box opens. The pixel grid shows a magnified
representation of the icon. The tool’s Tool Tip text is shown in
the Tool Tip field. The tool’s status bar description is shown in
the Description field. The action string (see page 3-40) associated
MicroStation Administrator Guide 3–13
Customizing the User Interface
Modifying tools
with the tool is shown in the Key-in field.
Insert Tool
dialog box
with tool icon
displayed
2. Use the controls in the dialog box to modify the tool.
To modify the icon (foreground) color, select the desired
color in the color palette.
To modify the tool icon, use the graphical tools in the tool palette to the left
of the pixel grid. See “To create and insert a tool” on page 3-10.
If the small version of the icon is in the pixel grid and you want to modify
the large version, or vice-versa, click the corresponding button, on which
the icon is displayed at its actual size, to the left of the pixel grid.
To modify the Tool Tip text, key in the text in the Tool Tip field.
To modify the status bar description, key in the text in the Description field.
To modify the action string (see page 3-40) associated with the tool,
key in the new action string in the Key-in field. If a multiple key-in
action string is specified, the key-ins must be separated by semicolons
(;) — for example, co=red;wt=2;lv=3;place smartline.
3–14 MicroStation Administrator Guide
Customizing the User Interface
Pull-Down Menus
3. When done, click the OK button.
If you make a mistake while modifying the tool and want to start over,
click the Reset button in the Insert Tool dialog box.
Pull-Down Menus
The Customize dialog box (Workspace > Customize) is used to customize
the main menu bar and its member menus.
General Procedure — To Customize the Main Menu Bar
1. From the Workspace menu, choose Customize.
The Customize dialog box opens. The following tabs are on the
dialog box: Tool Boxes, Tool Frames, Menu Bar, View Border, View
Pop-up, Interface Settings, Convert Palettes.
2. From the tab menu, choose Menu Bar.
The source (Available Menus From) and destination (Edit Menu Bar)
list boxes show the names of the tools in the menu bar. (The destination
list box is used only for inserting menus and menu items.)
Customize
dialog box with
the Menu Bar
tab displayed
3. Double-clicking anywhere on a row with a menu or submenu will
expand/collapse the menu. It is not necessary to click precisely on the arrow.
MicroStation Administrator Guide 3–15
Customizing the User Interface
Rearranging menus
4. Make the desired modifications to the menu bar (repeat step 3 as necessary).
Modification type
Rearranging menus (see page 3-16)
Modifying menus (see page 3-18)
Inserting menus and menu items (see page 3-21)
Most modification procedures are simple “drag-and-drop” operations.
As you drag the entry for a menu or menu item, a rectangular outline
pointer indicates the tentative position of the entry.
5. Click the Save button.
The menu bar blinks to indicate the effect of the modification.
The Customize dialog box lets you choose between a number of techniques for
manipulating the list box entries that represent menus and menu items. The
following procedures cover only the most intuitive technique — drag-and-drop.
Separator bars, the horizontal lines that serve as logical subdivisions within
menus, are themselves menu items. In the list boxes in the Customize
dialog box, a dot indicates a separator bar.
To restore the main menu bar to its as-delivered state
1. With the Customize dialog box open, key in CUSTOMIZ RESTORE
MENUBAR in the Key-in window.
An alert box opens to confirm the request.
2. Click the Yes button.
Rearranging menus
To move the location of a menu on the menu bar
1. In the source list box, drag the entry for the menu to the desired slot.
The destination slot is determined by the position of the pointer
relative to other entries when you drop the entry and release the Data
button. If the pointer is in the top half of an entry, the destination slot
3–16 MicroStation Administrator Guide
Customizing the User Interface
Rearranging menus
is directly above that entry; if the pointer is in the bottom half of an
entry, the destination slot is directly below that entry.
2. If you move a top level menu to a slot inside another menu, the
moved menu becomes a submenu.
To move a menu item to a different location in the
same menu or to a different menu
1. In the destination list box, drag the entry for the menu item to the desired slot.
If you move a menu item with an attached submenu to a slot directly
before a top level menu, the submenu becomes a menu.
If you move a menu item with no submenu to a slot directly before a top
level menu, the item is inserted as the first item in that menu. The remaining
items are automatically listed if they were not previously.
Some standard MicroStation menu items should not be moved to other
menus as they may no longer exhibit their unique behavior. For example,
if Undo is moved from the Edit menu, it will no longer display the action
that is eligible for negation (for example, Undo place smartline). It will
also always be enabled or disabled, as specified in the Modify Menu Item
dialog box, regardless of the state of the undo buffer.
To delete a menu from the menu bar
1. Drag the destination list box entry for the menu off the list box.
or
In the destination list box, select the entry for the menu and
click the Remove button.
To delete a menu item
1. Drag the destination list box entry for the menu item off the list box.
or
In the destination list box, select the entry for the menu item
MicroStation Administrator Guide 3–17
Customizing the User Interface
Modifying menus
and click the Remove button.
If the menu item is a submenu, deleting the item also deletes the submenu entries.
Modifying menus
You can:
• Modify a menu’s name
• Modify a menu item’s name
• Enable or disable a menu item
• Attach or detach a submenu
• Modify the action string (see page 3-40) associated with a menu item
You can create menu items that start multiple key-in action strings. For example,
a menu item, Wiring, for drawing electrical wiring might do the following:
ACTIVE COLOR=red;ACTIVE WEIGHT=2; ACTIVE
LEVEL=3;PLACE SMARTLINE
This menu item, would set the Active Color to red, set the Active Line Weight to
2, set the Active Level to 3, and select the Place SmartLine tool.
To modify a menu’s name
1. In the destination list box, select a menu item and then click the Modify
button to modify a menu name. This is necessary since double-clicking
3–18 MicroStation Administrator Guide
Customizing the User Interface
Modifying menus
the menu item name expands the submenu if one exists.
The Modify Menu dialog box opens.
2. In the Label field, type the new name. Insert the tilde character (~)
immediately before the character that will be the mnemonic access
character — for example, E~lement for Element.
3. Click the OK button.
To modify a menu item
1. In the destination list box, double-click the entry for the item.
The Modify Menu Item dialog box opens.
2. Use the controls in the Modify Menu Item dialog box to make
the desired modifications.
To modify the name, type the new name in the Label field. Insert
the tilde character (~) immediately before the character that will
be the mnemonic access character.
To enable or disable the item in the menu, turn Enabled on or off.
To modify the action string (see page 3-40) associated with the item,
MicroStation Administrator Guide 3–19
Customizing the User Interface
Modifying menus
type the new action string in the Key-in field.
To attach a submenu to the item, turn on SubMenu Attached. To detach
a submenu from the item, turn off SubMenu Attached.
To assign or modify the keyboard accelerator, select Control alone
or with Alt or Shift to indicate the modifier key(s) and type the
accelerator key in the Accelerator field.
3. When done, click the OK button.
The following are important to remember when modifying a menu item.
• Any label that dynamically changes — for example, Show Clipboard,
Hide Clipboard — is always set by MicroStation. The name of such
an item can be changed, but the label may not reflect the change
when the menu bar is loaded for use.
• MicroStation controls the enabled state of some menu items — for example,
Cut, Copy, and Paste. The setting for such an item can be changed, but the
item may not reflect the change when the menu bar is loaded for use.
To attach a tool box to a menu item
1. From the destination list box, expand the selection by
double-clicking any menu.
2. Select an individual item and click Insert (or Modify).
The Insert Menu Item dialog box opens.
3. Click Attach Tool Box.
The Select Tool Box dialog box opens.
3–20 MicroStation Administrator Guide
Customizing the User Interface
Inserting menus and menu items
4. Select the desired tool box and click OK to attach.
Inserting menus and menu items
To insert a new menu in the menu bar
1. In the destination list box, select the entry for the existing menu
before which you want to insert the new menu.
2. Click the Insert button.
The Insert Menu dialog box opens.
3. In the Label field, type the menu name. Insert the tilde character (~)
immediately before the character that will be the mnemonic access
character — for example, E~lement for Element.
4. Click the OK button.
To insert a new menu item
1. In the destination list box, select the entry for the existing menu item
MicroStation Administrator Guide 3–21
Customizing the User Interface
View Control Bars
before which you want to insert the new menu item.
2. Click the Insert button.
The Insert Menu Item dialog box opens.
3. Use the controls in the Modify Menu Item dialog box.
Type the item name in the Label field. Insert the tilde character (“~”)
immediately before the character that will be the mnemonic access character.
To enable or disable the item in the menu, turn Enabled on or off.
In the Key-in field, type the action string (see page 3-40) you
want to associate with the item.
(Optional) To assign a keyboard accelerator, select Control alone
or with Alt or Shift to indicate the modifier key(s) and type the
accelerator key in the Accelerator field.
4. When done, click the OK button.
For more information about specifying menu items, see “To modify
a menu item” on page 3-19.
View Control Bars
The Customize dialog box (Workspace > Customize) is used to customize the
view control bars in view window borders. The default contents of the view
control bars vary depending on whether the active DGN file is 2D or 3D.
3–22 MicroStation Administrator Guide
Customizing the User Interface
View Control Bars
General Procedure — To Customize View Control Bars
1. From the Workspace menu, choose Customize.
The Customize dialog box opens. The following tabs are on the
dialog box: Tool Boxes, Tool Frames, Menu Bar, View Border, View
Pop-up, Interface Settings, Convert Palettes.
2. From the tab menu, choose View Border (if not already chosen).
Customize dialog box
with the View Border
tab displayed
3. From the Edit View Border option menu, choose 2D View Border (for
2D design files) or 3D View Border (for 3D design files).
4. Make the desired modifications to the view control bar.
Modification type
Rearranging view controls (see “Rearranging tools” on page 3-9)
Inserting view controls (see “Inserting tools” on page 3-10)
These modification procedures are simple drag-and-drop operations.
As you drag the entry for a view control, a square outline pointer
indicates the tentative position of the entry.
5. Click the Save button.
If the active DGN file has the same dimensionality (2D or 3D) of the
newly modified view control bar, the view control bars in open windows
blink to indicate the effect of the modification.
6. Repeat steps 3–5 to modify the other type of view control bar (3D or 2D).
The Customize dialog box lets you choose between a number of techniques for
MicroStation Administrator Guide 3–23
Customizing the User Interface
View Control Pop-up Menu
manipulating the list box entries that represent tools. The following procedures
cover only the most intuitive technique — “drag-and-drop.”
To restore a view control bar(s) to its as-delivered state
1. With the Customize dialog box open, enter the appropriate
key-in in the Key-in window:
To restore Key in
View control bar CUSTOMIZ RESTORE VIEWTOOLS 2D
— 2D designs
View control bar CUSTOMIZ RESTORE VIEWTOOLS 3D
— 3D designs
View control bar CUSTOMIZ RESTORE VIEWTOOLS BOTH
— all designs
An alert box opens to confirm the request.
2. Click the Yes button.
View Control Pop-up Menu
The Customize dialog box (Workspace > Customize) is used to
customize the view control pop-up menu in view windows. The default
contents of the view control pop-up menu are:
• Reset
• Quickset Save
• Quickset Recall
• Displayset
• Update View
• Fit Active Design
• Window Area
3–24 MicroStation Administrator Guide
Customizing the User Interface
View Control Pop-up Menu
• Window Center
• Zoom In
• Zoom Out
• Previous
Customizing the view control bar allows you to rearrange or remove
view controls. However, customizing the view control pop-up menu is
analogous to customizing pull-down menus. You can:
• Modify a submenu item’s name
• Enable or disable a menu item
• Attach or detach a submenu
• Modify the action string (see page 3-40) associated with a menu item.
To customize the view control pop-up menu
1. From the Workspace menu, choose Customize.
The Customize dialog box opens. The following tabs are on the
dialog box: Tool Boxes, Tool Frames, Menu Bar, View Border, View
Pop-up, Interface Settings, Convert Palettes.
2. From the tab menu, choose View Pop-up.
The source (Available Menus From) and destination list boxes show the
names of the tools in the view control pop-up menu. (The destination list
MicroStation Administrator Guide 3–25
Customizing the User Interface
View Control Pop-up Menu
box is used only for inserting and rearranging menus and menu items.)
Customize
dialog box
with the View
Pop-up tab
displayed
3. Make the desired modifications to the view control pop-up
menu (repeat step 3 as necessary).
Most modification procedures are simple drag-and-drop operations.
As you drag the entry for a menu or menu item, a rectangular outline
pointer indicates the tentative position of the entry.
4. Click the Save button.
The menu bar blinks to indicate the effect of the modification.
To restore the view control pop-up menu to its
as-delivered state
1. With the Customize dialog box open, key in CUSTOMIZ RESTORE
VIEWPOPUP in the Key-in window.
An alert box opens to confirm the request.
2. Click the Yes button.
To rearrange or delete an item from the view control pop-up menu, see
Rearranging menus (see page 3-16) . To modify the menu or attach or detach
a submenu, see Modifying menus (see page 3-18).
3–26 MicroStation Administrator Guide
Customizing the User Interface
User Interface Settings
User Interface Settings
This feature allows you assign an identifier to a set of modifications to the
user interface. This identifier behaves like a comment.
To save a set of customizations
1. From the Workspace menu, choose Customize.
The Customize dialog box opens. The following tabs are on the
dialog box: Tool Boxes, Tool Frames, Menu Bar, View Border, View
Pop-up, Interface Settings, Convert Palettes.
2. From the tab menu, choose Interface Settings.
Customize dialog
box with the
Interface Settings tab
displayed
3. Enter a description for the User Interface Settings.
4. Click Save to store the description.
This description can be read in the About Workspace window (Workspace
MicroStation Administrator Guide 3–27
Customizing the User Interface
AccuDraw Keyboard Shortcuts
> About Workspace) to the right of the User Interface field.
AccuDraw Keyboard Shortcuts
You can customize AccuDraw keyboard shortcuts using the
AccuDraw Shortcuts window.
To open the AccuDraw Shortcuts window
1. With the focus in the AccuDraw window, press the 〈?〉 key.
3–28 MicroStation Administrator Guide
Customizing the User Interface
AccuDraw Keyboard Shortcuts
Alternative method — To open the AccuDraw Shortcuts window
1. From the Settings menu, choose AccuDraw.
The AccuDraw Settings dialog box opens.
2. Click the Shortcut Key-ins button.
To edit a keyboard shortcut
1. In the list box, select the shortcut to edit.
2. In the AccuDraw Shortcuts window, click the Edit button.
The Edit Shortcut dialog box opens.
3. Make the desired changes — you can change the shortcut key, the
Description, or the MicroStation command entry.
4. Click the OK button.
To create a keyboard shortcut
1. In the AccuDraw Shortcuts window, click the New button.
The New Shortcut dialog box opens.
2. Key in the shortcut key, Description, and the MicroStation
key-in to be simulated.
3. Click the OK button.
AccuDraw keyboard shortcuts are stored in a text file so they can be edited
using any word processor or text editor as well as by using the AccuDraw
Shortcuts window. The configuration variable AccuDraw Shortcuts
(MS_ACCUDRAWKEYS) in the Operation category of the Configuration
dialog box identifies the name and location of the shortcuts file. In the “as
delivered” Default workspace, the configuration variable points to the file
shortcut.txt in Bentley’s “Workspace\system\data” directory.
Manually editing the shortcuts file is the only way to delete a shortcut, identify
a shortcut as 2D or 3D only, or rearrange the ordering of the shortcuts.
MicroStation Administrator Guide 3–29
Customizing the User Interface
Function Key Menus
Function Key Menus
A function key menu is a file that contains keyboard function key definitions
— assignments of actions to function keys. Function key definitions are action
strings (see page 3-40) as in other types of user-definable menus.
The default function key menu in the Default workspace is funckey.mnu,
which is installed in Bentley’s “Workspace\interfaces\fkeys” directory.
The Function Keys dialog box (Workspace > Function Keys) is
used to modify function key menus.
Definitions can also be created for pressing the function keys along
with the modifier keys 〈Ctrl〉, 〈Alt〉, and 〈Shift〉.
Creating function key definitions for function key combinations that have special
meaning in MicroStation, such as 〈F1〉 (Help), is not recommended.
To modify function key definitions
1. From the Workspace menu, choose Function Keys.
The Function Keys dialog box opens. The title bar identifies
3–30 MicroStation Administrator Guide
Customizing the User Interface
Function Key Menus
the open function key menu.
2. Select a function key in the list box.
or
In the Shortcut Keys section, turn on Ctrl, Alt, and/or Shift and choose
the desired function key from the Key option menu.
or
Press the desired function key and any modifiers.
3. Click the Edit button.
The Edit Key Definition dialog box opens.
4. In the New field, edit the definition. The definition must be specified as an
action string (see page 3-40). If you select a previous key-in in the Key-in
MicroStation Administrator Guide 3–31
Customizing the User Interface
Capturing MicroStation Screen Images
History list box, that key-in replaces whatever text is in the New field.
5. (Optional) — To modify more function key definitions, repeat steps 2–4.
6. (Optional) — To save the function key definitions in the open function
key menu, choose Save or Save As from the dialog box’s File menu. If
you choose Save, the open function key menu is overwritten. If you
choose Save As, the Save Function Key As dialog box opens for creating a
function key menu with a different name or location.
7. In the Function Keys dialog box, click the OK button. If the definitions
were not saved (step 6), an alert box opens. If you do not save the
definitions at this point, they will remain in effect only for the remainder
of the session unless saved before the session ends.
Another function key menu can be opened from within a function key menu.
The action string (see page 3-40) must include the MicroStation key-in for
opening a function key menu: MENUATTACH MENU <file_spec>, FK. This
capability lets you create a series of related function key menus that reference
each other. (The alternate key-in for ATTACH MENU is AM=.)
Capturing MicroStation Screen Images
The Screen Capture utility (scrncapt.ma) makes a “screen shot” of all or part of
a MicroStation screen and saves it in a specified file format. Using Screen
Capture, you can take snapshots of items that are in the graphical user interface
of MicroStation or an MDL application, such as tool boxes, dialog boxes, and
pull-down menus, and then use them in documentation or training manuals.
Screen Capture saves an image as it appears on screen, at the resolution
of your monitor, and without the screen pointer.
Keep these considerations in mind:
• Using certain word processing or page layout software with
certain printers may not produce a high quality printed image of
grayscale information in a screen shot.
• In many screen shots, elements lose detail. To reproduce detailed
linework, you should plot the view as either an Encapsulated PostScript
3–32 MicroStation Administrator Guide
Customizing the User Interface
Capturing MicroStation Screen Images
(EPS) or a HPGL plotfile, depending on the format that works
best with your software and hardware.
• Using the Screen Capture utility, the quality of rendered images depends
on the resolution of your monitor and the number of colors it supports.
Regardless of your display hardware, you can create 24-bit files at a specified
resolution by choosing Utilities > Image > Save…. If you use a high
resolution output device, a higher quality printed image is possible.
General Procedure — To Capture Part or All of a Screen
1. Configure the display as desired.
2. Key in MDL LOAD SCRNCAPT.
This key in is recommended for capturing the entire display.
3. Using the following information, specify the part of the screen to capture.
To capture (see for Key-in Button in dialog
details) box
To capture the entire CAPTURE SCREEN Capture Screen
screen (see page
3-34)
To capture a CAPTURE.RECTANGLE Capture
rectangular area Rectangle
inside a view (see
page 3-35)
To capture a view’s CAPTURE VIEW Capture View
contents (see page CONTENTS
3-35)
To capture a view’s CAPTURE VIEW Capture View
contents and border WINDOW Window
(see page 3-35)
To capture the CAPTURE SCREEN None
entire screen with
a pull-down menu
(see page 3-36)
To capture the CAPTURE FOCUS None
window that has
the input focus (see
page 3-36)
MicroStation Administrator Guide 3–33
Customizing the User Interface
Capturing MicroStation Screen Images
4. Follow the prompts in the status bar.
These prompts change dynamically depending on the action
taken in the previous step.
The Capture Screen Output dialog box opens.
5. From the Format Type option menu, choose the desired output format.
If you choose an item other than the default, the default suffix for the image
file in the Files field changes to be consistent with the chosen file type.
6. From the Compression option menu, choose the desired compression
level for the screen capture.
7. If the selected format supports more than one mode, choose the
desired mode from the Mode option menu .
8. In the Files field, key in a name for the image file.
9. Click OK.
While the image is saving, an animated character appears in the status bar.
To capture the entire screen
1. In the Screen Capture dialog box, click the Capture Screen button
3–34 MicroStation Administrator Guide
Customizing the User Interface
Capturing MicroStation Screen Images
or key in CAPTURE SCREEN.
The pointer determines which screen is captured if more than one monitor
is used, but it is not included in the image captured.
If CAPTURE SCREEN is assigned to a function key, it can be activated
by pressing the assigned function key. Using CAPTURE SCREEN, you
can document the exact state of MicroStation during a particular operation.
This is the only way to make screen shots of pull-down menus and modal
dialog boxes. Using the CAPTURE FOCUS key-in, you can capture
the window that has the input focus. You can assign key-ins to function
keys by choose Workspace > Function Keys….
To capture a rectangular area inside a view
1. In the Screen Capture dialog box, click the Capture Rectangle button
or key in CAPTURE RECTANGLE.
2. To define one corner of the area, enter a data point.
3. To define the diagonal corner of the area, enter another data point.
You must enter both data points in the same view.
To capture the contents of a view
1. In the Screen Capture dialog box, click the Capture View button or
key in CAPTURE VIEW CONTENTS.
2. Select the view to capture.
To capture the contents and border of a view
1. In the Screen Capture dialog box, click the Capture View Window
button or key in CAPTURE VIEW WINDOW.
2. Select the view to capture.
MicroStation Administrator Guide 3–35
Customizing the User Interface
Digitizing Tablet Menus
To capture the entire screen with a pull-down menu
1. Post the menu.
2. Press the function key defined as CAPTURE SCREEN.
To capture the window that has the input focus
1. Focus on the desired window.
2. Press the function key that is defined as CAPTURE FOCUS.
Digitizing Tablet Menus
You can use the following types of digitizing tablet menus with MicroStation:
• Tablet menus contain menu blocks of varying shapes and sizes. Tablet
menus are sometimes referred to as “paper menus” because they exist in
printed form or “command menus” to make a distinction that no longer
applies. To use a digitizing tablet menu you must first print it and attach
the printed output to the surface of the digitizing tablet. A maximum
of four tablet menus can be simultaneously attached.
The tablet cursor button designated as the Command button is used
to select a menu item in a menu block.
• Cursor button menus assign actions to the tablet cursor buttons
that are not assigned as the Command, Data, 3D Data, Reset,
3–36 MicroStation Administrator Guide
Customizing the User Interface
Attaching and activating tablet menus
Tentative, or 3D Tentative buttons.
MicroStation is supplied with several tablet menus.
Attaching and activating tablet menus
The ATTACH MENU (AM=) key-in is used to attach and activate tablet menus.
To attach and activate a tablet menu
1. Tape the menu to the tablet surface.
2. In the Key-in window dialog box, key in AM=<file_speci-
fication>,<model_name>,t<#>.
File_specification and model_name identify the DGN file and the model
within that file in which the menu was drawn.
# is a number in the range 1–4, indicating the first, second,
third, or fourth tablet menu.
For the file_specification you can enter the full path and filename
or the path and filename relative to the search path defined by the
configuration variable MS_APPMEN.
3. Enter a data point to identify the menu origin at the lower
left corner of the menu.
4. Enter a data point on the upper right corner of the menu.
The message “Menu successfully attached” is displayed in the status bar.
To activate a cursor button menu
1. In the Key-in window, key in AM=<menu>,cb.
Menu is the name of the menu.
MicroStation Administrator Guide 3–37
Customizing the User Interface
Selecting menu items
Selecting menu items
Before using a tablet menu, you must use the ATTACH MENU (AM=)
key-in to activate (see page 3-37) it.
To select a tool view control, or key-in using a tablet menu
1. Position the tablet cursor on the menu block for the desired
tool or view control.
2. Press the Command button.
To select a tool, view control, or key-in using a
cursor button menu
1. Press the cursor button to which the desired tool, view control,
or key-in is assigned.
Deactivating menus
The ATTACH MENU (AM=) key-in is used to deactivate tablet menus.
To deactivate a tablet menu
1. In the Key-in window, key in AM=,t<number>.
Number is in the range 1–4, indicating the first, second, third,
or fourth tablet menu.
To deactivate a cursor button menu
1. In the Key-in window, key in AM=,cb.
3–38 MicroStation Administrator Guide
Customizing the User Interface
Supplied menus
Supplied menus
The tablet menu DGN file "v8menu.dgn" is installed in Bentley’s
“Workspace\System\menus\dgn” directory.
Customizing tablet menus
You can create your own tablet menus in MicroStation DGN files, customize
the ones supplied with MicroStation, or purchase them from various vendors.
Typically, when creating a tablet menu, you will want to draw the menu close to
the size at which you will print it for use on the digitizing tablet.
To create or modify a tablet menu
1. In a DGN file, create a 2D model and make it the active model
2. On one or more levels in a Top (unrotated) view, draw the portions of the menu
that will identify menu items to users. You can use text, icons, or a mixture.
For example, in the area of the model in which you will create, in
step 3, a menu block for a menu item that will activate the key-in
PLACE CIRCLE CENTER CONSTRAINED, you might draw a
circle or place the text, “Place Circle by Center.”
3. On a separate level, draw the menu block boundaries as closed shapes.
The boundaries can be contained in cells. Element types other than lines, line
strings, arcs, ellipses, complex chains, and complex shapes will be ignored.
4. On a separate level, for each menu block, place a text element containing
that block’s action string (see page 3-40).
The text in these elements can be of any size. However, it is essential that in
each case the center of the text lies within the block to which it pertains.
5. At the “origin” — lower left corner — of the model, place a
three line text node as follows:
Menu Origin
FrameLevels=<level_containing_menu_block_boundaries>
CommandLevels=<level_containing_action_strings>
MicroStation Administrator Guide 3–39
Customizing the User Interface
Action Strings
For example:
Menu Origin
FrameLevels=Menu Border, Menu Partitions
CommandLevels=Command Text
The placement point of this text node is the origin of the menu.
Note that if you use multiple levels for menu block boundaries or
action strings, separate the level names with commas, as illustrated
above in the line beginning with FrameLevels.
6. If the DGN file that contains the model has not been saved, save it
now. It is not necessary to save settings first.
When you are finished, print the menu and attach it to the digitizing
tablet (see page 3-37).
Action Strings
The actions MicroStation performs when you select a tool, choose a menu item,
or press a function key are defined by the action string associated with that object.
At first it is simplest to think of an action string as a MicroStation key-in or series
of key-ins. For example, the action string associated with the Place SmartLine
tool is the key-in PLACE SMARTLINE. The true effect of selecting the Place
SmartLine tool is activation of the PLACE SMARTLINE key-in.
Action types
Several types of actions can be specified in action strings and associated
with tools, view controls, menu items, and function keys.
3–40 MicroStation Administrator Guide
Customizing the User Interface
Action types
Action type Syntax Description
Command Entry E,<key-in> Simulates a key-in. The key-in specified
Key-in by a command entry key-in is always
activated, regardless of state of the
active key-in. For example, suppose
that PLACE CIRCLE RADIUS is the
active key-in and is prompting for the
radius. If the user presses a function
key defined in the function key menu
to have action type E that activates the
PLACE LINE CONSTRAINED key-in,
then PLACE LINE CONSTRAINED
becomes the active key-in.
Terminated T,<key-in> Simulates a key-in. A terminated
Key-in key-in is normally used to get data
requested by prompts, such as the
radius of a circle, text, or an answer
to a yes-or-no question.
Unterminated K,<key-in> Keys in an unterminated string of
Key-in characters and waits for the user
to finish the string.
Print Message M,<message> Prints a message in one of the
status bar fields.
Place Active Cell: C,<cellname> Sets the Active Cell to cellname
absolute and activates the PLACE CELL
ABSOLUTE key-in.
Place Active Cell: R,<cellname> Sets the Active Cell to cellname
relative and activates the PLACE CELL
RELATIVE key-in.
If no type specifier (a single character separated from the rest of the
string with a comma) exists, MicroStation assumes that the action
type is a command entry key-in (E).
For examples of action strings, examine the sample tablet menu DGN file
"v8menu.dgn" installed in Bentley’s “Workspace\System\menus\dgn” directory
or see “Entering multiple action strings” on page 3-42.
MicroStation Administrator Guide 3–41
Customizing the User Interface
Action type options
Action type options
These options can be used immediately following the E, T, or K action
types or anywhere in a multiple action string following a semicolon (see
“Entering multiple action strings” on page 3-42).
/<character> If there is a slash (/) in an action string,
MicroStation pauses for user input. If the
slash is followed by d, k, or no character,
MicroStation does the following:
• /d — waits for a data point.
• /k — waits for a key-in.
• No character — proceeds after any input.
%<character> A percent (%) character in an action string is
identical to the slash, except that MicroStation
does not display any of its normal prompts.
This is useful to display custom prompts
from a menu. The actions %d and %k work
analogously to /d and /k.
Entering multiple action strings
Each action string can contain several actions (separated by semicolons).
For example, this action string places a blue two-inch circle at a user-specified
point:’co=blue;E,PLACE CIRCLE RADIUS;T,2;M,cfPlace 2 Inch Circle;%d;null’
The actions are as follows:
Action Description
co=blue A command entry key-in (since no type is
specified) that sets the Active Color to blue.
MicroStation activates the ACTIVE COLOR
key-in even if it currently expects a data key-in.
E,PLACE CIRCLE The MicroStation key-in PLACE
RADIUS CIRCLE RADIUS.
T,2 A terminated key-in that enters a radius of 2.
3–42 MicroStation Administrator Guide
Customizing the User Interface
Entering multiple action strings
Action Description
M,cfPlace 2 Inch Displays the message “Place 2 Inch
Circle Circle” in the status bar.
%d Waits for a data point without displaying
the normal prompts (preserving the prompt
displayed by the previous action).
null After the circle is placed, executes the NULL
key-in so that no tool or view control is selected.
MicroStation Administrator Guide 3–43
3–44 MicroStation Administrator Guide
V7 File Migration
MicroStation V8 opens design files from all previous editions of MicroStation.
When you open a V7 design file, you have the option of either upgrading
the file to V8 DGN file format or opening it read-only. If you want
to work with V7 design files in MicroStation V8 but need to maintain
backward compatibility, you have two choices:
• Upgrade newly opened V7 design files to the new format, but
save them when done making changes as V7 files in which the
graphic representation is maintained.
• Configure MicroStation V8 to operate in V7 workmode, in which
MicroStation V8 permits the opening of V7 design files for write access
but disables functionality that is not backward-compatible.
Options for Saving V8 DGN Files as V7 Design Files
You can use the Save As V7 Options dialog box to map MicroStation V8 DGN
file format data constructs, such as levels above 63, fonts that are new to
MicroStation V8, cells that are too large or have names that are too long, etc., to
V7 analogues, and to select other options that influence backward compatibility.
To save the open DGN file as a V7-format design file
1. Choose File > Save As.
The Save As dialog box opens.
2. From the Select Format To Save option menu, choose MicroStation
V7 DGN Files (*.dgn).
3. (Optional) — To select save options, click Options and use the
MicroStation Administrator Guide 4–1
V7 File Migration
Setting Up and Using V7 Workmode
controls in the Save As V7 Options dialog box. When done, click
OK to return to the Save As dialog box.
4. Specify the name and location of the new V7-format file using
the standard dialog box controls.
5. Click OK.
When saving a MicroStation V8 DGN file in V7 format, MicroStation does not
save “live” nested reference attachments to the resulting V7 file.
Setting Up and Using V7 Workmode
V7 workmode operation differs from other MicroStation V8 workmodes, and for
that manner, from previous editions of MicroStation, in a fundamental way:
When operating MicroStation V8 in V7 workmode, it is necessary to manually
save changes to the open DGN file by choosing File > Save.
The following capabilities are disabled in V7 workmode:
• view group creation
• level creation
• model creation
• 3D references in 2D design files
• reference associations
• references to models created in V8 DGN files
• references to models created in DWG files
You cannot use V7, MicroStation/SE, or other pre-V8 cell libraries in V8 using
the V7 format, even in V7 workmode. Once you attach a cell library in a V8
design session, it is automatically upgraded to V8 format and a backup is saved
to MS_BACKUP (or MS_TMP, if MS_BACKUP is not defined).
To continue using a cell library with a V7 format, you will need to maintain the
cell library in V7, and upgrade a copy to V8 as needed. This does not affect
cells placed in a DGN file, which will save to V7 files successfully.
4–2 MicroStation Administrator Guide
V7 File Migration
Batch Migration
To enable V7 workmode
1. From the Workspace menu, choose Configuration.
The Configuration dialog box opens.
2. In the View/Modify All Configuration Variables list box, select MS_OPENV7.
3. Click Edit.
The Edit Configuration File dialog box opens.
4. In the New Value field, type 3.
5. Click OK to return to the Configuration dialog box.
6. From the File menu of the Configuration dialog box, choose Save.
7. To close the Configuration dialog box, click OK.
8. Exit and restart MicroStation.
To reenable the default workmode, DGN, set MS_OPENV7 to 0. Follow
the above steps, except in step 4, type 0 instead of 3.
To ensure that the project data conforms with the project requirements, the system
administrator or project manager should specify the workmode at the project level.
Batch Migration
In addition to the Batch Conversion utility, MicroStation V8 provides a second
utility for upgrading a set of V7 design files and/or cell libraries to V8 DGN format.
To use this utility, choose File > Upgrade Files to V8 in the MicroStation Manager
dialog box (File > Close) or the Cell Library dialog box (Element > Cells).
MicroStation Administrator Guide 4–3
V7 File Migration
Batch Migration
To explicitly specify the working unit setup for upgraded files, you must specify
the desired working units in a text file. During the upgrade, if the unit labels
in a file being processed are identical to those in a custom unit definition,
MicroStation V8 creates the V8 DGN file with the specified units.
For the syntax and examples of custom unit definitions, see the
sample unit definition file, "units.def", which is installed in the
“..\Bentley\Workspace\System\data” directory.
The configuration variable MS_CUSTOMUNITDEF defines the location of the
unit definition file. In MicroStation V8 as delivered, MS_CUSTOMUNITDEF
is set to the installed sample file, "units.def". All of the unit definitions in that
file are on lines that begin with the # character — that is, “commented out” —
so even if you do not modify the file or redefine MS_CUSTOMUNITDEF,
none of the sample unit definitions are applied by default.
If a unit from the units definition file conflicts with one of the standard
MicroStationunits, the unit from the definition file is used.
The Batch Conversion utility has more options for controlling the
upgrading of V7 files than the MicroStation Manager-based utility and
is therefore likely to yield better results.
4–4 MicroStation Administrator Guide
Building Custom Projects
This chapter covers projects, the component of MicroStation’s workspaces
that comprises the data files used for a particular discipline or undertaking. A
project manager can create projects for consistency among a number of users,
and a single user can create projects to quickly customize MicroStation’s
environment for different projects and customers.
There are four steps to building and preserving a custom project:
1. Designing a Module (see page 5-1) includes establishing file naming
conventions and a directory structure for the data.
2. Assembling Module Data Files (see page 5-6).
3. Modifying the Project Configuration File (see page 5-90).
4 . Archiving: Bundling Module Data Files (see page 5-92) associated
with a specific DGN file.
Designing a Module
A module is a collection of data files that are organized to take advantage of
MicroStation’s workspace feature. Module files can include:
• DGN files containing sample design models or sheet models.
• Seed DGN files (see page 5-6).
• Cell libraries (see page 5-7), including those with dimension-driven
cells (see page 5-9).
• Level libraries (see page 5-57).
• Color tables (see page 5-58).
MicroStation Administrator Guide 5–1
Building Custom Projects
Sample modules delivered with MicroStation
• Line style libraries (see page 5-62).
• Dimension style libraries (see page 5-80).
• Settings files (see page 5-81).
• Text style libraries (see page 5-90).
• Material tool box and material assignment table files (see
“Surface Material Definitions”in.the.online.Visualization .Guide.).
• Tag set libraries.
• Tag report template files (see the.online,Guide.to.Generating.Drawings).
• Font libraries.
• Function Key Menus (see page 3-30).
• Menu cell libraries that contain the specifications for Digitizing
Tablet Menus (see page 3-36).
Of course, a module need not contain all of these file types.
A workspace’s project component can specify or “point to” data files in many
modules. However, for the sake of this introduction to designing modules, it will
be assumed that each module is associated with a particular project.
The sample modules delivered with MicroStation are examples of module
design. (If you already deal with many data files, you may already have
“modules” on your system or network.) The Architecture module is shown
as an example of how a module can be organized in Sample modules
delivered with MicroStation (see page 5-2). The advantages of this structure
are discussed in Module design goals (see page 5-4).
Sample modules delivered with MicroStation
The sample modules are delivered by default in Bentley’s
“Workspace\projects\examples” directory.
5–2 MicroStation Administrator Guide
Building Custom Projects
Sample modules delivered with MicroStation
The “arch” module is one of the delivered samples:
The “arch” module
arch
cell
“arch.cel”
“archpat.cel”
(and so on)
data
“aiaarch.lvl”
“aiacivil.lvl”
“arch.gls”
(and so on)
dgn
“border_d.dgn”
“igi_flrp.dgn”
“lad_dia.dgn”
(and so on)
out
(initially empty)
seed
“archseed.dgn”
“sdarch.sht”
“sdarch3d.dgn”
(and so on)
symb
“archlsty.rsc”
(and so on)
MicroStation Administrator Guide 5–3
Building Custom Projects
Module design goals
Module design goals
These are some of the design goals you should have in mind when
you design your own modules.
Creation, maintenance, and removal
The modules should be kept in parallel directory structures that make
it easy to create new modules, to add or delete files in the modules,
and to remove entire modules.
File duplication
If data files are shared by two or more projects, to avoid creating an
administrative nightmare of duplicate files, do not put a copy of each shared
data file in each module that needs it. Since the data files are specified by
configuration variables in the project configuration file, different projects
can easily specify any file in any module. In other words, no one-to-one
correspondence between project and module is required.
The user configuration file and user preference file should be kept on
local systems, not on a network. In no case should two users try to
simultaneously write to the same user configuration file or user preference
file. MicroStation reads these files for some operations and does not expect
to find the file open (and locked) by another user.
DGN Libraries
A DGN library is a DGN file used to store:
• Cells
• Dimension styles
• Structures
• Levels
5–4 MicroStation Administrator Guide
Building Custom Projects
DGN Libraries
• Text styles
• Multi-line styles
These are shared within the workgroup as standards.
The procedure for creating a DGN file, whether from scratch or by
doing a “Save As,” is the same as for any DGN file. A DGN library is
sometimes referred to as a DGN lib (pronounced with a long ’i’). The
recommended file extension for this file is *.dgnlib.
Cells, dimension styles, levels, and text styles are created in a DGN
library using MicroStation tools, the same way they are created in a
DGN file which contains a design model.
A DGN library typically has a single empty design model, and models
contain only cells, typically one cell per model. When ready to be shared,
DGN libraries should be copied to a file server.
The environment variable MS_DGNLIBLIST defines a list of DGN Libraries,
e.g., d:\standards.dgnlib, that are available for use. After DGN libraries
are defined and established, users need to set the configuration variable
MS_DGNLIBLIST to point to the libraries in order to use them. Once this
is done, they can attach a DGN library as a cell library.
If the contents of a library changes, anything placed in DGN files prior to
the change are not automatically updated in DGN file. To update the DGN
file to reflect these changes, use the following key-ins.
Type of Library Update key-in
Levels DGN UPDATE LEVELS
Text Styles DGN UPDATE textstyles
Dimension Styles DGN UPDATE dimstyles
Multi-line Styles DGN UPDATE MLINE styles
All libraries DGN UPD ATE all
MicroStation Administrator Guide 5–5
Building Custom Projects
Assembling Module Data Files
Assembling Module Data Files
The sample workspace modules contain many examples of data files. You may
find these appropriate for inclusion in your workspace module. If so, assembling
module data files is simply a matter of copying the files from the sample workspace
modules into the directory structure you have designed for your module.
Should you wish to create module data files, MicroStation’s settings boxes
and dialog boxes make it fairly easy. Each of the following sections cover
how to create a different type of module data file.
Seed Files
MicroStation lets you create two types of seed files: seed DGN
files and seed DWG files.
Seed DGN files and seed sheet models are simply DGN files that are
copied to create DGN files and sheet models. DGN files can contain
one or more design models and or sheet models.
Seed DWG files are DWG files that are copied to create DWG files. DWG
files can contain one design model and multiple sheet models.
General Procedure — To create a seed file
1. Open any DGN or DWG file. It is recommended that you open a
copy of an existing seed file. “Generic” seed files are installed in
Bentley’s “Workspace\system\seed” directory.
2. From the File menu, choose Save As.
The Save As dialog box opens.
3. In the Files field, key in the name for the new seed file.
4. Click the OK button.
5. Place elements that you want to include in all designs that will be created
using the new seed file. Most seed files do not contain any graphical
elements. Seed sheet files typically contain a drawing border.
6. Adjust settings to be appropriate for starting a design. See "Preparing
5–6 MicroStation Administrator Guide
Building Custom Projects
Cell Libraries
to Draw" in the QuickStart Guide.
7. Arrange the view configuration to be appropriate for starting a drawing.
See “Arranging View Windows” in the QuickStart Guide.
8. From the File menu, choose Save Settings to save the settings
and view configuration in the file.
9. Close the file.
Cell Libraries
The term “cell library” refers to a component of a DGN library (see page
5-4) that contains cells — usually one per model. Recall that cells are small
drawings — usually of frequently-used or complex symbols.
Cell libraries used with previous versions of MicroStation are standalone files in a
special format that is not directly supported by MicroStation V8. Pre-V8 cell
libraries are automatically converted to DGN libraries when attached to a DGN
file in MicroStation V8, but they retain their extension, typically “.cel.”
For more information about creating, defining the contents of, and
disseminating cell libraries, see Cells.
To create an HTML Web page that displays the contents of a cell library, use
the HTML Author dialog box (Utilities > HTML Author).
Using multiple cell libraries
If you key in ACTIVE CELL <cellname> or AC=<cellname>, if the cell is not
a shared cell in the design or in the attached cell library, or if there is no attached
cell library, MicroStation searches for the cell in the cell library list specified by
the Cell Library List configuration variable (MS_CELLLIST). Cell libraries are
searched in their order in the list. If wildcard characters are used, cell libraries are
searched in alphabetical order. For example, if MS_CELLLIST expands to:
Bentley\Workspace\projects\proj1\cell\master.cel;Bentley\Workspace\sys-
tem\cell\p*.cel
MicroStation Administrator Guide 5–7
Building Custom Projects
Using multiple cell libraries
and the files “projcel.cel,” “pipe2.cel,” “house.cel,” and “peter.cel” are in
the “Bentley\Workspace\system\cell” directory.
MicroStation searches for a cell as follows:
1. In the attached cell library.
2. In “Bentley\Workspace\projects\proj1\cell\master.cel”.
3. In “Bentley\Workspace\system\cell\peter.cel”.
4. In “Bentley\Workspace\system\cell\pipe2.cel”.
5 . In “Bentley\Workspace\system\cell\projcel.cel”.
To make it easier to attach different cell libraries, an item for each cell library in
the cell library list is appended to the File menu in the Cell Library dialog box.
Default cell
library list for
the sample
workspace.
All files in the specified directory with the “.cel” extension are listed
in the File menu in the Cell Library dialog box. Any cell in any listed
cell library can be placed by keying in AC=<cell_name>, regardless
of whether its cell library is attached.
To attach a cell library that is in the cell library list
1. From the File menu in the Cell Library dialog box, choose the cell library.
Cell libraries in the cell library list must have a cell library index file.
The first time a cell library is attached, MicroStation automatically
generates the cell library index file.
Nested cells are always expanded from the same cell library as their parent.
5–8 MicroStation Administrator Guide
Building Custom Projects
Dimension-driven Cells
Dimension-driven Cells
A dimension-driven cell is based on such a model and serves as a
template for a family of cells that can be derived — solved for a specified
set of dimension values. Constraints and constructions represent a
dimension-driven cell’s underlying structure. A derived cell is a cell in a
design that is derived from a dimension-driven cell.
Dimension-driven design tools are used to specify constraints and constructions
that determine the size, extent, or shape of associated elements in the model. All
dimension-driven design tools are in the DD Design tool frame (see page 5-16).
The dimensions and constants on which a dimension-driven cell are based can be
modified with the Dimension-Driven Design dialog box (see page 5-56).
The Dimension-Driven Design dialog box is also used to place derived cells. See
“Dimension-driven Cells” in the “Using Cells” chapter of the User Guide.
Concepts and terminology
This section has definitions of basic terminology and other introductory
information about dimension-driven cell creation.
Important terminology
The following terms are important for understanding dimension-driven
cell creation:
Constraint — a piece of information that limits or controls a construction.
See also Constraints (see page 5-10).
Construction — an element (point, infinite line, circle, ellipse, or B-spline curve’s
control polygon) that lets constraints locate, delimit or arrange other elements.
For example, a construction line can be the center line of a symmetric design.
MicroStation Administrator Guide 5–9
Building Custom Projects
Concepts and terminology
Well-constrained — a set of constructions that is completely defined
by constraints or is constant and has no redundant constraints. There is
generally more than one feasible solution for a set of well-constrained
constructions, but the choice is usually clear.
Under-constrained — a set of constructions that is not completely defined
by constraints and is not constant. An under-constrained construction has
many possible “solutions” and is unacceptably ambiguous.
Redundant — A constraint that is applied to a set of constructions that are already
well-constrained. A redundant constraint may or may not be inconsistent with
other constraints, but, in either case, it adds no useful information.
Degrees of freedom — Number that sums up a dimension-driven cell’s ambiguity.
Solve — To construct the design from a given set of constraints
and show what remains to be defined.
Constructions are elements with the class construction and special symbology
(see “Diagnosing an ambiguous dimension-driven cell” on page 5-11).
Constraints
Constraints say what characteristics a dimension-driven cell must have, but
not necessarily how to arrive at a design with those characteristics. How to
compute geometry in the light of constraints is the task of “solving.”
Most constraint relationships apply to the design’s essential layout or general
structure. The design’s details are located and shaped by its structure. For
example, if a dimension-driven cell is generally symmetrical, it has constraints
that relate elements to a center line in some way.
The following types of constraints can be created:
• Location — A constraint that fixes the location of a point
in the design plane.
5–10 MicroStation Administrator Guide
Building Custom Projects
Concepts and terminology
• Geometric — A constraint that controls the position or orientation
of two or more elements relative to each other.
• Dimensional — A constraint that is a controlled by a dimension.
• Algebraic — An equation that expresses a relationship among variables.
When a constraint is added, modified, or deleted, the model is resolved —
an attempt is made to reconstruct the design so that the new or modified
constraint, as well as all existing constraints, are satisfied.
• If a solution is found, the affected elements are updated and
redisplayed. The solution may affect elements that are not obviously
or locally related to the new constraint.
• If no solution is possible, the message “Not Solved” and graphical cues as
to where the trouble is are displayed. The design’s geometry is not updated,
but the constraint is accepted anyway. If MicroStation reports “Not
Solved” even though the new constraint is not redundant and you are sure
that a solution is in fact possible, it may help to re-arrange the geometry of
the model to look more like the solution you want and then re-solve.
Adding a new constraint removes ambiguity from the design. (Deleting
a constraint has the opposite effect.)
A constraint can apply only to a construction. An element is converted to
the equivalent construction when a constraint is applied to it.
Most location and geometric constraints are assigned the class Construction.
You can define the level and class of dimensions, location constraints, and
equations. In the future, you will be able to specify the level, symbology,
and class of all constraints and constructions.
Diagnosing an ambiguous dimension-driven cell
The symbology of constrained elements and of the constraint and dimension
elements themselves alert you to ambiguities and inconsistencies in the design.
• If a construction or variable is completely defined by constraints or is
constant, it is well-constrained and is displayed in solid white.
MicroStation Administrator Guide 5–11
Building Custom Projects
Equation syntax
• If a construction or variable is not completely defined by constraints,
it is under-constrained and is displayed dashed in yellow.
• If a constraint is applied to a set of construction that are already
well-constrained, it is redundant and is displayed dashed in red.
Valid constraints are displayed as follows:
Constraint Displayed In
Dimensions solid white
Other geometric constraints solid blue
Equations white
The remaining ambiguity in a design is summed up by a number called “degrees
of freedom.” Each new construction adds degrees of freedom as follows:
Construction Degrees of
Freedom Added
Point 2
Line up to 4
Circle up to 3
Ellipse up to 5
Each valid constraint removes one or more degrees of freedom.
A well-constrained design has zero degrees of freedom and no redundant
constraints. All constructions are well-constrained (displayed in white).
If the number of degrees of freedom is not zero, then parts of the design
are under-constrained (displayed in yellow).
When a constraint is added, the remaining degrees of freedom are displayed,
followed by the message “Over-constrained” if there are any redundant constraints.
Equation syntax
An equation consists of an algebraic expression (or just a variable), optionally
5–12 MicroStation Administrator Guide
Building Custom Projects
Equation syntax
followed by an equals “=” sign and another algebraic expression. For
example, “a + b = c^2” is an equation relating a, b, and c. If just one
expression is given, “= 0” is assumed. For example, the equations “a +
b = 2” and “a + b - 2” mean the same thing.
Constant expressions are valid in equations. A constant expression
is an algebraic expression involving numbers, operators, built-in
functions and built-in constants (like pi).
Algebraic expression
An algebraic expression can contain variable identifiers, numbers,
arithmetic operators, and built-in functions and constants, according
to the usual rules of algebra.
Formally, the grammar of an algebraic expression is as follows:
Clause Grammar
exp2: exp1 [ [op2] exp2 ]*
exp1: [op1]* exp0
exp0: ‘(’ exp ‘)’ | variable | number | const
op2: binary arithmetic operator
op1: unary operator or built-in function
const: numerical constant reserved word
number: integer, floating point, exponential, or
mu:su:pu notation
variable: user-defined variable identifier
[ …] denotes an optional clause
* means zero or more clauses
| separates alternatives quotes
MicroStation Administrator Guide 5–13
Building Custom Projects
Equation syntax
‘…’ denote a literal character.)
Fractional clauses are valid in algebraic expressions. A fractional
clause has the following grammar:
‘#’ integer ‘/’ integer ‘#’ (example: #2 1/2#)
In number clauses, distances and coordinates can be expressed in working
units (MU:SU:PU:), decimal, or fractional notation.
The multiplication operator * is not assumed. Omitting an operator
is a grammatical error.
White space and comments
White space and comments can appear anywhere in an expression and are ignored.
A comment is a sequence of characters enclosed in brackets or braces, as follows:
‘[’ ...‘]’ | ‘{’ ... ‘}’ | ‘/*’ ... ‘*/’
Arithmetic operators
The following arithmetic operators are available:
Operator Operation Performed
- arithmetic negation
cos cosine
sin sine
tan tangent
acos arccosine
5–14 MicroStation Administrator Guide
Building Custom Projects
Equation syntax
Operator Operation Performed
asin arcsine
atan arctangent
sqrt square root
+ addition
- subtraction
* multiplication
/ division (floating point)
% modulo
^ exponent (e.g., a ^ 2 squares the value of a)
= equal to
Built-in numerical constants
The following built-in numerical constant is available:
Constant Means
pi π
Numbers
A number can be expressed in integer, floating point or exponential notation,
followed by an optional units keyword, or in working units notation
(mu:su:pu). Units keywords are as follows:
Keyword Units Denoted
deg degrees (for angles)
Variable names
A variable name can have up to 32 characters, beginning with a letter
MicroStation Administrator Guide 5–15
Building Custom Projects
DD Design tool frame
or underscore, followed by letters, numbers or underscores, with no
embedded blanks. Variable names are case-sensitive.
A variable name cannot be the same as a built-in function or constant, but may
contain a reserved word as part of its name. For example, if “sin” is a built-in
function, then “sin” is not a valid variable name, but “sin_of_x” is valid. Reserved
names are not case sensitive, so “Sin” is not a valid variable name.
A variable’s name must be unique within the cell or sub-design in which it is used.
DD Design tool frame
Tools for creating and modifying dimension-driven profiles and cells
are accessed from the DD Design tool frame.
To Use tools in the
Sketch a profile,
or
Convert an element to a profile.
Profile tool box (see page
5-17)
Convert dimensions to constraints,
or
Assign equations to variables,
or Parameter Constraints
Assign variables to dimensional constraints. tool box (see page 5-24)
5–16 MicroStation Administrator Guide
Building Custom Projects
Profile tool box
To Use tools in the
Construct an arc, line string, or shape that is
attached to one or more constructions.
Attach Element tool box
(see page 5-28)
Create geometric constraints.
Geometric Constraints
tool box (see page 5-34)
Evaluate, modify, and re-solve constraints
for dimension-driven profiles.
Evaluate Constraints tool
box (see page 5-44)
Break or trim constrained geometry,
or
Add fillets and chamfers to constrained
geometry, Modify Constraint tool
or box (see page 5-48)
Modify dimension or variable values.
Key-in: DIALOG TOOLBOX DDDTOOLS [OFF | ON | TOGGLE]
Profile tool box
The tools in the Profile tool box are used to sketch a profile and
convert an element to a profile.
MicroStation Administrator Guide 5–17
Building Custom Projects
Sketch Profile
To Select in the Profile tool
box
Sketch a geometrically-constrained profile.
Sketch Profile (see page
5-18)
Convert a line string shape or complex shape
to a geometrically-constrained profile.
Convert Element to Profile
(see page 5-23)
Key-in: DIALOG TOOLBOX DDDDRAW
Sketch Profile
Used to sketch a dimension driven profile. When using this tool, geometric
constraints are automatically applied to the profile as it is being created.
Constrained profiles will have a fixed point (a point relative to which dimensional
modifications are performed) when the Location constraint is turned on in the
Sketch Profile tool settings window. A fixed point can be relocated on the profile.
As you create a sketch with the Sketch Profile tool, geometric constraints
are automatically applied and dimensional constraints are applied to
rounded or chamfered connections.
5–18 MicroStation Administrator Guide
Building Custom Projects
Sketch Profile
Sketch Profile tool
settings
Tool Setting Effect
Segment Sets the type of segment being sketched: Line, Arc
by Center, Arc by Edge, Curve.
Vertex Sets the type of connection at a vertex.
Sharp—Simple intersection point.
Rounded—Creates an arc.
Chamfered—Creates a chamfer.
Tangent—Creates a tangent point between a line
and an arc or between two arcs.
Geometric If on (the default), geometric constraints are added
Constraints as the profile is sketched.
Type (Segment set to Curve only) Sets the method by which the
curve is sketched: Define Pole or Through Points.
Order (Segment set to Curve and Type set to Define Poles
only) Sets the Order of the equation that defines
the curve. Default Order is 4.
Radius (Vertex set to Rounded or Chamfered only) Sets the radius
of the circle used to construct the connection.
Set Text If On, automatically sets height and width of dimension
Size Auto- text and constraint symbols.
matically
MicroStation Administrator Guide 5–19
Building Custom Projects
Sketch Profile
Tool Setting Effect
Set Toler- If On, automatically sets Distance and Angle tolerances. If
ances Au- Off, Distance and Angle tolerances are set by user.
tomatically
Distance Tolerance—Sets the distance within which
points are located to unify.
Angle Tolerance—Sets the angle within which elements
are located for parallel and perpendicular constraints. Also
snaps lines parallel to 0 , 45 , or 90 .
Constraints The following constraints are automatically applied
to the profile, when on.
Unify—Constrains endpoints of two elements, or
the endpoints of a single element, to be united
into a single common point.
Dimension—Converts a dimension to a constraint.
Concentric—Constrains two elliptical/circular
arcs to be concentric.
Parallel—Constrains two lines (or the primary axes of
two ellipses) to the same rotation angle.
Perpendicular—Constrains two lines (or the primary axes of
two ellipses) to be at a right angle (90 ) to one another.
Fix Angles—Fixes the orientation of a line (or the
primary axis of an ellipse) to 0 , 45 , or 90 , when
it is within the Angle Tolerance.
Point On—Constrains a point (or the center of a circle
or an ellipse) to lie on a construction.
Tangent—Constrains two constructions to be tangent.
Location—Fixes the location of a point in the design.
5–20 MicroStation Administrator Guide
Building Custom Projects
Sketch Profile
Tool Setting Effect
Confirm Confirm whether or not to add the constraint to
the profile, when on.
Constraints are applied when certain conditions are present:
• A line segment is nearly horizontal (0 ) , vertical
(90 ), or 45 , and the first linear segment has
a fixed angle constraint.
• The first three vertices of the profile define the plane
of the sketch. Profiles must be planar.
• For a rounded vertex, a circle with a radial constraint is
constructed and attached to the vertex, and the circle’s
radius is set in the Radius tool setting.
• Dimensional constraints are not applied to items
other than fillets or chamfers.
As each additional segment is drawn, it is checked
for information relative to previously-placed segments
in the following order:
1. Is it colinear with any existing segment? If not, then:
2. Is it parallel to the first segment? If not, then:
3 . Is it perpendicular to the first segment?
If any of these conditions are met, the constraint is applied.
MicroStation Administrator Guide 5–21
Building Custom Projects
Sketch Profile
To relocate a constrained profile’s fixed point
1. From the Settings menu, choose View Attributes.
The View Attributes dialog box opens.
2. Turn on Constructions.
3. Select the Delete Element tool from the Main tool frame and delete the
existing fixed location constraint.
4. (Optional) — Turn off Constructions.
5. Select the Fix Point at Location tool (see page 5-43) from the Geometric
Constraints tool box.
6. Identify the point on the profile that is to be the new fixed point constraint.
7. Enter a data point to accept the fixed point constraint.
Rounds and chamfers can be omitted from the sketch and applied to the solid.
Rounds and chamfers in the profile cannot be deleted.
To sketch a parametric profile
1. Select the Sketch Profile tool.
2. In the Tool Settings window:
From the Segment option menu, choose the segment type.
From the Vertex option menu, choose the connection type.
5–22 MicroStation Administrator Guide
Building Custom Projects
Convert Element to Profile
Turn on Geometric Constraints.
3. Enter a data point to define the first point.
4. Continue entering data points to define the profile.
Key-in: SKETCH
Convert Element to Profile
Used to convert a line string, shape, complex chain or complex shape to a
geometrically-constrained profile. This tool also works with selection sets.
This tool allows users to create dimension-driven profiles from existing elements
in the design. Users can select the desired constraint types to apply to the profile,
as well as allow MicroStation to confirm each constraint before it is applied.
Controls in this Tool Settings window are analogous to those in the
Sketch Profile tool (see page 5-18).
MicroStation Administrator Guide 5–23
Building Custom Projects
Parameter Constraints tool box
To convert an element to a geometrically-constrained profile
1. Select the Convert Element to Profile tool.
2. Identify the element or selection set.
3. In the Tool Settings window:
Enter text height and width or accept automatic size settings (default).
Enter Distance and Angle Tolerances or accept automatic
tolerance settings (default).
4. Click the Settings button.
The Convert Element to Profile dialog box expands to
display a constraints list.
5. Turn on the constraints to be applied.
6. Turn on confirmations, where required.
7. Enter a data point to initiate the conversion.
The Convert Element to Profile tool also works with a selection set.
In MicroStation, construction elements do not need to be displayed in the view
when converting an element to a geometrically-constrained profile.
Key-in: CONVERT PROFILE
Parameter Constraints tool box
The tools in the Parameter Constraints tool box are used to apply
dimensional constraints to constructions.
5–24 MicroStation Administrator Guide
Building Custom Projects
Convert Dimension to Constraint
To Select in the Parameter Constraints tool
box
Convert an associative
dimension into a constraint.
Convert Dimension to Constraint (see page
5-25)
Assign an equation to a model.
Assign Equation (see page 5-26)
Assign a constant or variable
to a dimensional constraint.
Assign Variable to Dimensional Constraint
(see page 5-27)
Key-in: DIALOG TOOLBOX DDDPARM [OFF | ON | TOGGLE]
Convert Dimension to Constraint
The Convert Dimension to Constraint tool is used to convert a dimension into
a dimensional constraint. This tool works only on dimensions that have not
been previously constrained with the Dimension Element tool.
When MicroStation is running, it is possible to convert dimensions that are not
associative. Since a non-associative dimension is not associated to any element,
an attempt is made to link the dimension to an element based on the possible type
of dimensional constraint the dimension could become, the element type(s) it
could apply to, and the element the dimension touches or is aligned with.
Possible problems when converting a non-associative dimension are as follows:
MicroStation Administrator Guide 5–25
Building Custom Projects
Assign Equation
• If no suitable element can be found, the message “Targets not
found” displays in the status bar.
• A constraint is created, but it is incorrect or unsatisfactory.
If you cannot satisfactorily convert a non-associative dimension, delete it and
replace it with an associative dimension to specify exactly the desired constraint.
To convert a dimension to a dimensional constraint
1. Select the Convert Dimension to Constraint tool.
2. Identify the dimension and accept.
The Choose Parameter Name dialog box opens.
Type a name for the dimensional constraint in the Variable field and click OK.
The dimension updates with the variable name and dimension value.
Key-in: CONSTRAIN DIMENSION
You cannot convert the angle of a line from the X or Y axis, ordinate
dimensions, or the size or location of an arc.
Assign Equation
Used to assign an algebraic constraint — an equation that expresses
a constraint relationship between variables, numerical constants and
built-in functions and constants — to a model.
An equation is stored in a text element and is created using the Place Text
tool and can be edited using the Edit Text tool.
5–26 MicroStation Administrator Guide
Building Custom Projects
Assign Variable to Dimensional Constraint
Equation syntax (see page 5-12) follows the rules of algebra. Built-in
functions and pre-defined constants can be used.
To assign an equation to a model
1. Select the Assign Equation tool.
2. Identify the text element that contains the equation.
3. Identify one of the equation’s variables or any element in the model
to which the equation is being assigned.
4. An attempt is made to solve and one degree of freedom is removed.
Key-in: CONSTRAIN EQUATION
Assign Variable to Dimensional Constraint
Used to assign a constant or variable to a dimensional constraint. The constant
or variable then represents the dimension’s value in equations.
A constant or variable is created using the Place Text tool and can be edited
using the Edit Text tool. A constant or variable is identified by name. See
“Variable names” on page 5-15 for naming rules.
MicroStation Administrator Guide 5–27
Building Custom Projects
Attach Element tool box
To assign a constant or variable to a dimensional constraint
1. Select the Assign Variable to Dimensional Constraint tool.
2. Identify the text element that contains the constant or variable.
3. Identify the dimensional constraint.
If a variable is assigned, the dimensional constraint’s value becomes
an unknown and one degree of freedom is added.
Key-in: CONSTRAIN VARIABLE
To make a variable constant, use the Edit Text tool to assign the
variable a constant value.
Attach Element tool box
The tools in the Attach Element tool box are used to construct an arc, line
string, or shape that is attached to one or more constructions. Only the
elements size, shape, or location are modified when solving.
To Select in the Attach Element tool box
Construct an attached line sting or shape.
Construct Attached Line String or
Shape (see page 5-29)
Construct an attached arc.
Construct Attached Arc (see page
5-30)
5–28 MicroStation Administrator Guide
Building Custom Projects
Construct Attached Line String or Shape
To Select in the Attach Element tool box
Construct an attached ellipse or circle.
Construct Attached Ellipse or Circle
(see page 5-31)
Attach an element’s location to a
construction or constraint.
Attach Element to Point (see page
5-31)
Attach an element’s location and rotation
to a constraint.
Align Element with Point and Line
(see page 5-32)
Cause an element to track a point,
ellipse, or constraint.
Attach Pen Element to Point (see
page 5-33)
Key-in: DIALOG TOOLBOX DDDATTACH [OFF | ON | TOGGLE]
Construct Attached Line String or Shape
Used to create a line string or shape with its vertices attached to
construction points, circles, or constraints.
MicroStation Administrator Guide 5–29
Building Custom Projects
Construct Attached Arc
To construct an attached line string or shape
1. Select the Construct Attached Line String or Shape tool.
2. Distinguish an existing element to define the first vertex by
entering a data point near the element.
3. Continue identifying elements to define other vertices.
4. To create an attached shape, enter the last data point at the starting point.
5. Reset to end the line string or shape.
Key-in: ATTACH LSTRING
Construct Attached Arc
Used to construct an arc that is attached to the identified construction
circle or ellipse. The arc is defined in the counterclockwise direction
from its beginning to its endpoint.
To construct an attached arc
1. Select the Construct Attached Arc tool.
2. Identify the underlying construction circle or ellipse.
3. Identify an element to define the arc’s beginning, from which
5–30 MicroStation Administrator Guide
Building Custom Projects
Construct Attached Ellipse or Circle
the arc extends counterclockwise.
4. Identify an element to define the arc’s endpoint.
Key-in: ATTACH ARC
Construct Attached Ellipse or Circle
Used to create and attach a circle to a construction circle (or an
ellipse to a construction ellipse).
To construct an attached ellipse or circle
1. In the Attach Element tool box, select the Construct Attached
Ellipse or Circle tool.
2. Identify the target construction.
3. Accept the attachment.
Key-in: ATTACH CIRCLE
Attach Element to Point
MicroStation Administrator Guide 5–31
Building Custom Projects
Align Element with Point and Line
Attaches an element’s (text, cell, line string, or shape) location to a constraint
or construction point. The element then moves whenever the construction
or constraint is moved. The element’s rotation is not changed.
To attach the location of an element to a construction
or constraint
1. Select the Attach Element to Point tool.
2. Identify the element.
3. Identify a construction or constraint to which to attach the element’s location.
The element is attached to the construction or constraint and moved
to the construction or constraint location.
Key-in: ATTACH LOCATION
Align Element with Point and Line
Attaches an element’s (text, cell, line string, or shape) location and
orientation to a constraint. The element then is moved and rotated
whenever the constraint is moved or rotated.
To attach the location and rotation of an element to a constraint
1. Select the Align Element with Point and Line tool.
2. Identify the element.
3. Identify the constraint.
The element is attached to the constraint, moved to the constraint’s
5–32 MicroStation Administrator Guide
Building Custom Projects
Attach Pen Element to Point
location, and rotated to the constraint’s orientation.
Key-in: ATTACH TRANSFORM
Attach Pen Element to Point
Used to cause an element (of any type) to track a point, ellipse, or
constraint, leaving a “trail” behind it.
Whenever the model is re-solved, the “pen element” is moved to the
target point’s location without first being erased from its old location. A
history of images accumulates in the view. A pen attachment is useful
for “range of motion” and interference studies.
To attach a pen element to a point, ellipse, or constraint
1. In the Attach Element tool box, select the Attach Pen Element tool.
2. Identify the element that is to become the “pen.”
3. Identify the element to which to attach the pen.
MicroStation Administrator Guide 5–33
Building Custom Projects
Geometric Constraints tool box
To erase a trail of “pen ink” images
1. Update the view.
Key-in: ATTACH PEN
Geometric Constraints tool box
The tools in the Geometric Constraints tool box are used to
create geometric constraints.
To Select in the Geometric Constraints
tool box
Constrain geometry to be tangent,
perpendicular, parallel, or fix angle
to horizontal or vertical.
Constrain Elements (see page 5-35)
Make a variable a constant or
make a construction invariant (not
recalculated when solving).
Make Construction or Parameter
Invariant (see page 5-39)
Constrain a point (or the center
of a circle or an ellipse) to lie
on a construction.
Constrain Point On Construction
(see page 5-40)
Constrain a point to the intersection
of two constructions.
Constrain Point at Intersection (see
page 5-41)
5–34 MicroStation Administrator Guide
Building Custom Projects
Constrain Elements
To Select in the Geometric Constraints
tool box
Constrain two points to be coincident,
two circles to the same center, or a
point to the center of a circle.
Constrain Two Points to be
Coincident (see page 5-42)
Fix the location of a point in the design.
Fix Point at Location (see page 5-43)
Equate the endpoints of constructions.
Equate Parameters or Constructions
(see page 5-43)
Key-in: DIALOG TOOLBOX DDDCONSTRAINT [OFF | ON | TOGGLE]
Constrain Elements
Used to apply tangent, perpendicular, parallel, or fix angle
constraints to profile geometry.
MicroStation Administrator Guide 5–35
Building Custom Projects
Constrain Elements
Tool Setting Effect
Method Sets the method by which to constrain profile geometry.
Smart Constrain Elements—Constrains constructions
tangent, perpendicular, or parallel, or by fixing the angle,
depending upon the identified element(s) and the number
of data points. This Method is recommended unless
you need to override or force constraints.
Constrain Two Constructions to be Tangent—Constrains
two constructions (two circles, two ellipses, a circle
or ellipse and a line) to be tangent at as many points
as their geometry makes possible.
Constrain Two Lines to be Perpendicular—Constrains
two lines (or the primary axes of two ellipses) to be
at a right angle (90 ) to one another.
Constrain Two Lines to be Parallel —Constrains two lines (or
the primary axes of two ellipses) to the same rotation angle.
Fix Angle of Line or Ellipse—Constrains a line’s
orientation or an ellipse’s rotation angle.
Fix Angle (Method set to Smart Constrain Elements only) Sets the
Snap tolerance for constraining a line or the primary axes of an
Tolerance ellipse (that is on an angle) to the closest view axis (x- or y-).
Used in conjunction with the Smart Constrain Elements
method, this setting forces individually selected elements
to be constrained to the view x- or y-axis if the current
position of the element is within the tolerance value
from a vertical or horizontal position.
For example, if Fix Angle Snap Tolerance is 10 and a
single line drawn at 45 is identified, the line is fixed at
45 . If the line was placed at a 5 slope off the view
x-axis, the line is forced to be horizontal.
This setting also forces multiple elements to be constrained
parallel, perpendicular, or tangent with one another
along the view x- and y- axes if the current position
of the elements are within the tolerance value from
a vertical or horizontal position.
5–36 MicroStation Administrator Guide
Building Custom Projects
Constrain Elements
Tool Setting Effect
Angle Lock (Method set to Fix Angle of Line or Ellipse only) Constrains a
line or the primary axes of an ellipse by the following options.
None—Geometry is constrained at the angle it was created.
Horizontal—Geometry is constrained to the view x-axis.
Vertical—Geometry is constrained to the view y-axis.
Settings Toggles the display of the Convert to Constructions and
Join Ends at Junctions check boxes.
Convert to Converts primary elements to construction elements.
Construc-
tions
Join Extends primary elements to intersection.
Ends at
Junctions
To apply a tangent constraint
1. Select the Constrain Elements tool.
2. In the Tool Settings window, set Method to Smart Constrain
Elements by selecting the first icon.
3. Identify the first construction.
4. Identify the second construction.
The tangent constraint is displayed. An attempt is made to solve and
remove one degree of freedom. The acceptance point determines which
solution is selected if there are two solutions or approximately where
the solution will be if there is a range of possibilities.
To override or force a tangent constraint, set Method to Constrain
Two Constructions to be Tangent by selecting the second icon
in the Tool Settings window.
MicroStation Administrator Guide 5–37
Building Custom Projects
Constrain Elements
To apply a perpendicular constraint
1. Select the Constrain Elements tool.
2. In the Tool Settings window, set Method to Smart Constrain
Elements by selecting the first icon.
3. Identify the first line or ellipse.
4. Identify the second line or ellipse.
The perpendicular constraint is displayed, and the lines are trimmed at their
intersection. An attempt is made to solve and remove one degree of freedom.
To override or force a perpendicular constraint, set Method to Constrain Two
Lines to be Perpendicular by selecting the third icon in the Tool Settings window.
To apply a parallel constraint
1. Select the Constrain Elements tool.
2. In the Tool Settings window, set Method to Smart Constrain
Elements by selecting the first icon.
3. Identify the first line or ellipse.
4. Identify the second line or ellipse.
The parallel constraint is displayed. An attempt is made to solve
and remove one degree of freedom.
To override or force a parallel constraint, set Method to Constrain Two Lines
to be Parallel by selecting the fourth icon in the Tool Settings window.
To fix the angle of a line or ellipse
1. Select the Constrain Elements tool.
2. In the Tool Settings window, set Method to Smart Constrain
5–38 MicroStation Administrator Guide
Building Custom Projects
Make Construction or Parameter Invariant
Elements by selecting the first icon.
3. Identify the line or ellipse.
4. Enter a second data point on the line or ellipse.
5. Enter a third data point on the line or ellipse.
To force a line or the primary axis of an ellipse to be horizontal or vertical, set
Method to Fix Angle of Line or Ellipse by selecting the fifth icon in the Tool
Settings window and set Angle Lock to Horizontal or Vertical.
Key-in: CONSTRAIN ELEMENT
Make Construction or Parameter Invariant
Used for either of the following:
• To make a variable a constant, fixing the value of the dimension
to which it is assigned.
• To make a construction invariant (not recalculated when solving). An
invariant construction can be used in constraints. Direct, single-element
constraints, such as the radial or angle of line dimension constraints or the
location constraint, are redundant if applied to an invariant construction.
To make a variable a constant or a construction invariant
1. Select the Make Construction or Parameter Invariant tool.
2. Identify the construction or variable.
An attempt is made to remove the variable or curve’s remaining
MicroStation Administrator Guide 5–39
Building Custom Projects
Constrain Point on Construction
degrees of freedom.
Key-in: CONSTRAIN CONSTANT
Constrain Point on Construction
Used to constrain a point (or the center of a circle or an ellipse)
to lie on a construction that is not a point, or, equivalently, the
construction to pass through a point.
To apply a point-on constraint
1. Select the Constrain Point On Construction tool.
2. Identify the construction.
3. Identify the point.
4. Reset to have MicroStation create the point.
The constraint is displayed next to the point. An attempt is made to solve
and remove one degree of freedom. The acceptance point determines
which solution is selected if there are two solutions or approximately
where the solution will be if there is a range of possibilities.
Key-in: CONSTRAIN POINTON
In MicroStation, Construction elements do not need to be displayed in
5–40 MicroStation Administrator Guide
Building Custom Projects
Constrain Point at Intersection
the view when applying a point-on constraint.
Constrain Point at Intersection
Used to constrain a point to lie at the intersection of two constructions, or,
equivalently, to force two constructions to pass through a point.
The two constructions can be any kind of construction, except points. The
intersection can be a construction point or the center of a circle or an ellipse.
To apply a point-at constraint
1. Select the Constrain Point At Intersection tool.
2. Identify the first construction.
3. Identify the construction with which it is to intersect.
4. Identify the point of intersection.
or
Reset to create the point of intersection at the intersection
of the two constructions.
The intersection constraint is created next to the point of intersection. An
attempt is made to solve and remove two degrees of freedom. The acceptance
point determines which solution is selected if there are two solutions or
MicroStation Administrator Guide 5–41
Building Custom Projects
Constrain Two Points to be Coincident
approximately where the solution will be if there is a range of possibilities.
Key-in: CONSTRAIN INTERSECTION
Constrain Two Points to be Coincident
Used to constrain one of the following:
• Two points to the same location (to be coincident).
• Two circles/ellipses to be concentric (have the same center).
• A point to lie at the center of a circle/ellipse.
To constrain two points to be coincident, two circles/ellipses
to be concentric, or a point to a circle’s/ellipse’s center
1. Select the Constrain Two Points to be Coincident tool.
2. Identify the two points, circles or ellipses, or any combination thereof.
The concentric constraint is displayed next to the point. An attempt
is made to solve and remove two degrees of freedom.
Key-in: CONSTRAIN CONCENTRIC
In MicroStation, Construction elements do not need to be displayed in
5–42 MicroStation Administrator Guide
Building Custom Projects
Fix Point at Location
the view when applying a coincident constraint.
Fix Point at Location
Used to fix the location of a point (or the center of a circle or ellipse) in the design.
To constrain a point to a location
1. Select the Fix Point at Location tool.
2. Identify the point, circle, or ellipse.
The constraint is displayed next to the point. Two degrees
of freedom are removed.
Key-in: CONSTRAIN LOCATION
In MicroStation, Construction elements do not need to be displayed in
the view when applying a location constraint.
Equate Parameters or Constructions
MicroStation Administrator Guide 5–43
Building Custom Projects
Evaluate Constraints tool box
Used to equate the endpoints of constructions. That is, endpoints of two elements
can be united, or constrained to be equal. This tool also can be used to equate
other constructions, such as constraining two lines to be colinear.
To equate two endpoints
1. Select the Equate Parameters or Constructions tool.
2. Identify the endpoint on the first element.
3. Identify the endpoint on the second element.
4. Accept.
The two elements are adjusted to join at the identified endpoints.
To equate two lines to be colinear
1. Select the Equate Parameters or Constructions tool.
2. Identify the first line (not at its endpoints).
3. Identify the second line (not at its endpoints).
4. Accept.
The two lines are adjusted to become colinear.
Key-in: CONSTRAIN MATCH
Construction elements do not need to be displayed in the view when
equating parameters or constructions.
Evaluate Constraints tool box
The tools in the Evaluate Constraints tool box are used to evaluate, modify,
and re-solve constraints for dimension-driven profiles.
5–44 MicroStation Administrator Guide
Building Custom Projects
Re-solve Constraints
To Select in the Evaluate Constraints
tool box
Re-establish dimensions and other
constraints in a parametric profile that
has been modified with conventional
element modification tools. Re-solve Constraints (see page 5-45)
Modify a dimension-driven profile.
Modify and Re-solve Constraints
(see page 5-47)
See a visual representation of
relationships between constraints
in a profile.
Describe Selected Construction or
Constraint (see page 5-48)
Key-in: DIALOG TOOLBOX DDDMODEL [OFF | ON | TOGGLE]
Re-solve Constraints
Used to display where constraints are needed for a parametric profile
drawn with the Sketch Profile tool (see page 5-18).
You can also use the tool to re-establish dimensions and other constraints
in a parametric profile that have been modified with conventional element
modification tools. For example, use Re-solve Constraints if you:
MicroStation Administrator Guide 5–45
Building Custom Projects
Re-solve Constraints
• Modify a construction using the Modify Element tool or the Place
Fence tool and you want to reconstruct the design based on the new
modifications, while satisfying all constraints.
• Delete constructions or constraints and want to drop any constructions
or elements that are dependent on the deleted elements and then
re-analyze the design’s degrees of freedom.
• Copy constructions.
To re-solve constraints
1. Select the Re-solve Constraints tool.
2. Identify an element in the profile and accept.
Question marks are displayed on each vertex of an attachment (line
segment, arc, or B–spline curve) that is under-determined.
If possible, the profile is reconstructed.
If the profile cannot be reconstructed, “Not Solved” is displayed.
A diagnostic message is displayed and the symbology of constructions
and constraints may be changed.
The question marks are placed at the Active Text Size. If they are not visible, zoom
in and they will become visible. The question marks will automatically disappear
as missing constraints are added to the profile. The total number of question mark
symbols may greatly exceed the remaining degrees of freedom in the profile and do
not necessarily represent the number of constraints needed to make a well-defined
profile. However, they often do represent where constraints should be applied.
It may not be possible to reconstruct the model to satisfy constraints. For
example, constructions might have been modified to such an extent that
the solver cannot “pull them back together.” In this case, you can choose
Undo from the Edit menu to negate the changes.
All constraint placement tools activate Re-solve Constraints automatically.
Constraints can be applied to a modified design without using
5–46 MicroStation Administrator Guide
Building Custom Projects
Modify and Re-solve Constraints
the Re-solve Constraints tool.
Key-in: MODEL UPDATE
Modify and Re-solve Constraints
Used to graphically modify a dimension-driven profile. This tool is
particularly helpful in visualizing the remaining degrees of freedom
in a profile while applying constraints.
In some cases, you can manipulate the question marks interactively, or you
can manipulate attachments that are flagged by question marks to investigate
a profile’s ambiguities with Constructions turned off.
To isolate the effects of interactive manipulations and make the tool more
responsive, the Modify and Re-solve Constraints tool tries to “freeze” as
many of the model’s degrees of freedom as possible.
To modify a dimension-driven profile
1. Select the Modify and Re-solve Constraints tool.
2. Identify an element in the profile.
If the message Cannot modify element is displayed, the identified
element cannot be modified with this tool.
As you move the pointer, the profile is solved and dynamically updated.
3. Accept the modification.Reset to restore the profile as it was.
The message Not Solved is displayed if the profile cannot
be modified as requested.
If the profile is over-constrained, it may not be possible to solve for any
MicroStation Administrator Guide 5–47
Building Custom Projects
Describe Selected Construction or Constraint
pointer location, and you must change or delete constraints to modify it.
Key-in: MODEL MODIFY
Describe Selected Construction or Constraint
Used to display the name of a construction or constraint and the names
of the objects to which it is attached.
To get information about an object in a model
1. Select the Describe Selected Construction or Constraint tool.
2. Identify an element.
3. Accept the element.
The object’s number is displayed at this point. The object’s
description is displayed in the status bar.
Key-in: MODEL INFO
Each object in a model is assigned a unique name, based on its type (for
example, “Line1” for a line, “Tangent2” for a tangent constraint, and so
on). Names are not unique across models. The assigned numbers distinguish
one object from another and have no other significance.
Modify Constraint tool box
The tools in the Modify Constraint tool box can be used to break or trim
constrained geometry, add fillet and chamfer constraints to constrained
5–48 MicroStation Administrator Guide
Building Custom Projects
Modify Constraint tool box
geometry, and modify dimension or variable values.
To Select in the Modify Constraint tool
box
Break an element between constraints
so that additional geometry and
constraints can be inserted.
Break Constrained Geometry (see
page 5-50)
Trim two elements that share a
common intersection.
Trim Constrained Geometry (see
page 5-50)
Add a fillet between two constrained
elements.
Fillet Constrained Geometry (see
page 5-51)
Add a chamfer between two
constrained elements.
Chamfer Constrained Geometry (see
page 5-52)
Change the value of a dimensional
constraint or variable.
Modify Value of Dimension or
Variable (see page 5-55)
Key-in: DIALOG TOOLBOX DDDMODIFY [OFF | ON | TOGGLE]
MicroStation Administrator Guide 5–49
Building Custom Projects
Break Constrained Geometry
Break Constrained Geometry
Used to break elements between constraints in order to insert
additional geometry and constraints.
To place a break between constraints on a line
1. Select the Break Constrained Geometry tool.
2. Identify a line to break.
3. Identify a point on the line.
A constraint is placed at the point of the break.
Key-in: CONSTRAIN MODIFY BREAK
Trim Constrained Geometry
Used to trim two elements that share a common intersection.
5–50 MicroStation Administrator Guide
Building Custom Projects
Fillet Constrained Geometry
To trim two lines that share a common intersection
1. Select the Trim Constrained Geometry tool.
2. Identify the first line of the intersection.
3. Identify the second line of the intersection, then accept with a data point.
The section of each line that extends beyond the intersection is trimmed, and
constraints are placed at the beginning of each line and at the intersection.
Key-in: CONSTRAIN MODIFY TRIM
Fillet Constrained Geometry
Used to add fillet constraints to a constrained profile. You can specify the
size of the fillet radius and you can name the fillet constraint.
Tool Setting Effect
Radius Sets the size of the radius for the fillet constraint.
Create Di- A radius dimension will be placed with the fillet, when on.
mensions
Constraint Sets the constraint name for the fillet constraint.
(dialog
setting)
MicroStation Administrator Guide 5–51
Building Custom Projects
Chamfer Constrained Geometry
To add a fillet at the intersection of two lines
1. Select the Fillet Constrained Geometry tool.
2. In the Radius field, enter the required radius.
3. Identify the first line of the intersection.
4. Identify the second line of the intersection, then accept with a data point.
If Create Dimensions is off, the intersecting lines are filleted
and no dimensions are created.
If Create Dimensions is on, accepting the second line of the intersection
opens the Choose Parameter Name dialog box.
5. Enter a name for the fillet constraint and click OK.
The intersecting lines are filleted, and the dimension of the fillet radius
is displayed with its name below (for example, “rad1 = 0.5000”). If no
name is entered for the constraint, a generic name is given (for example
“Radius23”) and only the dimension is displayed.
Key-in: CONSTRAIN MODIFY FILLET
Chamfer Constrained Geometry
Used to add chamfer constraints to a constrained profile. There are three methods
for specifying the size of the chamfer and you can name the chamfer constraint.
5–52 MicroStation Administrator Guide
Building Custom Projects
Chamfer Constrained Geometry
Tool Setting Effect
Method Sets the placement parameters for the chamfer constraint.
Distances—Sets (1) Distance 1, the chamfer distance
from the vertex, along the first selected surface, and
(2) Distance 2, the chamfer distance from the vertex,
along the second selected surface.
Distance and Angle—Sets (1) the chamfer Distance from
the vertex, along the selected surface, and (2) the angle
formed by the chamfer and the selected surface.
Chamfer Length—Sets the distance between the two
selected surfaces, along the chamfer.
Create Di- When on, chamfer dimensions are placed with the chamfer.
mensions
Distance 1 (Method set to Distances only) Sets the chamfer distance
along the surface that is selected first.
Distance 2 (Method set to Distances only) Sets the chamfer distance
along the surface that is selected last.
Distance (Method set to Distance and Angle only) Sets the chamfer
distance with respect to the selected surface.
Angle (Method set to Distance and Angle only) Sets the chamfer
angle with respect to the selected surface.
Length (Method set to Chamfer Length only) Sets the
length along the chamfer.
Constraint
1 (dialog • (Method set to Distances) Sets the constraint name
setting) for the Distance 1 constraint.
• (Method set to Distance and Angle) Sets the constraint
name for the Distance constraint.
• (Method set to Chamfer Length) Sets the constraint
name for the Length constraint.
MicroStation Administrator Guide 5–53
Building Custom Projects
Chamfer Constrained Geometry
Tool Setting Effect
Constraint
2 (dialog • (Method set to Distances) Sets the constraint name
setting) for the Distance 2 constraint.
• (Method set to Distance and Angle) Sets the constraint
name for the Angle constraint.
To add a chamfer at the intersection of two lines
1. Select the Chamfer Constrained Geometry tool.
2. In the Distance 1 and 2 fields, enter the required values.
3. Identify the first line of the intersection.
4. Identify the second line of the intersection, then accept with a data point.
If Create Dimensions is off, the intersection is chamfered
with no dimensions created.
If Create Dimensions is on, accepting the second line of the intersection
opens the Choose Parameter Name dialog box.
5. Enter a name for the first constraint and click OK.
The Choose Parameter Name dialog box remains open for you
to name the second constraint.
6. Enter a name for the second constraint and click OK.
The intersecting lines are chamfered, and the dimensions are displayed
with their respective names below (for example, “cham1 = 0.5000”). If
no names are entered for the constraints, a generic name is given (for
example, “Distance21”) and only the dimensions are displayed.
Key-in: CONSTRAIN MODIFY CHAMFER
5–54 MicroStation Administrator Guide
Building Custom Projects
Modify Value of Dimension or Variable
Modify Value of Dimension or Variable
Used to edit the value of a variable or dimensional constraint.
Tool Setting Effect
Parameter Sets the value of the variable or dimensional constraint.
To edit the value of a dimensional constraint
1. Select the Modify Value of Dimension or Variable tool.
2. Identify the dimensional constraint.
3. Accept the dimensional constraint.
The “Parameter” field’s label changes to the name of the variable
that sets the dimensional constraint’s value.
4. Key in a new value.
5. Press 〈Tab〉 or 〈Enter〉.
The profile is updated.
Key-in: MODEL EDIT_DIMENSION
MicroStation Administrator Guide 5–55
Building Custom Projects
Dimension-Driven Design dialog box
Dimension-Driven Design dialog box
Used to place derived cells or to modify the dimensions and constants
of dimension-driven cells or derived cells — cells that are derived
from Dimension-driven Cells (see page 5-9). A derived cell’s geometry
is defined by values entered for each dimension or constant and the
dimension-driven cell’s underlying constraints.
Key-in: MDL LOAD DDCELL
Key-in: PLACE CELL DIMENSION
Edit
Sets the value of the dimension or constant that is selected in the list box.
If the cell cannot be derived from the supplied dimension and constant values,
the cell is not placed, and you are prompted to enter new values.
Save Constraints (derived cell placement only)
If on, the Active Cell will be placed with active constraints, so it
can be modified after placement.
When modifying a dimension-driven (or derived) cell, you can also specify
the values by keying in RESET DIMENSION <parameter>[=]<value>
[<parameter>[=]<value> …]. Parameter is the name of some constant in the
model (or possibly the internal name of some dimension), and value is a numeric
constant. Each assignment expression must be preceded by a space or punctuation.
The syntax permits comments enclosed in brackets (“[]”). Upon entry of the
key-in with a valid syntax, the dimension-driven cell is solved and modified.
5–56 MicroStation Administrator Guide
Building Custom Projects
Level Libraries
Level Libraries
The term “level library” refers to a component of a DGN library (see page 5-4)
that contains a level structure — that is, one or more level definitions. They
can be filtered at any time to make only specific levels within a level library
available during the design process. New level libraries can be created, and new
and existing level libraries can be attached, detached, imported, and exported
using the Level Manager dialog box (Settings > Level > Manager).
Level structures are not hierarchical but level library filters are. In MicroStation
level filters are used to combine level definitions into groups.
The level library Attach and Detach utility is a good way to set up Seed
files. CSV files can be manually attached to drive levels, however they
cannot be used in the MS_DGNLIBLIST variable.
Level files (*.lvl) from previous versions of MicroStation will import to
V8. However, any previous group structure will not follow.
A level definition does not technically attach from a level library to a DGN file until
it is used. This is analogous to attaching a cell from a cell library. After attaching
a cell library, the cells are not present in the DGN file until they are placed.
The level library Import utility is valuable for copying levels from a
DGN or CSV file into an active file.
The level library Export utility is valuable for creating a new DGN or CSV file
containing levels that are defined by individual administrators. After defining and
establishing levels and optional level filters, the administrator would export the
levels to the users as a project standard. Users would then attach or import the
levels. It is recommended that the administrator use the file extension *.dgnlib
when exporting a level library. For more information on the mechanics of creating
levels and level filters see the Level System in the User Guide.
Administrators can export level libraries as CSV files by choosing Levels > Export
in the Level Manager dialog box. Once exported, the *.csv file can be opened in
Microsoft Excel where the level definitions can be modified. The modified *.csv
file can then be made available to the users for import into their DGN files.
Furthermore, administrators can achieve ultimate control of level
libraries by connecting Excel to a database via ODBC, whereby
using the database to drive level usage.
MicroStation Administrator Guide 5–57
Building Custom Projects
Color Tables
Color Tables
An element’s color attribute is stored with the element in the DGN file
as a number in the range 0-254. The DGN file color table determines the
correspondence between the 255 color attribute values and display colors. For
example, if according to the DGN file color table color number 3 corresponds to
red, elements with a color attribute of 3 are displayed in red.
You can attach a color table to a DGN file. If a DGN file has a color table
attached, the color table is opened (and its colors used to display elements)
each time the DGN file is opened. Color tables can be customized and
saved in color table files for subsequent attachment to multiple DGN files.
(See “Customizing a Color Table” on page 5-59.)
If a DGN file does not have a color table attached, its color table is the
MicroStation system default color table. The Default Color Table configuration
variable (MS_DEFCTBL) in the Configuration dialog box of the Workspace
menu specifies the default color table so it too can be customized.
When the active workmode is DWG, MicroStation’s handling of color tables
is restricted to maintain compatibility with the DWG format.
Balanced colors
MicroStation uses balanced colors to represent colors in the DGN file. Balanced
colors are a representative spread of colors, evenly spaced across the color
spectrum. Colors of elements in the DGN file are mapped to the colors that
the hardware can display using a “closest match” algorithm.
• If the display hardware supports many colors, then a large balanced
color table can be constructed and the colors of elements in the DGN
file can be accurately represented on screen.
• If the display hardware supports only a few colors (especially 16
or less), then a smaller number of balanced colors must be spread
more thinly across the spectrum — this may cause some colors to
be less accurately represented on screen.
The benefits of balanced colors are:
5–58 MicroStation Administrator Guide
Building Custom Projects
Balanced colors
• Display hardware that supports a small number of colors can be made
to seem to have many more colors than it actually does.
• Elements in references that have their own color tables can be matched to
the balanced colors to more accurately represent their colors.
• Balanced colors allow MicroStation to create realistic renderings of 3D
models regardless of the number of colors in the DGN file, even on
hardware that supports a limited number of colors.
General Procedure — To customize a color table
1. From the Settings menu, choose Color Table.
The Color Table dialog box opens.
2. If the attached color table (or the default color table if none is attached) is not
the color table you want to customize, open a color table file or retrieve the
default color table. From the File menu in the Color Table dialog box, choose
Open to open a color table file or Default to retrieve the default color table.
In the former case, the Open Color Table dialog box opens. It
is operated like the Open dialog box.
3. (If opening a color table file) select a file in the Open Color Table
dialog box and click the OK button.
4. Use the controls in the Color Table dialog box:
To interpolate colors (see page 5-60)
MicroStation Administrator Guide 5–59
Building Custom Projects
Balanced colors
To duplicate a color elsewhere in the table (see page 5-61)
To individually modify a color (see page 5-61)
5. When done customizing the colors, choose Save As from the File
menu in the Color Table dialog box.
The Save Color Table dialog box opens. It operates like
the Save As dialog box.
6. Use the Save Color Table dialog box to save the color table in a color table file.
7. To attach the custom color table to the active DGN file and close the
Color Table dialog box, click the Attach button.
or
To simply close the dialog box, click the Cancel button.
To interpolate colors
1. From the Edit menu in the Color Table dialog box, choose Interpolate Colors.
The Color Interpolation dialog box opens.
2. From the Interpolation Style option menu, choose RGB (Red, Green,
5–60 MicroStation Administrator Guide
Building Custom Projects
Balanced colors
Blue) or HSV (Hue, Saturation, Value).
3. Turn on Start Color and select the starting color by clicking
it in the color palette.
4. Turn on End Color and select the ending color by clicking it in the color palette.
5. To start interpolation, click the Blend button.
6. (Optional) — Repeat steps 2–5 for other color ranges.
7. Click the OK button to accept the color table modifications and
return to the Color Table dialog box.
During this procedure, you can double-click colors to manually modify them using
the Modify Color dialog box (see “To individually modify a color” on page 5-61).
To duplicate a color elsewhere in the table
1. In the Color Table dialog box’s color palette, select the color
you want to duplicate.
2. From the dialog box’s Edit menu, choose Copy Color.
3. Select the color you want to replace with the duplicate of the copied color.
4. From the dialog box’s Edit menu, choose Paste Color.
To individually modify a color
1. In the Color Table dialog box’s color palette, select the color
and click the Change button.
or
In the color palette in the Color Table dialog box or the Color
MicroStation Administrator Guide 5–61
Building Custom Projects
Line Style Libraries
Interpolation dialog box, double-click the color.
The Modify Color dialog box opens.
2. Use the controls in the Modify Color dialog box to adjust the color.
3. When done, click the OK button.
Line Style Libraries
Line style libraries contain custom line style definitions. A line style definition
consists of a name and one or more Line style components (see page 5-64).
In MicroStation V8, line styles can be stored in DGN files. You can
selectively import line styles from a v7 line style library or an AutoCAD
“.lin” file into the open DGN file. Conversely, you can export all custom
line styles stored in the open DGN file to a v7 line style library for use with
MicroStation v7. To perform these operations use the File menu in the Line
Style Editor dialog box (Element > Line Style > Edit).
Copying Line Style Definitions
Line style definitions are copied from source line style libraries to destination
line style libraries. The source line style library is the file that contains the
line style definitions you want to copy, and the destination line style library
is the file to which you copy the selected definitions.
5–62 MicroStation Administrator Guide
Building Custom Projects
Copying Line Style Definitions
To copy line style definitions from one line style
library to another
1. From the Element menu, choose Line Style > Edit.
The Line Style Editor dialog box opens.
2. From the File menu, choose Open.
The Open Line Style Library dialog box opens. (You can also use
File > New to create a new line style library.)
3. In the File list box, select the file you want to be the line style library.
4. Click OK.
The Line Style Editor dialog box displays relevant information on the
line styles contained in the selected line style library.
Once you have a line style library file assigned, you can then select
then the source and destination files.
5. From the Line Style Editor’s File menu, choose Manage.
The Manage Line Style Definitions dialog box opens listing the
line styles in the current line style library.
6. From the File menu, choose Open Source File.
The Select Source Line Style Library dialog box opens.
7. In the File list box, select the name of the file that you want to be the source
file (the file from which you want to copy line styles), and click OK.
The filename and list box on the left contain the source entries; and the
MicroStation Administrator Guide 5–63
Building Custom Projects
Line style components
filename and list box on the right contain the destination entries. You can
copy line styles from the source file into the destination file, rename the line
styles in this file, and delete line style resources from this file. The resource
file is open only for reading and copying line styles into another file; the
original resource file is not modified by copying styles from it.
8. Select the name of the line style definition you want to copy
in the source list box.
9. Click Copy.
or
Drag the line style name over to the Destination list box and drop it.
The line style name appears at the bottom of the Destination
line style name list.
10. Click OK.
You can copy line styles from more than one source file in the destination
file at one time by using File > Open Source File.
You may also open more than one destination file to add styles as well, by
using File > Open Destination File. If you have made changes to the current
destination file, you will be prompted to save them before continuing.
Line style components
A line style component is a component of a line style definition. The line
style library, “lstyle.rsc”, installed in Bentley’s “Workspace\system\symb”
directory contains many sample line style definitions.
The line style component types are stroke patterns, point symbols,
and compound components.
Stroke pattern
A stroke pattern is a pattern of dash strokes and gap strokes that is displayed
repeatedly along the length of an element. For each dash stroke, the length
and optionally, the color and width, are specified.
5–64 MicroStation Administrator Guide
Building Custom Projects
Line style components
Stroke pattern attributes
The following are stroke pattern attributes:
• Shift (the relationship between the stroke pattern, the first stroke,
and the beginning and end of the element).
• Whether the stroke pattern is truncated and restarted for each element
segment (displayable vector) or continued across segments.
• The number of repetitions of the stroke pattern used to display elements.
Stroke attributes
The following are stroke attributes:
• Whether the stroke is a dash stroke or a gap stroke.
• Length, in master units.
• Whether the length is fixed or variable (subject to scaling).
• Whether the stroke is displayed with width and if so, which half or halves.
• Starting and ending width, in master units.
• The type of end cap (if any).
• Whether the stroke can be broken at element vertices.
Point symbol
A point symbol defines how a series of point symbols (like shared cells)
are displayed along the length of an element. A point symbol component
contains an association to a stroke pattern component from which dash stroke
information is extracted to place the point symbols.
MicroStation Administrator Guide 5–65
Building Custom Projects
Line style components
A point symbol is a named group of elements, much like a shared
cell, that includes the following information:
• An association to the stroke pattern on which the component is based.
• Associations between point symbols and strokes in the base stroke pattern.
• How point symbols are justified on strokes.
• Optional offset, rotation, and scale factors.
Compound
A compound component is a combination of components of any type. Compound
components can be nested. The only way to display both dash strokes and point
symbols along the length of an element is to create a compound component.
For each component specified in a compound component, an offset is
specified. The offset value specifies the distance (perpendicularly) from
the working line to where the component is displayed. Offsets can be used
to produce many of the effects available with multi-lines.
5–66 MicroStation Administrator Guide
Building Custom Projects
Line style components
General Procedure — To define a line style
1. From the Element menu, choose Line Style > Edit.
The Line Style Editor dialog box opens.
2. From the dialog box’s File menu, choose New to create a line style
library or Open to open an existing line style library.
The Create Line Style Library dialog box or the Open Line Style
Library dialog box opens. The controls are analogous to the New
and Open dialog box, respectively.
3. Use the dialog box to create or open a line style library.
When you close the dialog box, focus returns to the Line
Style Editor dialog box.
4. Create or modify a line style. See one of the following sections:
Working with stroke pattern components (see page 5-68)
Working with point symbol components (see page 5-73)
Working with compound components (see page 5-77)
MicroStation Administrator Guide 5–67
Building Custom Projects
Working with stroke pattern components
5. From the Edit menu’s Create submenu, choose Name.
A line style named “Unnamed” is inserted in the Styles list box and is
automatically selected. If a component is selected in the Components
list box, >> is displayed next to the component’s type to indicate the
component is directly linked to the new line style definition. (If the
component is a compound component, its subcomponents are part
of the definition — in essence, indirectly linked.)
If a component is not selected, the new line style is linked by default to
the Default solid line internal stroke pattern component. To select and
link a different component, see “To change the component to which
a line style definition is directly linked” on page 5-68.
6. In the Name field below the Styles list box, key in the line style
name (replace “Unnamed”).
The specified name replaces “Unnamed” in the Styles list box.
7. From the File menu in the Line Style Editor dialog box, choose Save.
To change the component to which a line style
definition is directly linked
1. In the Line Style Editor dialog box’s Components list box,
select the desired component.
2. From the dialog box’s Edit menu, choose Link.
3. From the dialog box’s File menu, choose Save.
Working with stroke pattern components
Here are procedures for creating, modifying, and deleting stroke
pattern components.
In some cases, the most efficient way to create a stroke pattern component is to
adapt an existing component by duplicating it and then modifying the duplicate.
5–68 MicroStation Administrator Guide
Building Custom Projects
Working with stroke pattern components
To create a stroke pattern component (by adapting
an existing component)
1. In the Components list box, select the stroke pattern component to adapt.
The controls for working with stroke patterns are displayed.
Controls for
working with
stroke pattern
components
in Line Style
Editor dialog
box
2. From the Edit menu, choose Duplicate.
The component is duplicated. The duplicate is automatically selected
in the Components list box, and a sample line with the stroke pattern
component and the Stroke Pattern itself are displayed.
3. (Optional) — For each stroke you want to delete from the duplicate, select
the stroke, and click the Delete button. To select a stroke, click the stroke in
the Stroke Pattern display. The selected stroke is highlighted.
4. (Optional) — For each stroke you want to add, click the Add button.
Each stroke is added to the (right) end of the Stroke Pattern as a gap
stroke, which is indicated with an unfilled bar.
5. (Optional) — For each stroke you want to change from a gap stroke to a dash
stroke, select the stroke and choose Dash from the Stroke Type option menu.
Each dash stroke is indicated with a filled bar. The resulting stroke pattern
component is displayed above the stroke pattern display.
6. (Optional) — Set other stroke attributes.
To permit the length of the selected stroke to be adjusted when the stroke
pattern is fractionally shifted or repeated a fixed number of times, choose
Variable from the Length option menu. Otherwise, choose Fixed.
MicroStation Administrator Guide 5–69
Building Custom Projects
Working with stroke pattern components
To change the length of the selected stroke, key in the length, in
master units, in the Length field. You can also change the length of a
stroke by dragging its handle, which is located in the Stroke Pattern
display above or below the ending point of the stroke.
To set the type of end cap to be displayed on the selected stroke
when the stroke is displayed with width, choose the desired end
cap type from the Dash Caps option menu.
Dash Caps
(from top):
Arc, Closed,
Extended,
Hexagon, Open
To cause the selected stroke to break at element vertices, choose Break
from the Corners option menu. Otherwise, choose Bypass.
Corners:
Break, Bypass
To display the selected stroke with width, choose Full from
the Width option menu.
or
To cause only the left or right half of the stroke to be displayed (with
width), choose Left or Right from the Width option menu.
or
To display the stroke without width, choose None from the
Width option menu.
Width: Full,
Left
5–70 MicroStation Administrator Guide
Building Custom Projects
Working with stroke pattern components
If the selected stroke is a dash stroke that is set to display with width, to set
the stroke’s start and end width, key in the widths, in master units, in the
Start and End fields. To taper the stroke, set Start and End to different values.
7. (Optional) — Set stroke pattern attributes.
To set the fraction of the first stroke that is displayed at the start
and end of an element (or element segment) displayed using this
stroke pattern, choose Fraction from the Shift option menu and key
in the desired fraction, in decimal, in the field.
To set the distance, in master units, that the stroke pattern is shifted relative to
the beginning of an element (or element segment), choose Distance from the
Shift option menu, and key in the desired distance, in master units, in the field.
To set the number of repetitions of the stroke pattern along the length
of an element (or each segment), choose Count from the Repetitions
option menu and key in the desired number in the field.
To cause the stroke pattern to repeat continuously along the
length of an element (or each segment), choose Unlimited from
the Repetitions option menu.
To truncate and restart the stroke pattern for each element segment
(displayable vector), turn on Single Segment.
To continue the stroke pattern across element segments,
turn off Single Segment.
MicroStation Administrator Guide 5–71
Building Custom Projects
Working with stroke pattern components
Effect of Shift
settings based
on dash and
gap at top:
Distance = 0.0
(top); Distance
= 0.2 (center);
Fraction = 0.5
(bottom)
8. (Optional) — In the field below the Components list box, key
in the component description.
9. From the File menu in the Line Style Editor dialog box, choose Save.
To create a stroke pattern component (without adapting
an existing component)
1. From the Edit menu’s Create submenu, choose Stroke Pattern.
A new, blank row is inserted and is automatically selected in the Components
list box. The controls for working with stroke patterns are displayed.
2. Follow the steps in “To create a stroke pattern component (by
adapting an existing component)” (page 5-69), beginning with
step 4. Steps 4 and 5 are not optional.
To modify a stroke pattern component
1. In the Components list box, select the stroke pattern component to modify.
The controls for working with stroke patterns are displayed, along with a
sample line with the stroke pattern component and the stroke pattern itself.
2. Follow the steps in "To create a stroke pattern component (by adapting an
existing component)" (page 5-69), beginning with step 3.
5–72 MicroStation Administrator Guide
Building Custom Projects
Working with point symbol components
To delete a stroke pattern component
1. In the Components list box, select the stroke pattern component to delete.
A sample line with the stroke pattern component and the stroke
pattern itself are displayed.
2. From the Edit menu, choose Delete.
3. From the File menu in the Line Style Editor dialog box, choose Save.
Working with point symbol components
The following are procedures for creating, modifying, and deleting point
symbol components, and creating a point symbol.
In some cases, the most efficient way to create a point symbol component is to
adapt an existing component by duplicating it and then modifying the duplicate.
To create a point symbol component (by adapting
an existing component)
1. In the Components list box, select the point symbol component to adapt.
The controls for working with point symbol components are displayed.
MicroStation Administrator Guide 5–73
Building Custom Projects
Working with point symbol components
2. From the Edit menu, choose Duplicate.
The component is duplicated. The duplicate is automatically selected in the
Components list box, and a sample line with the point symbol component,
the base stroke pattern, and the point symbol itself are displayed.
3. (Optional) — Click the Base Stroke Pattern button.
The Base Stroke Pattern dialog box opens.
4. (Optional) — In the Base Stroke Pattern dialog box, select a stroke pattern
component on which to base the new point symbol component, and click
the OK button (or double-click the desired component).
5. (Optional) — Back in the Line Style Editor dialog box, select the stroke
with which you want to associate a point symbol by first having the
desired Point Line Style displayed. Then, click the Select button at the
bottom of the dialog box in the stroke pattern display.
The selected stroke is highlighted.
6. (Optional) — Click the Select Symbol button.
The Select Point Symbol dialog box opens. All point symbols in
the open line style libraries are available for selection. To create
additional point symbols and make them available for selection, see
“To create a point symbol” on page 5-77.
5–74 MicroStation Administrator Guide
Building Custom Projects
Working with point symbol components
7. (Optional) — In the Select Point Symbol dialog box, select a point symbol,
and click the OK button (or double-click the desired point symbol).
Back in the Line Style Editor dialog box, the resulting point symbol
component is displayed below the list boxes.
8. (Optional) — Specify the association between the point symbol
and the selected stroke:
To put the origin of the associated point symbol on the midpoint of
the stroke, choose Center from the Origin option menu.
or
To put the origin of the associated point symbol on the starting point (left
end) of the stroke, choose Left from the Origin option menu.
or
To put the origin of the associated point symbol on the ending point (right
end) of the stroke, choose Right from the Origin option menu.
To specify an additional point symbol origin horizontal offset distance
(from the justification point set on the stroke in the previous step),
key in the desired distance, in master units in the direction of the
stroke pattern (x-axis), in the X Offset field.
To specify an additional point symbol origin vertical offset distance
(from the justification point on the stroke), key in the desired distance,
in master units in the direction perpendicular to the stroke pattern
(x-axis) and its plane, in the Y Offset field.
MicroStation Administrator Guide 5–75
Building Custom Projects
Working with point symbol components
To set the point symbol rotation angle, key in the desired angle,
in degrees, in the Rotation field.
9. (Optional) — Repeat steps 5-8 to associate point symbols
with additional strokes.
10. (Optional) — In the field below the Components list box, key
in the component description.
11. From the File menu in the Line Style Editor dialog box, choose Save.
To create a point symbol component (without adapting
an existing component)
1. From the Edit menu’s Create submenu, choose Point.
A new, blank row is inserted and is automatically selected in the Components
list box. The controls for working with point symbols are displayed.
2. Follow the steps in “To create a stroke pattern component (by
adapting an existing component)” (page 5-69), beginning with
step 3. Steps 3-8 are not optional.
To modify a point symbol component
1. In the Components list box, select the point symbol component to modify.
The controls for working with point symbols are displayed, along
with a sample line with the point symbol component, the base
stroke pattern, and the point symbol itself.
2. Follow the steps in "To create a stroke pattern component (by adapting an
existing component)" (page 5-69), beginning with step 3.
To delete a point symbol component
1. In the Components list box, select the point symbol component to delete.
A sample line with the point symbol component, the base stroke
5–76 MicroStation Administrator Guide
Building Custom Projects
Working with compound components
pattern, and the point symbol itself are displayed.
2. From the Edit menu, choose Delete.
3. From the File menu in the Line Style Editor dialog box, choose Save.
To create a point symbol
1. Draw the elements that will be part of the point symbol.
2. Select or fence the elements. If you use the fence, the Fence (Selection)
Mode is ignored; only elements completely enclosed by the fence are used.
3. (Optional) — Use the Define Cell Origin tool (see the “Using Cells”
chapter in the User Guide) to define the point symbol origin.
4. In the Components list box, select any point symbol component.
The controls for working with point symbol components are displayed.
5. Click the Create button.
The Create Point Symbol dialog box opens.
6. In the Name field, key in a name for the symbol.
7. Click the OK button.
8. If you skipped step 3, enter a data point to define the point symbol origin.
If a point symbol with the same name is already present in the library, an alert
box containing that information is displayed, and you are given the option of
overwriting the existing point symbol or cancelling creation.
Working with compound components
Here are procedures for creating, modifying, and deleting compound components.
In some cases, the most efficient way to create a compound component is to adapt
an existing component by duplicating it and then modifying the duplicate.
MicroStation Administrator Guide 5–77
Building Custom Projects
Working with compound components
To create a compound component (by adapting
an existing component)
1. In the Components list box, select the compound component to adapt.
The controls for working with compound components are displayed.
Controls for
working with
Compound
components
in Line Style
Editor dialog
box
2. From the Edit menu, choose Duplicate.
The component is duplicated. The duplicate is automatically
selected in the Components list box, and a sample line with the
compound component is displayed.
3. (Optional) — For each subcomponent you want to remove from
the duplicate, select the subcomponent in the Sub-Components
list box, and click the Remove button.
4. (Optional) — To insert a subcomponent, click the Insert button.
The Select Component dialog box opens.
5–78 MicroStation Administrator Guide
Building Custom Projects
Working with compound components
5. (Optional) — In the Select Component dialog box, select a component, and
click the OK button (or double-click the desired component).
Back in the Line Style Editor dialog box, the component is listed
in the Sub-Components list box.
6. (Optional) — Repeat steps 3-4 to insert additional subcomponents
in the new compound component.
As you insert additional subcomponents, a sample line with the resulting
compound component is displayed above the subcomponents list box.
7. (Optional) — To cause a component to be displayed parallel to the work
line, select the component in the Sub-Components list box. Then, in the
Offset field, key in the desired offset distance, in master units measured
perpendicular to the work line. Repeat for additional components as desired.
8. (Optional) — In the field below the Components list box, key
in the component description.
9. From the File menu in the Line Style Editor dialog box, choose Save.
To create a compound component (without adapting
an existing component)
1. From the Edit menu’s Create submenu, choose Compound.
A new, blank row is inserted and is automatically selected in the Components
list box. The controls for working with compound components are displayed.
2. Follow the steps in “To create a stroke pattern component (by
adapting an existing component)” (see page 5-69), beginning with
step 4. Steps 4 and 5 are not optional.
To modify a compound component
1. In the Components list box, select the compound component to modify.
The controls for working with compound components are displayed,
MicroStation Administrator Guide 5–79
Building Custom Projects
Technical background
along with a sample line with the compound component.
2. Follow the steps in “To create a stroke pattern component (by adapting an
existing component)” (see page 5-69), beginning with step 3.
To delete a compound component
1. In the Components list box, select the compound component to delete.
A sample line with the compound component is displayed.
2. From the Edit menu, choose Delete.
3. From the File menu in the Line Style Editor dialog box, choose Save.
Technical background
The attribute data section of an element placed with a line style contains a
name ID plus any line style modifiers specified in the Line Styles dialog box.
The name ID identifies only the name of the line style in an ID-to-Name map
that is contained in the DGN file. This name is used to obtain the resource
type and ID of each line style component in the line style definition based on
a Name-to-Resource ID map that is stored in the line style library, which is
a resource file along with the component definitions themselves.
The name indirection is necessary to avoid the need for unique component
resource IDs across many different line style libraries. It also provides a
simple method for replacing line styles for different display options. Line
styles can be completely replaced simply by changing line style libraries,
provided the new line style library contains a compatible Name-to-Resource
ID map. (Line style libraries are binary-compatible across all MicroStation
platforms.) The indirection also makes it possible for a single line style
component to be contained in multiple line style definitions.
Dimension Style Libraries
The term “dimension style library” refers to a component of a DGN library
(see page 5-4) that contains dimension styles. To create a dimension style, use
the Dimension Styles dialog box (Element > Dimension Styles).
5–80 MicroStation Administrator Guide
Building Custom Projects
Multi-line Style Libraries
Multi-line Style Libraries
The term “multi-line style library” refers to a component of a DGN library
(see page 5-4) that contains multi-line styles. To create a multi-line style, use
the Multi-line Styles dialog box (Element > Multi-line Styles).
Settings Files
Settings files contain settings groups which in turn contain settings group
components. For information about using already defined settings groups
and their components, see “Using the Select Settings Window” in the
“Placing Elements in 2D” chapter of the User Guide.
While you can still define dimension and text settings groups and save
them in settings files, you should instead define dimension styles using the
Dimension Styles dialog box, and text styles using the Text Styles dialog
box, and save these styles to DGN libraries (see page 5-4).
This section describes how to create and modify settings files, settings
groups, and settings group components. The Edit Settings dialog
box is used to perform these functions.
To open the Edit Settings window
1. From the Settings menu, choose Manage.
The Select Settings window opens.
The listed settings groups and components are stored in the open
settings file; its filename is shown in the title bar.
2. From the Select Settings window’s File menu, choose Edit.
If you selected a legacy V7 settings file (.stg), the Edit V7 Settings dialog
opens. If you create a new V8 settings file, the Edit V8 Settings dialog opens
MicroStation Administrator Guide 5–81
Building Custom Projects
Creating settings files
Edit V8 Settings
dialog box
Edit V7 Settings
dialog box
Creating settings files
Because settings group components refer to other types of module data such
as cell libraries and custom line styles, you will likely want to create your
own settings files. Although you can create settings files “from scratch,”
it is easier to modify a copy of an existing settings file.
5–82 MicroStation Administrator Guide
Building Custom Projects
Creating settings files
The sample workspace settings files are excellent examples and starting
points for customization. They are installed in workspace “data” directories
— for example, “Workspace\system\data\styles.stg”. Use your system’s
file copying function to make a copy of a settings file. The Edit Settings
dialog box contains controls that make it easy to duplicate settings groups
and individual components in an existing settings file.
To create a settings file “from scratch”
1. From the Edit Settings dialog box’s File menu, choose New.
The Create New Settings File dialog box opens.
2. Use the Drives option menu and Directories list box to specify the destination
directory. See “Modifying the Project Configuration File” on page 5-90.
3. In the Files field, key in the desired filename.
4. Click the OK button.
The focus returns to the Edit Settings dialog box. The title bar shows
the name of the new settings file indicating that the file is open for
the creation and maintenance of settings groups.
To duplicate a settings group or component
1. From the Category option menu in the Edit Settings dialog box, choose the
category — Drawing, Scale, or Working Unit — to which the settings
group (or the “parent” settings group of the component) belongs.
2. In the Group or Component list box, select the settings group
or component to duplicate.
3. From the dialog box’s Edit menu, choose Duplicate.
You can also create settings files from settings group specifications stored
in text files using the ASCII Group utility.
MicroStation Administrator Guide 5–83
Building Custom Projects
Creating settings files
General Procedure — To create a settings group “from scratch”
1. From the Category option menu in the Edit Settings dialog box,
choose the desired settings group category — Drawing (the
default), Scale, or Working Units.
2. If the open settings file, identified in the title bar, is not the file in which
you want to create the settings group, then you must create or open the
desired file. From the File menu in the Edit Settings dialog box, choose
New to create a file or Open to open an existing file.
The Create Settings File dialog box or the Open Settings File
dialog box opens. The controls are analogous to the New and
Open dialog box, respectively.
Use the dialog box to create or open a settings file.
When you are done, focus returns to the Edit Settings dialog box.
3. From the Edit menu’s Create submenu, choose Group.
A new group, Unnamed, is added to the Group list box and
automatically selected.
4. In the field below the Group list box, key in a meaningful group name.
5. If the group is a Scale or Working Units settings group, define its
settings (see “To define or modify the settings in a scale settings
group” on page 5-85 or “To define or modify the settings in a
working units settings group” on page 5-85).
or
If the group is a Drawing settings group, define its components (see
“Defining a Drawing Component” on page 5-86).
5–84 MicroStation Administrator Guide
Building Custom Projects
Creating settings files
To define or modify the settings in a scale settings group
1. From the Category option menu in the Edit Settings dialog box, choose Scale.
2. In the Group list box, select the desired group.
3. From the Edit menu in the dialog box, choose Modify.
The Edit Scale dialog box opens.
4. Use the fields and option menus to specify the relationship between
paper units and drawing units.
5. Click the OK button.
To define or modify the settings in a working
units settings group
1. From the Category option menu in the Edit Settings dialog
box, choose Working Unit.
2. In the Group list box, select the desired group.
3. From the Edit menu in the dialog box, choose Modify.
The Edit Work Units Group dialog box opens.
MicroStation Administrator Guide 5–85
Building Custom Projects
Creating settings files
4. From the Master Units option menu, choose the desired master units.
5. From the Sub Units option menu, choose the desired subunits.
6. In the Pos Units Per Sub-Unit field, key in the number of
positional units per subunit.
7. Click the OK button.
General Procedure — To define a drawing component
1. Locate an element whose attributes you want to match in the component
definition, and remember its location.1
2. If you are defining a Cell component2 and you will want the active scale
factors to be automatically adjusted when the component is selected in the
Select Settings window, check for the existence of an appropriate working
units settings group(s) and, optionally, an appropriate scale settings group(s).
For more information about scale and working units settings groups, consult
the following table and refer to the cross-referenced section.
Group type For background For the definition
information, see procedure, see
Scale “Scale settings “To define or modify
groups” in the the settings in a scale
“Placing Elements settings group” on
in 2D” chapter of the page 5-85
User Guide
Working Units “Working units “To define or modify
settings groups” in the settings in a
the “Placing Elements working units settings
in 2D” chapter of the group” on page 5-85
User Guide
3. From the Category option menu in the Edit Settings dialog
box, choose Drawing.
4. In the Group list box, select the group to which the component belongs.
1 The general procedure for modifying an existing drawing component is similar. Only steps 5-6 are unique to
the creation procedure, and steps 1, 8, and 9 are optional in the modification procedure.
2 Actually, a Cell component or an Active Point or Area Pattern component that will specify a cell.
5–86 MicroStation Administrator Guide
Building Custom Projects
Creating settings files
5. From the Edit menu’s Create submenu, choose the type of
component you want to create — Active Point, Area Pattern, Cell,
Dimension, Linear, Multi-line, or Text.
A new group, Unnamed, is added to the Component list box
and automatically selected.
6. In the field below the Component list box, key in a meaningful
component name.
7. In the Component list box, double-click the component.
or
From the Edit menu, choose Modify.
A Modify component dialog box opens in which you can
define the component’s settings.
Modify
component
dialog box
(Linear
component
type)
8. Click the Match button.
9. Identify an existing element attributes will serve as the basis
for the component’s settings.
The controls in the Modify component dialog box update to reflect the
attributes of the identified element. The check box settings are not affected.
10. Turn on the check boxes that directly correspond to active settings — Level,
Color, (Line) Style, (Line) Weight, (Active) Angle, (Active) Cell, (Active)
Scale, etc. — that you want to be automatically adjusted when the component
is selected in the Select Settings window. For example, if you want the
Active Color to be automatically set when the component is selected (to the
color of the element you identified in step 9), turn on the Color check box.
11. To fine-tune the matched settings, use the fields and option menus.
12. If the component type is Text (or Active Point and the element you identified
in step 9 is a text element) and you want the active text size and spacing
MicroStation Administrator Guide 5–87
Building Custom Projects
Cell scaling
settings to be automatically adjusted when the component is selected,
specify the manner in which text is to be sized and spaced.
or
If the component type is Dimension or Multi-line, select the dimension or
multi-line style. (For information about defining styles, see “Defining
dimension and multi-line styles” on page 5-89.)
13. Click to accept the element identified in Step 9.
14. Click the Save button.
The Modify component dialog box closes and focus returns
to the Edit Settings dialog box.
It is possible, although not as easy, to define a drawing settings group component
without using the element attribute matching capability (Match button, step 8).
Cell scaling
The manner in which selecting a cell component3 in the Select Settings window
affects the active scale factors takes the cell library’s working units settings and
optionally, the active scale settings group, into account. (Using the Match button
in the Modify component dialog box matches the default scale factors to an
existing cell. See “Defining a Drawing Component” on page 5-86, steps 2 and 8.)
To specify cell scaling
1. In the X field in the Scale section of the Modify component dialog
box, key in default horizontal scale factor.
Scale section of
the Modify Cell
component dialog
box
3 Actually, a Cell component or an Active Point or Area Pattern component that specifies a cell.
5–88 MicroStation Administrator Guide
Building Custom Projects
Defining multi-line styles
2. In the Y field, key in the default vertical scale factor.
3. In the Z field, key in the default depth scale factor.
4. From the Cell Work Units option menu, choose the working units used
to create cells. (The option menu items correspond to working units
settings groups defined in the open settings file.)
For cell placement, the default scale factors will be automatically adjusted
by the ratio of the active DGN file’s working units to the cell library’s
working units. For example, if a cell was created with the units ft:10:100
(1000 UORs/ft.) and the current units are ft:12:8000 (96,000 UORs/ft.),
the default scales are adjusted by a factor of 96.
5. (Optional) — To adjust the default scale factors upon cell placement as
specified in the active scale settings group (number of paper units per master
unit), turn on Apply Drawing Scale. For example, in a metric design with
a scale 1:100, there are 100 master units to 1 paper unit. In this case the
default scale factors would be adjusted by 100.0. If you are working on a
design with a scale of 1"=100’ then the adjustment factor would be 1200.0
(1" on paper = 1200" on the design plane). Likewise, if the scale is 1/4" = 1’
the adjustment factor would be 48.0 (1" on paper = 48" on the design plane).
Defining multi-line styles
It is necessary to define a multi-line style before selecting it as the basis
for a Multi-line settings group component.
To define a multi-line style
1. Use the Multi-line Styles dialog box (Element > Multi-line Styles)
to define a multi-line as desired. See “To define a multi-line” in the
“Advanced 2D Drafting Techniques” chapter of the User Guide.
2. From the Edit Settings dialog box’s Style menu, choose Multi-Line.
The Edit Multi-line Styles dialog box opens.
MicroStation Administrator Guide 5–89
Building Custom Projects
Text Style Libraries
3. Click the Get Active button.
The style is created. It is assigned a Name and Description each beginning
with “Mline” and ending with one or more numeric characters. The
list box entry for the new style is automatically selected.
4. In the Name field, key in a meaningful style name.
5. In the Description field, key in a meaningful description.
To delete a multi-line style definition
1. From the Edit Settings dialog box’s Style menu, choose Multi-Line.
The Edit Multi-line Styles dialog box opens.
2. In the list box, select the style you want to delete.
3. Click the Delete button.
Text Style Libraries
The term “text style library” refers to a component of a DGN library (see
page 5-4) that contains text styles. To create a text style, use the Text
Styles dialog box (Element > Text Styles).
Modifying the Project Configuration File
The project configuration file is a text file, which you can edit using any word
processor or text editor. See “Configuration Variable File Syntax ” on page 2-55.
5–90 MicroStation Administrator Guide
Building Custom Projects
Modifying the Project Configuration File
This table shows which project configuration variables specify
which parts of a module.
Module component Project configuration variable
DGN files MS_DEF (DGN files)
MS_RFDIR (References)
DGN Libraries MS_DGNLIBLIST (DGN Library List)
Seed DGN files and MS_SEEDFILES (Seed File Location)
drawing sheet files MS_DESIGNSEED (Default DGN file Seed)
MS_SHEETSEED (Drawing Sheet Seed File)
Cell libraries MS_CELL (Cell Library Directories)
MS_CELLLIST (Cell Library List)
Dimension style MS_DGNLIBLIST (DGN Library List)
libraries
Level libraries MS_DGNLIBLIST (DGN Library List)
MS_LEVEL_LIB_DIR (Level Library Path)
Text style libraries MS_DGNLIBLIST (DGN Library List)
Color tables MS_DEFCTBL (Default Color Table)
Font libraries MS_SYMBRSRC (Symbology Resources)
Function key menus MS_FKEYMNU (Function Key Menu)
Line style libraries MS_SYMBRSRC (Symbology Resources)
Settings files MS_SETTINGS (Settings Resource)
MS_SETTINGSDIR (Settings Directory)
Material table files MS_MATERIAL (Material Palettes)
(and other files MS_PATTERN (Pattern Maps)
associated with MS_BUMP (Bump Maps)
rendering and images) MS_IMAGE (Images)
MS_SHADOWMAP (Shadow Maps)
Tag set libraries MS_TAGOUTPUT
Tag report template MS_TAGTEMPLATES (Tag Templates)
files
When a new Project is created, MicroStation uses the file "project.template" to
set project configuration variables that are normally required for a project. The
project template variables are established in the new project file (*.pcf) which is
stored in the directory “Workspace\projects\examples” by default. Administrators
MicroStation Administrator Guide 5–91
Building Custom Projects
Packaging Module Data Files
can open new project files in a text editor to edit the list of variables.
If an administrator determines that additional configuration variables are needed
in the project template, the project template file can also be opened in a text editor.
The project template is located in the default directory “Workspace\projects”.
You are not required to set these configuration variables at the Project level.
The above table is intended as a recommendation. Depending on site or
workgroup requirements, it may be preferable to set some or all of these
configuration variables at the Site or User level.
The configuration variable for digitizing a tablet menu (MS_MENU) can
be set at the system level using the syntax explained in “Configuration
Variable File Syntax” (see page 2-55).
Packaging Module Data Files
Packaging refers to the bundling of a DGN file and the associated module
data files for use on a different system. The Create Package wizard (Utilities
> Packager) enables you to create new packages, add to existing ones, and
restore design data, including the supporting resources.
5–92 MicroStation Administrator Guide
Building Custom Projects
Packaging Module Data Files
The Create
Package dialog
box.
The Create Package wizard is an intuitive utility. Once opened, it will guide
and instruct the user through the process of packaging.
MicroStation Administrator Guide 5–93
5–94 MicroStation Administrator Guide
Part II: Digital Rights Technologies
File Protection
File Protection makes the contents of a protected DGN file inaccessible
to unauthorized persons, even if they hold a copy of the file. File
Protection is based on standardized cryptography and digital certificate
mechanisms that restrict access in several ways, from simple password
protection to digital rights enforcement.
The author limits access to designated users who are identified by digital
certificates. Before opening a protected file, MicroStation authenticates the
current user, disables functions that are not permitted, and applies the assigned
rights. When in a rights-restricted file, MicroStation loads only digitally signed
applications that have been identified by the author as rights-compliant.
What is File Protection?
File Protection applies primarily to the distribution of files to locations and
recipients outside of an organization’s normal file-management system.
Therefore, you will normally apply file protection to the copies of your DGN files
that leave your control. File protection has the following components:
• Encryption (see page 6-4)
• Recipients
• Rights (see page 6-4)
• Expiry
General Procedure — Protecting a file
1. Enable File Protection functionality.
MicroStation Administrator Guide 6–1
File Protection
Author and user distinction
2. Protect the file (see page 6-6) with a certificate or a password.
3. Create licenses for users to access the protected file.
You can create certificate (see page 6-14), password (see page 6-13)
and/or everyone (see page 6-12) licenses.
4. Identify digital rights-compliant applications (see page 6-22).
5. Distribute protected file to the appropriate users.
Author and user distinction
It is important to distinguish between the author, the person who protects a
file and has unlimited rights, and users, the people who open and work with
a protected file. File Protection assumes that any user who has physical
read/write access to an unprotected file is authorized to protect it. In other
words, the author is simply the person who first protects the file.
Levels of security
Using File Protection, an author can protect his digital property at two levels by:
• excluding unauthorized persons
The author protects a file by encrypting it, then authorizing only specific
digital certificates and/or passwords to access it. It is impossible for anyone
to open a protected file without an authorized certificate or password.
• restricting usage rights to authorized persons
The author uses an authorized certificate or password to restrict usage by
the user. Specifically, the author restricts the user’s right to print, export,
and/or modify the file or places a time limit on the user’s right to access
the file. The author may also specify an “authentication URL” to function
as a dynamic check on a user’s right to access the file.
To ensure that your files will become more secure over time, older
versions of MicroStation will be unable to open files that are protected
by newer versions of MicroStation.
Enabling protection
File Protection is disabled by default in MicroStation. To enable
6–2 MicroStation Administrator Guide
File Protection
Enabling protection
the File Protection functionality, change the configuration variable
MS_PROTECTION_ENABLE from 0 to 1, 2 or 3.
To enable file protection
1. From the Workspace menu, choose Configuration.
The Configuration dialog box opens.
2. In the Category list box, select Protection.
The File Protection configuration definitions are displayed.
3. Select the definition to edit, then press the Edit button.
The Edit Configuration Variable dialog box opens.
4. With the Edit Mode set to Overwrite, replace the 0 in the New Value
MicroStation Administrator Guide 6–3
File Protection
Encryption
field with the desired file protection value.
File Protection values Description
0 Disables file protection (default)
1 Enables password or certificate protection
2 Enables password protection
3 Enables certification protection
The value also changes in the Expansion field and the OK
button becomes active.
5. Click the OK button.
The Configuration dialog box displays.
6. Click OK.
The Alert box opens.
7. Click Yes to save the configuration changes.
The configuration change does not take affect until you completely
exit then re-start MicroStation.
MS_PROTECTION_ENABLE replaces the old MS_PROTECTION_ENCRYPT.
Encryption
File Protection encrypts a file so that it can only be opened with an encryption
key. Encryption scrambles all of the data in the DGN file making it
impossible to use the data until it is unscrambled. There are several ways
to provide this key to users while keeping it secret.
By default, File Protection encrypts the file’s thumbnail image and summary
properties. These items are shown by Windows File Explorer, by MicroStation
Manager, and by the File Properties dialog box. To make either of these items
unencrypted, set the MS_PROTECTION_NOENCRYPT_THUMBNAIL and/or
MS_PROTECTION_NOENCRYPT_PROPERTIES configuration variables.
Rights
The author controls who can access the file’s contents as well as grants
or denies rights to users to publish or modify data. MicroStation disables
all commands for which the corresponding right is not granted. File
6–4 MicroStation Administrator Guide
File Protection
Unlimited rights
Protection defines the following rights:
Type of Access Description
View See contents displayed on the screen
Print Plot contents of the file to paper
Edit Modify contents of the file
Export Edit > Copy and ^C — copy (or cut) elements to the clipboard
File > Export/SaveAs — save the contents of the
file to a different format
File > Save As — save the contents of the file to a different
name without encryption or restrictions
Fence File
Generate an e-plot
Since view right is the default right, it is not explicitly granted by the author.
Any user authorized to access the file has the right to view it. The remaining
rights control how or if the user can capture the contents.
Unlimited rights
File Protection also defines the “unlimited” right. Unlimited implies all basic
rights, plus the right to grant rights and authorize users. Anyone with unlimited
rights fills the role of the author who can assign unlimited rights to other users.
Authorizing Users and Assigning Rights
An author creates one or more licenses to identify users and their rights.
In turn, to open a protected file, a user acquires and uses a license which
is stored in a protected file. A user must be authenticated in order to
acquire a password or certificate-based license. Additional authentication
checks can be set up via a server through an authentication URL. An author
can also set the time when a license will expire or use the authentication
URL to revoke access to the protected file.
Authenticating users
An author can identify authorized users in the following ways:
MicroStation Administrator Guide 6–5
File Protection
Protecting a file
Authentication Type Description
Digital Certificate A certificate-based recipient license is usable only by the person
who owns the designated certificate. This is similar to sending
an encrypted e-mail to the recipient. That is, the author uses
the user’s public key to create a license that can only be opened
by the recipient using the corresponding private key. When
opening a protected file, MicroStation looks in the user’s secure
keystore for the needed private key. MicroStation considers
possession of the private key as proof of the recipient’s identity.
This authenticates the user as an authorized user. MicroStation
then grants the rights contained in the recipient license.
Smart Card A smart card is a variation of a certificate-based recipient
license. A user arranges for a private key corresponding to
their digital certificate to be stored on a “token” or “smart
card.” When MicroStation accesses the private key, the user is
required to supply the smart card and to authenticate himself.
Failing either of those, the license does not open.
Password Anyone who knows the password can use a password license.
Usually, the author creates multiple passwords conveying
different rights to the same file. Then the author sends passwords
to the users via some “secure” channel. When opening a
password-protected file, MicroStation prompts the user, finds
the license corresponding to the supplied password, and then
grants the rights contained in the password license.
Everyone The everyone license is usable by everyone, without credentials.
This option is generally useful only when combined with limited
rights or with an authentication URL. The everyone license
can also be added to a set of targeted password or recipient
licenses. In those cases, the everyone license is selected as the
default in case the user has access to no other license
Authentication URL The authentication URL can modify any of the license types
listed above. If the author adds a URL, MicroStation only uses
the license if the user can also access the URL. The URL may
identify a file on a secure WebDAV server or on a site accessed
via a VPN. This allows an organization to apply its own user
authentication on top of the license authentication mechanism.
Protecting a file
To protect a file, the author invokes the File > Protection > Protect command.
6–6 MicroStation Administrator Guide
File Protection
Protecting a file
This is only done once, then the menu item is disabled in the protected file.
File menu
showing
Protection
menu options
A user with unlimited rights to a protected file can unencrypt the file without
prompting for confirmation with the PROTECT ENCRYPT REMOVE key-in.
You can use the PROTECT NOPROTECT key-in to mark a file so that the
encryption commands won’t work. However, another user could encrypt
the file by using the reverse key–in to clear the flag. This key-in is only
intended to communicate the file owner’s wishes to the user.
Protecting with certificate or password
The Protect dialog box allows the author to use either a certificate
or a password to protect a file.
MicroStation Administrator Guide 6–7
File Protection
Protecting a file
Protecting with Certificate is the preferred method. MicroStation
encrypts the file using a random key, then creates a license with
unlimited rights for the specified certificate.
Protecting with Password allows the author to supply a password to protect
the file. MicroStation encrypts files using the password and creates a
password license with unlimited rights for that password.
Typically, the author identifies his own certificate to protect a file. This
gives the author access to the file allowing for additions or changes to the
licenses. Alternatively, the author can use some other person’s certificate
to protect the file. In that case, the file is accessible to that other person
only. This approach only makes sense when applied to a copy of the file and
only if the author will not need access to the file later on.
Protecting a file with a certificate
The author can select certificates from their personal certificate store or certificate
files. After the author identifies a certificate, the OK button on the Protect
dialog is enabled. When the author presses OK, the file is protected.
6–8 MicroStation Administrator Guide
File Protection
Protecting a file
To protect a file with a certificate
1. From the Protect dialog box, click the With Certificate button.
2. To select a certificate from your personal certificate store, click the Choose
Certificate icon and choose a certificate for the Certificate dialog box.
or
To select a certificate file, click the Choose Certificate file icon and choose
a certificate file from the Certificate files dialog box.
3. Click OK.
The file is protected with the certificate.
If you try to protect a file with a certificate sent to you buy someone
else and it could prevent you future access to your own file, you will
receive the following warning message:
MicroStation Administrator Guide 6–9
File Protection
Protecting a file
It is a good idea to protect your private key against loss. Check with
Microsoft for the best method to protect your private key.
Protecting a file with a password
The author can limit access to a file so that a user must supply the correct
password before gaining access to the file. Protecting with a password is
recommended only for those who do not have a digital certificate because
password protection can be less secure than a certificate because it is easier to lose
or accidentally disclose. However, password-protecting a file can be convenient
because recipients do not need certificates. Additionally, passwords can be a good
solution for archiving protected files because they do not have to expire.
To protect a file with a password
1. From the Protect dialog box, click the With Password button.
2. Type the desired password to protect the file in the Password field.
3. Retype the password in the Confirm field
4. Click OK.
The file is protected with the password.
The MS_PROTECTION_PASSWORD_MINIMUM configuration variable
sets the minimum length of a file protection password. The default is 5.
Setting this variable to 0 allows for a blank password.
The MS_PROTECTION_PASSWORD_MIXED configuration variable
determines if a file protection password can contain a mixture of numbers
6–10 MicroStation Administrator Guide
File Protection
Protecting a file
and letters. The default (0) permits only letters in the password. Setting
the variable to 1 requires a combination of numbers and letters in the
password. This option is more secure since it is harder to guess a mixed
password than an all numeric password.
Creating licenses to authorize users
After protecting the file, the Protect command opens the Digital Rights dialog
box. MicroStation created a license for the certificate used to protect the
file. This license grants unlimited (‘*’ stands for unlimited) rights. Initially
this is the only recipient authorized to access the file.
Digital Rights
dialog box with
initial license
create when file
was protected
Nobody, including the author, is able to delete or modify the author’s
license. This prevents the author from accidentally locking himself out of the
file or denying himself the right to administer rights. The author can add
other recipients and assign rights to them. Only the author (or anyone with
unlimited rights) can open the Digital Rights dialog box. A user who gains
access to this file by using a license sees only the description of his own
license, including rights, expiry, URL, and annotation data.
If the author used a certificate belonging to someone else to encrypt the
file, then the author will only have access to the encrypted file until
the end of the current session. The person whose certificate was used
to encrypt the file has unlimited access.
The MS_PROTECTION_LICENSE_ENABLE configuration variable controls
the type of licenses that can be added to a protected file
Value Description
0 Disable license creation
1 Enable password licenses
2 Enable certificate licenses
MicroStation Administrator Guide 6–11
File Protection
Protecting a file
Value Description
4 Enable Everyone licenses
7 (default) Enable all types of licenses
Add individual values together to enable two or more license types.
The MS_PROTECTION_ENABLE configuration variable controls the
method by which a file is encrypted. Some organizations do not want to
password protect a file for fear that password could be forgotten. Using the
MS_PROTECTION_LICENSE_ENABLE configuration variable to add
licenses to a file provides additional entry points to the file.
The everyone license
An author grants access to a file to everyone by using the Add access for
everyone tool on the Digital Rights dialog box. Generally, it makes sense
to create an Everyone license that only grants limited rights. For example,
creating an everyone license that allows anyone to view the file
Everyone license
with view only
rights
To add an everyone license
1. From the Digital Rights dialog box, click the Add access for everyone icon.
The License Properties dialog box opens with the Recipient
6–12 MicroStation Administrator Guide
File Protection
Protecting a file
field set to Everyone.
2. Assign the desired rights and properties for the license.
3. Click OK.
The Everyone license is added to the file.
Password license
An author grants access to a file by creating a password license using the
Add a password tool on the Digital Rights dialog box.
MicroStation never divulges the password associated with this license.
To add a password license
1. From the Digital Rights dialog box, click the Add a Password icon.
The Add a Password dialog box opens.
2. Enter a password in the Password field.
3. Assign the desired rights and properties for the license.
4. Click OK.
The Password license is added to the file.
MicroStation Administrator Guide 6–13
File Protection
Protecting a file
Recipient license
An author grants access to a file by creating a certificate-based recipient license
using the Add a recipient license tool on the Digital Rights dialog box. The
author first selects the recipient’s certificate, then defines a license for that
recipient, including rights, expiry and/or authentication URL. The author can
select a digital certificate from their personal certificate store or identify a
signed e-mail message file (.msg) or certificate file (.cer or .p7b).
To add a recipient certificate license
1. From the Digital Rights dialog box, click the Add a Recipient certificate icon.
The Add a Recipient Certificate dialog box opens.
2. Select a digital certificate from your personal certificate store
with the Choose certificate tool.
or
Identify a signed e-mail message file (.msg) or certificate file (.cer or
.p7b) with the Choose certificate file tool.
3. Assign the desired rights and properties for the license.
4. Click OK.
The recipient license is added to the file.
The common name becomes the default name of the recipient in the license.
This is annotation data for the license that can be changed.
6–14 MicroStation Administrator Guide
File Protection
Obtaining a person’s certificate
Adding a recipient certificate via drag and drop from Windows Explorer
The author can add recipient certificates to a protected file by dragging
signed e-mail message (.msg) files and/or certificate (.cer, or .p7?) files
from Windows Explorer or the desktop onto the Digital Rights dialog. The
rights, expiry, etc., assigned to the new recipients are the same as the recipient
that was selected in the dialog when the files were dropped.
Removing a license
An author removes a license from a file using the Remove selected
recipients tool on the Digital Rights dialog box.
To remove a license
1. From the Digital Rights dialog box, select the recipient(s) to be removed.
2. Click the Remove selected recipients tool.
The license is removed from the file.
Obtaining a person’s certificate
An author can obtain a person’s certificate by:
• Asking the intended recipient to send you the certificate
• Looking up the certificate
Receive the certificate from the intended recipient
The recipient must have already obtained a certificate from a Certificate
Authority such as Verisign or Thawte.
There are three ways to get a certificate from the recipient:
MicroStation Administrator Guide 6–15
File Protection
Obtaining a person’s certificate
Method of receiving a certificate from a Description
recipient
Ask the intended recipient to send you a This requires Microsoft Outlook 2000 or later
signed e-mail message in S/MIME format. or another e-mail program such as Netscape
that supports S/MIME. The message should
not be encrypted. Drag or save the e-mail
message to a normal file folder. The resulting
.msg file contains the recipient’s certificate.
You can specify a .msg file anywhere that
MicroStation prompts for a certificate file.
Ask the intended recipient to send you In Microsoft Outlook, the procedure is as
a signed e-mail message then extract the follows: Open the message and issue the
signer’s certificate from the e-mail message. File > Properties > Security > View Signing
Certificate command to bring up the Windows
certificate viewer. On the Details tab of the
viewer, use the Copy to File command to
export the certificate to a .cer or .p7b file. In
Outlook Express and other e-mail programs,
the procedure will be slightly different.
Ask the intended recipient to send The recipient uses the Windows Internet
you his certificate file as an e-mail Options > Content > Certificates >
attachment or via ftp, etc. Certificates > Export tool to create a .cer or
.p7b file and sends that file to you.
To obtain a user’s certificate via signed e-mail
1. Have the user send their certificate to the author of the file in a signed e-mail.
The user must set the Secure Message Format to S/MIME and
check the “Send these certificates…” box on the Outlook Tool >
Opens > Security> Settings > Change Security Settings dialog box.
Also, the “Send clear text signed message” on the Outlook Tool >
Opens > Security tab must also be checked.
2. The author then drags the signed e-mail from Outlook on to
6–16 MicroStation Administrator Guide
File Protection
Obtaining a person’s certificate
the desktop or into a folder.
A .msg file is created.
3. Drag the .msg file onto the Digital Rights dialog box in the protected file.
A message signed with clear text has a red certificate seal on the icon. A
message signed with non-clear text has a blue lock on the icon.
Search for the certificate
There are two ways to search for the certificate of the recipient:1
Search Method Description
Directory Service In Outlook Express, go to Start | Find | People, select
Lookup through Verisign as the server and type in the e-mail address of
LDAP the person whose certificate you wish to download.
Download Go to the web site of the certifying authority, e.g.,
Directly from [http://digitalid.verisign.com], and use the Find feature
the Certifying to search for a DID. To be effective in your search, you
Authority need to know the person’s e-mail address. Click on the
ID summary information. At the bottom of the resulting
page of detailed information where several download
options are available, choose “Someone Else’s Digital ID
for Outlook Express.” The default download format is
“cert.p7c,” which you should save to your hard disk. When
the downloaded is complete, the file icon looks like a small
rolodex card. Note that if you choose either “My Digital
ID for Microsoft Internet Explorer” or “S/MIME Format
(Binary PKCS #7),” the downloaded file format will be
“query.exe.” If you do this, rename the file to “cert.p7c.”
Once a certificate file is obtained, you can store and reuse it to designate recipients.
Verifying a certificate
You should not use a certificate unless it meets the following requirements:
1 http://www.okinfoweb.com/moe/smime/DIDs/did_008.htm
MicroStation Administrator Guide 6–17
File Protection
Using protected files
• It has not expired.
• It was issued by a trusted certification authority (CA) such as Verisign or
Thawte. Note that an organization can implement its own CA.
• It positively identifies the person you intend. Use the Windows
certificate viewer to check trust and expiration.
You can direct File Encryption (see page 6-4) to use expired certificates
with the key-in SIGNATURE TOGGLEEXPIREDCERTS.
References
Each file is protected separately and carries its own set of licenses and
rights. Therefore, a master file can be protected while references are not,
or vice versa. To protect all files in a set, the author must protect each file
individually. In turn this means when opening a file with references attached,
a user must acquire a separate license for each reference.
Using certificate-based licenses is as easy for multiple files as for a single
file. For password licenses, Bentley recommends that the author assign
the same password to all files in a set. The author decides which rights
the password should convey in each file individually. This allows the user
to open an entire set of files with a single password.
Using protected files
This section describes the user ’s usage of protected files. When a user attempts to open
a protected file, he must first obtain a license. How a user obtains a license
depends on how the file was encrypted and what type of licenses are in the file.
6–18 MicroStation Administrator Guide
File Protection
Using protected files
Protection type Description
Certificate If the file was protected using a certificate, MicroStation
preferred first tries to find certificate-based license. MicroStation
opens the file using the first certificate-based license the
user can open. If the license does not possess the private
key needed to open any certificate-based license, then
MicroStation tries password-based access. If there is no
password license or Everyone license in the file, then the
user is denied access. If there are any password licenses in
the file, MicroStation prompts the user for a password and
attempts to open the file. If the password is invalid, the user
is denied access to the file. If the user presses Enter without
entering a password, MicroStation attempts to obtain the
Everyone license. If there is an Everyone license, the file is
opened using that license. If not, access is denied.
Password If the file was protected using a password, MicroStation
preferred first prompts the user for the password. If a password
is entered, MicroStation attempts to obtain a password
license. If the password is valid, the corresponding license
is used to open the file. If the password is invalid, access
is denied. If the user presses Enter without entering a
password, MicroStation attempts to obtain the Everyone
license. If there is an Everyone license, the file is opened
using that license. If not, access is denied.
After opening a protected file, MicroStation displays a lock icon in the status bar.
When a pre-File Protection version of MicroStation V8 tries to open a
protected file, it recognizes the file as a V8 encrypted file. MicroStation
displays an explanatory message but will not open the file.
While in a protected file, MicroStation disables functions when the
corresponding right was not granted as part of the license. Here is
a partial listing of functions by right.
Right Granted Functions Enabled
Print File > Print
File > Print Preview
PRINT key-in
MicroStation Administrator Guide 6–19
File Protection
Using protected files
Right Granted Functions Enabled
Export File > Export
File > Save As
FENCE FILE (FF=) key-in
〈Ctrl-C〉 (copy to clipboard)
〈Ctrl-X〉 (cut to clipboard)
Edit File > Save
〈Ctrl-X〉
In some cases, a command may start but then fail because a right has not been
granted. For example, a user enters the PRINT key-in when the Print right
has not been granted. In that case, the command is aborted with the following
error message: “the author” has restricted access to the DGN file. The current
operation requires an access right that has not been granted.
The file is read-only if the license does not grant the Edit right.
URL authentication
Once a license is acquired for the user to open the protected file, if the
author attached an authentication URL to the license, then MicroStation
attempts to access the URL. If this step fails, MicroStation does not
open the file and displays the failure alert box.
Opening a file in an unsecure environment
MicroStation loads only digital rights-compliant applications when in a protected
file with limited access. This implies that a user may not open a protected file if
non-compliant applications have already been loaded. This can happen when
the user first opens an unprotected file and then tries to open a protected file. It
can also happen when the user moves between different protected files, where
each file has a different set of digital rights-compliant applications. When this
happens, even an authorized user will be denied access to the protected file.
6–20 MicroStation Administrator Guide
File Protection
Using protected files
Opening a file in secure mode
Security provides users with the ability to shield themselves from applications
that are not trusted. In contrast, digital rights is the authors mechanism for
excluding use of specific applications on a protected file.
The combination of File Protection and Security can effectively deal with the
conflict between legacy applications and digital rights. Problems can occur
when a user attempts to open a rights-restricted file when non-right-compliant
applications are already loaded on the machine. MicroStation will not open
the file in this situation. Secure mode is intended as a temporary way (until a
rights–compliant (see page 6-22) version of the application can be obtained) to
prevent these applications from loading so the file can be opened.
The user can setup MicroStation to load only digitally signed MDL applications
and VBA macros by setting the MS_SECURITY_LEVEL configuration
variable to MEDIUM or HIGH. The default security level is none.
MS_SECU- Description
RITY_LEVEL value
LOW Allows any application to be loaded and used.
MEDIUM Allows the loading of applications that are
digitally signed by Bentley or by any software
publishing certificates that are trusted. The
user identifies trusted certificates in the
MS_SECURITY_SPC configuration variable.
MS_SECURITY_SPC defaults to all .cer files in
the ../workspace/standards/SPC directory. The
user identifies the applications that he trusts
by putting copies of the certificates used to
sign them into this directory.
HIGH Only loads applications that are digitally
signed by Bentley.
The fact that a user trusts an application does not necessarily mean that the
application is authorized for use with a given protected file.
Bentley applications that are not signed as rights–compliant are unloaded when
you enter a restricted file. For example, if your rights to a file excludes export,
MicroStation Administrator Guide 6–21
File Protection
Digital Rights-Compliant Applications
the export capabilities will be unloaded while you are in that file.
URL authentication
Once a license is acquired for the user to open the protected file, if the
author attached an authentication URL to the license, then MicroStation
attempts to access the URL. If this step fails, MicroStation does not
open the file and displays the failure alert box.
Digital Rights-Compliant Applications
MicroStation loads only digital, rights-compliant applications in a file that has
limited rights. This section explains how the author certifies an application as
rights-compliant and how MicroStation screens applications at runtime.
File Protection allows for the use of rights-compliant applications developed
outside of Bentley, while preventing non-compliant MDL applications from
circumventing rights enforcement. A compliant MDL application checks for
digital rights and does not perform any unauthorized functions, such as printing,
exporting, or modifying. Many MDL applications, including pre-existing
applications, are compliant because they do not perform restricted functions.
Other applications have to be changed to become compliant. Rather than trying to
prevent illegal operations, MicroStation refuses to load a non-compliant MDL
application when less than unlimited rights are granted. Thus, the user can safely
use compliant applications and has no access to non-compliant ones.
Bentley has certified the applications that ship with MicroStation.
Bentley cannot certify applications developed by others. It is up to the
author to certify non-Bentley applications as rights-compliant. Once an
application is certified, it is designated as being digital rights-compliant.
An application is digital rights-compliant if it is:
• digitally signed
• its signature is verified
• the signing key is either Bentley’s signing key or is a key
6–22 MicroStation Administrator Guide
File Protection
Signing applications
identified by the author
MicroStation recognizes digital rights-compliant applications by the public keys
used in their signatures. Keep in mind that the author identifies the signing keys
rather than applications. MicroStation treats any application that was signed using
a specified signing key as rights-compliant. Therefore, the author must be careful
to guard the signing certificate and only use it to sign rights-compliant applications.
The digital signature prevents anyone from modifying an application after it has
been certified and signed by the author. File Protection allows multiple authors
to sign the same application without invalidating each other’s signatures. A
signed application can also be modified and then re-signed. If an application
has multiple signatures, MicroStation recognizes the application as digital
rights-compliant if it can verify and recognize any one of them.
If an author adds a signature to an application, he must distribute the affected
.MA files to users. In most cases, an author will rely on the original software
publisher to sign the application files and simply cite the publisher’s key.
Signing applications
The author uses the rsign and checksignature command-line programs to
mark an application as trusted. These programs computes the digital signature of
the .MA file and then stores the signature inside the file. MicroStation .MA files
have the capacity to store up to about 100 digital signatures internally. Adding a
new digital signature to a signed .MA file does not invalidate existing signatures.
This means that up to 100 different authors can independently sign the same .MA.
The syntax of the rsign command is:
rsign [-flags] <filename>
Flags to identify the signing certificate:
MicroStation Administrator Guide 6–23
File Protection
Signing applications
Flag Description
<filename> Identifies the file to signs
-spc <file> file containing encoded software publishing
certificate
-sp <policy> Add the certification path (chain) or add the
certification path excluding the root certificate
(spcstore): <chain|spcstore>
default to spcstore
-s <location> Location of the cert store in the registry:
<localMachine|currentUser>
default to currentUser
-k <KeyName> Key container name (in current user’s default
keystore) where private key can be found
-cn <name> The common name of the certificate
-v <pvkFile Pvk file name containing the private key (in case
certificate does not specify container or pvk file)
The —sp argument allows the signer of an application to store more information
in the digital signature about their identity making it easier for other users
to verify their signature. Storing this information takes up more space in
the signature section of the application. This section is 50,000 bytes in
size. Each signature in the signature chain takes up space so you may be
limited in the number of these signatures you can store.
Flags to modify the result of signing:
Flag Description
--iN Include the signer’s name in the signature for
display purposes.
--iKNDLC Information to include in the digital signature:
• K – public key
• N – certificate common name
• D – today’s date
• L – name of this computer
• C – a copy of the certificate
6–24 MicroStation Administrator Guide
File Protection
Signing applications
Flag Description
-a <algorithm> Hashing algorithm for signing: <md5|sha1>.
Default to sha1.
-sha1 <thumbPrint> The sha1 hash of the certificate (to be used instead
of –cn, in case name is not unique)
Miscellaneous flags:
Flag Description
--r remove existing signature
The syntax of the checksignature command is:
checksignature [-flags] <filename>
Flags to identify the signature being checked:
Flag Description
<filename> Identifies the file to check. If not specified,
filename is read from stdin
--l[l] List (-ll for verbose)
--x Verify signatures
--xb Verify that file is signed by Bentley
--n <filename> List of Bentley applications that are known
to be non-rights-compliant
--e <filename> Export certificates from signatures
The – e argument allows a user to extract the signer’s certificate or
certification chain from the digital signatures in an application. Standard
tools, such as the Microsoft certmgr.exe program can be used to examine
and check the certificates for trustworthiness.
Any certificate that has a private key can be used to sign an MDL application.
Certificates may be selected from the current user’s certificate store or from
standard X.509 certificate (.cer) files and from PKCS#7 (.p7b) files. You can use
the Windows Internet Options > Content > Certificates dialog to review your
MicroStation Administrator Guide 6–25
File Protection
Signing applications
certificate store. The author must distribute the signed .MA to users. A signed
.MA file can be used in earlier versions of MicroStation and in non-protected files.
.PFX and .P12 files are not supported.
Identifying signed applications
Use the File > Protection > Applications command to view, add, and remove
certificates that identify digital rights-compliant applications (see page 6-22).
The Compliant Applications Add command allows the author to choose
a certificate that has was used by rsign to digitally sign applications that
6–26 MicroStation Administrator Guide
File Protection
Signing applications
were digital rights-compliant. You can identify any number of certificates that
MicroStation should use to recognize rights-compliant certificates in a given
protected file. If another party signed the application(s), you must obtain a
copy of the signer’s certificate in order to enter it into the file.
To add a certificate that identifies a rights–compliant
application
1. From the File menu’s Protection submenu, choose Applications.
The Compliant Applications dialog box opens.
2. Select the certificate(s).
MicroStation should use to recognized rights-compliant
applications in a protected file.
3. Click the Add a signature key icon.
The Add Compliant Application dialog box opens.
4. Select a digital certificate from his personal certificate store.
or
MicroStation Administrator Guide 6–27
File Protection
VBA macros
Select a signed e-mail message file (.msg) or a certificate file (.cer or .p7)
5. (Optional) — Enter a date the certificate expires.
6. Click OK.
A rights-compliant certificate is added to the file.
VBA macros
File Protection supports rights-compliant VBA projects in a similar way
that it handles MDL applications. The developer must certify that the
VBA project is rights compliant. The developer digitally signs the VBA
project using the Tools>Digital Signature dialog in the Visual Basic Editor.
The author of a protected DGN file authorizes use of the VBA project by
identifying the certificate used to sign the project. MicroStation will not
load unsigned or unauthorized VBA project when rights restricted files (or
reference) are open. Conversely, MicroStation will not open a protected
file (or reference) with restricted rights if any open VBA project is either
unsigned or is not authorized for use with the protected file.
6–28 MicroStation Administrator Guide
Digital Signatures
In MicroStation, digitally signing a model or file can be used to indicate
approval of the design. Another user can then detect the signature, verify
the signer’s identity, and verify that the design has not been changed since
it was signed. Model-specific signatures are displayed graphically in the
context of the design. Multiple signatures can be affixed to a single file or
model. Hierarchical signing is also supported so that one signature is dependent
upon prior signatures. A signature can cover the content of a model or file
and all of its references including DGN and DWG references.
Starting with the 2004 Edition, MicroStation saves not only the signer information
but also who issued the signer’s certificate. In earlier versions, if the user’s
computer and the signer’s computer were not set up to recognize the same
intermediate certificate authority (CAs), valid signatures could be viewed as
not trusted. By saving the entire chain of certificates leading from the signer
back to the trusted root, adequate information is available for any computer to
verify a signature regardless of the intermediate CAs it recognizes.
Signatures created in the 2004 Edition and later will not be backward compatible
with MicroStation V8.1 because it is possible that the signatures could be larger
then the earlier version allows. These signatures will be marked as unverified
because they contain information that is not recognizable. Users who want
to exchange signatures should all be running the 2004 Edition.
Among other key features, signers can use cells to represent signatures with
arbitrary graphics; an API is defined to allow applications to customize where
signatures can be placed and how a signer’s identity is authenticated; and there
are several ways users can detect valid signatures to prevent spoofing.
MicroStation Administrator Guide 7–1
Digital Signatures
MicroStation Digital Signatures
MicroStation Digital Signatures
A digital signature in MicroStation has the following components:
An element (a cell)
stored in the file
Special linkage
• Hash of model or file and optionally
containing
its references
• Signer’s certificate
• Time of signing
• Optional information, such as expiration,
annotation data, signature graphics, or
list of prerequisite signatures
“Signature cells” A signature cell is really just a cell. It is created
and managed as a normal cell in a cell library.
It is then placed in the model that is being
signed. What makes a signature cell special is
that it itself is digitally signed
Model scope
A signature with model scope (“model signature”) captures the data
in the model in which it is placed.
Included in a model
• contents of all elements in the model
signature
(graphic and non-graphic)
• contents of file-wide, non-graphic data,
such as shared cell definitions
• model properties, such as model name,
number, type, and units
7–2 MicroStation Administrator Guide
Digital Signatures
File scope
Excluded from a model
• last–modified time of each element
signature
• “m” and “n” properties flags on
graphic elements
• archive flag on each element
• signatures
• reference attachment data, if the signature
does not include references
A signature may apply to some but not all models within a design file.
File scope
A signature with file scope captures the state of all the models in the file plus
file-level information (defined below). Thus, a file signature becomes invalidated
by any change to the content of any model or to file-level information.
File-level information
• Editable summary properties including
included in the signature
title, subject, category, keywords,
comments, author, company, category,
manager, and application
• Shared status of file (set for Design
History file sharing feature)
• File format (V8, V7, DWG)
MicroStation Administrator Guide 7–3
Digital Signatures
Signature scope not restricted to view and level display
File-level information
• File path and name
excluded from the
signature
• File size
• “Opens With” (application association)
• Attributes (read only, hidden)
• Volatile “Summary Properties” including
revision number, date last saved, last
saved by, edit time, security, modified
time, accessed time
• Thumbnail
• “Security Properties”
• “Custom Properties”
• MicroStation “Session” data, including last
user and computer to access the file
• Licenses defined by File Protection
• Design History
• All “Custom Properties”
• All nested property sets
A file signature excludes streams and storage added to the file by applications.
All summary properties not mentioned here are excluded from the signature.
Design History is excluded from the signature so that history may
be used to manage signatures.
Signature scope not restricted to view and level display
A signature includes all elements in the file or model. View attributes that
are turned off, such as display of cells, text, dimensions, constructions, or
tags, and view parameters, such as window area and clipping planes, are
included in the scope of the signature. Similarly, all levels are included
– regardless of whether they are displayed. In summary, all elements are
signed even if no views are open and all levels are off.
Even though the scope of a signature is not limited by view and level
setting, a signature includes the state of those settings. Therefore,
7–4 MicroStation Administrator Guide
Digital Signatures
Signature excludes external resources, databases and user preferences
changing view parameters, turning levels on/off, or other design file
settings will invalidate all signatures in that file.
Signature excludes external resources, databases and user preferences
External resources are excluded from model and file signatures. This means
that a signature is not invalidated when an external resource changes, even
though that might affect the appearance of the design.
Examples of external resources excluded from signatures:
• most fonts
• user preferences
• external databases
• application .RSC files
Changes inside file that do not invalidate signatures
A few very special types of change will not invalidate digital signatures:
• adding and deleting an element
• making a change and then using Undo or Design History to back it out.
• using the compress command
• committing changes to Design History
• creating, re-validating, or deleting a digital signature
Changes outside file that do not invalidate signatures
Any of the General and Security Properties, including name and location of a
signed file, can be changed without invalidating signatures inside the file.
MicroStation Administrator Guide 7–5
Digital Signatures
Signatures and design history
Signatures and design history
A digital signature does not include the contents of Design History. While
a signature captures the current state of a model or file, Design History
holds previous or alternate states. Thus a signature is not invalidated
when changes are committed to Design History because commit does
not modify the current state of the design.
You can use Design History to restore broken signatures that result from changes
to a file, which causes signatures to become invalid. By restoring the original
contents of the signed design, the signature again becomes valid.
Design History can also restore deleted signatures. If a signature is deleted,
that is a change to the DGN file that can be committed. Design History can
then be used to undo that change, restoring the signature.
A restored signature becomes valid only if the rest of the design is in
the exact state that was originally signed.
Signatures and other signatures
A signature normally ignores other signatures so you can place new
signatures without invalidating existing ones. A signature can depend
on other signatures by creating a signature hierarchy (see page 7-13).
This is also known as countersigning.
A signer has no way of knowing if the DGN file has been signed
by another person. Additionally, a signer can not prevent another
signer from signing the file afterwards.
Digital signatures and references
A signature may or may not include reference models.
7–6 MicroStation Administrator Guide
Digital Signatures
Digital signatures and references
Including references
The user determines if the signature includes referenced content. If live
nesting is turned on when creating the signature, nested references are also
included in the signature. A reference and its children are only included in
the signature if the attachment is marked for display.
Signatures of both model (see page 7-2) and file scope (see page 7-3) can be
marked to include references. When a model signature includes references,
only the references attached to that model are included. When a file signature
includes references, all references attached to all models are included. The
“biggest” signature is a signature of a file and all of its references.
A Reference denotes a model not a file.
A signature that includes referenced content is marked with a star
in the Digital Signatures dialog box.
Reference attachment data included
A signature always includes reference attachment data, such as reference
origin, scale, rotation, and clip boundary regardless of whether or not
referenced content is included in the signature.
DWG reference included
A reference to a DWG model can be included in a signature.
Signatures not restricted by clip boundaries
When a reference is included in a signature, the signature captures its
entire contents regardless of the clip boundary.
MicroStation Administrator Guide 7–7
Digital Signatures
File signatures
Signatures in references
A signature placed in the master file may depend on a signature in a reference.
The Digital Signatures dialog box displays all signatures in references.
Status display of signatures in references
If a reference has signatures, they are displayed in the view and in the Digital
Signatures dialog box. A red seal displays in the status area indicating there is
a signature on the active file. However, this area remains blank if the active
file has no signatures but there are signatures on the references.
The Digital Signatures dialog box lists all signatures in all references, regardless
of whether or not the active file has any signatures. Checking the Digital
Signatures dialog box is much more accurate than the status bar.
File signatures
A file signature is displayed only in the Digital Signatures dialog box,
which displays all file signatures regardless of the current model. The
existence of a file signature is not indicated on plots.
The MicroStation status bar displays a signature icon when a file
contains any file or model signatures.
Model signatures
A model signature is a cell with a special linkage containing the non-graphical
data associated with the signature, as well as graphics that visually
represent a signature. A signer supplies a signature cell which can contain
raster and/or OLE objects to create a realistic and meaningful signature.
Some organizations have their own guidelines for signatures. Signature
placement can be controlled by a custom application.
7–8 MicroStation Administrator Guide
Digital Signatures
Signature cell
MicroStation displays a model signature by displaying the cell. Model
signatures display on plots as cells.
There are two types of Model signatures: hidden and non-hidden. Both types
are listed in the Digital Signatures dialog box but non-hidden model signatures
are also displayed as an element in the context of the model.
The “Fast Cells” view parameter does not apply to signature cells.
The Digital Signatures dialog displays only the model signatures of the
current model and, optionally, its references.
The MicroStation status bar displays a signature icon when the file
contains any file or model signatures.
Signature cell
A cell that represents a model signature (see page 7-8) is called a “signature
cell.” It is created and managed as a normal cell in a cell library and then
placed in the model that is being signed. What makes a signature cell special
is that it is digitally signed. Digitally signing the cell prevents tampering and
associates a digital certificate with the cell. Internally, a signature cell contains
an embedded cell, which is the cell’s (hidden) signature.
Signature Cell Structure
Cell <John Doe>
• Graphics (OLE, text, etc.)
• Orphan Cell Header (signature linkage)
This method of associating a certificate with cell graphics reduces errors in placing
signature cells but does not make signature cells more or less secure or trustworthy.
When creating a signature cell, set the current level to default and
place all its elements on the default level. This ensures that placing a
signature cell will not break existing signatures.
MicroStation Administrator Guide 7–9
Digital Signatures
Signature cell
To create a signature cell using a cell library
1. Create a cell. For more information on creating a cell, see “To
create a cell” in the User Guide.
2. Open the cell as a DGN file.
3. From the Digital Signatures dialog box, click the Add Hidden
Digital Model Signatures icon.
The Add Hidden Digital Model Signatures dialog box opens.
4. Add the signature cell as a Hidden Signature.
To create a signature cell using a model
1. From the File menu, select New.
The New dialog box opens
2. Enter a new file name in the Files field and press OK.
The new DGN opens.
3. From the File menu, select Models.
The Models dialog box opens.
4. From the Models dialog box, select the Create a Model tool.
The Create Model dialog box opens.
5. Select Design or Sheet in the Type field
or
Select Design from Seed or Sheet from Seed in the Type field.
6. If Design or Sheet was selected, choose a 2D seed file. You can
create a 3D signature but 2D is recommended.
or
If Design from Seed or Sheet from Seed was selected, use the Change
7–10 MicroStation Administrator Guide
Digital Signatures
Signature cell
Seed Mode icon to browse for the desired seed file.
7. Enter Signature in the Name field.
8. Turn on the Can be placed as a cell check box.
9. Turn off the Create A View Group check box.
10. Select Point in the Cell Type field.
11. Click OK.
A new model is created.
12. From the Digital Signatures toolbox, select the Digital Signatures icon.
The Digital Signatures dialog box opens.
13. From the Digital Signatures dialog box, select the Add Hidden
Digital Model Signature icon.
The Add Hidden Digital Model Signature dialog box opens.
14. Select a certificate installed on your machine with the browse
icon and then click OK.
Verify that the model has been signed by a green check mark in the
Verified column on the Digital Signatures dialog box.
To place a signature cell
1. Open the DGN you want to sign.
2. Attach the model or cell containing the signature as a cell.
3. From the Tools Menu, select Digital Signatures.
The Digital Signatures toolbox opens.
4. Click the Add a model signature icon.
The Place Signature Cell dialog box opens.
5. Click on the Attach Signature Cell Library icon.
The Signature Cell Library dialog box opens.
6. Select a signature cell library file.
The Signature Cell Library dialog box closes.
7. Select the signature cell from the Cell drop-down list box on the
MicroStation Administrator Guide 7–11
Digital Signatures
Signature decoration
Place Signature Cell dialog box.
Only valid signatures cells belonging to the current user display
and are available for placement.
8. Place a data point in the DGN being signed.
Signature decoration
MicroStation draws special “decoration” graphics next to a signature cell
that represent a signature and depict the status as either genuine or invalid.
Since the decoration graphic is view independent, it has the same size and
orientation regardless of view zoom or rotation. Signature decorations
display outside and to the left of the cell’s actual range adjacent to the
cell origin. Signature decorations appear on plots.
Spoofing and trust
If you see a cell that appears to be a signature, how can you know whose signature
it is? The signer supplies the signature cell, and the cell can display anything
at all. The cell is not guaranteed to reflect the signer’s identity or the purpose
of the signature. The user must check the signer’s identity by inspecting the
certificate associated with the signature. In particular, the user must verify
that the certificate is trusted and is recognized by his organization. In some
organizations, the user will also consider the signature’s annotation data and/or
use a custom application to verify the authenticity of signatures.
An element that appears to be a signature is only a genuine
MicroStation digital signature if:
• a view-independent red seal is displayed to its left
• it has a corresponding item on the Digital Signatures dialog box
When you select an item in the Digital Signatures dialog box, the
corresponding element will highlight on the screen.
7–12 MicroStation Administrator Guide
Digital Signatures
Signature integration
Signature integration
Digital signatures become part of the design file. In fact, a digital signature is
really an element in the model to which it applies. File signatures are elements in
the internal “settings” model. Making the signature a part of the file makes it
impossible for a signature to somehow be detached from the design accidentally,
as can happen when a signature is applied externally to a file.
MicroStation does not require a different file format, special packaging, or
special viewing software to associate signatures with design data.
MicroStation automatically validates digital signatures. In other words, you
cannot look at a signature without seeing that it is valid or invalid.
Multiple signatures
Either a model or a file can contain multiple and unlimited signatures.
Adding a new signature does not invalidate existing signatures, although one
signature can be valid while others are invalid. Support for multiple signatures
means that more than one person can add his signature to a single model or
file. Or that one person can sign one model in several places. Since each
signature has its own verified status, you can add a new signature after
a previous signature has been invalidated by a change to the model or file.
This is like initialing a change. The Digital Signatures dialog is useful for
detecting and locating signatures in a model or file.
Signature hierarchy
Sometimes a user can sign only after others sign. When a new signature certifies
both the file content and other signatures, it is sometimes called “countersigning”
but in MicroStation it is referred to as a “signature hierarchy.”
A hierarchy captures signing order and also records which signatures are
required as prerequisites for a new signature. The new signature depends on
these prerequisite signatures and is invalidated if a prerequisite signature is
MicroStation Administrator Guide 7–13
Digital Signatures
Multi-user support
deleted or otherwise invalidated. When this happens, the (new) dependent
signature remains invalid, even if the prerequisite signature is re-validated.
This preserves signing order. Nested hierarchies can be created so that a new
signature becomes dependent on a signature that already has prerequisite
dependencies. There are no structural limitations to the depth of a signature
hierarchy. One signature can be a prerequisite of several dependent signatures
so that hierarchies overlap (defining a graph rather than a tree). The Digital
Signatures dialog box visually displays hierarchy relationships.
A signature hierarchy is the only true proof of signing order. Signature dates
is not a reliable indicator of signing order for several reasons:
• Signature dates are not reliable indicators.
• A deleted signature can be reinstated with an earlier date.
• If Shared Files are used, it is possible for users to sign a file simultaneously.
Multi-user support
A user must select a certificate from the secure, private certificate store of
the user currently logged in under Windows. This usually means that a
user must be logged into his own Windows account when adding a digital
signature. When smart cards are used, it is possible to install references to
a single certificate on multiple machines, while keeping the private key on
the card itself. In this case, multiple users could sign the same file or model
using the same machine, each supplying his own smart card.
Customization
MicroStation supports customization and control over digital
signatures in two ways:
• The signer defines the cell for model signature graphics.
• MicroStation defines an API for creating and reviewing signatures.
7–14 MicroStation Administrator Guide
Digital Signatures
Digital Signatures dialog box
Digital Signatures dialog box
Used to create, delete and revalidate digital signatures.
Add File Signature
Opens the Add File Signature dialog box used to create a digital signature with
file scope. A signature with file scope (“file signature”) captures the state
of all of the models in the file, plus file-level information.
Key-in: SIGNATURE ADD FILESIGNATURE
Add Hidden Digital Model Signature
Opens the Add Hidden Digital Model Signature dialog box used to place
a model signature that is hidden. A hidden model signature is listed
only in the Signatures dialog and is not displayed as an element in the
context of the model to which it applies.
Place Signature Cell
Opens the Place Signature Cell dialog box used to place a model signature
that applies to and is displayed in the context of the current model.
Remove a Signature
Removes a model or file signature. Since model signature elements are
MicroStation Administrator Guide 7–15
Digital Signatures
Digital Signatures dialog box
locked, this tool is the most convenient way to remove them.
Key-in: SIGNATURE REMOVE FILESIGNATURE <signername>
Revalidate a Signature
Revalidates a signature based on the current content. This is really just a short
cut for deleting the invalid signature and adding a new one.
Zoom To Signature
Allows you to zoom to the signature of a reference.
Signature Properties
The Signature Properties tool is used to inspect the definition and
state of the selected signature.
Hierarchy Toggle
Toggles on/off the display of all dependent signatures in the “Hierarchy”
area. The dependent signature is shown as the root of a tree, with
its prerequisites shown as its children.
Hierarchy
Hierarchy area that displays a hierarchical tree of dependent signatures.
Verified
The Verified field is Yes (green check mark) if the signature is verified. “Verified”
means that the signed data and prerequisite signatures have not changed.
Trusted
The Trusted field tells you if the signature is based on a certificate that is
trusted. A certificate is trusted if it was issued by a trusted CA and is not
7–16 MicroStation Administrator Guide
Digital Signatures
Digital Signatures dialog box
expired. If the certificate is trusted, then “Yes” is displayed. Otherwise, a
short explanation of the problem is displayed. The Signatures dialog displays
a green check mark or a red X in the Trusted column
Current
This column displays a green checkmark if the signature is not expired
or a red X if the signature is expired.
Source
The Source column identifies the attachment that contains the signature. A
blank Source indicates that the signature is from the master file.
Scope
Indicates the type and extent of the signature: model, hidden model, or file.
A model signature includes the contents of just one model. A hidden model
signature is a model signature that is not displayed. A file signature includes
the contents of all models in the file, plus file-level information. The Scope
field does not indicate if the signature includes references or not.
Refs
Displays a star if references were included when the file was signed.
Certificate
Name and email address associated with the certificate.
Signer
Person signing the file. The Signer defaults to the current user’s login
name. This could also be some code or identifier that is meaningful within
an organization. This is useful for identifying the signer, especially if the
certificate name is different from the signer’s real name.
MicroStation Administrator Guide 7–17
Digital Signatures
Add File Signature dialog box
Location
The Location defaults to the current user’s computer name. This could
also be some location code, building name, or other identifier that
is meaningful within an organization.
Date
Date and time the file was signed.
Expiry
Date the signature is to be revoked. This is not the same as the expiry date of
the underlying digital certificate. A signature does not have to have an expiry
date, while a certificate always does. Normally, a signature will remain valid
long after the certificate on which it was based has expired.
Purpose
This field could be used to display the signer’s intent and normally is a phrase
or code that is meaningful within the organization or project.
Add File Signature dialog box
Used to create a digital signature with file scope.
7–18 MicroStation Administrator Guide
Digital Signatures
Add File Signature dialog box
Certificates
The certificate the signer selected when signing the file. MicroStation uses the
chosen certificate to access the signer’s private key when creating the signature.
MicroStation then saves a copy of the certificate with the signature in order to
identify the signer and to carry the public key needed to verify the signature later.
Signer
The Signer defaults to the current user’s login name. This could also be
some code or identifier that is meaningful within an organization. This
is useful for identifying the signer, especially if the certificate name
is different from the signer’s real name.
Location
The Location defaults to the current user’s computer name. This could
also be some location code, building name, or other identifier that
is meaningful within an organization.
Purpose
This field could be used to describe the signer’s intent and is normally be a
phrase or code that is meaningful within the organization or project.
Expiry
Date, if any, on which the signature expires. A signature that has passed
its expiration date is displayed as untrusted.
This is not the same as expiry date on the underlying digital certificate.
A signature does not have to have an expiry date, while a certificate
always does. Normally, a signature will remain valid long after the
certificate on which it was based has expired.
Dependent Signature
Check this option to make the new signature depend on all signatures
that are currently selected in the Digital Signatures dialog box. The
MicroStation Administrator Guide 7–19
Digital Signatures
Place Signature Cell dialog box
checkbox is disabled if no signatures are selected.
This check box is used to create a signature hierarchy. The new signature is
marked as “dependent.” The Signatures dialog shows all dependent signatures
in the “Hierarchy” area. The dependent signature is shown as the root
of a tree, with its prerequisites shown as its children.
Include References
If checked, the new signature will include the content of all attached references.
As a result, modifying any referenced model will invalidate the signature.
Checking this option does not add signatures to the referenced files. If this
option is not checked, the new signature will not depend on references and
will not be invalidated if referenced models are changed.
OK
Adds the signature to the file.
Cancel
Closes the Add File Signature dialog box without adding the
file signature to the file.
Place Signature Cell dialog box
Used to create a digital signature with model scope. A signature with model scope
(“model signature”) captures the state of the model when the signature is placed.
7–20 MicroStation Administrator Guide
Digital Signatures
Place Signature Cell dialog box
Cells
Signature Cell that contains the digital certificate for the signature and the graphics
that visually represents the signature. This field is disabled if no signature cell
library has been identified with the Attach Signature Cell Library tool.
Attach Signature Cell Library
Opens the Signature Cell Library dialog box used for selecting signature
cells. This is known as the “signature cell library.” The signature cell
library is different from the current placement cell library. MicroStation
only looks for signature cells in the signature cell library.
Active Angle
Sets the angle by which the cell is rotated.
Scale
Scale by which the cell is placed.
Include References
If checked, the contents of the attached references are included in the signature.
Signer
Name of the person signing the model. The Signer defaults to the current user’s
login name. This could also be some code or identifier that is meaningful
within an organization. This is useful for identifying the signer, especially
if the certificate name is different from the signer’s real name.
Location
The Location defaults to the current user’s computer name. This could
MicroStation Administrator Guide 7–21
Digital Signatures
Add Hidden Digital Model Signature dialog box
also be some location code, building name, or other identifier that
is meaningful within an organization.
Purpose
This field could be used to describe the signer’s intent and will normally be a
phrase or code that is meaningful within the organization or project.
Expiry
(Optional) Date the signature expires.
This is not the same as expiry date on the underlying digital certificate.
A signature does not have to have an expiry date, while a certificate
always does. Normally, a signature will remain valid long after the
certificate on which it was based has expired.
Dependent Signature
This check box is used to create a signature hierarchy. The new signature is
marked as “dependent” and is dependent on the currently selected signatures
in the dialog box. The Signatures dialog box shows all dependent signatures
in the “Hierarchy” area. The dependent signature is shown as the root
of a tree, with its prerequisites shown as its children. This check box is
disabled if no signature is selected in the dialog box.
Add Hidden Digital Model Signature dialog box
Used to create a hidden digital signature with model scope. A signature with
model scope (“model signature”) captures the state of the model when the
signature is placed. A hidden model signature is listed only in the Signatures
dialog and is not displayed as an element in the content of the model.
7–22 MicroStation Administrator Guide
Digital Signatures
Add Hidden Digital Model Signature dialog box
Certificates
The certificate the signer selected when signing the file. MicroStation uses the
chosen certificate to access the signer’s private key when creating the signature.
MicroStation then saves a copy of the certificate with the signature in order to
identify the signer and to carry the public key needed to verify the signature later.
Choose Certificate icon
Opens the Certificate dialog box used to select certificates
installed on your machine.
Signer
Name of the person signing the model. The Signer defaults to the current user’s
login name. This could also be some code or identifier that is meaningful
within an organization. This is useful for identifying the signer, especially
if the certificate name is different from the signer’s real name.
Location
The Location defaults to the current user’s computer name. This could
also be some location code, building name, or other identifier that
is meaningful within an organization.
Purpose
This field could be used to describe the signer’s intent and will normally be a
MicroStation Administrator Guide 7–23
Digital Signatures
Signature Properties dialog box
phrase or code that is meaningful within the organization or project.
Expiry
Date the signature expires.
Dependent Signature
This check box is used to create a signature hierarchy. The new signature
is marked as “dependent.” The Signatures dialog box shows all dependent
signatures in the “Hierarchy” area. The dependent signature is shown as
the root of a tree, with its prerequisites shown as its children.
Include References
If checked, the master file and all attached references are signed.
OK
Adds the signature to the file.
Cancel
Closes the Add Hidden Digital Model Signature dialog box without
adding the signature to the file.
Signature Properties dialog box
Used to inspect the definition and state of the selected signature.
7–24 MicroStation Administrator Guide
Digital Signatures
Signature Properties dialog box
View Signer’s Certificate icon
Opens a viewer for reviewing the certificate information.
Certificates
The certificate the signer selected when signing the file.
Signer
The Signer defaults to the current user’s login name. This could also be
some code or identifier that is meaningful within an organization. This
is useful for identifying the signer, especially if the certificate name
is different from the signer’s real name.
Location
The Location defaults to the current user’s computer name. This could
also be some location code, building name, or other identifier that
is meaningful within an organization.
Purpose
This field could be used to describe the signer’s intent and is normally be a
MicroStation Administrator Guide 7–25
Digital Signatures
Signature Properties dialog box
phrase or code that is meaningful within the organization or project.
Signed
Date and time the file was signed
Scope
Indicates the type and extent of signature: model, hidden model, or file. A
model signature includes the contents of just one model. A hidden model
signature is a model signature that is not displayed. A file signature includes
the contents of all models in the file, pluse file-level information. The Scope
field does not indicate if the signature includes references or not.
Prereqs?
If yes, this signature depends on other signature.
References
If yes, the signature includes the content of attached refereneces..
Trusted
If yes, the signature is based on a certificate that is trusted. A certificate is
trusted if it was issued by a trusted CA and is not expired.
Verified
If yes, the user can be sure that no data in the scope of the signature has changed.
Expiry
Date the signature expires if an expiration date was set upon signing.
This is not the same as expiry date on the underlying digital certificate.
A signature does not have to have an expiry date, while a certificate
7–26 MicroStation Administrator Guide
Digital Signatures
Tools for Signing
always does. Normally, a signature will remain valid long after the
certificate on which it was based has expired.
OK
Closes the Signature Properties dialog box.
Tools for Signing
This section describes Digital Signatures support from the point of view of the
signer and of other users who view and verify signatures. The main user interface
is the Digital Signatures dialog. The signer uses this dialog to create, delete,
and re-validate signatures. Other users will find tools to locate and review
signatures. The Digital Signatures dialog is accessed from the Tools menu.
Signing an entire file
The Add File Signature tool is used to create a digital signature with file scope.
To sign an entire file
1. From the Digital Signatures dialog box, select the Add File Signature icon.
The Add File Signature dialog box opens. The name of the signer
is filled in from the selection of the certificate. The location
MicroStation Administrator Guide 7–27
Digital Signatures
Signing multiple files via batch command
defaults to the computer name.
2. Select a certificate from your personal certificate store.
3. (Optional) — Enter the reason the file is being signed in the Purpose field.
4. (Optional) — Enter the date the signature expires in the Expiry field.
5. (Optional) — Click the Dependent Signature check box if you
want to create a signature hierarchy.
6. (Optional) — Click the Include References check box if you want the contents
of all references attached to the master file to be included in the signature.
7. Click OK.
MicroStation automatically annotates the new signature with the
current time from the signer’s machine.
Signing multiple files via batch command
The Batch Process tool can be used to sign multiple files with
a single batch operation.
Only file-wide signatures can be applied using this method.
To sign multiple files via batch command
1. From the Utilities menu, choose Batch Process….
The Batch Process dialog box opens.
2. Click the Create Command File icon.
The Create Command File dialog box opens.
3. Enter the name of the Batch Process Command file you want to create.
4. Navigate to the path where you want the Batch Process Command
7–28 MicroStation Administrator Guide
Digital Signatures
Signing a model
file to reside and press OK.
Notepad opens your Batch Process Command file.
5. Enter the following key-in: SIGNATURE ADD FILESIGNATURE
“certificate common name” and save the file.
The “certificate common name” is the name associated with the
digital signature to be used for the signings.
6. From the Batch Process dialog box Edit menu, select Add Files...
or
Click the Add Files or Directories to Process icon.
The Select Files and Directories to process dialog box opens.
7. Select the file or files to be included in the batch and click the Add button.
or
Double-click on each file to be included in the batch.
The selected files appear in the Selected Files dialog section.
8. Click the Done button.
The selected files appear in the Process Tasks dialog section
of the Batch Process dialog box.
9. From the Batch Process dialog box File menu, select Process…
or
Click the Process Batch Process icon.
The Files to Process dialog box opens.
10. Click the Process button.
All of the selected files are signed via the batch process.
You can remove file signatures via the same batch process as described
above by simply using the SIGNATURE REMOVE FILESIGNATURE
“signer” key-in where “signer” is what displays in the Signer column
of the Digital Signatures dialog box.
Signing a model
The Place Signature Cell and Add Hidden Model Signature tools on the
Digital Signatures dialog create digital signatures with model scope. A
model signature applies to the contents of the current model.
MicroStation Administrator Guide 7–29
Digital Signatures
Signing a model
Adding a model signature
The Place Signature Cell tool is used to place a model signature that applies
to and is displayed in the context of the current model. A model signature
(see page 7-8) requires a signature cell (see page 7-9) that is placed in the
current model to represent the signature visually.
To add a model signature
1. From the Digital Signatures dialog box, select the Place Signature Cell icon.
The Place Signature Cell dialog box opens. This tool is used to place a
model signature that applies to and displays in the current model.
2. Select the cell library that contains the signature cell with the
Attach Signature Cell Library tool.
The Cell field will be populated with a list of available signature cells
from the currently attached signature cell library.
3. Choose a signature cell from the Cell pull-down menu.
4. Enter the angle by which the cell is rotated in the Active Angle field.
5. Enter the scale at which the cell will be placed in the Scale field.
6. (Optional) — Check the Include Reference box to include all
attached references in the signing.
7. (Optional) — Enter the name of the person signing the
7–30 MicroStation Administrator Guide
Digital Signatures
Creating additional signatures
model in the Signer field.
The Signer defaults to the current user’s login name.
8. (Optional) — Enter a description of the signer’s intent.
9. (Optional) — Enter a date that the signature expires.
10. Check this option to make the new signature depend on all signatures
that are currently selected in the Digital Signatures dialog box.
This check box is disabled if no signatures are selected.
11. Click a data point to place the signature cell.
The new signature displays in the current model of the DGN file
and appears in the Signature dialog box.
A red seal next to the signature in the model indicates that it is a signature.
Moving or modifying the signature invalidates the signature. An invalid signature
is displayed with a red X across it. A yellow warning symbol is displayed if the
signature is based on a certificate that is not trusted or if the signature has expired.
Creating additional signatures
Use the Add Signature tool on the Digital Signatures dialog to add additional
signatures to a file or model. Adding a new signature does not invalidate
existing signatures. The same user can place multiple instances of the same
signature cell or multiple signature cells. The same user can also place
a mixture of file, model, and hidden model signatures.
Hierarchical signing
To create a hierarchy, the signer selects one or more existing signatures
in the Digital Signatures dialog before activating the Add Model or
File Signature tool. The signer then specifies that the new signature
will depend on the selected signatures.
MicroStation Administrator Guide 7–31
Digital Signatures
Removing a signature
To create a signing hierarchy
1. From the Digital Signatures dialog box, select one or more existing signatures.
2. Select the Add File Signature (or Place Signature Cell) icon.
The Add File Signature (or Place Signature Cell) dialog box opens. The name
of the signer and there location is filled in from the selection of the certificate.
3. Select a certificate from your personal certificate store.
4. Click the Dependent Signature check box if you want to
create a signature hierarchy.
5. Click OK.
Removing a signature
The signer can use the Remove a Signature tool on the Digital Signatures dialog
to remove a model (see page 7-8) or file signature (see page 7-8). Since model
signature elements are locked, this tool is the most convenient way to remove them.
Only the original signer can remove a signature. That is, the current
user can remove a signature only if he possesses the certificate and
private key used to create the signature.
Undo and Design History can be used to undo the removal of a signature.
Anyone can undo the removal of a signature. Whether the restored
signature is valid or not depends on whether the rest of the DGN file
and prerequisites are in the state that was signed.
To remove a signature
1. From the Digital Signatures dialog box, select the signature
or signatures to be removed.
2. Select the Remove a Signature tool.
The selected signature(s) is removed from the file. If a prerequisite
7–32 MicroStation Administrator Guide
Digital Signatures
Re-validating a signature
signature is deleted, the dependent signatures become invalid.
Re-validating a signature
A signature is invalidated by any change to the data in its scope or to the signature
itself. The signature can be restored using the Undo or Design History function.
The signer (and only the signer) can re-validate the signature after file changes
based on the current content using the re-validate tool. This is a short cut
for deleting the invalid signature and adding a new one.
To re-validate a signature
1. From the Digital Signatures dialog box, select a signature that is invalid.
Invalid signatures have an X in the verified column.
2. Click the re-validate a Signature tool
The signature is re-validated with the current state of the file. The signature
now displays verified (green check mark) and the red X is removed.
Re-validating a signature does not re-validate the signatures that depend on it.
Conversely, a dependent signature cannot be re-validated until all of its prerequisite
signatures have been re-validated. In general, the signatures in a hierarchy must
be re-validated in the reverse of the order in which they were created.
If a model signature element is copied, the copy will be a signature
but will be invalid. The signer (and only the signer) could then
recreate it, thus updating its signing time.
Digital Signatures tool box
The Digital Signatures tool box contains tools to access the Digital Signatures
dialog box and the Add a Digital Model Signatures dialog box.
MicroStation Administrator Guide 7–33
Digital Signatures
Digital Signatures
To Select in the Digital Signatures tool
box
Opens the Digital Signatures
dialog box.
Digital Signatures (see page 7-34)
Opens the Place Signature Cell
dialog box.
Place signature cell (see page 7-35)
Key-in: DIALOG TOOLBOX DIGITALSIGNATURES TOGGLE
Key-in: SIGNATURE ADD FILESIGNATURE
Digital Signatures
Used to open the Digital Signatures dialog box for creating, deleting
and revalidating digital signatures.
7–34 MicroStation Administrator Guide
Digital Signatures
Place Signature Cell
Key-in: DIALOG TOOLBOX DIGITALSIGNATURE TOGGLE
Place Signature Cell
Used to create a digital signature with model scope. A signature with model scope
(“model signature”) captures the state of the model when the signature is placed.
A hidden model signature is listed only in the Digital Signatures dialog box. The
signature is not displayed as an element in the content of the model.
Tool Setting Effect
Cells Cell that contains the graphics that visually represents the
signature. This field is disabled if no signature cell library has
been identified with the Attach Signature Cell Library tool.
Attach Opens the Signature Cell Library dialog box used for
Signature selecting signature cells. This is known as the “signature
Cell cell library.” The signature cell library is different from the
Library current placement cell library. MicroStation only looks
for signature cells in the signature cell library.
MicroStation Administrator Guide 7–35
Digital Signatures
Place Signature Cell
Tool Setting Effect
Active Sets the angle by which the cell is rotated.
Angle
Scale Scale by which the cell is placed.
Include If checked, the master file and all attached
References references are signed.
Signer Name of the person signing the model. The Signer defaults
to the current user’s login name. This could also be some
code or identifier that is meaningful within an organization.
This is useful for identifying the signer, especially if the
certificate name is different from the signer’s real name.
Include If checked, the master file and all attached
References references are signed.
Location The Location defaults to the current user’s computer name.
This could also be some location code, building name, or
other identifier that is meaningful within an organization.
Purpose This field could be used to describe the signer’s intent
and will normally be a phrase or code that is meaningful
within the organization or project.
Expiry Date the signature expires.
Dependent This check box is used to create a signature hierarchy. The
Signature new signature is marked as “dependent.” The Signatures
dialog box shows all dependent signatures in the “Hierarchy”
area. The dependent signature is shown as the root of a
tree, with its prerequisites shown as its children.
7–36 MicroStation Administrator Guide
Digital Signatures
Place Signature Cell
To place a signature cell
1. Click the Attach Signature Cell Library icon
The Signature Cell Library dialog box opens.
2. Select the model containing the signature cell.
3. Place a data point in the DGN being signed.
4. Click the Add a model signature icon.
The Place Signature Cell dialog box opens
5. Click the Attach Signature Cell Library icon.
The Signature Cell Library dialog box opens.
6. Select the model containing the signature cell.
7. Place a data point in the DGN being signed.
Key-in: SIGNATURE ADD FILESIGNATURE
MicroStation Administrator Guide 7–37
7–38 MicroStation Administrator Guide
Part III: Internet Technologies
Engineering Links
Designed to embrace the new engineering workflow, Engineering Links
is a series of Web-enabling technologies that simplifies management
of your MicroStation-based engineering projects. Engineering Links
forms a solid foundation for tomorrow’s completely collaborative
MicroStation engineering environments.
E(ngineering)-Links tool box
The Engineering Links tool box contains tools for linking to
and managing remote data.
The Engineering Links tool box opens in the following situations:
• when Engineering Links is chosen from the Tools menu
• when Connect Web Browser is chosen from the Utilities menu
• when MicroStation on the Web is chosen from the Help menu
• when the MicroStation on the Web icon is selected in the Standard tool box.
All but the first option listed here also launches your default Web browser.
MicroStation Administrator Guide 8–1
Engineering Links
E(ngineering)-Links tool box
To Select in the Engineering Links tool
box
Highlight all the elements in the design
file that contain an Internet tag.
Show Engineering Links (see page
8-3)
Create an Internet tag and attach
it to an element.
Attach Engineering Link (see page
8-4)
Edit an Internet tag that is attached
to an element.
Edit Engineering Tags (see page 8-6)
Send the browser to the Web
page specified by the Internet tag
attached to an element.
Follow Engineering Link (see page
8-7)
Connect MicroStation to or disconnect
it from your default Web browser.
Connect to/Disconnect from Browser
(see page 8-8)
Remove an attached Internet tag
from an element.
Delete Engineering Link (see page
8- 9 )
Key-in: DIALOG WEBTOOLS
8–2 MicroStation Administrator Guide
Engineering Links
Show Engineering Links
Show Engineering Links
Used to highlight all the elements in the design file that contain an Internet tag.
To show all elements containing Internet tags
1. Select the Show Engineering Links tool.
The line style and color of elements in the design file containing
an Internet tag changes to dashed and blue.
2. Select the Show Engineering Links tool again to return elements
containing Internet tags to their normal display.
Key-in: SHOW WEBTAGS 〈OFF | ON | TOGGLE〉
The color of elements containing an Internet tag defaults to blue. To change
to another color, key in SHOW WEBTAGS COLOR <color_number>.
For example, if you want the color of these elements to be yellow,
key in SHOW WEBTAGS COLOR 4.
MicroStation Administrator Guide 8–3
Engineering Links
Attach Engineering Link
Attach Engineering Link
Used to attach an Internet tag to an element. After attaching an Internet
tag, selecting the tagged element using the Follow Engineering Link (see
page 8-7) takes you to the Internet address specified in the tag.
Tool Setting Effect
Link Type Sets the type of link you are creating: HTML or XML.
If you are creating a simple XML link, you can specify
parameters which further define how the link should operate
(See the Role and Show descriptions below).
URL The Internet address to which to link the element.
Title The logical name of the Internet address in the URL field.
Role (Enabled when Link Type is Xlink:simple) Specifies
what role the object of the link will specify, for example,
that of a reference or cell library.
Show (Enabled when Link Type is Xlink:simple) Determines
whether any existing page should be replaced or if
a new browser should be opened.
8–4 MicroStation Administrator Guide
Engineering Links
Attach Engineering Link
To attach an Internet tag to an element
1. Select the Attach Engineering Link tool.
The Attach Engineering Link dialog box opens with the URL
and Title fields empty.
2. Type the appropriate Internet address and description in the
URL and Title fields.
3. Identify an element.
4. Accept.
The above procedure is useful when you know the exact Internet
address you want to use as your link. When you do not know the
exact address, use the following procedure.
Alternative method — To attach an Internet tag to an element
1. Select the Connect to Browser tool.
If your default Web browser was not open, it opens now, and
MicroStation connects to it.
2. In the Web browser, navigate to the exact Internet address to
which to link the element.
For example, http://www.bentley.com/products/index.htm.
3. In MicroStation, select the Attach Engineering Link tool.
The Attach Engineering Link dialog box opens with the URL field
automatically pointing to the Internet address open in your Web browser.
If you want to change this address, go back to the Web browser,
navigate to a new location, and select the Attach Engineering Link
MicroStation Administrator Guide 8–5
Engineering Links
Edit Engineering Tags
tool again to refresh the address in the URL field.
4. Change any of the fields or settings necessary.
5. Identify an element.
6. Accept.
Key-in: ATTACH WEBTAG
Edit Engineering Tags
Used to edit an Internet tag that is attached to an element.
To edit an attached Internet tag
1. Display all the elements in the design with attached Internet tags by
8–6 MicroStation Administrator Guide
Engineering Links
Follow Engineering Link
selecting the Show Engineering Links tool (see page 8-3).
2. Select the Edit Engineering Tags tool.
3. Identify an element with an attached Internet tag.
4. Accept.
The Edit Tags [Internet] dialog box opens.
5. In the list box, select a line item.
6. In the text field below, edit the value as desired.
7. Click OK.
Key-in: EDIT ENGLINKS TAGS
Follow Engineering Link
Used to send the browser to the URL specified in the selected
element’s attached Internet tag.
MicroStation Administrator Guide 8–7
Engineering Links
Connect to/Disconnect from Browser
To “jump” to the URL specified in an element’s Internet tag
1. Display all the elements in the design with attached Internet tags by
selecting the Show Engineering Links tool (see page 8-3).
2. Select the Follow Engineering Link tool.
3. Identify an element with an attached Internet tag.
4. Accept.
If it is not already open, the Web browser opens and takes you to the
URL specified in the selected element’s Internet tag.
Key-in: FOLLOW WEBTAG
Connect to/Disconnect from Browser
Used to connect MicroStation to or disconnect it from your default Web browser.
To connect MicroStation to the default Web browser
1. Select the Connect to Browser tool.
The default Web browser opens, if not open already, and
MicroStation connects to it.
8–8 MicroStation Administrator Guide
Engineering Links
Delete Engineering Link
To disconnect MicroStation from the default Web browser
1. Select the same tool, whose icon has slightly changed and whose
tool tip now says Disconnect from Browser.
If you had originally opened the browser through one of the Engineering
Links tools or by choosing Connect Web Browser, selecting Disconnect
from Browser closes the browser in addition to disconnecting it from
MicroStation. If you had opened the browser from outside MicroStation and
then connected to it, selecting Disconnect from Browser only disconnects
MicroStation from the browser without closing the browser.
Key-in: BROWSER CONNECT
Delete Engineering Link
Used to remove an attached Internet tag from an element.
Tool Setting Effect
Use Fence If on, you can delete all engineering links within
the fence contents.
To delete an attached Internet tag
1. Display all the elements in the design with attached Internet tags by
MicroStation Administrator Guide 8–9
Engineering Links
Remote Open/Attach
selecting the Show Engineering Links tool (see page 8-3).
2. Select the Delete Engineering Link tool.
3. Identify an element with an attached Internet tag.
4. Accept.
Key-in: DELETE WEBTAG
Remote Open/Attach
The Remote Open/Attach function allows you to select a URL as a DGN file
location instead of a specific local DGN file. URLs can also be attached to a remote
settings file, archive, reference, or cell library. Downloaded files from a URL are
stored in a directory specified by the configuration variable MS_WEBFILES.
The dialog box for creating a URL (for example, the Select Remote
Design File dialog box) has the same appearance no matter which type
of file is being attached. The methods for creating each type of URL
are described in the following procedures:
• To open a remote DGN file (see the “Fundamentals” chapter
in the QuickStart Guide)
• To open a remote settings file (see the “Placing Elements in 2D”
chapter in the MicroStation User Guide)
• To attach a remote cell library (see the “Using Cells” chapter
in the MicroStation User Guide)
• To attach a remote reference (see the “References” chapter in
the MicroStation User Guide)
Entering the URL
Once you have reached the dialog box for creating the URL you can enter the
URL into the address field by using one of following methods:
• Selecting a bookmark
8–10 MicroStation Administrator Guide
Engineering Links
Entering the URL
• Choosing an entry from the history
• Typing in the desired location
Bookmarks are stored in one of several files, depending on the data type.
Current types and the associated configuration variables are:
Design Files MS_BOOKMARKS_DGN
Cell Libraries MS_BOOKMARKS_CELL
Archives MS_BOOKMARKS_ARCHIVE
Resources MS_BOOKMARKS_RSC
Images MS_BOOKMARKS_IMAGE
MicroStation Administrator Guide 8–11
8–12 MicroStation Administrator Guide
Publishing Data to the Internet
This section provides information on MicroStation features that help
you publish data to the Internet.
Using HTML Author
HTML Author is used to create HTML files that can be viewed via any Web
browser. HTML files can be created from a Cell Library, DGN file Saved
View, MicroStation BASIC Macros, or a Design File Snapshot. Thumbnail
images can be generated in several Internet-aware formats, including JPEG
(default), WMF, CGM, TIFF, PNG, and SVF, when creating HTML files from
a Cell Library, Design File Saved View, or Design File Snapshot.
MicroStation’s plotting system is used to create thumbnail images
so you must access to the appropriate drivers (JPEG, WMF, CGM,
TIFF, PNG, or SVF) and PLT files.
To open the HTML Author dialog box
1. From the Utilities menu, choose HTML Author….
The HTML Author dialog box opens.
MicroStation Administrator Guide 9–1
Publishing Data to the Internet
Using HTML Author
To create an HTML file from a Cell Library
1. In the HTML Author dialog box, select Cell Library.
2. Click OK.
The Select Cell Library to Open dialog box opens.
3. Select a cell library file and click OK.
The HTML Cell Page dialog box opens.
4. Adjust any settings necessary and click OK.
The Create HTML File dialog box opens.
5. Adjust any settings necessary and click OK.
The HTML file is created and stored in the directory defined in the
Create HTML File dialog box’s File Name field. If Display File In
Browser is checked, clicking OK also opens your default Web browser
to display the newly created HTML file.
9–2 MicroStation Administrator Guide
Publishing Data to the Internet
Using HTML Author
To create an HTML file from a saved view of a DGN file
1. In the HTML Author dialog box, select Design File Saved Views.
2. Click OK.
The Select Design File dialog box opens.
3. Select the file containing the desired saved view and click OK.
The Design File Walkthrough dialog box opens.
4. Adjust any settings necessary and click OK.
The Create HTML File dialog box opens.
5. Adjust any settings necessary and click OK.
The HTML file is created and stored in the directory defined in the
Create HTML File dialog box’s File Name field. If Display File In
Browser is checked, clicking OK also opens your default Web browser
to display the newly created HTML file.
MicroStation Administrator Guide 9–3
Publishing Data to the Internet
Using HTML Author
To create an HTML file from a directory of MicroStation
BASIC macros
1. In the HTML Author dialog box, select Basic Macros.
2. Click OK.
The Select Basic Macro Directory dialog box opens.
3. Navigate to the desired directory and click OK.
The Basic Macro HTML Page dialog box opens.
4. Adjust any settings necessary and click OK.
The Create HTML File dialog box opens.
5. Adjust any settings necessary and click OK.
The HTML file is created and stored in the directory defined in the
Create HTML File dialog box’s File Name field. If Display File In
Browser is checked, clicking OK also opens your default Web browser
to display the newly created HTML file.
9–4 MicroStation Administrator Guide
Publishing Data to the Internet
Using HTML Author
To create an HTML file of a DGN file snapshot
1. In the HTML Author dialog box, select Design File Snapshot.
2. Click OK.
The Select Design File dialog box opens.
3. Select a DGN file and click OK.
The Create HTML File dialog box opens.
4. Adjust any settings necessary and click OK.
The HTML file is created and stored in the directory defined in the
Create HTML File dialog box’s File Name field. If Display File In
Browser is checked, clicking OK also opens your default Web browser
to display the newly created HTML file.
MicroStation Administrator Guide 9–5
9–6 MicroStation Administrator Guide
Part IV: Using Software Extensions
Scripts and Macros
To more efficiently perform specific tasks with MicroStation, you can use various
forms of customization. These kinds of application software are available:
• Key-in Scripts (see page 10-1)
• MicroStation BASIC Macros (see page 10-2)
• VBA Macros (see page 10-4)
Key-in Scripts
The simplest software applications are key-in scripts. A key-in script is a
sequence of MicroStation key-ins that are stored in a text file. For example, the
following script sets the active level, active color, and active line weight:
active level Level 3
active color blue
active weight 2
The Batch Process utility (see page 12-1) provides a convenient way to
create a script and apply it to a set of files or directories. You can also
use the Key-in window to run a key-in script.
To load and run a key-in script in the Key-in window
1. In the Key-in window, key in @<script_file>
script_file must include the full path and filename to the script file.
MicroStation Administrator Guide 10–1
Scripts and Macros
MicroStation BASIC Macros
MicroStation BASIC Macros
MicroStation BASIC Macros are BASIC programs that automate often-used,
usually short sequences of operations. Many MicroStation-specific
extensions have been added to the BASIC language to customize
it for the MicroStation environment.
In its simplest form, a macro “drives” MicroStation in much the same way a
human user does. Macros select tools and view controls, send key-ins, manipulate
dialog boxes, modify elements, and more, using many of the tools documented
in this guide. The obvious advantage of writing a macro to perform a task that
could otherwise be done manually is automating mechanical and repetitive
tasks. Several sample macros are supplied with MicroStation.
Macro code is stored in text files with .bas file extension. The macro
language is BASIC with MicroStation-specific extensions. Compiled
macros are stored in resource files with .ba extensions.
For information about developing your own macros, see “Introduction to Macros”
and the chapters that follow in the MicroStation BASIC Guide.
Running macros
You can load, run, and edit a macro using the Macros dialog box or a key-in.
10–2 MicroStation Administrator Guide
Scripts and Macros
Running macros
To load and run a macro
1. From the Utilities menu, choose Macros > MicroStation BASIC.
The Macros dialog box opens.
2. In the Macro name list box, select the macro.
3. Click the Run button.
Alternative method — To load and run a macro
1. From the Utilities menu, choose Macros > MicroStation BASIC.
The Macros dialog box opens.
2. Click the Browse button.
The Select Macro dialog box opens.
3. Key in or select the desired macro, and click the OK button.
The Start Macro dialog box opens.
4. Click the Run button.
MicroStation Administrator Guide 10–3
Scripts and Macros
VBA Macros
Alternative method — To load and run a macro
1. In the Key-in window, key in: MACRO <macro_name>
[arg1 arg2 …argn]
You can define an action string that specifies a key-in that runs a macro and
assign the action string to a custom tool, menu item, function key, or AccuDraw
keyboard shortcut. In this way, you can run frequently used macros with a single
click or key press. See “Customizing the User Interface” on page 3-1.
VBA Macros
MicroStation implements Microsoft’s Visual Basic for Applications (VBA).
MicroStation VBA has extensions to VBA that allow interaction to the
MicroStation design file elements and settings.
Several sample VBA macros are supplied with MicroStation. For information
about developing your own macros, see the MicroStation VBA Help.
Running VBA macros
You can create, run, and edit a VBA macro using the Macros dialog box.
10–4 MicroStation Administrator Guide
Scripts and Macros
Running VBA macros
To load and run a macro
1. From the Utilities menu, choose Macro > Macros.
The Macros dialog box opens.
2. In the Macro Name list box, select the macro.
3. Click the Run button.
Alternative method — To load and run a macro
1. In the Key-in window, key in:
VBA RUN [project name]module name.subprocedure
MicroStation Administrator Guide 10–5
10–6 MicroStation Administrator Guide
MDL Applications
MDL applications are extensions to MicroStation. MDL stands for MicroStation
Development Language — essentially the C language executed by MicroStation.
Many parts of standard MicroStation are actually MDL applications.
Bentley Developer Network (http://www.bentley.com/developer/)
members around the world offer products and services that compliment
Bentley engineering solutions.
An MDL application can only be used in MicroStation. MicroStation can
be (and almost always is) operated with more than one MDL application
loaded at a time. MicroStation can manage multiple MDL applications
simultaneously. In fact, there are no practical limitations placed on the
number of MDL applications that can be loaded.
Some MDL applications insert their own submenus in the Applications menu
in MicroStation’s main menu bar. (The Applications menu only appears in the
menu bar when an MDL application has inserted a submenu in it.)
In this chapter, you will find procedures concerning MDL applications, including:
• Loading and Unloading MDL Applications (see page 11-2)
• Loading MDL Applications Automatically (see page 11-4)
For information about designing and programming MDL applications, see
“MicroStation Development Environment” in the MicroStation BASIC Guide.
MicroStation Administrator Guide 11–1
MDL Applications
Loading and Unloading MDL Applications
Loading and Unloading MDL Applications
The MDL dialog box (Utilities > MDL Applications) can be used
to load and unload MDL applications.
To load an MDL application
1. From the Utilities menu, choose MDL Applications.
The MDL dialog box opens.
2. In the Available Applications list box, select the application.
3. Click Load.
Alternative method — To load an MDL application
1. From the Utilities menu, choose MDL Applications.
The MDL dialog box opens.
2. Click the Browse button.
The Select MDL Application dialog box opens.
3. Key in or select the desired MDL application, and click the OK button.
11–2 MicroStation Administrator Guide
MDL Applications
Loading and Unloading MDL Applications
Alternative method — To load an MDL application
1. Key in MDL LOAD <application_name>.
For example, to load the MDL application MERGE (merge.ma),
key in MDL LOAD MERGE.
MDL applications that are part of standard MicroStation are not listed in
the Available Applications list box in the MDL dialog box. However, upon
loading, they are listed in the Loaded Applications list box.
To view technical details about an MDL application
1. From the Utilities menu, choose MDL Applications.
The MDL dialog box opens.
2. In the Loaded Applications list box, select the desired application.
3. Click the Detail button.
To view key-ins for an MDL application
1. From the Utilities menu, choose MDL Applications.
The MDL dialog box opens.
2. In the Loaded Applications list box, select the desired application.
3. Click the Key-ins button.
The Key-in window opens, displaying the key-ins that are associated
to the selected MDL application.
MicroStation Administrator Guide 11–3
MDL Applications
Loading MDL Applications Automatically
To unload an MDL application
1. From the Utilities menu, choose MDL Applications.
The MDL dialog box opens.
2. In the Loaded Applications list box, select the application.
3. Click the Unload button.
Alternative method — To unload an MDL application
1. Key in MDL UNLOAD <application_name>.
Loading MDL Applications Automatically
You can have selected MDL applications load automatically every
time you open a DGN file.
To specify MDL applications for automatic loading
1. From the Workspace menu, choose Configuration.
The Configuration dialog box opens.
2. In the Category list box, select Design Applications.
The controls for selecting applications for automatic loading are
11–4 MicroStation Administrator Guide
MDL Applications
Loading MDL Applications Automatically
shown to the right in the dialog box.
3. In the Available Applications list box, select an MDL application that
you want to load automatically upon start-up.
4. Click the Add button.
The application’s name is shown in the Applications to Load list box.
5. Repeat steps 3 and 4 until all the desired applications’ names appear
in the Applications to Load list box.
6. Click OK.
MDL applications that require more control over MicroStation are referred to
as “initapps” after the name of the configuration variable (MS_INITAPPS)
that specifies them. Using the Design Applications configuration variable
is the preferred way to load MDL applications automatically.
For more information about modifying configuration variables, see “Working
With Configuration Variables” on page 2-7.
MicroStation Administrator Guide 11–5
11–6 MicroStation Administrator Guide
Batch Process Utility
The Batch Process utility lets you create and run a script that can be
performed on individual files or entire directories of files. The script
is a text file that contains a series of MicroStation key-ins that can run
commands, MicroStation BASIC macros (see page 10-2), VBA Macros
(see page 10-4), or MDL applications (see page 11-1).
Using this utility, you can easily run a series of commands on a group of
files. For example, you could use the Batch Process utility to quickly
remove the unused levels from many design files.
The Batch Process utility also lets you define and save a batch process job
file that defines the script (command file) and the files to be processed with
it. Later, you can open the job file and rerun the batch process.
Setting up and running a batch process
Before you run a batch process, you must create a script, then
identify the files to process.
General Procedure — To set up and run a batch process
1. Create the command file, and enter the key-in commands.
2. Select the files to process.
3. Run the batch process on the selected files.
MicroStation Administrator Guide 12–1
Batch Process Utility
Setting up and running a batch process
To create the command file
1. From the Utilities menu, choose Batch Process.
The Batch Process dialog box opens.
2. Click the Create a New Command File icon.
The Create Command File dialog box opens.
3. Enter a name for the command file, and click OK.
If the command file uses the default .txt extension, the text file
12–2 MicroStation Administrator Guide
Batch Process Utility
Setting up and running a batch process
opens in a text editor window.
4. Enter the MicroStation key-ins.
Most MicroStation commands have key-ins. You can also use key-ins
to run MicroStation BASIC macros (see page 10-2), VBA macros (see
page 10-4), and MDL applications (see page 11-1).
Command file in
text editor
To pause the script so that you can modify the design file interactively,
enter the BATCHPROCESSPAUSE key-in. Later, when the batch
process is running, it will pause at this point. To restart the process, click
the Continue button in the Files to Process dialog box. For details, see
To process a batch process job (see page 12-5).
5. Save and exit the text file.
To select the files to process
1. From the Initial Model option menu in the Batch Process dialog box, choose
the models to process in each file: All Models, or Default Model Only.
After you select the files and directories to process, you can modify
the Model setting for any of the files.
2. In the dialog box’s icon bar, click Add Files or Directories to Process.
The Select Files and Directories to Process dialog box opens. This dialog
box allows multiple selection of both files and directories.
MicroStation Administrator Guide 12–3
Batch Process Utility
Setting up and running a batch process
3. Select individual files or directories to process.
4. Click Add.
The specifications for the selected directories or files are listed in the
Selected Files list box. The wildcard string “*\” at the end of a directory
specification indicates that subdirectories are included.
5. Repeat steps 5 and 6 until you have selected all directories and files to process.
6. Click Done.
The Select Files and Directories to Process dialog box closes,
and the Process Tasks list box in the Batch Process dialog box
updates to reflect your selections.
Files for processing can be selected using drag and drop from Windows Explorer.
Models for processing can be selected using drag and drop from the Models
dialog box of the current session, or from another open session of MicroStation.
At this point, you can directly modify the Model setting for an individual file.
Select a file in the Process Tasks list, then click on and modify the Model setting.
12–4 MicroStation Administrator Guide
Batch Process Utility
Setting up and running a batch process
Using drag and drop to select files from Windows Explorer
1. From the Initial Model option menu in the Batch Process dialog box, choose
the models to process in each file: All Models, or Default Model Only.
After you select the files and directories to process, you can modify
the Model setting for any of the files.
2. Open Windows Explorer and navigate to the directory
containing the files to process.
3. In Windows Explorer, select one or more files as required.
4. Hold down the data button and drag the selected files to the Batch
Process list box, releasing the button to drop the files.
If you want the files to be dropped between two existing tasks, position
the pointer between them prior to dropping the new files.
Using drag and drop to select models for batch processing
1. From the Utilities menu, choose Batch Process.
2. In either the active design file, or from a second session of
MicroStation, open the Models dialog box.
3. In the Models dialog box, select the model(s) required to process.
4. Hold down the data button and drag the selected files to the Batch
Process list box, releasing the button to drop the files.
If you want the files to be dropped between two existing processing tasks,
position the pointer between them prior to dropping the new files.
To run the batch process
1. (Optional) — To process specific files or directories, select them
in the Batch Process dialog box’s Process Tasks list box, and turn
on Process Selection Only in the icon bar.
2. In the Batch Process dialog box’s icon bar, click the Process
MicroStation Administrator Guide 12–5
Batch Process Utility
Saving and recalling batch process jobs
Batch Process Job icon.
The Files to Process dialog box opens. The individual files
to process are listed.
3. Click Process.
The Process button label automatically changes to Pause, and the Status
column identifies the file being processed. Click Pause to pause processing
between commands. (Click Continue to restart processing.)
When processing is complete, the Pause button label changes to Done.
4. To return to the Batch Process dialog box, click Done.
Saving and recalling batch process jobs
If you plan to reuse the job setup in future jobs, you should save it to a batch
process job file. This text file is similar to a Windows initialization file.
It contains the log file name, the list of files to process, and the command
file name. You can edit it in a text editor if desired.
12–6 MicroStation Administrator Guide
Batch Process Utility
Saving and recalling batch process jobs
To save the job setup to a batch process job file
1. In the Batch Process dialog box’s icon bar, click the Save icon.
The Save Batch Process Job File dialog box opens.
2. In the Files field, key in the desired filename. The default extension is “.bprc.”
3. Click OK.
The file is created, the dialog box closes, and the focus returns
to the Batch Process dialog box.
If you change the job setup in MicroStation, you can save the modified
setup to the same batch process job file by clicking the Save icon, or
to a new file by choosing File > Save As.
To load a saved batch process job setup
1. In the Batch Process dialog box’s icon bar, click the Open icon.
The Open Batch Process Job File dialog box opens.
2. In the Files list box, select the desired batch process job file.
3. Click OK.
The dialog box closes, and the focus returns to the Batch Process
dialog box. In that dialog box, the Process Tasks list box updates
to show the tasks specified in the file.
MicroStation Administrator Guide 12–7
12–8 MicroStation Administrator Guide
Part V: External Database Interface
MicroStation and Non-graphical
Data
Typically private enterprise and government entities manage two significant
data sets about their physical plant or products:
• Architectural or engineering design drawings
• Non-graphical data stored in organization-wide databases
One data set is typically of limited use without the other, yet many times
the sets are kept separate. The non-graphical data is printed and added to
drawings only after they are plotted. While this approach may be fine for a
production shop, it may be inappropriate for a project manager who wants
intelligent, useful drawings for the life of a project.
Several advanced design applications link non-graphical data to drawings —
for example, products such as Facility Management Systems and Geographic
Information Systems (GIS) do this very well. The one aspect most of these
systems have in common is that the database interface is built into the application.
Associating Elements to Non-graphical Data
MicroStation lets you build your own application that associates non-graphical
data to graphical elements, including text and cells, using standard interfaces
that are part of MicroStation. This association can be accomplished
using either of two MicroStation features:
• Element tags, where associated data is stored in the DGN file with the
graphical elements. Tags are appropriate if your needs for associating
non-graphical data to elements in the DGN file are relatively simple or
MicroStation Administrator Guide 13–1
MicroStation and Non-graphical Data
Tag to Database Converter
you must maintain compatibility with other CAD packages that store
data inside their drawing files. The associated tag data may be copied
from the tag, loaded into a database and linked back to the tag. For more
information, see “Tagging Elements”in the User Guide.
• Database interface, where associated data is stored in a separate relational
database that is linked to elements in the DGN file.
The remainder of this chapter covers the database interface.
Tag to Database Converter
The tag to database converter exports tag data from the DGN file into an
existing database table for use with MicroStation’s database interface. When
exporting the tag data, the application scans the DGN file for elements which
have tag data attached, extracts the tag data, and builds and executes an Insert
statement to add the tag data to a database table. The application adds a database
link to the element for the row which was inserted into the table.
For general information about tag data, see “Tagging Elements”in the User Guide.
What is the Database Interface?
The database interface is a set of tools and settings that lets you associate (or
link) a row in a relational database to an element in the design. This is done
by storing information about the linkage on the element in the DGN file. In
order to link a table to a graphical element, the table must have a numeric
MSLINK column. This column acts as a unique row identifier (essentially
a row ID) for MicroStation. The second requirement is that the database
contains a table called MSCATALOG, which MicroStation creates upon
connecting to a database if one has not already been created. The attribute
table name is entered and assigned a unique entity number.
There are two pieces of information that are used to retrieve the correct row from
the correct table. The first is the entity number, a unique value assigned to
the table in the MSCATALOG. The second is the MSLINK number, a unique
value assigned to the row of data in the table. When a database row is linked
to a graphical element, attribute data, in the form of a USER DATA Linkage
13–2 MicroStation Administrator Guide
MicroStation and Non-graphical Data
Why Use the Database Interface?
containing the MSLINK and entity number, is written to the element.
Once this linkage is established you can manipulate and review the
database information from inside MicroStation.
The following commercial database products are directly supported: Oracle, OLE
DB and those conforming to Open Database Connectivity Standard (ODBC).
ODBC is not a relational database; it is a generic interface that allows advanced
design applications to access SQL compliant databases.
Why Use the Database Interface?
Using the database interface offers many capabilities not otherwise available to
the CAD user. These range from a simple application that tracks part numbers
in an assembly to a sophisticated facility management system, which tracks the
operation and maintenance of a large organization, and everything in between.
For example, a graphical element representing a street on a map can be linked
to a road or street name, traffic flow rate, accident rate, construction date,
and resurfacing data in a database table. The centroid point and text for
the lot number of each parcel of land could be linked to another database
table that includes owner, area, and street name.
By relating the two tables, you could, for example:
• Selectively display all properties that have a value of over 100,000 dollars
and a traffic flow of over 100,000 vehicles per year, and produce a
report that included each owner’s name and address.
• Selectively display or highlight all roads in the northeast quadrant of the county
that have a traffic flow of 50,000 vehicles a day and over 10 accidents per year.
• Produce a map of a subdivision showing all owner’s names and property
values. When the database changes you can globally update the map.
Using the database interface requires more memory than MicroStation’s
standard memory requirements. Additional memory improves the
MicroStation Administrator Guide 13–3
MicroStation and Non-graphical Data
What is a Relational Database?
performance of both MicroStation and the database.
What is a Relational Database?
A relational database is an ordered collection of tables or files that represent
objects, their properties, and relationships between the objects.
These terms are used throughout this guide:
• A relational database contains a collection of tables.
• Each table is composed of rows and columns.
Usually the tables in a database have a common column or field that relates
one to the other. Hence the term relational database.
Why Use a Relational Database?
There are many reasons to use external relational databases to link textual
information to graphics. Relational databases are by far the most popular
database models on the market today. They are designed to hold large
amounts of data. They typically use Structured Query Language (SQL) for
accessing and modifying data. Products like Oracle along with the standard
SQL model, have revolutionized how information is managed.
Microsoft’s Open Database Connectivity (ODBC) interface and OLE DB
allows applications, through database drivers, access to data in a variety
of database management systems (DBMS). This enables users to evaluate
their own database environment and add ODBC database drivers without
the need for changes to the ODBC-enabled application.
See Bentley’s website for a complete list of certified and supported databases.
Database Server
The MicroStation database interface software program for a particular database
package — for example, Oracle — is sometimes called the database server. The
13–4 MicroStation Administrator Guide
MicroStation and Non-graphical Data
Choosing a Database
server model defines the interaction between MicroStation, the database package,
and the database server. Unless you are developing database applications for
MicroStation, you need not be familiar with the details of the server model. It is
sufficient to be aware that in the server model, database functions are separated
from graphics functions. This means memory requirements for MicroStation
sessions are reduced when a database is not connected (a server is not loaded).
Choosing a Database
MicroStation supports many of the popular relational database software product
families on the market today. Selecting the “right one” can be difficult as
these databases represent a broad range in sophistication, performance and
cost. You can implement anything from a simple single-user database on a PC
to a full featured corporate network system with database servers and different
vendor databases all interacting with the same design files.
MicroStation database interface availability varies from operating
system to operating system. For the latest information on supported
database versions, see Bentley’s website.
This chapter identifies issues you should consider in selecting a database as well
as the major features of the various supported database products.
Selection Factors
There are many factors that influence the selection of a database. For
example, if only one person will use the database information you might
choose to keep it on the user’s system. Or, if several people need access to
the data you may choose to place it on a network server.
Most of the supported database products will run from a network server, but
they operate quite differently. On the single user system, the server just stores
the database file. All processing is accomplished on the user’s system. This
can result in considerable data being passed across the network.
Oracle is a client server database. Here the database engine runs on the server.
It receives requests from client software on each user’s system. A request is
MicroStation Administrator Guide 13–5
MicroStation and Non-graphical Data
Database Product Families
processed and only the answer is passed back across the network. This type of
database can support more users because there is less traffic on the network. These
products can also run with the client and server software both on the user’s system.
Here are some selection criteria you should consider:
• Will the database be local or on a network server?
• Will you access the data from different types of systems?
• Will you be required to run the database independent of MicroStation?
• Should the MicroStation application be independent of the database? That is,
should the application run unchanged with different vendor databases?
• Will tabular reporting of non-graphical data be required?
• Will corporate database standards influence your selection?
• Will you need to interface with the corporate database?
• Will you be required to access more than one vendors’ database?
Database Product Families
Typically database products are not just one program or application, but a
family or suite of application tools to allow you to build, maintain, and report
your information. Because MicroStation supports such a broad range of
commercial databases you should familiarize yourself with the capabilities
of each family of products before you make a selection.
Oracle
Oracle, by Oracle Corporation, is a very popular database based
on the client-server model.
Oracle offers several database products with varying capabilities that can be used
with MicroStation. Although there are significant differences between these
products, the MicroStation issues revolve around the following questions:
13–6 MicroStation Administrator Guide
MicroStation and Non-graphical Data
Oracle
• Is access required to a local or remote (on a server) database?
• Will access be required from several different types of systems?
The following is a partial listing of Oracle products and requirements for
their use with local and remote (on a server) databases:
Product Local Database Remote Database
RDBMS Required (not applicable)
SQL*Plus Required Optional
SQL*Net Optional* Required
Required Support Required Required
Files
* Required to support remote clients
Product descriptions
These Oracle products are of interest to the MicroStation user:
Product Description
Oracle (base The core of the relational database management
product) system. It includes features that control data
storage, retrieval, and security.
Oracle development tools
Oracle Pro*C Lets developers embed database manipulation
statements into their applications.
Oracle Lets database tables from other sources
SQL*Loader be loaded into Oracle.
JDeveloper Lets developers design applications
and components according to the J2EE
specification.
Oracle database tools
Oracle SQL*Plus Provides an interactive interface to Oracle
with facilities for ad hoc queries and
database manipulations.
MicroStation Administrator Guide 13–7
MicroStation and Non-graphical Data
ODBC Database Interface
Product Description
Oracle Network tools
SQL*Net Lets MicroStation access remote Oracle
databases over a network.
Oracle Client Software
Required Support MicroStation database server interacts with
Files these files to connect to a remote server.
ODBC Database Interface
Microsoft’s Open Database Connectivity (ODBC) interface allows
applications, through database drivers, access to data in a variety of database
management systems (DBMS). This enables users to evaluate their own
database environment and add ODBC database drivers without the need
for changes to the ODBC-enabled application.
For the latest information on supported ODBC versions, refer to Bentley’s Web site.
OLE DB Database Interface
OLE DB provides an open data access and uses a standard set of COM interfaces
for accessing and manipulating many types of data. OLE DB interfaces can
access simple data or relational databases. This provides access to data that
cannot be accessed through the current ODBC technology.
The following is a list of supported OLE DB providers:
Supported OLE DB providers
Microsoft Jet 3.51 OLE DB Provider
Microsoft Jet 4.0 OLE DB Provider
Oracle Provider for OLE DB
Microsoft OLE DB Provider for SQL Server
While Microsoft also supplies an OLE DB provider for Oracle, Bentley
13–8 MicroStation Administrator Guide
MicroStation and Non-graphical Data
OLE DB Database Interface
recommends the use of the provider supplied by Oracle.
The following databases are supported with an OLE DB connection:
Databases supported with an OLE DB connection
Access 97
Access 2000
Oracle 8i
Oracle 9i
SQL Server 2000
MicroStation Administrator Guide 13–9
13–10 MicroStation Administrator Guide
Connecting to Databases
This chapter discusses how to set up databases and connect to
them from within MicroStation.
Setting Up the Database Interface
Setting up MicroStation for the database has been simplified by the delivery
of database configuration files. These files are automatically loaded when
Settings > Database > Connect is chosen. Also, the database variables
from these configuration files may be loaded automatically with the use of
the -wd<config file> switch when executing MicroStation.
Set the database linkage type in the database configuration file(s) since they
override MicroStation configuration variables such as MS_LINKTYPE.
Connecting to ODBC
ODBC (see page 13-8) uses a data source to maintain the connection information
for a database. MicroStation uses the same ODBC data source name for the
connection string. The ODBC driver(s) must be loaded before data sources can be
created. Once the drivers are loaded, an ODBC icon appears in the Windows
Control Panel or Administrative Tools, depending on the operating system.
To set up the ODBC interface
1. Open the ODBC driver manager by double-clicking the
MicroStation Administrator Guide 14–1
Connecting to Databases
Connecting to ODBC
ODBC control panel icon.
2. Click the Add button.
3. Select the ODBC driver for the DBMS that contains your data.
The data source dialog box opens.
4. Define the data source name (this is the string you will use in
MicroStation’s Connect to Database dialog box).
5. (Optional) — Provide a description.
For the remaining settings, look at the table below for your specific database.
Refer to your ODBC driver manual for specifics on other fields.
Database Action
Access Click the Select button to pick the *.mdb file.
The delivered Access example database is
in the Bentley “Program\MicroStation\data-
base\odbc\examples\access\gis.mdb”.
dBase Provide the database directory (the directory that
contains the .dbf and index files).
The delivered Dbase IV gis example is in
the Bentley “Program\MicroStation\data-
base\odbc\examples\db4\”.
Oracle Provide the data source name, service name
(created through the Oracle Client Configuration
software), and User ID.
SQL Server Follow the prompts in the dialog box. At a
minimum you should specify Name, Server,
and Login/Password.
To connect to an ODBC database from within MicroStation
1. From the Settings menu, choose Database > Connect.
The Connect to Database dialog box opens.
2. Set the Database Server to ODBC.
3. Provide the connect string by entering the Data Source Name
14–2 MicroStation Administrator Guide
Connecting to Databases
Connecting to Oracle
created in the ODBC Administrator.
If you do not enter a connect string or if you enter an “*” as the
data source name, the ODBC driver manager displays and you can
select the desired data source from the list box.
Alternative method — To connect to an ODBC database
from within MicroStation
1. Right-click the MicroStation icon and from the menu that
appears, choose Properties.
2. In the Properties dialog box, select the Shortcut tab.
3. At the end of the Target field, key in -wdodbc.
The Target field should now look something like this:
C:\Bentley\Program\MicroStation\ustation.exe
-wdodbc
4. Click Apply to save the changes and close the dialog box.
5. Start MicroStation by double-clicking the MicroStation icon.
6. In the Key-in window, key in DB = <data source name> where
data source name is the name created in ODBC.
If you were once connected to the database with this DGN file and you
saved the settings in the file after connecting the first time, starting
MicroStation with the -wdodbc switch automatically loads the configuration
variables and will connect you to the database.
Connecting to Oracle
This section covers how to set up an Oracle database for use with MicroStation.
For general information about the Oracle product family, see “Oracle” on
page 13-6, or the Oracle Web site (“http://www.oracle.com”).
MicroStation Administrator Guide 14–3
Connecting to Databases
Connecting to Oracle
General Procedure — Setting Up Oracle
1. Perform any indicated special setup steps in the “notes” section for
your system. (See Windows Notes (see page 14-6).)
2. Start Oracle on the server. This step must be performed before any
MicroStation session during which you will connect to an Oracle database.
See the “notes” section for your system. (The database administrator
is commonly responsible for starting Oracle.)
3. If the database resides on a remote server, create an alias using
the Oracle SQL Net Easy Configuration utility. For Oracle 8i, use
Net8 Configuration Assistant. For Oracle 9i and later, the utility
is called Net Configuration Assistant.
4. Have the Oracle database administrator set up an Oracle user. Make sure
that the appropriate permissions are granted to the user to allow select,
update, delete, insert, create, alter, and drop table permissions.
5. Test the connection to the remote server through SQL Plus or SQL Worksheet
to ensure that the Oracle client has been configured correctly.
To set up the GIS example database
1. Run the loadgis.bat file located in the “\Bentley\Program\MicroStation\data-
base\oracle\examples\tables” directory from a DOS prompt.
The MSCATALOG is created with sample tables.
To connect to an Oracle database from within MicroStation
1. From the Settings menu, chose Database > Connect.
The Connect to Database dialog box opens.
2. Set the Database Server to Oracle.
3. In the Connect String field, key in <user_name>/<pass-
word>@<database_alias>.
4. Click OK.
14–4 MicroStation Administrator Guide
Connecting to Databases
Connecting to Oracle
Alternative method — To connect to an Oracle database
from within MicroStation
1. Right-click the MicroStation icon and from the menu that
appears, choose Properties.
2. In the Properties dialog box, select the Shortcut tab.
3. At the end of the Target field, key in -wdoracle.
The Target field should now look something like this:
C:\Bentley\Program\MicroStation\ustation.exe
-wdoracle
4. Click Apply to save the changes and close the dialog box.
5. Start MicroStation by double-clicking the MicroStation icon.
6. In the Key-in window, key in DB =<user_name>/<pass-
word>@<database_alias>.
Starting MicroStation with the -wdoracle switch automatically
loads the configuration variables.
The default Oracle client files delivered with MicroStation are for use with
Oracle 8i and Oracle 9i. To connect to Oracle 8.0.x from MicroStation, you must
have the Oracle 8.0.x client installed and properly configured. In addition,
you must take the following steps to connect to your database:
1. Exit any running MicroStation session.
2. Back up any existing Oracle client files, if desired. (These files include
orservrd.dll, oralddlm.ma, and orserver.rsc.)
3. Unzip oracle804.zip (located in the folder “ ..\Program\MicroSta-
tion\database\oracle\redist”), and extract the contents to the folder
“..\Program\MicroStation\mdlsys\asneeded”.
4 . Restart MicroStation with the Oracle 8.0.x client files.
If you have multiple Oracle clients installed on your system, ensure that
the correct Oracle client files are used to connect to Oracle by setting the
configuration variable MS_ORACLE_HOME in the configuration file
"Program/MicroStation/config/database/oracle.cfg".
MicroStation Administrator Guide 14–5
Connecting to Databases
Connecting to an OLE DB data source
Windows Notes
For the batch file loadgis to run correctly, the Oracle SQL Loader
utility must be installed.
For Windows NT, search for a file named sqlldr*.exe located in the
“\orant\bin” directory of Oracle. Make sure this matches the executable
name found in the loadnt.bat file.
The sqlldr*.exe file is located in Oracle’s “bin” directory for Oracle 8i and Oracle 9i.
Connecting to an OLE DB data source
This section covers how to set up an OLE (Object Linking and Embedding)
database for use with MicroStation.
OLE DB provides open data access and uses a standard set of COM
interfaces for accessing and manipulating many different types of data.
These interfaces are commonly referred to as Data Providers. You may
need to contact your database vendor to determine if a OLE database
provider is available for your database product.
Applications, such as MicroStation, that access data through OLE DB are called a
Data Consumer. OLE DB interfaces can be developed to access simple data or true
relational databases making it more flexible then the current ODBC technology.
For general information about OLE DB, see the “OLE DB section” on page 13-8.
General Procedure — Setting Up OLE DB
1. Set up a UDL (Microsoft Data Link) file through Windows (see
page 14-7) or MicroStation (see page 14-8).
UDL files are stored in the directory defined in the MS_UDLDIR directory.
The default directory is ..\Bentley\Program\MicroStation\database\oledb\udl.
2. Obtain the appropriate OLE DB Provider software from your database vendor.
14–6 MicroStation Administrator Guide
Connecting to Databases
Connecting to an OLE DB data source
3. Connect to the OLE DB data source.
To create a UDL file in Windows
1. In the Windows Explorer, navigate to the directory where you
want the UDL files to be stored.
2. Right–click on the right panel of the Windows Explorer.
A pop-up window opens.
3. Select Microsoft Data Link from the New menu.
A file named New Microsoft Data Link.UDL is created.
If Microsoft Data Link is not an option on your operating system, select
the Text Document option. Once the text file has been created, rename the
extension to .udl so it will be recognized as a Microsoft Data Link file.
4. Right-click on the file and rename it to a more appropriate name.
5. Double-click the .udl file.
The Data Link Properties dialog box opens.
6. Click on the Provider tab.
A list of available OLE DB Providers installed on your machine displays.
If your do not a provider installed for you database, contact your
database vendor to see if one is available.
7. Select the desired OLE DB Provider and press Next.
The Connection tab displays.
8. Enter the necessary information. This information will vary
based on the selected provider.
9. Click the Test Connection button to verify the connection is correct.
10. (Optional) — Click the Advanced tab and set the desired initialization
parameters for the data you are accessing.
11. Click OK.
MicroStation Administrator Guide 14–7
Connecting to Databases
Connecting to an OLE DB data source
To create a UDL file through MicroStation
1. From the Database submenu on the Settings menu, select Connect.
The Connect to Database dialog box opens.
2. Select OLEDB from the Database Server pull-down menu.
3. Select New from the Database Source pull-down menu.
4. Click OK.
The UDL Filename dialog box opens.
5. Enter the name of the .udl file to be created in the File Name field.
6. Click OK.
The Data Link Properties dialog opens with the Connection tab displayed.
7. Follow steps 6 through 11 in the To create a UDL file in Windows procedure.
To edit a UDL file
1. Navigate to the folder containing your .udl files with Windows Explorer.
2. Double-click on the .udl file.
The Properties dialog box for the select .udl file opens.
3. Make the desired changes to the file and click OK to save the changes.
Editing the UDL file with a text editor may corrupt the file.
14–8 MicroStation Administrator Guide
Connecting to Databases
MS_LINKTYPE
To connect to an existing OLE DB data source
1. From the Database submenu on the Settings menu, select Connect.
The Connect to Database dialog box opens.
2. Select OLEDB from the Database Server pull-down menu.
3. Click on the desired .udl file in the Database Source pull-down menu.
4. Press OK to connect to the data source.
MS_LINKTYPE
Linkages between design elements and the database can be written
as any of the following types:
• ORACLE
• ODBC
• OLEDB
The MS_LINKTYPE configuration variable definition controls which linkage
types the MicroStation database interface software recognizes. By default, the
delivered configuration files are set to recognize many types of linkages.
The OLEDB_ID configuration variable can be used with the MS_LINKTYPE
variable. It tells MicroStation what linkages to write to the file and which
linkages to recognize during review operations.
OLEDB configuration variables
The following configuration variables can be set in the OLEDB.cfg:
MicroStation Administrator Guide 14–9
Connecting to Databases
MS_LINKTYPE
Configuration variables Description
MS_OLEDBMAXDATA Limits the amount of data returned
from database columns with unlimited
space. These columns are MEMO
columns in Microsoft Access and
LONG columns in Oracle. The
default value is 1024.
MS_DBOLEDBDATEFORMAT Format of date fields returned
from the database.
• %B — Full Month Name
• %d — Day of the month
• %Y — Year including the
century
MS_UDLDIR Identifies the directory which con-
tains the Universal Data Link files
(.UDL). The .UDL files contain the
connection strings to a particular
data source. The default directory
is “...\Bentley\Program\MicroSta-
tion\database\oledb\udl.”
For more formatting date options, visit the Microsoft Developer Network
Web site (“http://msdn.microsoft.com/”) and look up the syntax for strftime
or wcsftime in the Run-Time Library Reference document.
Copying elements with attached linkages
When you copy an element that has database linkages, the database linkages
are copied with it. The linkage is written as the type first specified in the
MS_LINKTYPE variable, regardless of the original elements’ link type.
For example, suppose you copied an element that has an ORACLE linkage
attached to it. If MS_LINKTYPE=ODBC in the current database session, the
linkage that is attached to the new element (the copy) contains exactly the
same data. However, when you analyze the element, the linkage is written
as “ODBC Data Linkage” rather than “Oracle Data Linkage.”
14–10 MicroStation Administrator Guide
Connecting to Databases
Troubleshooting Database Connections
The copy function also respects the Linkage Mode setting. For example, if
Linkage Mode is set to New, any element with a database linkage that is copied
has a new row added to the database. If Linkage Mode is set to Duplicate,
the copied element is linked to the same record as the original.
The above example assumes MicroStation is connected to the database. If
not connected to a database, the element and database linkage are copied
as is, without regard to MS_LINKTYPE or Linkage Mode.
For more information about Linkage Mode, see “Setting Linkage
Mode” on page 15-43.
Troubleshooting Database Connections
To most effectively troubleshoot a database connection, set the
configuration variable MS_SESSION_DEBUG.
If you set this configuration variable, session debug will start prior
to "server.ma" loading. That is, debug messages will start as soon
as the database components load.
If you set MS_SESSION_DEBUG to 1, you will get debug information from
"server.ma" and the corresponding DLL (ORACLE, ODBC, OLEDB). If you
set MS_SESSION_DEBUG to 0 you will only get output from the DLL.
MicroStation Administrator Guide 14–11
14–12 MicroStation Administrator Guide
Linking Database Rows to
Elements
In this chapter, you will find procedures concerning linking information
in a database to graphic elements in MicroStation.
Database Tools Available in MicroStation
There are two database interfaces available to the user for database interaction.
The first, Visual SQL Query Builder, is a GUI–based interface. VSQL does
not require users to key in the exact SQL query statement to interact with the
database. The SQL statement is built as the user clicks the table and columns and
selects criteria for queries from pull down menus. Execution of the auto-generated
query statement produces query results in the form. Values can be edited or new
rows can be added/deleted in the database by a click of a button.
The second is the SQL window and a series of tools from the Database tool
box. SQL (pronounced se-quel) stands for Structured Query Language.
SQL is a simple yet powerful language that is the industry standard
for database access and data manipulation.
Visual SQL Query Builder
The Visual SQL Query Builder provides a graphically intuitive means
of generating simple and complex queries and joining tables. From the
generated query, the Visual Query Builder automatically builds form dialogs
— dialogs containing simple controls for interfacing to a database — which
can be saved and recalled when needed. Using the form editing tool, a form
dialog can be visually manipulated and reformatted.
The Visual SQL Query Builder is the default database query tool and is available
MicroStation Administrator Guide 15–1
Linking Database Rows to Elements
Visual SQL Query Builder dialog box overview
when Settings > Database > Query Builder is chosen.
To open the Visual SQL Query Builder dialog box, you must be
connected to a database.
Visual SQL Query Builder dialog box overview
The Visual SQL Query Builder dialog box uses a simple graphical means of
generating query statements of varying complexity, graphically generates and
displays table joins, builds form dialogs from generated queries, and allows
you to save form dialogs and to retrieve them for later use.
Selecting Query Builder from the Database menu opens the Visual
SQL Query Builder dialog box.
The Visual SQL Query Builder dialog box lets you easily build SQL
queries. It helps ensure proper syntax and reduces time consuming
key-ins for both novice and expert SQL users. The dialog box uses a tab
structure that separates and organizes the main query building steps. The
tab names follow the intuitive SELECT, WHERE, GROUP BY, ORDER
BY order with which most users are familiar.
15–2 MicroStation Administrator Guide
Linking Database Rows to Elements
Building simple SELECT statements
The Visual SQL Query Builder also generates a database form dialog
from the query statement. The dialog form can be used to navigate
through a database table, and to query, insert, update and delete rows in
the table. The form can be saved for future use.
The Standard Form Items dialog box is used to specify the control items
which appear on newly generated dialog forms.
To open the Visual SQL Query Builder dialog box, you must be
connected to a database.
Building simple SELECT statements
This section starts with a simple SQL statement and sequentially builds
more complex statements, explaining how the Visual SQL Query Builder
is used to create SELECT statements, how it displays the results to the
user, and how the results are displayed in a dialog form.
All the examples in this section apply to the GIS database.
The following examples reflect different settings in the Standard
Form Items dialog box.
You can either type an SQL statement directly into the SQL Select
Statement field or you can proceed with following procedures and have
MicroStation generate an SQL statement for you.
To use the Visual SQL Query Builder to build the following
query: SELECT parcel_no, owner, parc_value FROM parcel
1. In the Visual SQL Query Builder dialog box (Settings > Database > Query
MicroStation Administrator Guide 15–3
Linking Database Rows to Elements
Building simple SELECT statements
Builder), click Tables or from the Tables menu choose Open.
The Select Table dialog box opens.
2. In the Table List option menu, choose MSCATALOG to display the tables
listed in the MSCATALOG table, or choose All to display all project tables.
3. In the Select Table dialog box, double-click Parcel.
The Parcel dialog box opens in the work area on the Select table page.
The Parcel dialog box contains all columns of the Parcel table.
4. In the Select Table dialog box, click Close to dismiss the dialog box.
5. To move the Parcel dialog box, left click the title bar, hold the left mouse
button down, drag the dialog box to a new location, and release the mouse
button. This functionality is very useful for visually generating table joins.
The following appears in the SQL Select Statement text box:
SELECT
FROM parcel
6. Double-click the parc_no, owner, and parc_value fields.
The SQL Select Statement updates to the following, indicating
that the query is complete:
15–4 MicroStation Administrator Guide
Linking Database Rows to Elements
Building simple SELECT statements
SELECT parcel_no,owner, parc_value
FROM parcel
Double-clicking again any of these selected fields will deselect them, and
the query statement updates to reflect the change. Double-clicking the
asterisk (*) toggles between selecting and deselecting all fields.
7. Click the Execute button to review the results based on this query.
If Output > Forms is turned on with Dataset Mode selected,
the following form is generated.
In this example, the user can navigate forward and backward through the
Parcel table using the First, Next, Previous and Last buttons. This dialog
box, called a form, can be saved and retrieved for future use.
If Output > Browser is turned on, the same results are displayed in
the Visual SQL Data Browser dialog box.
A maximum of 50 tables may be open at one time.
You can minimize or dismiss the large Visual SQL Query Builder
dialog box, leaving the smaller form dialog box active. This can be
useful if screen space is limited.
If you are working with a table that currently contains no rows of
data, turn off Execute Query on Open and Dataset Mode. This will
generate an empty form ready for data entry.
MicroStation Administrator Guide 15–5
Linking Database Rows to Elements
Building simple SELECT statements
To use the Visual SQL Query Builder to build the following
query: SELECT max(parc_area) FROM Parcel
1. In the Visual SQL Query Builder dialog box (Settings > Database > Query
Builder), click ClearSQL, and then Clear All to clear everything.
2. In the Select tab page, click Tables or from the Tables menu choose Open.
The Select Table dialog box opens.
3. In the Select Table dialog box, double-click Parcel.
The Parcel dialog box opens.
The SQL Select Statement now reads:
SELECT
FROM Parcel
4. In the Select Table dialog box, click Close.
5. Click the Functions options menu button, and select Maximum Value of.
6. In the Parcel dialog box, double-click Parc_area.
The SQL Select Statement updates to the following, indicating
the query is complete:
SELECT MAX(parc_area)
FROM Parcel
7. Click the Execute button to review the results based on this query.
If Output > Forms is turned on with Dataset Mode selected,
15–6 MicroStation Administrator Guide
Linking Database Rows to Elements
Building simple SELECT statements
the following form is generated.
If Output > Browser is turned on, the same results are displayed in
the Visual SQL Data Browser dialog box.
8. Click ClearSQL, Clear All to delete the table and the SQL query.
Aggregate functions (Max, Min, Count, Sum and Avg) operate only in
Cursor mode. Clicking Execute places the Query Builder in Cursor
mode. The Dataset Mode check box is off.
Joining tables
A relational database typically consists of data stored in many different tables.
Joining tables allows you to obtain information from more than one table at
one time and enables you to choose various data subsets of the joined tables.
In a join, the currently selected table is the Master Table and the table it is
joined to is the Lookup Table. The currently selected table name appears
after the FROM keyword in the SQL Select Statement text box.
A table join relationship can be established in the following way:
The join is defined in Visual SQL Query Builder dialog box. The table
currently selected is the Master Table, and the second table selected is the
Lookup Table. The join is completed visually by left clicking a field in the
Master Table, holding the left mouse button down, dragging and dropping to
the field in the Lookup Table. A join graphic, a line with two end nodes,
is generated showing the fields that have been joined.
MicroStation Administrator Guide 15–7
Linking Database Rows to Elements
Building simple SELECT statements
To delete the join, click one of the join graphic nodes, and press Delete.
Insert, Update, and Delete database operations are not supported for joined tables.
The Where tab page can be used to create compound Where clauses
with joined tables. For example:
To use the Visual SQL Query Builder to build the following
query: SELECT parcel_no,owner, house_num,str_name FROM
parcel WHERE parc_value >= 50000 AND parc_area >= 100,000
1. Click ClearSQL, Clear All to clear any existing tables.
2. In the Select tab page, click Tables or select menu option Tables > Open Table.
3. In the Select Table dialog box, double-click Parcel.
4. In the Select Tables dialog box, click Close.
5. In the Parcel dialog box, double-click the Parcel_no, owner,
15–8 MicroStation Administrator Guide
Linking Database Rows to Elements
Building simple SELECT statements
house_num, str_name fields.
The following displays in the SQL Select Statement text box:
SELECT parcel_no, owner, house_num, str_name
FROM parcel
6. Click the Where tab.
The Where tab page opens.
7. In the Available Fields list box, click the parc_value field.
The selected field appears in the Where Fields list box.
8. Click >= (greater than or equal to). In the Value text field,
type 50000 and press 〈Enter〉.
9. Click And to create the second WHERE clause.
AND displays in the Where Fields list box.
10. Click parc_area in the Available Fields list box, click >= (greater than or
MicroStation Administrator Guide 15–9
Linking Database Rows to Elements
Building simple SELECT statements
equal to), enter 100000 in the Value text field and press 〈Enter〉.
The entered operator and value display in the Where Fields list box.
11. Click Apply to add the clause in the Where Fields list box to
the SQL Select Statement text box.
The following displays in the SQL Select Statement text box:
SELECT parcel_no, owner, house_num ,str_name
FROM parcel
WHERE parc_value >= 50000 AND
parc_area >= 100000
The query in the SQL Select Statement text box is complete.
12. Click Execute.
If Output > Forms is turned on in the Visual SQL Query Builder dialog
box, clicking Execute generates a dialog form.
If Output > Browser is turned on in the Visual SQL Query Builder dialog box,
clicking Execute generates a list (containing the same information as in the
15–10 MicroStation Administrator Guide
Linking Database Rows to Elements
Building simple SELECT statements
dialog form) which is displayed in the Visual SQL Data Browser dialog box.
The Visual SQL Data Browser only displays the data. Make edits
to the database in the Forms mode
To edit any of the Where clauses, click the clause in the Where Fields list box.
Dynamically change the field, operator, value and AND/OR clause members
as you would normally do when building an SQL statement. Clicking Apply
conforms the SQL Select Statement to your changes in the Where Fields
dialog box. You can also delete the clause by clicking Clear.
If your selection in Available Fields is a character type, your entry in the Value
text field (for example, 100) is displayed with single quotes around it in the Value
column of the Where Fields list box (is displayed as ‘100’, for example).
Common Operators do not work with character fields.
To use the Visual SQL Query Builder to build the following
query: SELECT owner, parc_area, AVG(parcel_value)
FROM parcel GROUP BY owner, parc_area HAVING
parc_area > 100,000 ORDER BY parc_area
1. Click ClearSQL, Clear All to clear any existing tables.
2. In the Select tab page, click Tables or from the Tables menu
MicroStation Administrator Guide 15–11
Linking Database Rows to Elements
Building simple SELECT statements
choose Open Table.
3. In the Select Table dialog box, double-click Parcel.
4. In the Select Table dialog box, click Close.
5. In the Parcel dialog box, double-click the Owner and Parc_area fields.
The following is in the SQL Select Statement text box:
SELECT owner, parcel_area
FROM parcel
6. Click the Functions option button and choose Average Value of.
7. In Parcel, double-click parc_value.
The following text is in the SQL Select Statement text box:
SELECT owner, parc_area, AVG(parc_value)
FROM parcel
GROUP BY owner, parc_area
8. To edit the GROUPBY clause, click the GroupBy tab page.
The GroupBy tab page opens.
15–12 MicroStation Administrator Guide
Linking Database Rows to Elements
Building simple SELECT statements
9. In the GroupBy Fields list box, click parc_area. Click the > (greater than)
Common Operator, enter 100000 in the Value text field, and press 〈Enter〉.
10. Click Apply to generate the following statement:
SELECT owner, parc_area, AVG(parc_value)
FROM parcel
GROUP BY owner, parc_area, HAVING parc_area > 100000
11. To add the OrderBy clause, click the OrderBy tab page.
The OrderBy tab page opens.
MicroStation Administrator Guide 15–13
Linking Database Rows to Elements
Creating linkages using the Visual SQL Query Builder
12. In the Available Fields list box, click parc_area.
The selected field appears in the OrderBy Field text box.
13. Click Apply to add a OrderBy clause to the SQL Select Statement text box.
The query in the SQL Select Statement text box is complete:
SELECT owner, parc_area, avg (parc_value),
FROM parcel
GROUP BY owner, parc_area having parc_area > 100000
ORDER BY parc_area
14. Click Execute to display the results of the query in either a dialog form (Output
> Form) or in the Visual SQL Data Browser dialog box (Output > Browser).
Creating linkages using the Visual SQL Query Builder
Before creating linkages, it is important to be aware of the Linkage Mode setting.
Linkage Mode is set in the Database dialog box (Settings > Database > Dialog).
Usually New or Duplicate modes are used. New mode means that the data in
the database will be duplicated, and a unique row will be linked to the graphic
element. Duplicate means that the data in the database will be linked to the
graphic element, but neither a new row nor an mslink will be created.
15–14 MicroStation Administrator Guide
Linking Database Rows to Elements
Creating linkages using the Visual SQL Query Builder
To link a database row to a graphic element
1. In the Visual SQL Query Builder dialog box, click Tables.
The Tables dialog box opens.
2. Select the database table that contains the row to which you want to link.
3. Click the * button to select all columns.
4. Click Execute.
A form dialog box opens. This dialog box will have fields for each column
in the selected table. The table name is in the dialog box’s title bar. The
title bar identifies the selected table. Here is an example:
MicroStation Administrator Guide 15–15
Linking Database Rows to Elements
Creating linkages using the Visual SQL Query Builder
5. Click Clear.
6. In a field, key in a known value for one of the columns.
7. Click Query.
The fields populate with the remaining column values of the row
that contains the value you keyed in.
8. Click Attach.
9. Identify the graphic element to link.
10. Accept.
The message “Linkage attached” is displayed in the status bar.
To confirm a newly created linkage:
1. In the Visual SQL Query Builder dialog box, click Clear.
2. Click Review.
3. Identify the graphic element to which you linked the database row.
4 . Accept.
The form dialog box fields are populated with the column
values of the linked row.
If after executing a query (step 4 above), the form dialog box opens but does not
contain Attach, Delete, Locate, or Review buttons, perform these steps:
1. Close the form dialog box.
2. In the Visual SQL Query Builder dialog box, choose Settings > Forms
3. Turn on the check boxes in the Standard Form Items dialog box.
4 . Re-execute the query.
15–16 MicroStation Administrator Guide
Linking Database Rows to Elements
Reviewing database attributes
Reviewing database attributes
Clicking the Review button from the created form allows you to view a database
row linked to an element that you identify on the screen. Alternatively, if a
form is not created, keying in VSQL REVIEW, then identifying an element
with a database linkage, automatically generates a form for you.
The database row displays in a form dialog. The form buttons (Insert,
Update, Delete, etc.) displayed on the form dialog are those chosen from
the Standard Form Items dialog box (Settings > Forms).
Database form dialogs
MicroStation VSQL supports database operations including query, update,
review, and geolocate using dynamically definable database dialog forms.
These forms are generated using the Visual SQL Query Builder. Database
form dialog controls allow users to create, edit and save database forms after
first interactively defining form contents and dialog controls.
Database forms support row navigation operations, including find first
row, last row, next row, previous row, and row count. Database update and
query operations include query execute, row insert, row update, and row
delete. Database forms support integrated database and graphics operations
including database review, and locate. The form may also be used to
attach and detach linkages from graphical elements.
After generating the form, the user can customize the organization of the form and
associated controls using the visual editing tools in the Visual SQL Query Builder.
Individual dialog controls can optionally be set to read-only in the case that forms
are intended to support query operations only. (This is accomplished by selecting
Forms from the Settings menu, and turning off Insert Row Button, Delete Row
Button and Update Row Button.) Once a form has been created it can be used to
query and review database attributes using “query by example” functions that
allow users to enter values and operators (“>”, “<”) directly into form fields.
Only the columns selected in the <TABLENAME> dialog box appear in the
results section of a database dialog form. Instead of getting all rows in a table,
the form dialog provides only the fields needed by the user. This ability to
customize data display and editing enhances user productivity by reducing the
MicroStation Administrator Guide 15–17
Linking Database Rows to Elements
Database form dialogs
quantity of data to a manageable scale. The control of database resources in this
way enables the transformation of raw data into useful information.
You can minimize or dismiss the Visual SQL Query Builder after executing
a query, leaving the form dialog active.
The following procedure assumes that your form dialog contains all possible items.
To create a new form dialog containing all items
1. Choose Settings > Forms.
2. In the Standard Form Items dialog box, turn all items on, and click OK.
3. Create a new form as described in this chapter. For example, see
“Building Simple SELECT Statements” on page 15-3.
15–18 MicroStation Administrator Guide
Linking Database Rows to Elements
Database form dialogs
The Query text field is present because Query Multiline was turned
on in the Standard Form Items dialog box.
To perform a review from a form dialog
1. In the form dialog, click Review.
2. Identify an element that has database attributes from the same
table as the open form dialog.
3. Accept the element.
If the element that you select does not contain a linkage to a row in the
currently selected table, no information will appear in the form dialog.
In addition, the message, “The element does not satisfy the database
criteria,” will display in the status bar.
Locating linked elements
The locate functionality allows you to locate a graphic element if it is exists in
the active DGN file and is linked to the specific record that displays in the
VSQL form. This functionality can be enhanced by adding a column called
MAPID (integer) to the ATTRIBUTE table and adding a table called MAPS to
the database. This allows you to locate graphic elements linked to the current
database row that reside in different design files. The DGN file that the graphics
are linked to is attached as a reference. Without this additional column and table,
the locate function will return “No elements linked to the current row” when the
Locate button is clicked. The MAPS table can be created as follows:
1. Create table maps (mslink integer, mapname char(30))
2 . In the MAPS table, you must add a entry for every DGN file containing
linked graphics and assign that map an mslink number.
MicroStation Administrator Guide 15–19
Linking Database Rows to Elements
Database form dialogs
In the ATTRIBUTE table, you must create a numeric column called
mapid. The mapid column in the attribute table must contain the mslink
number assigned to the map in the maps table.
To display the design element linked to one of the records
resulting from the SELECT statement: SELECT * FROM parcel
1. Open either "cd9.dgn" or "cd10.dgn" (located by default in
“Bentley\Workspace\Projects\Examples\Mapping\dgn”).
These design files have linkages to GIS database tables.
2. Build the Select statement using the Visual SQL Query Builder. (See
“Building Simple SELECT Statements” on page 15-3.)
3. Turn on Output > Form.
4. Click Execute to create the form dialog.
5. In the form dialog, click Next to step through the list of query responses
until you find a particular parcel in which you are interested.
6. Click Locate to display the element corresponding to the
displayed query result.
You are prompted to select a view in which to locate the parcel element.
7. Select the view in which you want the parcel element displayed.
If the parcel record selected corresponds to a parcel in an open
map, the parcel element displays centered in the selected view,
with its number circled and highlighted.
15–20 MicroStation Administrator Guide
Linking Database Rows to Elements
Database form dialogs
If the parcel record selected is not linked to a graphic element in
the active DGN file, the following message is displayed: “No
element linked to current row.”
In SQL, in this context, * means ‘all columns’ or ‘all attributes’.
Opening, editing and saving form dialogs
To save or to further customize the form generated
from the Visual SQL Query Builder
1. From the Visual SQL Query Builder’s Forms menu, select Save As.
2. Into the Save Form dialog box (a standard file selection dialog
box, having its search filter preset to .rsc), select a directory and
type a filename for the form to be saved.
3. Click OK to save the open form dialog.
To save a form dialog, its SQL query must be in the Visual SQL Query
Builder dialog box’s SQL Select Statement text box.
To open a saved form
1. From the Forms menu, choose Open.
2. In the Open Form dialog box, select a directory, and select
a form filename to open.
3. Click OK.
Alternative method — To open a saved form using a key-in
1. Key in: VSQL FORMS OPEN <form_name>
This assumes that the form has been saved in the default directory or the directory
set in the configuration variable MS_DBDIALOGRSC. If the form has been
MicroStation Administrator Guide 15–21
Linking Database Rows to Elements
Database form dialogs
saved in another directory, the full path to the form must be provided in the key-in.
To resize a form dialog item on the form
1. From Visual SQL Query Builder’s Form menu, choose Edit.
The Edit Form dialog box opens.
2. Select the file of the form dialog you want to modify, and click OK.
The Builder dialog box, Builder’s Tools tool box, and the form dialog open.
3. On the form dialog, click the control to resize.
Handles appear at the corners of the button.
4. Drag and drop an edge of the button.
The button is resized.
5. Click anywhere inside the form dialog.
The handles disappear.
This procedure assumes you have saved the form dialog you want to modify.
To resize a form dialog item using the Builder dialog box
1. From Visual SQL Query Builder’s Form menu, choose Edit.
The Edit Form dialog box opens.
2. Select the file of the form dialog you want to modify, and click OK.
The Builder dialog box, Builder’s Tools tool box, and the form dialog open.
3. In the Builder dialog box, in the bottom list box, in the Label column
select the label of the control to resize.
In the form dialog, handles appear at the corners of the push-button.
4. In the text boxes under the list box you are working with, change the X
and Y values if you want to change the position of the button, change
Wdth if you want to change the width of the push-button, or change
Hght if you want to change the height of the push-button. After each
15–22 MicroStation Administrator Guide
Linking Database Rows to Elements
Database form dialogs
text box change, click 〈Enter〉 to apply the change.
The button is resized.
5. Click anywhere inside the form dialog.
The handles disappear.
This procedure assumes you have saved the form dialog you want to modify.
To interchange the positions of controls on a form dialog
1. From Visual SQL Query Builder’s Form menu, choose Edit.
The Edit Form dialog box opens.
2. Select the file of the form dialog you want to modify, and click OK.
The Builder dialog box, Builder’s Tools tool box, and the form dialog open.
3. In the form dialog, drag and drop the two buttons in order to
interchange their location.
4. In the form dialog, click the window menu button to dismiss the form dialog.
An Alert box opens asking you whether you want to save your changes.
5. Click Yes to save your changes, click No to discard your changes,
and click Cancel to dismiss the Alert box.
This procedure assumes you have saved the form dialog you want to modify.
To add an item to a form dialog
1. Click a button on the Builder’s Tools tool box.
2. Click the Form dialog to place the new item.
To delete an item from a form dialog
1. Click an item in the Form dialog.
2. In the Builder dialog box, select the menu option Edit > Delete.
MicroStation Administrator Guide 15–23
Linking Database Rows to Elements
Using SQL
Using SQL
SQL statements can be used to interactively query a database
directly from within MicroStation.
All SQL statements recognized by the database software are supported, including:
SELECT Query database tables.
UPDATE Edit rows in a table.
DELETE Delete rows.
INSERT Add new rows.
CREATE Define a new table and add
TABLE it to the database.
DROP TABLE Delete an existing table.
SQL statement syntax is covered in “SQL statements” on page 15-25.
Opening and saving query statements
To open and save query statements, proceed as follows:
To open a query statement
1. From the Queries menu, select Open.
2. Select a file with a .sql extension.
3. Click OK.
15–24 MicroStation Administrator Guide
Linking Database Rows to Elements
SQL statements
To save a query statement
1. From the Queries menu, select Save As.
2. Type in a filename.
3. Click OK.
This assumes a SQL statement is present in the SQL Select Statement
section of the Visual SQL Query Builder dialog box.
SQL statements
The following sections contain descriptions of some of the more powerful
SQL statements that are supported by the database interface.
Literal expressions used in assignments and comparisons can be of character,
numeric or date format. Character strings are single quote delimited.
In general, dates can be queried as follows:
• For ODBC — SELECT * FROM <table> where <date_field>
> #01/01/2000#
The date format through ODBC depends upon the setting of the MicroStation
configuration variable MS_DBODBCDATEFORMAT. It is set to
mm/dd/yyyy by default. The variable is stored in the "odbc.cfg" file
located in the “Program\MicroStation\config\database\”.
• For Oracle (direct connection) — SELECT* FROM <table>
where <date_field> > ’21-DEC-00’
The date format in Oracle is dependent upon the NSL_DATE_FORMAT
setting. You must use the following statement keyed in through the
SQL Window or the SQL statement portion of VSQL to alter the format
(substitute the format you require for mm/dd/yyyy):
alter session set nls_date_format = ’mm/dd/yyyy’
It is recommended that you use VSQL to create the SQL for the query as
it will assist you in properly delimiting the date field.
MicroStation Administrator Guide 15–25
Linking Database Rows to Elements
SQL statements
SELECT
SELECT 〈* | <column_name_list〉 FROM table WHERE <condition_list>
Used to query the database. Condition_list can contain any number of
comparisons separated by AND or OR operators. The comparisons need
not be equivalences (that is, <, >, <=, etc. are valid).
UPDATE
UPDATE <table> SET <assignment-list>
Used to edit column values.
DELETE
DELETE FROM <table> [WHERE <condition_list>]
Used to delete rows.
INSERT
INSERT INTO table <column_name_list> VALUES <expression_list>
Used to insert rows into a database table. If column_name_list is omitted,
there must be an expression for each column in the table and it must be listed
in the order in which the columns were added to the table.
15–26 MicroStation Administrator Guide
Linking Database Rows to Elements
SQL statements
CREATE TABLE
CREATE TABLE table <column_name_type_list>
Used to create a table. Column_name_type_list is a comma-delimited list of
expressions of the form: <<column_name> <column_type>>. For example:
CREATE TABLE mytable (myname char(10), age integer)
creates a table with a myname column of 10 characters and an integer age column.
Data types can be any ANSI SQL data type. Refer to any SQL reference for a list.
DROP
DROP TABLE table
Used to drop a table from the data dictionary and to physically
delete associated data and index files.
COMMIT
Used to explicitly request MicroStation to commit statements to the database
software for processing. See SESSION AUTOCOMMIT [OFF|ON] .
ROLLBACK
Used to undo all statements to the last commit point. See SESSION
AUTOCOMMIT [OFF|ON] .
MicroStation Administrator Guide 15–27
Linking Database Rows to Elements
Specific SQL Window key-ins
Specific SQL Window key-ins
The following section contain descriptions of MicroStation-specific
SQL Window key-ins.
CONNECT
Used to connect to a database. Either key in DB= or use Settings > Database
> Setup as described in Database Setup dialog box.
DISCONNECT
Used to disconnect from a database.
RELOAD
Used to force MicroStation to reread mscatalog and update the copy of the table
it maintains internally. (Changes to mscatalog resulting from SQL statements
typed and submitted by the user in the SQL Window are not automatically
reflected in MicroStation’s internal copy of the table.)
Using the SQL Window
The SQL Window is used to submit SQL statements and to review the results.
It requires knowledge of accurate SQL statement syntax.
If you do not know SQL statement syntax, use the Visual SQL
Query Builder (see page 15-1).
15–28 MicroStation Administrator Guide
Linking Database Rows to Elements
Using the SQL Window
To open the SQL Window
1. Key in SQL in the Key-in window (Utilities > Key-in).
The SQL Window has a large section at the top for reviewing SQL queries
and a smaller field at the bottom for submitting SQL statements.
The user can also enter SQL commands preceded by the pipe symbol
“|” in the MicroStation key-in window.
To submit a SQL statement
1. In the SQL Window, type the SQL statement. The statement can
be typed as a continuous string with automatic word wrap or you
can press 〈Enter〉 at the end of each line.
Literal expressions used in assignments and comparisons can be of character
(char), numeric (number). Character strings are single quote delimited.
2. Click the Submit button.
Retrieved database information is presented one row at a time. You can
use the scroll bar if the data exceeds the window size.
3. (Optional) — To advance between retrieved rows, click the Next button.
MicroStation Administrator Guide 15–29
Linking Database Rows to Elements
Command files
Command files
If you submit a particular SQL statement frequently, you can save it in a command
file for easier submission. A command file is simply a text file into which a SQL
statement has been placed. While the file can contain only one statement, the
statement can be continued on multiple lines. The default file extension is “.sql.”
Some database interface key-ins require SQL statements, such as (AE=). Unlike
actual SQL statements, these key-ins cannot be submitted in the SQL Window;
they must be keyed in the Key-in Window. Like all MicroStation key-ins, these
key-ins can also be activated from a script file with the key-in @<script_file>.
(The file extension cannot be omitted.) See Key-in Scripts (see page 10-1).
To create a command file
1. In the SQL Window, type the SQL statement you want to save.
2. From the SQL Window’s File menu, choose Save As.
The Save SQL Command File dialog box opens.
3. In the Name field, key in the desired filename.
4. Set the destination Directory as desired.
5. Click the OK button.
To submit a SQL statement stored in a command file
1. From the SQL Window’s File menu, choose Open.
The Open SQL Command File dialog box opens.
2. Select the file that contains the desired statement.
3. Click OK.
4. When the statement is displayed in the SQL Window, click
Submit to execute the query.
15–30 MicroStation Administrator Guide
Linking Database Rows to Elements
Manually committing SQL statements
Alternative method — To submit a SQL statement
stored in a command file
1. In the SQL Window, submit @<file_name>, where file_name is
a text file containing the SQL statement.
The “.sql” file extension is the default.
Manually committing SQL statements
SQL statements are generated by MicroStation each time you use certain
database tools and key-ins. For example, MicroStation generates a SQL
INSERT statement when you use the Attach Active Entity tool with Linkage
Mode set to New (see “Setting Linkage Mode” on page 15-43).
By default, MicroStation immediately commits SQL statements to the database
software. In an alternate mode, MicroStation commits statements only when
your input necessitates the addition of a row to a database table. The process
of adding rows requires the database software to lock tables, and commitment
is required to release those locks. The alternate mode can be useful when it
is desirable to be able to undo uncommitted SQL statements.
To activate the mode in which MicroStation does not
automatically commit SQL statements
1. In the Key-in window, key in: SESSION AUTOCOMMIT OFF
To explicitly request MicroStation to commit statements
when AUTOCOMMIT is set to OFF
1. In the SQL Window, submit: COMMIT
MicroStation Administrator Guide 15–31
Linking Database Rows to Elements
Creating Tables
To undo (negate) the effect of all statements to
the last commit point
1. In the SQL Window, submit: ROLLBACK
To reactivate the default mode
1. In the Key-in window, key in: SESSION AUTOCOMMIT ON
You must type COMMIT before exiting MicroStation when the AUTOCOMMIT
mode is set to OFF. Otherwise uncommitted transactions will be discarded.
Creating Tables
Creating a table is as simple as submitting a standard SQL
CREATE TABLE command.
To create a table
1. In the SQL Window, submit a statement in the following
form: CREATE TABLE table_name(Column_name_1
Column_spec_1,Column_name_2 Column_spec_2,…)
Column specifications can be any type supported by SQL, including
char, numeric, and date.
The only requirement to enable a row to be linked to an element is that one
of the columns in the table be named MSLINK and the table has an entry
(tablename and entity number) in the MSCATALOG.
For example, suppose in the utility map example on which the lesson at the
beginning of this chapter is based, you must create a new table for the purpose of
assessing real estate taxes. You might submit the following CREATE TABLE
statement: CREATE TABLE ASSESSOR(CLT_NO CHAR(30), AS_VAL
15–32 MicroStation Administrator Guide
Linking Database Rows to Elements
Creating Tables
NUMBER(10),TAX_RATE NUMBER(10,4),MSLINK NUMBER(10))
The resulting table would be created (sample data is shown): Note the common
column, clt_no, between the new table and the already existing parcel table.
assessor
clt_no as_val tax_rate mslink
119-LA 9 180,000 0.0500 37
119-LB 36 144,000 0.0500 38
119-LB 35 180,000 0.0500 39
parcel
mslink clt_no house_ name parc_valuearea
num-
ber
1 119-LA 9 220 BRIDGEWATER RD 9000 16,036
14 119-LB 36 8717 KILDARE DR 7200 16,668
15 119-LB 35 8713 KILDARE DR 9000 16,306
To add a table to the MSCATALOG
1. Select Database > Setup from the Settings menu.
The MSCATALOG dialog box displays.
2. In the MSCATALOG dialog’s Tables menu, select Add to MSCATALOG.
The Add to MSCATALOG dialog box opens.
3. Select the new table from the Tables list box.
4. Assign a unique number between 1–65535 in the Entity Number field.
5. Click the OK button.
MicroStation Administrator Guide 15–33
Linking Database Rows to Elements
mslink column
mslink column
The MSLINK column serves as a primary key for the table. This means that any
row can be uniquely specified solely by its MSLINK column value.
Key index
When a SELECT, UPDATE, or DELETE statement is submitted, the specified
table is searched. Indexes are used whenever available to speed the search. An
index is a linked list that contains only the column of interest and its row number
in the table. Indexes are optional, but they greatly improve performance. Any
column in a table can have its own index. Of course each index takes disk space,
so you need to make a trade-off between files size and performance.
As the MSLINK column is the primary key for a table, it makes sense to
create an MSLINK index. You must create this index using your database
program. Bentley recommends you create this index as a unique index and
do not allow NULLS in the MSLINK column.
MSCATALOG Table
Before you delve too far into creating tables, you need to have a good
understanding of the MSCATALOG table. It is the master table that tells
MicroStation information about the database tables available for links to
graphic elements. It is opened every time you connect to a database and
contains a row for each table that may be linked to the design. There is
only one MSCATALOG table for each database.
Any table in a database that will be linked to graphic elements in a DGN
file must have a corresponding row in MSCATALOG. However, through SQL
statements, any table in the database can be accessed from MicroStation even
if it does not have a corresponding row in MSCATALOG.
mscatalog structure
The MSCATALOG table has the following structure:
15–34 MicroStation Administrator Guide
Linking Database Rows to Elements
mscatalog structure
Column Type(width) Description
TABLENAME char(32) table name
ENTITYNUM number(10) unique entity or table
number
SCREENFORM char(64) screen form name
REPORTTABLE char(64) report table name
SQLREVIEW char(240) default SQL review
request
FENCEFILTER char(240) default SQL fence filter
DASTABLE char(32) displayable attributes
table name
FORMTABLE char(64) table used to locate screen
form (optional)
tablename column
The TABLENAME column in the MSCATALOG table contains the names of
the tables in the database that are to be linked to elements. The table names
must be added to the TABLENAME column before linkages to elements are
made. This is a required entry in the MSCATALOG table.
entitynum column
The ENTITYNUM column in the MSCATALOG row for a particular table
contains the entity number of the table. The entity number is a positive
integer from 1 to 65535 that uniquely identifies the table to the database;
each table used with a design must have a unique entity number. This is
a required entry in the.MSCATALOG.table.
screenform column
The SCREENFORM column in the MSCATALOG row for a particular table
MicroStation Administrator Guide 15–35
Linking Database Rows to Elements
mscatalog structure
specifies the default screen form, used in conjunction with the VSQL Review
key-in (VSQL REVIEW) if you are using VSQL, to review the database
attributes of elements linked to rows in the table. If the optional formtable
column exists in MSCATALOG, that column is examined to attempt to locate
a saved VSQL form to be used instead of the default screen form. The
SCREENFORM column will be used for both review and editing if FORMTABLE
is empty. This is an optional entry in the MSCATALOG table.
reporttable column
The REPORTTABLE column in the MSCATALOG row for a particular table
contains the name of the report table that can be created with the Generate Report
Table tool to report on the database attributes of elements linked to rows in the
table. This column is ordinarily loaded with the key-in ACTIVE REPORT (RS =)
but can be entered manually. This is an optional entry in the MSCATALOG table.
sqlreview column
The SQLREVIEW column in the MSCATALOG row for a particular table
contains the SQL SELECT statement that is submitted with the Review
Database Attributes of Element tool to review database attributes of elements
linked to rows in the table. If this SQL statement is entered incorrectly or
the column entry contains blank spaces, the SQL Review window is blank
when the database linkages are reviewed. When this field is left empty, the
default SQL statement: Select * From <tablename> is executed. This column
is ordinarily loaded with the key-in ACTIVE REVIEW (RA=) but may be
entered manually. This is an optional entry in the MSCATALOG table.
fencefilter column
The FENCEFILTER column in the MSCATALOG row for a particular table
contains the SQL SELECT statement that determines which elements linked
to rows in the table are selected for fence operations. This column must
be loaded with the key-in DEFINE SEARCH (DS=) to function properly.
This is an optional entry in the MSCATALOG table.
15–36 MicroStation Administrator Guide
Linking Database Rows to Elements
Creating and maintaining MSCATALOG
dastable column
The DASTABLE column in the MSCATALOG row for a particular table,
specifies the displayable attributes table that is used. Displayable attributes post
information from the database to text nodes placed in the DGN file.
Each row in a displayable attributes table (see the following table) specifies
a displayable attribute type number and definition.
Column Type(width) NULLs
dastype number(3) no
sqldas char(240) yes
The sqldas column specifies a SQL SELECT statement that selects
the attributes for display.
For more information about displayable attribute text nodes, see
Displaying Database Attributes in the Design (see page 16-3). This is
an optional entry in the MSCATALOG table.
Creating and maintaining MSCATALOG
The MSCATALOG dialog box (Settings > Database > Setup) is used
to create and maintain the MSCATALOG table.
To create the MSCATALOG table
1. From the Settings menu’s Database submenu, choose Setup.
An alert box opens to ask if you would like to create MSCATALOG
if none exists in the current database.
2. Click the Yes button.
MSCATALOG is created, and the MSCATALOG dialog box opens.
MicroStation Administrator Guide 15–37
Linking Database Rows to Elements
Creating and maintaining MSCATALOG
To create an attribute table in the database
1. From the Settings menu’s Database submenu, choose Setup.
The MSCATALOG dialog box opens.
2. From the dialog box’s Table menu, choose Create.
The Create Table dialog box opens.
3. In the Table Name field, key in the name of the table.
4. Click the Insert button.
The Insert Column dialog box opens.
5. In the Column field, key in the name of the first column.
6. From the Type option menu, choose the column’s data type —
Character, Integer, Real, or Date.
7. If Type is Character, key in the field width (number of
characters) in the Width field.
or
If the type is integer, key in the total number in the Width field.
or
Otherwise, skip to step 8.
If Type is Real, key in the total number of digits in the Width field and the
number of digits after the decimal point in the Decimal field.
8. Click the OK button to return to the Create Table dialog box.
9. For each additional column, repeat steps 4-8. (To edit or delete a previously
defined column, use the Edit and Delete buttons.)
10. Click the OK button.
Alternatively, table creation can be accomplished through the database software.
15–38 MicroStation Administrator Guide
Linking Database Rows to Elements
Creating and maintaining MSCATALOG
To add a table to the MSCATALOG table
1. From the Settings menu’s Database submenu, choose Setup.
The MSCATALOG dialog box opens.
2. From the dialog box’s Table menu, choose Add to MSCATALOG.
The Add Table to MSCATALOG dialog box opens.
3. From the Table Name option menu, choose the table to add. This will
become the TABLENAME value in the MSCATALOG row for the table.
4. In the Entity Number field, key in a unique entity number for the table. This
will become the ENTITYNUM value in the MSCATALOG row for the table.
5. Click the OK button.
Alternatively, update MSCATALOG through the database software.
To delete a table from the MSCATALOG table
1. From the Settings menu’s Database submenu, choose Setup.
The Database Setup dialog box opens.
2. In the Tables list box, select the table to delete.
3. From the dialog box’s Table menu, choose Delete from MSCATALOG.
To drop a table from the database
1. From the Settings menu’s Database submenu, choose Setup.
The Database Setup dialog box opens.
2. From the dialog box’s Table menu, choose Drop.
The Drop Table dialog box opens.
3. From the Table Name option menu, choose the table to drop.
4. Click the OK button.
MicroStation Administrator Guide 15–39
Linking Database Rows to Elements
Database Tools
Database Tools
The tool box is operated in the same manner as tool boxes that contain
MicroStation’s drawing tools. These database tools operate independently
from the Visual SQL Query Builder.
To open the Database tool box
1. From the Tools menu, choose Database.
Creating Linkages
Use the Attach Active Entity tool in the Database tool box to create linkages
from elements in the design to rows in the database.
This is an alternative way to create database linkages that requires
knowledge of SQL statements. It is recommended that you use the Visual
SQL Query Builder (see page 15-14) instead.
To create a Linkage(s)
1. Define the Active Entity (see “Defining the Active Entity”).
15–40 MicroStation Administrator Guide
Linking Database Rows to Elements
Defining the Active Entity
2. In the Database dialog box, set Linkage Mode (see “Setting Linkage
Mode” on page 15-43). Use the Attach Active Entity tool to attach an
element(s) to the row designated as the Active Entity.
Defining the Active Entity
The row that is designated as the target row to be attached to an element when
a linkage is created is called the Active Entity.
It becomes the only row in a special table named AE. The Active Entity
can be thought of as a temporary holding place for data multiplication.
It can be created several different ways:
• It can be defined graphically with the Define Active Entity Graphically tool.
• It can be created directly with the ACTIVE ENTITY (AE=) key-in.
• It can be located and copied from a seed row in the existing
table with the FIND (FI=) key-in.
To define the Active Entity graphically by using
the database tool
1. Select the Define Active Entity Graphically tool.
2. Select an element that is already linked to the database.
To directly define the Active Entity by key-in
1. In the Key-in window, key in: AE=INSERT INTO
<table_name>(<column_1>, <column_2>,…)VALUES
MicroStation Administrator Guide 15–41
Linking Database Rows to Elements
Defining the Active Entity
(<value_1>,<value_2>…)
or
ACTIVE ENTITY INSERT INTO <table_name>(<column_1>,
<column_2>,…)VALUES (<value_1>,<value_2>…)
Here you are creating the Active Entity, in the AE table, with the same
data structure as table_name. This active entity will create a new row in
the database table and is only valid in the new linkage mode.
To define an Active Entity from a seed row
1. In the Key-in window, key in: FI=SELECT * FROM <table_name>
WHERE <column_name>=’<value>’
or
FIND SELECT * FROM <table_name> WHERE
<column_name>=’<value>’
This key-in creates the active entity from an existing row in the attribute
table. Depending on the linkage mode (new or duplicate), the linkage will be
created the existing row, or a row will be added to the table.
The Show Active Entity tool is used to check the values in the Active Entity.
Editing the Active Entity
You can edit the Active Entity from within MicroStation before linking
it to an element using an SQL UPDATE statement.
Depending on Linkage Mode, which is set in the Database dialog box,
editing the Active Entity can change a row in the database. If Linkage Mode
is set to New, the Active Entity is a prototype record; editing the Active
Entity does not affect any rows. However, if Linkage Mode is not set to
New, editing the Active Entity changes the corresponding row. For more
information, see “Setting Linkage Mode” on page 15-43.
15–42 MicroStation Administrator Guide
Linking Database Rows to Elements
Setting Linkage Mode
To edit the Active Entity using an SQL UPDATE command
1. In the SQL Window, submit: UPDATE AE SET <column> =
<value>,<column> = <value>, …
For example, if you were working with the parcel table you might
submit: UPDATE AE SET house_num = ‘8716’,str_name
= ‘KILDARE DR’, value = 8000
Setting Linkage Mode
Linkage Mode, which is set in the Database dialog box, determines how
the Active Entity is treated when an element is linked to it. When Linkage
Mode is set to None, no linkages can be created.
New linkage mode
Use New linkage mode when you require a unique row for each linkage, such as
in the case of land parcels on a map. In New mode, the Active Entity is actually a
“prototype row” that does not need to represent an existing row in the table.
Each time a linkage is created in New mode, a copy of the Active Entity is
appended to the table as a new row. The element is then linked to the new row. If
you operate exclusively in New mode when establishing linkages, you can be sure
that each element you link has a corresponding unique row in the database.
Duplicate linkage mode
In Duplicate linkage mode, each designated element is linked to the same
row as long as that row remains the Active Entity. This is useful when it
is necessary only to associate elements with a generic “row type” rather
than to a particular occurrence of that row type.
For example, in a circuit board design, it may not be desirable for electrical
MicroStation Administrator Guide 15–43
Linking Database Rows to Elements
Attaching linkages to cell libraries
components like resistors and capacitors to be linked with unique rows.
Accurate part counts are still possible even if resistors of the same type
“share” rows using the MicroStation database reporting tools.
Information linkage mode
Information linkage mode is identical to Duplicate mode except that a
special bit is set in each linkage. This distinction is important to application
software that examines this bit when processing linkages. Information
linkages cannot be reported, and they do not cause table rows to be added
or deleted when the linked element is copied.
To set Linkage Mode
1. From the Settings menu, choose Database > Dialog.
The Database dialog box opens.
2. From the Linkage Mode option menu, choose the desired mode —
None, New, Information, or Duplicate.
Attaching linkages to cell libraries
Applications frequently need to associate database information with cells. The
Cell Link dialog box is used to link a cell library with an existing database
table by attaching database linkages to the library cells. This makes it possible
to place cells in the design with a database linkage already established.
15–44 MicroStation Administrator Guide
Querying and Maintaining
the Database
In this section you will find procedures concerning querying the
database, reviewing database attributes, detaching linkages, and
otherwise maintaining the database.
Reviewing Attributes
Reviewing the database attributes of elements is the cornerstone of the
database interface. You can graphically query the database to review
attributes using the Review Database Attributes of Element tool. The
attributes can be displayed for review in the SQL Window or in the Visual
SQL Query Builder dialog box (see page 15-1).
The SQL Window displays read-only database information when the Review
Database Attributes of Element tool is used to identify a graphic element.
The Visual SQL Query Builder form is generated and displays when
the VSQL REVIEW key-in is used to identify and accept an element.
These are editable database attributes.
Setting attribute review selection criteria
Attribute review selection criteria can be set and saved in the SQLREVIEW
column of the row in MSCATALOG for the desired table. The SQLREVIEW
value applies only to data retrieved for display in the SQL Window.
MicroStation Administrator Guide 16–1
Querying and Maintaining the Database
Setting attribute review selection criteria
To check the selection criteria for all tables (the SQLREVIEW
values for all tables listed in MSCATALOG)
1. In the Key-in window, key in: ACTIVE REVIEW $
or
RA=$
The SQLREVIEW value for the first table is displayed in the SQL Window.
2. Click the Next button to review the SQLREVIEW values for successive tables.
To change the selection criteria
1. In the Key-in window, key in: ACTIVE REVIEW
<SQL_SELECT_statement>
or
RA=<SQL_SELECT_statement>
For example, to review all columns in a table, key in: RA=SELECT
* FROM <table_name>
This is the default for any SQLREVIEW column with a NULL value.
To review specific columns, key in: RA=SELECT <column1>,<column2>,…
FROM <table_name>
Selection criteria can also be modified by directly submitting a SQL UPDATE
statement (through the SQL Window) or using the MSCATALOG dialog box.
Submitting a SQL UPDATE statement for this purpose can be confusing because
the statement must have a SQL SELECT statement embedded as a string.
Verify that the SQL statement is valid before updating the SQL review column.
No validation is done on this column, so if there is a mistake in the syntax, the
SQL review window will display with no information and no error message.
16–2 MicroStation Administrator Guide
Querying and Maintaining the Database
Displaying Database Attributes in the DGN File
Displaying Database Attributes in the DGN File
You can place a copy of some or all of an element’s database attributes as
text in the DGN file. The process of displaying attributes is really quite
simple: An empty text node is placed and then designated as a displayable
attribute text node. Selected attributes are loaded into the displayable attribute
text node based on an SQL SELECT statement. If the database information
changes or you change the columns selected by the SELECT statement,
you can update the design by simply reloading the text nodes.
Different types of displayable attribute text nodes can be defined to display
different combinations of attributes. The displayable attribute table specifies
the display format for each type of displayable attribute text node.
The SQL SELECT statement for the displayable attribute type defined
in the column determines the list of columns that are loaded. If no
SELECT statement is defined, SELECT * is used.
General Procedure — Displaying Attributes
1. If the desired display format is not yet specified as a displayable attribute
type, create a type. See “To create a displayable attribute” on page 16-4.
2. Use the Place Text Node tool to place text nodes as placeholders
for the attributes that will be displayed.
3. Use the Attach Displayable Attributes tool to designate the text nodes
as displayable attribute text nodes of the desired type. Be sure to
follow the prompts at the bottom of the screen.
The displayable attribute type is set in the Attach Displayable
Attributes settings window. Once a displayable attribute linkage is
attached, its type cannot be changed.
4. Use the Load Displayable Attributes tool to load the attributes for
MicroStation Administrator Guide 16–3
Querying and Maintaining the Database
Displaying Database Attributes in the DGN File
display in the displayable attribute text nodes. This may be used
with the Fence tool to update all text nodes.
5. If you change the displayable attribute select statement or the values of the
displayed attributes and you want to reflect the changes in the design,
reload the attributes using the Load Displayable Attributes tool.
To create a displayable attribute type
1. In the SQL Window, submit: INSERT INTO <displayable_at-
tribute_table> (dastype, sqldas) VALUES (<type_number>,
’<SQL_SELECT_statement>’)
The displayable attribute table contains two columns, dastype
(number), and sqldas (text).
Alternately, this record may be inserted through VSQL.
To modify a displayable attribute type
1. In the SQL Window, submit: UPDATE <displayable_attribute_table>
SET sqldas = ’<SQL_SELECT_statement>’ WHERE
dastype = <type_number>
Alternately, this can be updated through VSQL.
To change the appearance (as opposed to the arrangement) of attributes
in a displayable attribute text node, use the Text Styles dialog box (Element
menu > Text.Styles) and the Change Text Attributes tool.
16–4 MicroStation Administrator Guide
Querying and Maintaining the Database
Detaching Linkages
Detaching Linkages
The Detach Database Linkage tool is used to detach linkages from elements or
sets of elements using the Use Fence setting operation. Linkages of the type(s)
specified in the MS_LINKTYPE configuration variable definition are removed.
Linkages of other types and application user data are not disturbed. The Delete
Linked Database Rows setting in the Database dialog box determines whether the
row(s) that were attached to a particular element are deleted from the table.
Detaching linkages from cells
To detach linkages from a component element of a cell, you must first
drop the cell using a tool in the Drop tool box .
The Cell Link dialog box is used to link a cell library with an existing database
table by attaching database linkages to the library cells. You can also use the
dialog box to remove linkages from the library cells. For more information
about the Cell Link dialog box, see “Cell Link Utility”.
Verifying Linkages
When you delete an element that has an attached database linkage, MicroStation
automatically deletes the associated row from the database table if Delete Linked
Database Rows is on in the Database dialog box. However, the opposite is not
true. If you should delete data from the database without removing linkage
information from an element, you create what is called an orphan linkage. Orphan
linkages are linkages without associated rows in the database.
A quick visual check of elements that have a database linkage can be made by
using a fence filter, a query that determines which elements with linkages to rows
in a table are selected for fence operations. This procedure does not identify
orphan linkages, but it does show which elements do not have any attached
linkages. For example, if every desk in an office layout has a linkage, they will
MicroStation Administrator Guide 16–5
Querying and Maintaining the Database
Verifying Linkages
all highlight. Those that are missing a linkage will not highlight.
To visually check for database linkages
1. In the Key-in window, key in: DEFINE SEARCH SELECT
* FROM <table_name>
or
DS=SELECT * from <table_name>
This sets up a fence filter for all rows in the database that have an MSLINK
attachment. “Fence Filter: on” displays in the status bar window.
2. Use the Place Fence tool to fence the area of interest (or the entire design).
3. In the Key-in window, key in: MACRO HILITE.
All elements with database linkages will highlight.
16–6 MicroStation Administrator Guide
Generating Reports
No matter what your application for the database interface, at some point you
will need to generate reports to communicate information to others.
A report could be as simple as a parts list for a mechanical component or as
complex as a maintenance schedule for all equipment in a selected area of a large
facility that is still under warranty and requires shutdown time for repair.
Whatever the application, you will find that a major strength of the interface lies
in its ability to combine the power of the database query with graphical display
for analysis, manipulation and reports not otherwise possible.
In this section you will find procedures concerning generating reports
based on the database attributes of elements. In addition, you will find an
overview of the report formatting and output capabilities of the database
products to which MicroStation provides an interface.
Report Tables
Database report output from MicroStation can either be plots of a design
with report information highlighted or report tables.
The Generate Report Table tool is used to generate a report table for each
table that has rows attached to elements contained in the fence. A report
table contains a row for each row of a particular table attached to an element
MicroStation Administrator Guide 17–1
Generating Reports
Naming
contained in the fence. Formatting and printing report tables requires report
writer software that is available with the relational database package being
used (see “Report Formatting and Output” on page 17-5).
Since a row is written to the report table for each occurrence of a linked element,
the table gives an accurate count of linkages that were attached with Linkage
Mode set to Duplicate. Recall that Duplicate linkage mode lets the same row
be attached to multiple elements. Linkages that were attached with different
linkage modes can even be mixed in the same report table. Thus you may have
hundreds of identical items in a design, all with the same row attached, and still
generate a report table for inventory control or quantity-takeoffs.
Also note that linkages created with Linkage Mode set to
informational will not be reported.
To generate report tables
1. Make sure a report table name is specified in the MSCATALOG table for
each table that has rows attached to elements in the part of the design
you want to report on. See “Naming” on page 17-2.
2. (Optional) — To specify attribute-based criteria for reporting in addition
to the geographical criteria defined by the fence, define a fence filter(s)
(DS= ). See “Fence Filters” on page 17-3.
3. Place the fence so it contains the part of the design you want to
report on. Use the Place Fence tool.
4. Use the Generate Report Table tool.
The first three steps can be performed in any order.
Each time you generate report tables, any previously existing report
table with the same name is overwritten.
Naming
Before a report table can be generated, its name must be specified in
17–2 MicroStation Administrator Guide
Generating Reports
Fence Filters
the REPORTTABLE column of the MSCATALOG table. The name must
conform to SQL naming conventions. For example, no symbols or
spaces can be contained in the table name.
To check the report table names for all tables
listed in MSCATALOG
1. In the Command Window, key in: ACTIVE REPORT $
or
RS=$
The REPORTTABLE value for the first table is displayed in the SQL Window.
2. Click the Next button to review the REPORTTABLE values
for successive tables.
To change a report table name specification
1. In the Command Window, key in: ACTIVE REPORT
<table_name>:<report_table_name>
or
RS=<table_name>:<report_table_name>
For example, to name a report table parts_report for a table
PARTS, key in: RS=parts:parts_report
The MSCATALOG dialog box can also be used to view and change
a report table name specification. From the MicroStation command
line use the key-in SET DATABASE.
Fence Filters
Fence filters are used in conjunction with the Generate Report Table tool
and also to generate reports in the form of plotted designs. A fence filter
specifies non-graphical criteria used to select elements for fence operations.
Report tables generated using fence filters contain only rows for elements
contained in the fence that meet the specified criteria.
This has the added advantage of allowing you to graphically work
MicroStation Administrator Guide 17–3
Generating Reports
Fence Filters
with the selected elements.
The FENCEFILTER row in MSCATALOG contains fence filter specifications.
Each table listed in MSCATALOG can have a unique fence filter.
To discard previously defined fence filter specifications
and disable fence filter selection
1. In the Command Window, key in: DEFINE SEARCH none
or
DS=none
The FENCE FILTER values are cleared from each row in MSCATALOG.
To define a fence filter and enable fence filter selection
1. In the Command Window, key in: DEFINE SEARCH
<SQL_SELECT_statement>
or
DS=<SQL_SELECT_statement>
The specified SELECT statement is stored in the FENCE FILTER
column of the row for the specified table in MSCATALOG.
Updating the fence filter row in MSCATALOG manually with a SQL statement
works, but it is strongly discouraged. The DEFINE SEARCH or DS= commands
both modify this column, but they also turn on or off the filtering operation.
You can use the sample macro, “hilite.bas,” to highlight each element contained in
the fence that meets the filter criteria. Then you can use the Change Element
Attributes tool, with Use Fence on, to change the level, color, line style, or line
weight of the highlighted elements. These changes can be reflected in a plot to
dramatize an analysis. (To execute the macro, key in MACRO HILITE.)
17–4 MicroStation Administrator Guide
Generating Reports
Report Formatting and Output
Report Formatting and Output
A report table generated from within MicroStation can be formatted for
output as a report using a database report writing program. Following is
a brief discussion of the report writing programs available for the database
products to which MicroStation offers interfaces.
Oracle
Oracle supports report writing both from within the standard SQL*Plus
interface and with other sophisticated report writing packages. SQL*Plus
supports most report writing functions. It allows you to control column
layout, page size, add headers and footers, and control breaks for subtotals.
You can also join tables and create summary reports.
Microsoft Access
Microsoft Access contains reporting tools that allow for highly customized
results. Wizards provide guidance for control of data and creation of graphical
charts in the standard Microsoft Access package.
MicroStation Administrator Guide 17–5
17–6 MicroStation Administrator Guide
Database Application Software
MicroStation Development Language (MDL) applications can be used to extend
the database interface and adapt it for more specific uses. Like MDL applications
that extend MicroStation functionality outside the database interface, MDL
database applications can be acquired “off the shelf” from software publishers
or they can be developed using MicroStation programming tools.
In this chapter you will find some examples of types of commercially
available MDL database applications.
Existing Database Application Software
Following is a list that represents typical areas that commercial MDL
database applications extend the database interface:
• Architectural applications for automatically generating quantity takeoffs,
schedules, project file listings, and area takeoffs.
• Applications for associating spatial and other attributes to plotted
coordinate geometry data in site plans.
• Applications for visualizing work space utilization.
• Applications for converting geographic data between coordinate systems.
• Applications that allow direct modification of database rows
using dialog boxes.
• Mechanical design applications for automatically generating parts lists
and position numbers and extracting details from drawings.
For general information about acquiring and using MDL applications,
see “MDL Applications” on page 11-1.
MicroStation Administrator Guide 18–1
Database Application Software
Developing MDL Database Applications
Developing MDL Database Applications
MDL (MicroStation Development Language) is the primary programming
interface for developing applications for MicroStation. Closely resembling
ANSI-standard C, the MDL languages is a dialect of the C programming
language. MDL allows developers access to all MicroStation graphic and
database interface functions, as well as complete control over the graphical
user interface using menus and dialog boxes.
Although the fundamentals of MDL programming are beyond the scope of
this guide, the sample application, “gis.ma,” should give you an appreciation
of the potential of MDL for developing custom database applications. For
general information about MDL and developing MDL applications, see “The
MDL Alternative” in the MicroStation BASIC Guide.
18–2 MicroStation Administrator Guide
Part VI: Design History
Recording and Browsing
Design History
The capability to track changes to models and restore a model, if desired, to a
prior state can be quite useful in managing the design process. MicroStation
provides these capabilities in the Design History tool box. These capabilities
are collectively referred to as Design History.
The DGN file data structure in which MicroStation stores the historical information
that supports Design History is called, non-coincidentally, the design history.
What is Design History?
Design History allows users to better manage the design process. It provides a
complete revision control system which allows users to track and view the
incremental changes made to a model. You can also restore elements to a prior
state by a combination of undoing and redoing historic changes. Changes can
also be tracked down to the element level. To help track the revisions, each is
identified with a revision number, the time and date, the author, and a description.
Changes are tracked for all elements. While the Commits are keyed to
a single author, the changes can be viewed and restored from a wide
range of combinations. Because the logic for combinations of selection
sets, multiple revisions, and undos and redos can be quite complex, the
examples will deal with the straightforward usage.
A revision records the difference between the current state of the model and
the last revision saved. Only the delta is saved in the Design History area of
the file, which minimizes additional storage requirements for history. Design
History revisions record changes in a linear fashion, from the inception of
MicroStation Administrator Guide 19–1
Recording and Browsing Design History
What is Design History?
history to the present. Branching is not currently supported.
Once started, revisions cannot be removed from the Design History of a
file. Similarly, there is no way to modify historical information. When
enabled, history becomes part of the file. MicroStation preserves the
integrity of history as carefully as it does ordinary elements, therefore
Design History serves as a reliable audit trail.
The Design History is maintained even with a File > Save As. Within the
Element Changes dialog box, this is indicated as a change in the design
filename. All other items in the Design History are unchanged.
In addition to tracking the changes, a number of recovery options are
possible. You can return to specific revisions or element changes within
revisions with the Restore Elements (see page 22-3) tool. Undo and
Redo options are briefly described below.
Capabilities include:
• Tracking all committed changes
• Viewing changes Before and After
• Undoing changes
• Redoing changes
• Selecting via List Filter
• Viewing changes on an element level
• Restoring revisions by date and number
19–2 MicroStation Administrator Guide
Recording and Browsing Design History
Using Design History
Using Design History
Design History should be turned on as soon as a file is created. In this manner,
all changes in a model are identified and tied to a specific revision number.
By tracking all changes on the element and revision level, you can easily
recover any prior state of a model or undo any single desired change. How
often the revisions are committed (recorded) is entirely under user control.
The general recommendation is that with active model files the changes
should be recorded at least daily to allow for easier recovery. For some
projects, more frequent recording of data may be desirable.
Once the data has been committed, there are a number of viewing and
recovery options. In the Design History list box, you can see at a glance
Revision number, Author, Date, and a comment. You can view by type
of change with the icons at the top of the dialog box.
Design History fully supports changes to complex elements, including any
combination of group, drop, and edit. These changes are also supported
in the undo of such changes. Changes to individual elements are tracked
in history even while they are components. The isolate tool will show an
element’s history even while it is a member of groups.
MicroStation Administrator Guide 19–3
Recording and Browsing Design History
Using Design History
To start using Design History
1. From the Tools menu, choose Design History.
2. Dock the Design History tool box.
3. Select the Initialize History icon for this file.
Design History only needs to be initialized once. Once initialized,
Design History cannot be turned off.
Periodically commit your changes with the Record changes icon. You will be
prompted to enter a message with each commit. Changes should be committed
at least daily and, on complex designs, hourly commits may be warranted.
These time increments are entirely under user control.
To record Design History
1. Begin working on your design model and make changes.
If another user has made changes in a model and those changes are not yet
committed, you will see an alert box when you first open the file. The alert
indicates that any uncommitted changes will be assigned to you, the current user.
2. Select Commit changes to record a revision.
The Commit changes dialog box opens.
3. Key in a note to indicate the changes made in the revision.
4. Click OK.
The revision is committed and the note now appears in the
Design History dialog box.
19–4 MicroStation Administrator Guide
Restoring Recorded Changes
This section provides information on how to restore MicroStation designs to a
prior state using the Design History and Restore elements tools.
Design History supports several methods of recovering changes from prior
versions. You can recover from a single version, perform a multi-select from
several versions, restore by element, or use a combination of these methods.
Recovery is not limited to changes that have been made in a specific revision.
Working on the model itself, any element can be directly edited or the element can
be edited with the element information and the element changes dialog box.
Restoring a Design History from a specific revision
This section discusses how to restore the state of a model to that of a prior
revision using the Restore elements tool. This tool restores whatever you have
selected to the state it was in at the time you choose. So, if you want a given
element or area to look like it did just after you created revision 1.x, select
element or fence the area, select revision 1.x, and place a data point.
The effects of the Restore elements tool are cumulative. That is, for example,
if the current revision is 1.6, and you restore the history to revision 1.3,
you will remove all of the changes from revisions 1.6. 1.5, and 1.4. In
contrast, if you selected the changes in revision 1.3 in Design History and
performed an Undo, the changes would occur only for the modifications
made in revision 1.4, not for any of the subsequent revisions.
You do not need to fence in the entire model. With the Restore elements
tool you can focus on just a subset of the model.
MicroStation Administrator Guide 20–1
Restoring Recorded Changes
Restoring to a Revision with a Fence
To restore a specific revision number
1. Select the Restore elements from history icon.
2. Select the desired revision to restore from the scrolling list. You
can use the Design History to see if the desired elements are
included in the selected revision.
3. Select the element to restore.
4. Place a data point to accept the operation.
The revision is returned to the state of the selected revision.
Restoring to a Revision with a Fence
This section discusses recovery from a single revision using a fence
and the Restore elements tool.
To restore a specific revision number with a Fence
1. Place a Fence around the model. Make sure the fence is large enough
to encompass all elements in the design.
2. Select the Restore elements from history icon.
3. Check the use Fence option.
4. Select the desired revision to restore from the scrolling list. You
can use the Design History to see if the desired elements are
included in the selected revision.
5. Place a data point.
The revision is restored.
Restoring Multiple Revisions (Undoing Historical Changes)
This section discusses recovery from multiple revisions. The
general behavior is as follows:
20–2 MicroStation Administrator Guide
Restoring Recorded Changes
Undoing Historical Changes from Multiple Revisions
If you select revision 1.x and 1.y and then select Undo, you will undo
only the effects of those two revisions.
If you select revision 1.x and 1.y and then select Redo, you will reassert the effects
of those two revisions, possibly overriding the effects of revisions that came later.
If you select all revisions after revision 1.x and select Undo, you will
effectively roll the design back to the time just after 1.x.
If the results are not as expected, simply use the MicroStation Undo command.
To restore from multiple revisions
1. Select the Design history icon.
2. Select the desired revision(s).
3. Preview the changes with the options in the top of the dialog box for
Design History for color coding of the changes.
4. Select Undo.
The revision is restored.
Undoing Historical Changes from Multiple Revisions
This section discusses recovery of elements from multiple revisions.
To restore elements from multiple revisions
1. Select the Design history icon.
2. Select the elements to restore.
3. Use Show elements changed in selected revisions isolate tool to focus
on the revisions affecting those elements.
4. Preview the changes with the color-coding options in the
MicroStation Administrator Guide 20–3
Restoring Recorded Changes
Revision Level Changes
Design History dialog box.
5. Select some or all of the revisions and use the Show Design
History Undo or Redo tools.
Revision Level Changes
Undo and redo can be applied to a single revision or to a set of revisions.
You get one result by selecting a single revision and then invoking Undo.
You get another result by invoking Redo, and still other effects by selecting
sequences of revisions and using undo or redo. This information is intended
to serve as a caution that these tools should be used with care.
In addition to using the Restore elements tool, you can also restore design
data at a point in time using Design History and Undo.
The procedure below has two pre-conditions. First, the revisions must be
sorted in the correct revision sequence order, either first to last or last to first.
Sorts by Author or other criteria may give undesirable results. Second, all the
following revisions must be selected as a group with no breaks.
To return a design to a prior state
1. Open Design History.
2. Select all revisions that came after the state you want.
3. Select Undo.
20–4 MicroStation Administrator Guide
Using Design History in Projects
This section provides information on how to best use Design History in
MicroStation in a multi-user environment. You will learn techniques to restore to
specific revision levels, find changes, and if necessary, truncate history.
Using Design History in Projects
Design History works best if it is immediately turned on by the first user
after the file is created from the seed file. Once turned on, all changes in a
file are then identified and tied to a specific revision number. Typically, the
Design History will have been initialized by the site administrator. Users
will then make changes and commit them as revisions. How often the
revisions are stored is entirely under user control.
The tools provide flexibility in viewing the changes made and also a
number of methods of Undoing or Redoing these changes by Type, or
Author, or by a number of other characteristics.
Once Design History has been turned on, users can view the Design History and,
if desired, Restore the Design History. The restoration can be done at the Revision
level, at the Element level and by area, with a Fence, or with a selection set.
The Show Design History dialog box is primarily a viewing tool. Any changes
you make with the Undo or Redo are limited to the selected elements in the
selected revision. In contrast, the effects of the Restore elements dialog box
are cumulative. If you elect to restore an earlier revision, all of the changes
following the selected revision are removed. Therefore, it is suggested to use
the Restore elements dialog box for recovery to a specific version.
MicroStation Administrator Guide 21–1
Using Design History in Projects
Conflicts in Design History
To record Design History
1. From the Tools menu, select Design History.
2. Design History has been automatically initialized from the seed file.
Once Design History has been initialized, it cannot be turned off.
3. Make changes in the design.
4. Select Commit changes to record a revision.
The Commit changes dialog box opens.
5. Key in a note to indicate the changes made in the revision.
6. Click OK.
The revision is committed and the note now appears in the
Design History dialog box.
Conflicts in Design History
If another user has uncommitted changes in Design History and you open that
file before those changes were committed, you will see an alert. The alert
tells you that when you perform a commit, you will take ownership of all
previously uncommitted changes. From that point on, even though another
person had initially made the changes, they are now assigned to you as the
current author. This detail may become significant when searching Show Design
History (see page 22-5) with the List Filter for a specific author.
Revision Level Changes
Most firms are driven by strict revision control systems. If this is the case,
returning to a desired design state is a simple matter.
21–2 MicroStation Administrator Guide
Using Design History in Projects
Element Level Changes
To restore Design History by revision number with
a fence or selection set
1. Place the fence or select elements using a selection set.
2. Select Restore elements from history.
3. (Optional) — Check the Use Fence option if you are using a fence.
4. Select the revision number to be restored.
5. Place a data point in the active window and the desired revision is restored.
Element Level Changes
You can also work at the element level and select which revisions to Undo
by selecting the elements from the appropriate Design History revision. The
procedure below explains how to view changes at the element level.
To display changed elements
1. From the Design History tool box, select Show Design History.
2. Select the Use color coding to show changes icon.
3. From the list box, select the revisions for which you wish to
display changed elements.
The changed elements are displayed.
You can step through the other icons (Show elements added in green, Show
elements deleted in red, and so on) to see exactly the kinds of changes that have
occurred. The elements that are selected and highlighted with the various color
coded options also affect how the Undo and Redo operations work.
MicroStation Administrator Guide 21–3
Using Design History in Projects
Finding Changes
To restore elements from a specific revision
1. Select the elements you wish to restore (by selection set or fence).
2. Select Restore elements from history.
3. Select the revision to restore elements from.
4. Accept the operation.
Finding Changes
One of the challenges of large, complex designs is tracking both the
content and the changes to that content. Design History provides
tools to ease these tasks. They include:
• Isolate history by fence or selection (see page 21-4), which shows
the history of selected elements.
• List filter (see page 21-5), which lets you filter the history
list by selected criteria.
• Show revisions in reference files (see page 21-6), which displays the
history of attached references that have design history.
• Zoom to changes (see page 21-7), which lets you zoom to
selected changes in the models.
To isolate history by fence or selection
1. Place a fence or selection set.
2. Select the Show Design History tool.
3. In the Design History dialog box, click the Isolate history
by fence or selection icon.
4. In a view window, select the element or area on which you wish
to see the complete history of changes.
The Design History dialog box displays the results.
21–4 MicroStation Administrator Guide
Using Design History in Projects
Finding Changes
Selecting the Isolate tool again clears the Isolate filter.
To filter the Design History list
1. In the Design History dialog box, click the List Filter icon.
A blank filter row appears at the top of the Design History list.
2. Enter the desired filter criteria value in the appropriate category, and press
MicroStation Administrator Guide 21–5
Using Design History in Projects
Finding Changes
〈Enter〉. (You can use multiple categories as filter criteria.)
The Design History list displays the revisions that match the criteria.
To display revisions in references
1. Select the Show Design History tool.
2. Click the Show revisions in reference files icon.
Revisions for references that use Design History appear on the Design
History list. The Files column lists the reference name.
21–6 MicroStation Administrator Guide
Using Design History in Projects
Truncating Design History
The File category
shows revisions for
the DGN file and the
reference.
Select a reference revision to display the reference changes in the open
views. Click the Show elements changed in selected revisions icon to
review the changes to elements in references.
To Zoom to changes
1. Select the desired revision by highlighting it.
2. Select Zoom to changes.
3. Place a data point in the view in which you wish to zoom
to the changed element.
Truncating Design History
As projects near significant milestones, it may be desirable to truncate the
design history. For example, at the 50% completion point, the earlier, now
unapproved efforts may no longer be of practical or historical importance. To
reduce the size of the data files and to limit the possible problems of returning
to a design that is no longer desirable, you can use the following procedure
to eliminate a design history while preserving the design integrity.
This procedure is generally more desirable than completely deleting
MicroStation Administrator Guide 21–7
Using Design History in Projects
Controlling Design History Settings
the design history (see page 21-9).
To truncate Design History
1. Place a fence around the elements you wish to preserve.
2. From the Utilities menu, choose Key-in.
3. Key in FENCE FILE.
The Save Fence Contents as dialog box opens.
4. Key in a filename.
5. Click OK.
6. Accept fence contents.
The resulting file contains all of the elements of the initial file and none of
the history. It is recommended to restart history on this file.
Controlling Design History Settings
The MS_DESIGN_HISTORY configuration variable provides options to control
how Design History can be used. By default, the create, commit, and browse
capabilities are enabled, and the delete capability is disabled.
Generally, you should not change the default settings. In particular, use caution
in deleting the design history for a file, since it cannot be recovered. Rather
than deleting the design history, you can copy the contents of the file to a
new file that does not contain the design history, or you can truncate the
design history (see page 21-7). Removing history from the current file is
almost never necessary, except in cases where the file is so large that you
cannot open it in order to make a copy without history.
If you must delete the design history for the current file, use
the following procedure.
Set and lock the MS_DESIGN_HISTORY configuration variable at the site,
project, or system level to prevent users from changing the settings.
21–8 MicroStation Administrator Guide
Using Design History in Projects
Controlling Design History Settings
To delete Design History
1. From the Workspace menu, choose Configuration.
The Configuration dialog box opens.
2. Select the MS_DESIGN_HISTORY configuration variable.
3. Click the Edit button.
The Edit Configuration Variable dialog box opens.
4. In the New Value field, key in: delete=1.
5. Click OK, then click OK again to close the Configuration dialog box.
6. Verify that you want to save changes to the user configuration file.
7. Exit and restart MicroStation.
8. From the Utilities menu, choose Key-in.
9. Key in: HISTORY DELETE, and click OK.
10. Verify that you want to delete the Design History.
The Design History for the file is deleted.
MicroStation Administrator Guide 21–9
21–10 MicroStation Administrator Guide
Design History Reference
This topic describes the tools, dialog boxes, key-ins, and configuration
variables used in Design History.
Design History tool box
Tools in the Design History tool box are used to:
• Record changes in Design History
• Restore elements
• Show design history
• Initialize design history
To Select in the Design History tool box
Record changes
Commit Changes (see page 22-2)
Restore Elements
Restore elements from history (see
page 22-3)
MicroStation Administrator Guide 22–1
Design History Reference
Commit Changes
To Select in the Design History tool box
Review design history
Show Design History (see page 22-5)
Start recording design
history
Initialize history for this file (see page
22-12)
Key-in: TOOLBOX HISTORY INITIALIZE [INITIALIZE |
RESTORE | SHOW | COMMIT]
Commit Changes
Commits changes to the Design History. Increments the Design History revision
by one. This tool is selected from the Design History tool box.
22–2 MicroStation Administrator Guide
Design History Reference
Restore Elements
Tool Setting Effect
Text field Enter a brief note describing the changes made in the
revision. This note is not a searchable field.
OK Accepts the Commit and increases the revision by one.
Cancel Stops the Commit and erases the note.
To commit changes
1. With Design History initialized, make changes in the model file.
2. Select Commit changes as a revision to this file.
3. Key in a note.
4. Click OK.
The revision increments by one and the changes are committed.
Key-in: HISTORY COMMIT
Restore Elements
The Restore Elements tool allows you to undo all changes to a collection
of elements since a specific revision, thus restoring their state as of that
revision. To help you decide which revision to recover, use Show Design
History (see page 22-5) to view a history of the file.
To select the elements to restore, you can:
MicroStation Administrator Guide 22–3
Design History Reference
Restore Elements
• identify an element
• use a selection set
• use a fence
To restore deleted elements, use a fence. In this case, the other methods
(identifying an element, selection sets) cannot be used because the elements
are transient and therefore cannot be selected.
Other workflows, such as restoring an element’s location after a move, can use all
selection methods because the element to be restored exists in the active model.
Tool Setting Effect
Use Fence Sets the Fence Selection Mode that, in conjunction with the
fence placement, defines the fence contents for manipulation.
See “Specifying which elements are in the fence contents”.
Revision Lets you select the revision to recover.
Show
Design
History Opens the Design History dialog box, which provide a wider
range of viewing, selection, and restoration options.
To restore elements from a specific revision
1. Select the elements (by selection set or fence).
2. Select Restore elements from history.
3. Select the revision to restore elements from.
To restore a specific revision number with a Fence
1. Place a Fence around the model. Make sure the fence is large enough
to encompass all elements in the design.
2. Select the Restore elements from history icon.
22–4 MicroStation Administrator Guide
Design History Reference
Show Design History
3. Check the use Fence option.
4. Select the desired revision to restore from the scrolling list. You
can use the Design History to check to see if the desired elements
are included in the selected revision.
5. Place a data point.
The revision is restored.
Key-in: HISTORY RESTORE
Show Design History
Updates the open views to show the pending and committed changes and opens
the Design History dialog box (see page 22-6). The Design History dialog box is
used to track and view the incremental changes made to a model, restore a model
to a prior state, and updates the views to show the current state. This state can be
controlled by a combination of Redo and Undo commands, a combination of prior
selected (or unselected states), and with a fence. Changes also can be tracked down
to the element level. Pending changes are seen by clicking the Recent description.
MicroStation Administrator Guide 22–5
Design History Reference
Design History dialog box
Key-in: HISTORY SHOW
Design History dialog box
The Design History dialog box, which opens when the Show Design History
icon is selected in the Design History (see page 22-1) tool box, is used to
track and view the incremental changes made to all models in a file, as well
as changes to attached references. In addition, you can restore a model to a
prior state. This state can be controlled by a combination of Redo and Undo
commands, a combination of prior selected (or unselected) states, and with
a fence. Changes also can be tracked down to the element level. Pending
changes are seen by clicking the Recent description.
For more information on working with Design History, see Restoring Recorded
Changes (see page 20-1) and Using Design History in Projects (see page 21-1).
22–6 MicroStation Administrator Guide
Design History Reference
Design History dialog box
Use color-coding to show changes
Lets you toggle the display of elements added (in green), deleted (in
red), or modified (in blue) in the selected revision.
Show elements that were added in green
(Use color-coding to show changes on only) Displays, in green,
the elements added in the selected revision.
Show elements that were deleted in red
(Use color-coding to show changes on only) Displays, in red,
the elements deleted in the selected revision.
Show elements that were modified in blue
(Use color-coding to show changes on only) Displays, in blue,
the elements modified in the revision.
MicroStation Administrator Guide 22–7
Design History Reference
Design History dialog box
Show elements before they were modified in cyan
(Use color-coding to show changes on only) Displays, in cyan, the elements
in the selected revision as they appeared before they were modified.
Show revisions in reference files
When on, lists revisions for attached references that have Design History.
List Filter
Lists the revisions according to selected criteria. Search options include:
by Revision, by File, by Date, by Author, and by Description.
Searches with dates and times are handled as follows:
Search String Result
2000 All dates with the year 2000.
2001/07 All dates with the year 2000 and month 07.
*/07 All dates with the month 07.
*/*/21 All dates with the date 21.
T04 All dates with time of 04 hours.
T04:21 All dates with time of 04 hours and 21 minutes.
T14:16:10 All dates with time of 14 hours, 16 min. and 10 sec.
*/08/21T05 All dates with month 08, date 21 and time of 05 hours
The comparison operators > , >=, <, <=, and != are also supported
on Date/Time Expressions. Thus:
Search String Result
>2000 All dates with the year >2000.
<=*/07/21 All dates with month <= 07 and date <= 21
22–8 MicroStation Administrator Guide
Design History Reference
Design History dialog box
Isolate history by fence or selection
Shows the history of the selected elements, independent of the selection method.
Undo selected historic changes
Undoes the selected changes.
Redo selected historic changes
Redoes the selected changes
Zoom to changes
Zooms to the selected changes.
Show elements changed in selected revisions
Highlights the elements that have changed according to the color coding indicated
above. Opens the Element Changes dialog box (see page 22-10).
List box
The contents of the list box includes:
Revision
Lists revisions for the model, as well as for attached references (if
Show revisions in reference files is on).
MicroStation Administrator Guide 22–9
Design History Reference
Element Changes dialog box
Each revision in the file history is assigned a two-part number. The first
part is the version number, the second part is the revision number. Revision
numbers increase as revisions are added, from the earliest change to the most
recent change. You can set the version number using the key-in HISTORY
SETVERSION (see page 22-13). By default, the first revision in any design’s
history is 1.1, the second is 1.2, and so on. Revision number 1.0 refers by
default to the original state of the file when history was initialized.
File
Lists the name of the file associated with the revision. The list can include the
name of the open file, as well as references that have design history.
Date
Lists the date of the revision.
Author
Lists the person who saved the revision.
Description
Lists text that describes the reasons for the changes to the revision. This
text is not currently available for report generation.
If the Description is “Recent”, it is the current set of changes, as yet uncommitted.
If the Element Changes dialog box is open or if you have Show details
turned on, you can view those changed, pending elements.
Element Changes dialog box
Used to view Design History details to see specifically which elements were
deleted added, modified, or removed. Elements can also be restored with
Undo changes to selected element(s) or Redo changes to selected element(s).
User interface also shows full element information.
This dialog box shows the elements involved in the revisions selected
in the Design History dialog box. If Design History is in "Isolating"
mode, then the Element Changes dialog box shows only the qualifying
elements from the selected revisions.
22–10 MicroStation Administrator Guide
Design History Reference
Element Changes dialog box
Undo changes to selected element(s)
Undo changes negates the selected change to the element.
Redo changes to selected element(s)
Redo reasserts the selected change.
Zoom to version of selected element
Zooms to the selected (post-change) version of the element.
Show element information
Toggles the display of the detailed element information. This
is the same display as Analyze Element.
List box
Contents of the list box includes:
MicroStation Administrator Guide 22–11
Design History Reference
Initialize Design History
Type
Describes type of element according toMicroStation classification. Types
include, Cell header, text, SmartSolid, etc.
Name
Name of the model where the element is attached.
Change
Type of change made to the element. Types include Add, Modify,
Pre-modify, and Delete.
ID
The element’s unique identifier. This matches what you would
see in Element Information.
Model
Name of the model.
File
Name of the file associated with the revision. The list can include revisions
in the open DGN file, as well as revisions in attached references.
Initialize Design History
Initialize Design History starts tracking the changes made to a model. The
capability applies to both 2D and 3D models. The changes are recorded in the
increments defined by the frequency of the commits made with Record changes in
history file. Once started, the Design History cannot be turned off.
22–12 MicroStation Administrator Guide
Design History Reference
HISTORY SETVERSION
When Design History is running and commits are made, each change
is recorded. With the Show Design History, you can go back in time
and review the changes incrementally or use the Restore elements
from history to return to a specific revision.
Once Design History is initialized for a specific file, this icon
will no longer be active.
Key-in: HISTORY INITIALIZE
HISTORY SETVERSION
The HISTORY SETVERSION key-in is used to create a new revision
in history with the specified revision number. All subsequent commits
will have revision numbers following on from that.
To bump up a major revision number
1. Key in HISTORY SETVERSION <nn.mm>
A new revision number is set. The updated version number displays in
the Design History dialog box (see page 22-6). All subsequent commits
will have revision numbers following on from that.
Key-in: HISTORY SETVERSION 〈nn.mm〉
Design History Configuration Variables
MicroStation includes configuration variables that affect the way
that Design History behaves.
MicroStation Administrator Guide 22–13
Design History Reference
Design History Configuration Variables
Name Configuration Variable Use
Design History MS_DESIGN_HIS- Allows users to create, delete, commit,
capabilities TORY and browse Design History.
Valid key words: create, delete,
commit, browse.
Set the key word to 1 to enable the
capability, or set it to 0 to disable
the capability. Separate multiple
settings with a semicolon (;).
The default setting is MS_DE-
SIGN_HISTORY=cre-
ate=1;delete=0;commit=1;browse=1
Colors MS_DESIGN_HIS- Specifies the colors to use when
TORY_COLORS identifying changed elements.
The value must be a list of four
color numbers, in the following
order: added, deleted, changed,
pre-changed. Each color number
must be a menu color index value.
The default is: 2 4 1 3.
Commit before MS_DESIGN_HIS- Specifies whether changes are
close TORY_COM- committed to Design History before
MIT_ON_CLOSE the file is closed (File > Close).
Possible values are:
2 - The Close command commits
changes to Design History without
prompting, and without a description.
1 - The Close command prompts
you to commit changes to Design
History, with a description.
0 (default) – The Close command
saves changes in the design file without
prompting, and without committing
changes to Design History.
22–14 MicroStation Administrator Guide
Design History Reference
Revision Number Display Format configuration variable
Name Configuration Variable Use
Commit on save MS_DESIGN_HIS- Specifies whether changes are
TORY_COM- committed to Design History before
MIT_ON_SAVE the file is saved (File > Save).
Possible values are:
2 - The Save command commits
changes to Design History without
prompting, and without a description.
1 - The Save command prompts
you to commit changes to Design
History with a description.
0 (default) - The Save command saves
changes to the design file without
prompting, and without committing
changes to Design History.
Confirm when MS_DESIGN_HIS- Specifies whether you are prompted
taking ownership TORY_OWNER- to confirm that you will take
SHIP_WARNING ownership of all uncommitted changes
from another user.
Possible values are:
1 (default) - Prompt for confirmation
before opening the file.
0 - Open the file without prompting
for confirmation.
Revision number MS_DESIGN_HIS- Allows you to change the appearance
display format TORY_REVI- of the revision numbers. For details,
SION_NUM- see Revision Number Display
BER_FORMAT Format Configuration Variable
(page 22-15).
Revision Number Display Format configuration variable
The Revision Number Display Format configuration variable lets you change
the format of the revision numbers in Design History, according to your
organization’s standards. For example, some organizations use numbers
for design revisions, and use letters for field revisions.
If no format is specified, revision numbers default to the format <major
revision number>.<minor revision number>.
MicroStation Administrator Guide 22–15
Design History Reference
Revision Number Display Format configuration variable
Syntax
The syntax for the Revision Number Display Format configuration
variable is based on the Java MessageFormat.
formatClause : = { [ “[“ range “]” ] msgFormatPattern }+
range : start [,end]
msgFormatPattern : = string [ “{” msgFormatElement “}” string ]*
msgFormatElement : = argument [ “,” elementFormat ]
elementFormat : = “number” | “letter” [ “,” letterStyle]
letterStyle : = { “uppercase” | “lowercase“|”AA”|“AB”|{“omit”
letter}* }+
The table describes details of the syntax.
Syntax Element Use
formatClause One or more formatClauses are required.
Each formatClause has an optional
range and msgFormatPattern.
range: start [,end] Optional. Start and end range for
the revision number.
msgFormatPattern Consists of a string (possibly empty),
optional msgFormatElement (in curly
braces), and another optional string.
{msgFormatElement} Consists of an argument (number that
identifies the field of the revision
number) and an optional elementFormat.
22–16 MicroStation Administrator Guide
Design History Reference
Revision Number Display Format configuration variable
Syntax Element Use
elementFormat If used, specifies either “number” or
“letter”. “Number” indicates that the
revision number field is displayed as
a number, while “letter” indicates that
the revision number field is converted
to one or more letters.
letterStyle Specifies either “uppercase” or
“lowercase”. Also specifies the rule
for what to do when the number is
beyond 26, plus which letters to omit
from the alphabet. (Some organizations
omit O and I because these letters can
be confused with 0 and 1.)
See “AA and AB rules” on page
22-18 for details.
Examples of Revision Number Display Format values
Following are some examples of values for the Revision Number
Display Format configuration variable:
Revision Number Desired Appearance Value for Configuration
Variable
1.2 A2 {0,letter}{1}
1.2 A.2 {0,letter}.{1}
1.2 1.B {0}.{1,letter}
1.2 2A {1}{0,letter}
1.2 B1 {1,letter}{0}
1.2 RevB1 Rev{1,letter}{0}
1.2 RevB1*** Rev{1,letter}{0}***
1.28 1BB {1,letter,AA}
1.28 1AB {0}{1,letter,AB}
The following examples show how ranges are used:
MicroStation Administrator Guide 22–17
Design History Reference
Revision Number Display Format configuration variable
Example Using a Range Description
[2.1]{0}.{1,letter} Revisions starting with 2.1 are formatted
as number.letter, while all revisions
before that are formatted in the default
style (number.number).
[2.1]{0}.{1.letter}[3.3]{0},{1,let- Revisions between 2.1 and 3.3
ter,AB} (inclusive) are formatted as number.letter
in AA style (the default), while
revisions after 3.3 are formatted as
number.letter in AB style.
AA and AB rules
When the numerical value exceeds 26, a combination of letters is produced.
The letterStyle specifies how letters are combined. If AA is specified, then
the letters are repeated. If AB is specified, then the letters accumulate in a
fashion similar to that of an odometer. Specifically, the revision number is first
converted to a base-0 index, and then converted to a base-26 number.
When AA is specified, then the lowest base-26 digit is used as a 0–based
index to select a letter, and that letter is repeated as many times as
the number is a multiple of 26, plus 1.
When AB is specified, then the highest base-26 digit is decremented, and each
base-26 digit is used as a 0–based index to select a letter. (If letters are omitted,
then the base will not be 26, but the number of letters that remain in the alphabet.)
See the table for examples.
Number Value of the Number Value of the Number
Using AA Rules Using AB Rules
1 A A
2 B B
26 Z Z
27 AA AA
22–18 MicroStation Administrator Guide
Design History Reference
Revision Number Display Format configuration variable
Number Value of the Number Value of the Number
Using AA Rules Using AB Rules
28 BB AB
52 ZZ AZ
53 AAA BA
54 BBB BB
78 ZZZ BZ
79 AAAA CA
676 ZZZZZZZZZZZZZ YZ
ZZZZZZZZZZZZZ
(676 is 26*26, so there
are 26 Zs)
677 AAAAAAAAA AAA
AAAAAAAAA
AAAAAAAAA (27 As)
MicroStation Administrator Guide 22–19
22–20 MicroStation Administrator Guide
Part VII: Ensuring Standards Compliance
Introduction to the Standards
Checker
The Standards Checker lets you compare information in your design file against
standards that you have established. This utility lets you choose the type of
information to check, as well as the standard values for that information.
The standards checks are performed by Standards Checker plugins, not the
Standards Checker utility itself. MicroStation includes plugins for checking
level, text style, dimension style, and line style properties. Additional
plugins can be written in either VBA or MDL, and several VBA examples
are included in the MicroStation VBA online help.
The Standards Checker plugins store their setup information in a MicroStation
DGN library (DGNLib). A DGN library file (*.dgnlib) has the same file format as
a DGN file, but by convention contains information that is shared throughout
files, such as the levels and styles that are used in a project.
You can store the Standards Checker plugin settings in the same DGN library
in which you store your other project-wide information, or you can use
a separate DGN library. Small organizations and small projects can take
advantage of the simpler administration that is possible when all standards
and standards checking settings are stored in the same file. However,
many organizations have multiple DGN libraries that contain discipline- or
project-specific levels, styles, and other standards, and thus need the flexibility to
separate their Standards Checker settings into a separate file.
Multiple Standards Checker settings can be stored by name in a given DGN
library. This provides the flexibility of establishing more lenient standards to use
earlier in a project, and stricter standards to use near project completion. You
might also store a set of special-purpose checks in the DGN library.
MicroStation Administrator Guide 23–1
23–2 MicroStation Administrator Guide
Using the Standards Checker
The Standards Checker examines the active design file and compares the
contents to the standards selected in the settings.
To use the Standards Checker, you must first define a set of standards
checks in a DGNLib. You can then choose to run a standards checker
interactively or generate a standards check report.
A standards check can be run on an individual design file, or as a batch
process (see page 24-6) on multiple files.
General Procedure — To set up and run a standards
check on an individual file
1. Open a DGN library (*.dgnlib).
2. Define the standards checker settings.
These settings are saved in the DGN library.
3. Open the file to be checked.
4. Run the standards check.
5. Review, and optionally fix, the results of the standards check.
6. Run the standards check again to verify the fixes.
Defining Standards Checker Settings
The Standards Checker Settings dialog box (Utilities > Standards
Checker > Configure) lets you define a set of standards checks
that will be saved in a DGNLib.
The simplest way to organize standards check settings and standards is to
MicroStation Administrator Guide 24–1
Using the Standards Checker
Defining Standards Checker Settings
store them in the same DGNLib. You can also create a DGNLib to store only
the settings, and keep the standards in other DGNLibs.
To create standards check settings
1. Open a DGN library (*.dgnlib file).
This DGNLib will store the named set of standards checks (standards check
settings). It can be the same DGNLib that you use to store your other
project-wide information, or it can be a different DGNLib.
2. In the Standards Checker Settings dialog box (Utilities > Standards
Checker > Configure), click Create new Standard Checker Settings.
3. In the Create Standards Checker Settings dialog box, enter a name
and, optionally, a description. Click OK.
4. Turn on the standards checks that you want to use.
5. For a selected check, click the Settings button.
6. On the Settings dialog box, choose the DGNLibs that contains the standards.
The default Configured DgnLibs option chooses the *.dgnlib files
specified by the configuration variable MS_DGNLIBLIST.
The Selected DgnLibs option lets you use the icons to add or
remove DGNLibs from the list.
The active file is also listed as a standards source. By choosing this
option, you can create a standards file that includes both the actual
24–2 MicroStation Administrator Guide
Using the Standards Checker
Running the Standards Checker Interactively
standards and the settings for checking those standards.
7. Turn on the properties you want to check, and click OK.
8. Modify the settings for each remaining check.
9. When finished with settings, click OK.
The standard check settings are stored in the active DGNLib.
Running the Standards Checker Interactively
In Interactive mode, the Standards Checker (Utilities > Standards Checker
> Check) opens a window that displays the status of the checking process.
When the Standards Checker finds a difference from the standard, it displays
a message that explains the difference between the values found and the
standard values. For example, if you turn on the Nonstandard Levels property
in the Level Checker Settings, the Standards Checker will find each level in
the file being checked that does not exist in the standards.
For each difference, you can choose to fix, ignore, or skip the problem. If you
choose to ignore a problem, the Standards Checker records the fact that the
problem is ignored, the current user, and the time for later reference.
Running an interactive standards check
1. In the Standards Checker dialog box, choose the Standards DGNLib
that contains the saved standards check settings.
MicroStation Administrator Guide 24–3
Using the Standards Checker
Running the Standards Checker Interactively
2. From the Settings Name option menu, choose the saved
standards check settings.
In the Checks section, the checks that are included in the
settings are now active.
3. (Optional) — Turn on or off checks.
To view the settings for a check, click the Settings button.
4. In the Options section, turn on Interactive, and click OK.
The Checking Standards window opens. This window compares
the contents of the open DGN file with the standards in the
24–4 MicroStation Administrator Guide
Using the Standards Checker
Generating Standards Checker Reports
DGNLibs specified in the settings.
5. For each problem found, choose Ignore, Fix, or Skip the problem.
Generating Standards Checker Reports
The Standards Checker can optionally produce a report file that records
the problems that it encounters. The report is written as an XML file. It
contains information about the Standards Checker plugins that were applied,
the standards that each is checking against, the files that were checked,
and details about the problems that were discovered.
To view the XML file in an easily read format, you need an XML style sheet.
The MS_STANDARDSCHECKER_STYLESHEET configuration variable
specifies the style sheet to use. A default style sheet is provided, but you
may want to develop a custom style sheet for your organization.
MicroStation Administrator Guide 24–5
Using the Standards Checker
Running Standards Checks as a Batch Process
Generating a standards check report
1. In the Standards Checker dialog box, choose the Standards DGNLib
that contains the saved standards check settings.
2. From the Settings Name option menu, choose the saved
standards check settings.
3. (Optional) — Turn on or off checks.
To view the settings for a check, click the Settings button.
4. In the Options section, turn on Report File.
The default report file name is displayed in the adjacent field. The
default location for the report file is specified by the configuration
variable MS_STANDARDSCHECKER_OUT.
5. (Optional) — Click the magnifying glass icon to select an existing
report file, or to new directory for the report file.
6. Choose the report option.
Create New in Series lets you create new report using the report file
name and the next available number. Append adds the results of the
report to an existing report file. Overwrite replaces the contents of
an existing file with the new report contents.
Running Standards Checks as a Batch Process
The Standards Checker can be used in conjunction with the Batch Process
utility to automate checking standards for many files at once.
General Procedure — To set up and run a standards
check as a batch process
1. Open a DGN library (*.dgnlib).
2. Define the standards checker settings.
These settings are saved in the DGN library.
3. Create a batch process command file (see page 12-2) that contains
the standards checker commands (see page 24-7).
24–6 MicroStation Administrator Guide
Using the Standards Checker
Syntax for running standards checks in the Batch Process utility
4. Select the files to process (see page 12-3).
5. Run the batch process (see page 12-5).
6. Review, and optionally fix, the results of the standards check.
If you choose to create a standards check report, the results for all
files are consolidated into one report file.
7. Run the standards check again to verify the fixes.
Syntax for running standards checks in the Batch Process utility
In the batch process command file, the syntax for the Standards
Checker execution command is: standardschecker execute
[keyword=value,keyword=value...], where the keywords set the
standards checker operational parameters.
The possible keywords and values are:
Keyword Values
report true, false, 0 or 1
If true or 1, a report file is generated
interactive true, false, 0 or 1
If true or 1, the Standards Checker is
run in interactive mode. If the Batch
Process runs in non-graphics mode,
this keyword is ignored.
settingsfile File specification for the settings DGN-
Lib file. If the path is not specified,
MicroStation searches the directory
specified by the MS_SETTINGS-
DIR configuration variable. If the
MS_STANDARDSCHECKER_SET-
TINGSFILE configuration variable is
set, this keyword is ignored.
settingsname The named standards check settings to
be used within the settings file.
MicroStation Administrator Guide 24–7
Using the Standards Checker
Syntax for running standards checks in the Batch Process utility
Keyword Values
reportfile File specification for the Standards
Checker report file. If the directory
is not specified, the file is put
in the directory specified by the
MS_STANDARDSCHECKER_OUT
configuration variable.
reportopen overwrite, append, or new
If not set (and report is set to 1 or true),
a new report file is generated.
reviewignored true, false, 0, or 1
If true or 1, then problems previously
marked as ignored are displayed in
interactive mode. If the Standards
Checker is not run in interactive mode,
this keyword has no effect.
The keyword/value pairs can be separated by either commas or spaces.
Any value that includes a space or a comma can be specified by using
double quotes either around the entire keyword/value pair, or around
just the value portion, such as: “reportfile=d:\Program Files\Bent-
ley\Workspace\Projects\Stn_175\out\check.xml” or reportfile=”d:\Pro-
gram Files\Bentley\Workspace\Projects\Stn_175\out\check.xml”.
24–8 MicroStation Administrator Guide
Index
$ key-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–52 Attach Element tool box . . . . . . . . . . . . . . . . . . . . . .5–28
Align Element with Point and Line . . . . . . . . . . .5–32
A Attach Element to Point . . . . . . . . . . . . . . . . . . . .5–31
AC= key-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–7 Attach Pen Element to Point. . . . . . . . . . . . . . . . .5–33
Action type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–40 Construct Attached Arc. . . . . . . . . . . . . . . . . . . . .5–30
ACTIVE CELL key-in . . . . . . . . . . . . . . . . . . . . . . . .5–7 Construct Attached Ellipse or Circle . . . . . . . . . .5–31
Active Entity Construct Attached Line String or Shape . . . . . .5–29
and linkage mode . . . . . . . . . . . . . . . . . . . . . . . . .15–43 ATTACH LOCATION key-in. . . . . . . . . . . . . . . . . .5–32
attach to element . . . . . . . . . . . . . . . . . . . . . . . . .15–40 ATTACH LSTRING key-in . . . . . . . . . . . . . . . . . . .5–30
define database row as. . . . . . . . . . . . . . . . . . . . .15–41 ATTACH MENU key-in . . . . . . . . . . . . .3–37 thru 3–38
edit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–42 ATTACH PEN key-in . . . . . . . . . . . . . . . . . . . . . . . .5–34
ACTIVE ENTITY key-in . . . . . . . . . . . . . . . . . . . .15–41 ATTACH TRANSFORM key-in . . . . . . . . . . . . . . .5–33
Active point ATTACH WEBTAG key-in . . . . . . . . . . . . . . . . . . . .8–5
settings group component . . . . . . . . . . . . . . . . . . .5–87 Authenticate users
ACTIVE REVIEW key-in . . . . . . . . . . . . . . . . . . . .16–1 users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–5
AE= key-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–41 Authentication
Algebraic expressions . . . . . . . . . . . . . . . . . . . . . . . .5–13 URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–22
Align Element with Point and Line . . . . . . . . . . . . .5–32 Authentication URL. . . . . . . . . . . . . . . . . . . . . . . . . .6–20
AM= key-in. . . . . . . . . . . . . . . . . . 3–30, 3–37 thru 3–38 Authorized users . . . . . . . . . . . . . . . . . . . . . . . . 6–5, 6–11
Application software
database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18–1 B
MDL application . . . . . . . . . . . . . . . . . . . . . . . . . .11–1 BASIC macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10–2
Applications Batch operations
key-in scripts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10–1 processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12–1
macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10–2 signing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–28
signed. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–23 Batch Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12–1
Arcs Bookmarks
construct attached. . . . . . . . . . . . . . . . . . . . . . . . . .5–30 for URLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8–9
Assign Break
Digital Rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–5 Constrained Geometry. . . . . . . . . . . . . . . . . . . . . .5–50
Equation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–26 Browser
Variable to Dimensional Constraint. . . . . . . . . . .5–27 connect to . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8–7
Attach BROWSER CONNECT key-in . . . . . . . . . . . . . . . . .8–8
Active Entity to fence contents . . . . . . . . . . . . .15–40
color tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–57 C
database linkages to elements. . . . . . . . 15–14, 15–40 CAPTURE FOCUS key-in . . . . . . . . . . . . . . 3–33, 3–36
Displayable Attributes . . . . . . . . . . . . . . . . . . . . . .16–3 CAPTURE RECTANGLE key-in . . . . . . . . 3–33, 3–35
Element to Point . . . . . . . . . . . . . . . . . . . . . . . . . . .5–31 CAPTURE SCREEN key-in. . . . 3–33 thru 3–34, 3–36
Pen Element to Point . . . . . . . . . . . . . . . . . . . . . . .5–33 CAPTURE VIEW CONTENTS key-in . . . 3–33, 3–35
row to element . . . . . . . . . . . . . . . . . . . . 15–14, 15–40 CAPTURE VIEW WINDOW . . . . . . . . . . . . . . . . .3–35
ATTACH ARC key-in . . . . . . . . . . . . . . . . . . . . . . . .5–31 CAPTURE VIEW WINDOW key-in . . . . . . . . . . .3–33
ATTACH CIRCLE key-in . . . . . . . . . . . . . . . . . . . . .5–31
MicroStation Administrator Guide i–1
Index
Cell libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–7 Commit Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . .22–2
attach linkage . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–44 Compound line styles. . . . . . . . . . . . . . . . . . . . . . . . .5–66
build . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–7 create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–77
detach linkage from header. . . . . . . . . . . . . . . . . .16–5 delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–80
directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90 modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–79
link to database table . . . . . . . . . . . . . . . . . . . . . .15–44 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–7
link with database. . . . . . . . . . . . . . . . . . . . . . . . .15–44 Configuration files
list. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–7, 5–90 new. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–7
multiple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–7 processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–2
Cells project . . . . . . . . . . . . . . . . . . . . . . . . . . 2–1, 2–5, 5–90
derived . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–8, 5–55 user. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1, 2–5
scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–88 Configuration variables . . . . . . . . . . . . . . . . . . 2–1, 5–90
settings group component . . . . . . . . . . . . . . . . . . .5–87 file debug. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–60
Certificates application-level . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–4
obtain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–15 check value using key-in. . . . . . . . . . . . . . . . . . . .2–52
receive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–15 define . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–7
search for. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–17 definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–1
verify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–17 directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–4, 2–9
Chamfer edit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–7, 2–12
Constrained Geometry. . . . . . . . . . . . . . . . . . . . . .5–52 expand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–7, 2–52
Change file syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–55
workmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4–2 filename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–4, 2–10
Changes in key-ins. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–52
identify in Design History. . . . . . . . . . . . . . . . . . .21–4 keyword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–4, 2–11
Circles levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–4
constrain center. . . . . . . . . . . . . . . . . . . . . . . . . . . .5–40 modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–7
constrain point to lie at center . . . . . . . . . . . . . . .5–42 MS_BATCHPLT_SPECS . . . . . . . . . . . . . . . . . . .2–12
constrain two to be concentric . . . . . . . . . . . . . . .5–42 MS_BUMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90
construct attached. . . . . . . . . . . . . . . . . . . . . . . . . .5–31 MS_CELL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90
Color tables . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–57, 5–59 MS_CELLLIST . . . . . . . . . . . . . . . . . . . . . . 5–7, 5–90
attach . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–57 MS_CELLSEED . . . . . . . . . . . . . . . . . . . . . . . . . .5–90
customize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–59 MS_DEF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90
default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90 MS_DEFCTBL . . . . . . . . . . . . . . . . . . . . . 5–57, 5–90
Colors MS_DESIGN_HISTORY . . . . . . . . . . . . . . . . . .22–13
duplicate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–61 MS_DESIGN_HISTORY_COLORS . . . . . . . .22–13
interpolation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–60 MS_DESIGN_HISTORY_COM-
modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–61 MIT_ON_CLOSE . . . . . . . . . . . . . . . . . . . . . .22–13
Column MS_DESIGN_HISTORY_COM-
mslink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–34 MIT_ON_SAVE . . . . . . . . . . . . . . . . . . . . . . .22–13
Columns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13–4 MS_DESIGN_HISTORY_OWNERSHIP_WARN-
Command file ING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22–13
SQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–30 MS_DESIGN_HISTORY_REVISION_NUM-
Command menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–36 BER_FORMAT . . . . . . . . . . . . . . . . . . . . . . . .22–13
create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–39 MS_DESIGNSEED . . . . . . . . . . . . . . . . . . . . . . . .5–90
sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–39 MS_ENHANCEDPRECISION . . . . . . . . . . . . . .2–12
i–2 MicroStation Administrator Guide
Index
MS_FKEYMNU . . . . . . . . . . . . . . . . . . . . . . . . . .5–90 CONSTRAIN CONCENTRIC key-in. . . . . . . . . . .5–42
MS_IMAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90 CONSTRAIN CONSTANT key-in . . . . . . . . . . . . .5–40
MS_KEYPAIRLIST . . . . . . . . . . . . . . . . . . . . . . .2–12 CONSTRAIN DIMENSION key-in . . . . . . . . . . . .5–26
MS_LEVELNAMES. . . . . . . . . . . . . . . . . . . . . . .5–90 CONSTRAIN EQUATION key-in . . . . . . . . . . . . .5–27
MS_LIGHTING . . . . . . . . . . . . . . . . . . . . . . . . . . .2–12 CONSTRAIN INTERSECTION key-in . . . . . . . . .5–42
MS_LINKTYPE . . . . . . . . . . . . . . . . . . . . . . . . . .14–9 CONSTRAIN LOCATION key-in. . . . . . . . . . . . . .5–43
MS_MATERIAL . . . . . . . . . . . . . . . . . . . . . . . . . .5–90 CONSTRAIN MATCH key-in . . . . . . . . . . . . . . . . .5–44
MS_MENU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90 CONSTRAIN MODIFY BREAK key-in . . . . . . . .5–50
MS_PATTERN . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90 CONSTRAIN POINTON key-in . . . . . . . . . . . . . . .5–40
MS_RFDIR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90 CONSTRAIN VARIABLE key-in . . . . . . . . . . . . . .5–28
MS_SEEDFILES . . . . . . . . . . . . . . . . . . . . . . . . . .5–90 Constraints
MS_SETTINGS . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90 display where needed for a profile. . . . . . . . . . . .5–45
MS_SETTINGSDIR . . . . . . . . . . . . . . . . . . . . . . .5–90 rules for applying . . . . . . . . . . . . . . . . . . . . . . . . . .5–18
MS_SHADOWMAP . . . . . . . . . . . . . . . . . . . . . . .5–90 Construct
MS_SHEETSEED . . . . . . . . . . . . . . . . . . . . . . . . .5–90 Attached Arc. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–30
MS_SYMBRSRC . . . . . . . . . . . . . . . . . . . . . . . . .5–90 Attached Ellipse or Circle . . . . . . . . . . . . . . . . . . .5–31
MS_TAGOUTPUT . . . . . . . . . . . . . . . . . . . . . . . .5–90 Attached Line String or Shape . . . . . . . . . . . . . . .5–29
MS_TAGTEMPLATES. . . . . . . . . . . . . . . . . . . . .5–90 Convert
MS_TUTLIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90 custom V5 palettes to tool box . . . . . . . . . . . . . . . .3–7
MS_USEEXTERNALBROWSER . . . . . . . . . . .2–12 Convert Element
MS_WEBBOOKMARKS . . . . . . . . . . . . . . . . . .2–12 to Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–23
MS_WEBCACHEDIR . . . . . . . . . . . . . . . . . . . . .2–12 CONVERT PROFILE key-in . . . . . . . . . . . . . . . . . .5–24
MS_WEBDOWNLOADDIR . . . . . . . . . . . . . . . .2–12 Create
MS_WEBHISTORYLOG. . . . . . . . . . . . . . . . . . .2–12 cell libraries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–7
MS_WEBKIOSKMODE . . . . . . . . . . . . . . . . . . .2–12 licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–11
MS_WEBPAGEHOME . . . . . . . . . . . . . . . . . . . .2–12 user interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–10
MS_WEBTYPESFILE . . . . . . . . . . . . . . . . . . . . .2–12 CREATE SYMBOL key-in. . . . . . . . . . . . . . . . . . . .5–77
path. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–4, 2–8 Cursor button menu . . . . . . . . . . . . . . . . . . . . . . . . . .3–36
processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–2 activate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–37
project-level . . . . . . . . . . . . . . . . . . . . . . . . . 2–4, 2–54 deactivate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–38
set with key-in . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–52 Custom line styles
site-level . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2–4, 2–54 component. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–64
system-level . . . . . . . . . . . . . . . . . . . . . . . . . 2–4, 2–54 compound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–62
table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–54 define . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–67
types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–4 definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–62
user-level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–4 libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–62, 5–90
Configure Customize
workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–1 Convert Palettes . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–2
Connect
browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8–7 D
Constrain Database
Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–35 detach linkages from fence contents . . . . . . . . . .16–4
Point at Intersection . . . . . . . . . . . . . . . . . . . . . . . .5–41 query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–1
Point on Construction . . . . . . . . . . . . . . . . . . . . . .5–40 review attributes . . . . . . . . . . . . . . . . . . . . . . . . . .15–17
Two Points to be Coincident. . . . . . . . . . . . . . . . .5–42 Database attributes
MicroStation Administrator Guide i–3
Index
display in design. . . . . . . . . . . . . . . . . . . . 16–3, 15–37 Design History tool box. . . . . . . . . . . . . . . . . . . . . . .22–1
displayable types . . . . . . . . . . . . . . . . . . . . . . . . . .16–3 Commit Changes . . . . . . . . . . . . . . . . . . . . . . . . . .22–2
load into text node . . . . . . . . . . . . . . . . . . . . . . . . .16–3 Initialize Design History . . . . . . . . . . . . . . . . . . .22–12
load into text nodes in fence contents . . . . . . . . .16–3 Restore Elements . . . . . . . . . . . . . . . . . . . . . . . . . .22–3
review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–36 Show Design History. . . . . . . . . . . . . . . . . . . . . . .22–5
review selection criteria . . . . . . . . . . . . . . . . . . . .16–1 Detach
Database forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–17 linkages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16–4
operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–17 DGN files
Database linkages seed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–6
attach to cell library header. . . . . . . . . . . . . . . . .15–44 Dialog boxes
attach to element . . . . . . . . . . . . . . . . . . . . . . . . .15–14 screen capture of . . . . . . . . . . . . . . . . . . . . . . . . . .3–36
attach to elements. . . . . . . . . . . . . . . . . . . . . . . . .15–40 DIALOG TOOLBOX DDDCONSTRAINT
create . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15–14, 15–40 key-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–35
detach from fence contents . . . . . . . . . . . . . . . . . .16–4 DIALOG TOOLBOX DDDDRAW key-in. . . . . . .5–17
establish . . . . . . . . . . . . . . . . . . . . . . . . . . 15–14, 15–40 DIALOG TOOLBOX DDDMODEL key-in . . . . .5–45
orphan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16–5 DIALOG TOOLBOX DDDMODIFY key-in . . . .5–49
types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14–9 DIALOG TOOLBOX DDDPARM key-in . . . . . . .5–25
verify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16–5 DIALOG TOOLBOX DDDTOOLS key-in . . . . . .5–17
Database products. . . . . . . . . . . . . . . . . . . . . . . . . . . .13–4 DIALOG WEBTOOLS key-in . . . . . . . . . . . . . . . . . .8–2
Oracle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13–4 Digital copyright. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–4
Database servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13–4 Digital signatures
models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13–4 components of . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–2
Databases references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–6
relational . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13–4 Digital Signatures . . . . . . . . . . . . . . . . . . . . . . 7–15, 7–34
DB= key-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14–4 Digital Signatures tool box . . . . . . . . . . . . . . . . . . . .7–33
DD Design tool frame . . . . . . . . . . . . . . . . . . . . . . . .5–16 Digital Signatures. . . . . . . . . . . . . . . . . . . . . . . . . .7–34
Define Place Signature Cell. . . . . . . . . . . . . . . . . . . . . . . .7–35
Active Entity Graphically . . . . . . . . . . . . . . . . . .15–41 Digitizing tablets
search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16–5 activate menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–37
Degrees of Freedom . . . . . . . . . . . . . . . . . . . . . 5–9, 5–11 attach menu to. . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–37
DELETE WEBTAG key-in. . . . . . . . . . . . . . . . . . . . .8–9 deactivate menu . . . . . . . . . . . . . . . . . . . . . . . . . . .3–38
Design History . . . . . . . . . . . . . . . . . . . . . . . . 19–1, 22–6 detach menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–38
commit changes . . . . . . . . . . . . . . . . . . . . . . . . . . .22–2 menus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–36
configuration variables . . . . . . . . . . . . . . . . . . . .22–13 Dimension-driven cells . . . . . . . . . . . . . . . . . . . . . . . .5–8
conflicts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21–2 derive for placement . . . . . . . . . . . . . . . . . . . . . . .5–55
display changed elements . . . . . . . . . . . . . . . . . . .21–3 modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–55
initialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22–12 place as derived . . . . . . . . . . . . . . . . . . . . . . . . . . .5–55
isolate using fence . . . . . . . . . . . . . . . . . . . . . . . . .21–4 underlying constraint . . . . . . . . . . . . . . . . . . . . . . .5–55
recording . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19–4 Dimension-driven design . . . . . . . . . . . . . . . . . . . . .5–55
restore by revision number . . . . . . . . . . . . . . . . . .21–2 algebraic constraints . . . . . . . . . . . . . . . . . . . . . . .5–10
show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22–5 algebraic expressions in equation . . . . . . . . . . . .5–12
track changes in . . . . . . . . . . . . . . . . . . . . . . . . . . .21–4 arithmetic operators in equation. . . . . . . . . . . . . .5–26
truncate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21–7 constraint symbology. . . . . . . . . . . . . . . . . . . . . . .5–11
used within projects . . . . . . . . . . . . . . . . . . . . . . . .21–1 constraints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–9
using. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21–1, 19–3 construction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–9
i–4 MicroStation Administrator Guide
Index
degrees of freedom. . . . . . . . . . . . . . . . . . . . 5–9, 5–11 Environment variables
dimensional constraints . . . . . . . . . . . . . . . . . . . . .5–10 MS_CONFIG . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–54
equation syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . .5–12 operating system. . . . . . . . . . . . . . . . . . . . . . . . . . .2–54
geometric constraints. . . . . . . . . . . . . . . . . . . . . . .5–10 Equate Parameters or Constructions . . . . . . . . . . . .5–43
location constraints . . . . . . . . . . . . . . . . . . . . . . . .5–10 Equation
numerical constant in equation. . . . . . . . . . . . . . .5–26 assign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–26
redundant constraints. . . . . . . . . . . . . . . . . . . . . . . .5–9 Equation syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–12
solve constraints . . . . . . . . . . . . . . . . . . . . . . . . . . .5–10 Evaluate Constraints tool box . . . . . . . . . . . . . . . . . .5–44
variable names in equation . . . . . . . . . . . . . . . . . .5–26 Describe Selected Construction or Constraint . .5–48
Dimension-driven profiles Modify and Re-solve Constraints . . . . . . . . . . . .5–47
convert elements to . . . . . . . . . . . . . . . . . . . . . . . .5–23 Re-solve Constraints . . . . . . . . . . . . . . . . . . . . . . .5–45
display where constraints are needed . . . . . . . . .5–45 Everyone license. . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–12
modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–47 EXPAND ECHO key-in . . . . . . . . . . . . . . . . . . . . . .2–52
sketch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–18 EXPAND KEYIN key-in. . . . . . . . . . . . . . . . . . . . . .2–52
Dimensional constraints EXPAND SET key-in . . . . . . . . . . . . . . . . . . . . . . . .2–52
assign variables to . . . . . . . . . . . . . . . . . . . . . . . . .5–27
convert dimensions to . . . . . . . . . . . . . . . . . . . . . .5–25 F
Dimensions Fence contents
convert to constraints. . . . . . . . . . . . . . . . . . . . . . .5–25 detach rows from . . . . . . . . . . . . . . . . . . . . . . . . . .16–4
DS= key-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16–5 load attributes in text nodes in . . . . . . . . . . . . . . .16–3
Fence filters
E check linkages with . . . . . . . . . . . . . . . . . . . . . . . .16–5
Edit generate report table with . . . . . . . . . . . . . . . . . . .17–3
Active Entity. . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–42 FI= key-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–42
EDIT ENGLINKS TAGS key-in . . . . . . . . . . . . . . . .8–6 File menu
Element Changes . . . . . . . . . . . . . . . . . . . . . . . . . . .22–10 Save As . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–6
Elements Save Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–6
convert to profiles . . . . . . . . . . . . . . . . . . . . . . . . .5–23 File protection . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–1, 6–6
tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13–1 enable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–2
Ellipses with certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–8
constrain center. . . . . . . . . . . . . . . . . . . . . . . . . . . .5–40 with password . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–10
construct attached. . . . . . . . . . . . . . . . . . . . . . . . . .5–31 File signature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–8
Encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–4 Files
Engineering Links tool box. . . . . . . . . . . . . . . . . . . . .8–1 configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–1
Attach Engineering Link . . . . . . . . . . . . . . . . . . . . .8–3 duplication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–4
Connect to/Disconnect from Browser . . . . . . . . . .8–7 open in unsecure environment . . . . . . . . . . . . . . .6–20
Delete Engineering Link . . . . . . . . . . . . . . . . . . . . .8–8 protected . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–18
Edit Engineering Tags . . . . . . . . . . . . . . . . . . . . . . .8–5 recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19–1
Follow Engineering Link . . . . . . . . . . . . . . . . . . . .8–6 sharing among projects . . . . . . . . . . . . . . . . . . . . . .5–4
Show Engineering Links . . . . . . . . . . . . . . . . . . . . .8–2 user preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–1
Engineering Tags V7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4–1
edit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8–5 Fillet
Entity number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–35 Constrained Geometry. . . . . . . . . . . . . . . . . . . . . .5–51
Environment FIND key-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–42
unsecure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–20 Fix Point at Location . . . . . . . . . . . . . . . . . . . . . . . . .5–43
MicroStation Administrator Guide i–5
Index
Fixed point Input
move. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–18 focus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–36
FOLLOW WEBTAG key-in. . . . . . . . . . . . . . . . . . . .8–7 Interfaces
Font libraries in workspaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–4
default open. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90
Form dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–21 J
add items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–23 Join
delete items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–23 tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–7
move items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–21
open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–21 K
resize items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–21
Key-in
save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–21
scripts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10–1
Function keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–30
Key-ins
assignment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–30
expand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–52
default menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90
Keyboard
menu action types. . . . . . . . . . . . . . . . . . . . . . . . . .3–40
function key assignments . . . . . . . . . . . . . . . . . . .3–30
menus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–30
modifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–30
L
G Levels
libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–56
Geometric Constraints tool box . . . . . . . . . . . . . . . .5–34
structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90
Constrain Elements . . . . . . . . . . . . . . . . . . . . . . . .5–35
Libraries
Constrain Point at Intersection . . . . . . . . . . . . . . .5–41
cell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–1
Constrain Point on Construction . . . . . . . . . . . . .5–40
font . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–1
Constrain Two Points to be Coincident. . . . . . . .5–42
line style . . . . . . . . . . . . . . . . . . . . . . . . . . . 5–62, 5–90
Equate Parameters or Constructions . . . . . . . . . .5–43
Licenses
Fix Point at Location . . . . . . . . . . . . . . . . . . . . . . .5–43
create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–11
Make Construction or Parameter Invariant. . . . .5–39
Everyone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–12
GroupBy clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–7
password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–13
Groups
recipient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–14
settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–81
removal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–15
Line strings
H construct attached. . . . . . . . . . . . . . . . . . . . . . . . . .5–29
HISTORY COMMIT key-in. . . . . . . . . . . . . . . . . . .22–3 Line Style Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–62
HISTORY INITIALIZE key-in . . . . . . . . . . . . . . .22–13 Line styles
HISTORY REVISIONSICON key-in . . . . . . . . . . .22–6 compound (custom) . . . . . . . . . . . . . . . . . . . . . . . .5–66
HISTORY SETVERSION key-in . . . . . . . . . . . . .22–13 copy definitions . . . . . . . . . . . . . . . . . . . . . . . . . . .5–62
Linkage mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–43
I duplicate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–43
Import effect on Active Entity. . . . . . . . . . . . . . . . . . . . .15–43
V5 menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–6 information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–44
V5 palettes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–6 new. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–43
Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–34 Links
Initialize Design History . . . . . . . . . . . . . . . . . . . . .22–12 attach engineering . . . . . . . . . . . . . . . . . . . . . . . . . .8–3
i–6 MicroStation Administrator Guide
Index
delete engineering . . . . . . . . . . . . . . . . . . . . . . . . . .8–8 delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–17
edit engineering . . . . . . . . . . . . . . . . . . . . . . . . . . . .8–5 insert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–21
follow engineering . . . . . . . . . . . . . . . . . . . . . . . . . .8–6 label (name) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–18
show engineering . . . . . . . . . . . . . . . . . . . . . . . . . . .8–2 mnemonic access character. . . . . . . . . . . . . . . . . .3–21
Load Displayable Attributes mnemonic access characters . . . . . . . . . . . . . . . . .3–18
to fence contents. . . . . . . . . . . . . . . . . . . . . . . . . . .16–3 modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–19
Lot table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–3 Menus
capture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–35
M command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–36
Macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10–2 cursor button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–36
Macros digitizing tablet. . . . . . . . . . . . . . . . . . . . . . . . . . . .3–36
hilite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16–5 function key assignments . . . . . . . . . . . . . . . . . . .3–30
load. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10–2 matrix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–36
run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10–2 modify menu items . . . . . . . . . . . . . . . . . . . . . . . .3–19
VBA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10–4, 6–28 names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–18
Make Construction or Parameter Invariant . . . . . . .5–39 paper. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–36
Manage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–81 MODEL EDIT_DIMENSION key-in . . . . . . . . . . .5–55
Materials MODEL MODIFY key-in. . . . . . . . . . . . . . . . . . . . .5–48
palette. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90 Model signatures
Matrix menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–36 add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–30
MC_DESIGN_HISTORY_COLORS configuration MODEL UPDATE key-in . . . . . . . . . . . . . . . . . . . . .5–47
variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22–13 Modify
MC_DESIGN_HISTORY_COMMIT_ON_SAVE and Re-solve Constraints . . . . . . . . . . . . . . . . . . .5–47
configuration variable . . . . . . . . . . . . . . . . . . . . .22–13 dimension-driven profiles . . . . . . . . . . . . . . . . . . .5–47
MC_DESIGN_HISTORY_OWNERSHIP_WARNING Value of Dimension or Variable . . . . . . . . . . . . . .5–54
configuration variable . . . . . . . . . . . . . . . . . . . . .22–13 Modify Constraint tool box. . . . . . . . . . . . . . . . . . . .5–48
MDL Break Constrained Geometry . . . . . . . . . . . . . . . .5–50
program database applications with. . . . . . . . . . .18–2 Chamfer Constrained Geometry . . . . . . . . . . . . .5–52
MDL applications. . . . . . . . . . . . . . . . . . . . . . . . . . . .11–1 Fillet Constrained Geometry . . . . . . . . . . . . . . . .5–51
automatically load . . . . . . . . . . . . . . . . . . . . . . . . .11–4 Modify Value of Dimension or Variable . . . . . . .5–54
details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11–3 Trim Constrained Geometry . . . . . . . . . . . . . . . . .5–50
load. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11–2 MODIFY DIMENSION key-in . . . . . . . . . . . . . . . .5–55
unload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11–3 Modules
MDL LOAD DDCELL key-in . . . . . . . . . . . . . . . . .5–56 create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–4
MDL LOAD key-in . . . . . . . . . . . . . . . . . . . . . . . . . .11–2 design. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–1
MDL LOAD MERGE key-in . . . . . . . . . . . . . . . . . .11–2 directory structure . . . . . . . . . . . . . . . . . . . . . . . . . .5–2
MDL UNLOAD key-in . . . . . . . . . . . . . . . . . . . . . . .11–4 file duplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–4
Menu bar maintain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–4
delete menu from . . . . . . . . . . . . . . . . . . . . . . . . . .3–17 remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–4
insert menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–21 sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–5
move menu in . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–16 sample workspace . . . . . . . . . . . . . . . . . . . . . . . . . .2–6
Menu items Move
accelerator . . . . . . . . . . . . . . . . . . . . . . . . . . 3–19, 3–21 fixed point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–18
associated key-in . . . . . . . . . . . . . . . . . . . . 3–19, 3–21 MS_DESIGN_HISTORY configuration variable 22–13
change position in menu . . . . . . . . . . . . . . . . . . . .3–17 MS_DESIGN_HISTORY_COMMIT_ON_CLOSE
MicroStation Administrator Guide i–7
Index
configuration variable . . . . . . . . . . . . . . . . . . . . .22–13 convert to tool boxes . . . . . . . . . . . . . . . . . . . . . . . .3–2
MS_DESIGN_HISTORY_REVISION_NUM- Paper menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–36
BER_FORMAT configuration variable . . . . . .22–13 Parameter Constraints tool box. . . . . . . . . . . . . . . . .5–24
MSCATALOG Assign Equation . . . . . . . . . . . . . . . . . . . . . . . . . . .5–26
dastable column . . . . . . . . . . . . . . . . . . . . . . . . . .15–37 Assign Variable to Dimensional Constraint . . . .5–27
entitynum column . . . . . . . . . . . . . . . . . . . . . . . .15–35 Convert Dimension to Constraint . . . . . . . . . . . .5–25
fencefilter column . . . . . . . . . . . . . . . . . . . . . . . .15–36 Passwords
maintain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–37 licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–13
reportable column . . . . . . . . . . . . . . . . . . . . . . . .15–36 Patterns
screenform column. . . . . . . . . . . . . . . . . . . . . . . .15–35 stroke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–76
sqlreview column . . . . . . . . . . . . . . . . . . . . . . . . .15–36 PLACE CELL DIMENSION key-in . . . . . . . . . . . .5–56
structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–34 Place Signature Cell . . . . . . . . . . . . . . . . . . . . . . . . . .7–35
tablename column . . . . . . . . . . . . . . . . . . . . . . . .15–35 PLACE SMARTLINE key-in. . . . . . . . . . . . . . . . . .3–40
msconfig.cfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–54 Point
mslink column. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–34 fix at location . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–43
key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–34 symbol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–73
Multi-user support . . . . . . . . . . . . . . . . . . . . . . . . . . .7–14 Point symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–65
associate with stroke . . . . . . . . . . . . . . . . . . . . . . .5–75
N base stroke pattern . . . . . . . . . . . . . . . . . . . . . . . . .5–74
New delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–76
configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . .1–7 horizontal offset . . . . . . . . . . . . . . . . . . . . . . . . . . .5–75
project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–9 justification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–75
workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–7, 1–10 modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–76
offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–75
O origin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–75
rotation angle . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–75
OLE DB
vertical offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–75
setup for MicroStation. . . . . . . . . . . . . . . . . . . . . .14–6
Points
Open
constrain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–40
unsecure files . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–20
constrain to lie at center of circle . . . . . . . . . . . . .5–42
Oracle. . . . . . . . . . . . . . . . . . . . . . . . . . . . .13–5 thru 13–6
constrain two to same location . . . . . . . . . . . . . . .5–42
product bundles . . . . . . . . . . . . . . . . . . . . . . . . . . .13–6
Preferences
product descriptions. . . . . . . . . . . . . . . . . . . . . . . .13–7
file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–53
reports with . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17–5
Previous version . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22–5
setup for Bentley PowerDraft . . . . . . . . . . . . . . . .14–3
Profile tool box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–17
SQL Reports Developer . . . . . . . . . . . . . . . . . . . .13–6
Convert Element to Profile . . . . . . . . . . . . . . . . . .5–23
SQL*Forms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13–6
Sketch Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–18
OrderBy clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–7
Profiles
Orphan
modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–47
linkage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16–5
sketch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–18
Project
P
configuration files . . . . . . . . . . . . . . . . 1–1, 2–5, 5–90
Packaging custom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–1
module data files . . . . . . . . . . . . . . . . . . . . . . . . . .5–92 file sharing among . . . . . . . . . . . . . . . . . . . . . . . . . .5–4
Palettes in workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–4
i–8 MicroStation Administrator Guide
Index
module data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–6 Review
new. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–9 attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–17
sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–12 Database Attributes of Element . . . . . . . . . . . . . .16–1
Protection Revisions
file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6–6, 6–18 restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22–3
references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–18 Rights
digital . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–4
Q unlimited . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–5
Query statements Rows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13–4
open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–24 attach to element . . . . . . . . . . . . . . . . . . 15–14, 15–40
save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–24 detach from element . . . . . . . . . . . . . . . . . . . . . . .16–4
seed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–42
R selection criteria . . . . . . . . . . . . . . . . . . . . . . . . . . .16–1
Rows
RA= key-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16–1
navigation of . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–17
Re-solve Constraints . . . . . . . . . . . . . . . . . . . . . . . . .5–45
RSIGN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–23
Recipient license. . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–14
Run
Record
macro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10–2
changes in history file . . . . . . . . . . . . . . . . . . . . . .22–2
Recovery
file options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19–1 S
References Save
file protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–18 Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–6
Relational databases. . . . . . . . . . . . . . . . . . . . . . . . . .13–4 Save As . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–6
strengths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13–4 Scale
tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13–4 modify settings group . . . . . . . . . . . . .5–84 thru 5–86
Remove settings group . . . . . . . . . . . . . . . . . . . .5–84 thru 5–86
licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–15 Scope
Rendering settings file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–3
pattern/bump maps. . . . . . . . . . . . . . . . . . . . . . . . .5–90 model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–2
Report of signature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–4
formatting and output with database products . .17–4 Screen capture. . . . . . . . . . . . . . . . . . . . . . . . . 3–32, 3–35
Report tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17–1 rectangular area . . . . . . . . . . . . . . . . . . . . . . . . . . .3–35
generate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17–2 view window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–35
name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17–2, 15–36 Scripts
Reports key-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10–1
generate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17–1 Security levels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–2
RESET DIMENSION key-in . . . . . . . . . . . . . . . . . .5–56 Seed files
Restore create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–6
changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20–1 default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90
elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20–1 default directory . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90
Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22–3 design. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–6
from design history . . . . . . . . . . . . . . . . . . . . . . . .22–3 sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–6
from specific revision . . . . . . . . . . . . . . . . . . . . . .20–1 Select
multiple revisions. . . . . . . . . . . . . . . . . . . . . . . . . .20–2 tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–3
using fence . . . . . . . . . . . . . . . . . . . . . . . . . 20–2, 22–5 Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13–4
MicroStation Administrator Guide i–9
Index
Settings groups SKETCH key-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–23
categories. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–84 Sketch Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–18
create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–84 Smart cards support . . . . . . . . . . . . . . . . . . . . . . . . . .7–14
define/modify scale . . . . . . . . . . . . . . .5–84 thru 5–86 Spoofing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–12
scale . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–84 thru 5–86 SQL
Settings menu command file . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–30
Color Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–59 SQL statements. . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–25
Manage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–81 commit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–31
Shadow maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90 COMMIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–27
Shapes CONNECT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–28
construct attached. . . . . . . . . . . . . . . . . . . . . . . . . .5–29 CREATE TABLE . . . . . . . . . . . . . . . . . . 15–27, 15–32
Sheet models DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–26
seed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–6 DISCONNECT. . . . . . . . . . . . . . . . . . . . . . . . . . .15–28
Show DROP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–27
Design History . . . . . . . . . . . . . . . . . . . . . . . . . . . .22–5 INSERT . . . . . . . . . . . . . . . . . . . . . . . . . . . 16–3, 15–26
Engineering Links . . . . . . . . . . . . . . . . . . . . . . . . . .8–2 manually commit . . . . . . . . . . . . . . . . . . . . . . . . .15–31
SHOW WEBTAGS key-in . . . . . . . . . . . . . . . . . . . . .8–3 MicroStation-specific . . . . . . . . . . . . . . . . . . . . .15–28
SIGNATURE ADD FILESIGNATURE key-in . . .7–37 RELOAD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–28
Signature cells. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–9 ROLLBACK. . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–27
Signatures SELECT . . . . . . . . . . . . . . . . . . . . . . . . . 15–26, 15–36
customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–14 submit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–29
decoration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–12 UPDATE . . . . . . . . . . . . . . . . . . . . . . . . . 15–26, 15–42
Design History . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–6 SQL window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–28
external changes that don’t invalidate . . . . . . . . . .7–5 SQL*Forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13–6
hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–13, 7–31 Stroke patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–64
integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–13 base for point symbol component . . . . . . . . . . . .5–74
internal changes that don’t invalidate . . . . . . . . . .7–5 bypass corner . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–69
items not included . . . . . . . . . . . . . . . . . . . . . . . . . .7–5 delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–72
model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–8 modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–72
multiple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–13 stroke end cap . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–69
not restricted by clip boundaries . . . . . . . . . . . . . .7–7 stroke length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–69
placed without invalidating others. . . . . . . . . . . . .7–6 stroke width. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5–69
re-validate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–33 Styles
removal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–32 workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–1
scope, restrictions. . . . . . . . . . . . . . . . . . . . . . . . . . .7–4
that include referenced DWG . . . . . . . . . . . . . . . . .7–7 T
that include references. . . . . . . . . . . . . . . . . . . . . . .7–7 Tab page
Signed applications . . . . . . . . . . . . . . . . . . . . . . . . . .6–26 where . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–7
Signing Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13–4
a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–27 columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13–4
a model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–29 create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–32
hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–31 displayable attribute. . . . . . . . . . . . . . . . . . . . . . . .16–3
multiple files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–28 index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–34
order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–13 join . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–7
tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–27 name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–35
i–10 MicroStation Administrator Guide
Index
primary key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–34 User preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–1
rows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13–4 file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–1
select . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–3 Users
Tablet menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–36 authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–5
Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13–1 authorized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–11
Tags Utilities
report templates . . . . . . . . . . . . . . . . . . . . . . . . . . .5–90 batch processing . . . . . . . . . . . . . . . . . . . . . . . . . . .12–1
Text nodes screen capture . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–32
displayable attribute. . . . . . . . . . . . . . . . . . . . . . . .16–3 Utilities menu
Tool boxes Batch Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12–1
child . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–5, 3–8 MDL applications . . . . . . . . . . . . . . . . . . . . . . . . .11–2
convert custom palettes to. . . . . . . . . . . . . . . . . . . .3–2
customize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–2 V
frames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–2 V5 menus
insert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–8 import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–6
rearrange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–8 V5 palettes
restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–5 convert to tool box . . . . . . . . . . . . . . . . . . . . . . . . . .3–7
Tool frames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–2 import. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–6
TOOLBOX HISTORY key-in . . . . . . . . . . . . . . . . .22–2 V7
Tools file migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4–1
associated key-ins . . . . . . . . . . . . . . . . . . . 3–10, 3–13 Variables
change description . . . . . . . . . . . . . . . . . . . . . . . . .3–13 assign to dimensional constraints. . . . . . . . . . . . .5–27
delete from list box . . . . . . . . . . . . . . . . . . . . . . . . .3–9 references in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–57
icons . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–12 thru 3–13 VBA macros . . . . . . . . . . . . . . . . . . . . . . . . . . 10–4, 6–28
insert. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–10 View
modify icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–13 capture contents of . . . . . . . . . . . . . . . . . . . . . . . . .3–35
size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–10, 3–13 capture with border . . . . . . . . . . . . . . . . . . . . . . . .3–35
Trim Visual SQL Query Builder . . . . . . . . . . .15–1 thru 15–2
Constrained Geometry. . . . . . . . . . . . . . . . . . . . . .5–50 SELECT statements. . . . . . . . . . . . . . . . . . . . . . . .15–3
Truncate VSQL OPEN key-in. . . . . . . . . . . . . . . . . . . . . . . . . .15–1
Design History . . . . . . . . . . . . . . . . . . . . . . . . . . . .21–7
Trust . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7–12 W
WHERE clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15–7
U Windows
UC= key-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16–5 screen capture of . . . . . . . . . . . . . . . . . . . . . . . . . .3–36
Undo Workmode
historical changes. . . . . . . . . . . . . . . . . . . . . . . . . .20–2 change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4–2
Unlimited rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6–5 V7. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4–2
URL authentication . . . . . . . . . . . . . . . . . . . . 6–20, 6–22 Workspace
User configuration file . . . . . . . . . . . . . . . . . . . . . . . . .2–5 active . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–5
User interface components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–1
customize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–1 configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–1
modifications file . . . . . . . . . . . . . . . . . . . . . . . . . .2–52 configuration files . . . . . . . . . . . . . . . . . . . . . . . . . .1–1
select . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–1 create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–7, 1–10
User Preference files . . . . . . . . . . . . . . . . . . . . . . . . .2–53 menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–1
MicroStation Administrator Guide i–11
Index
module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2–6 Configuration . . . . . . . . . . . . . . . . . . . . . . . . 11–4, 2–7
overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–1 customize. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–2
project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–1 Customize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–23
sample components . . . . . . . . . . . . . . . . . . . . . . . .1–12 Function Keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . .3–30
setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–2
style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–1 Z
user interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–1 Zoom
user preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . .1–1 to change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22–3
Workspace menu
i–12 MicroStation Administrator Guide