MSJ Adminguide PDF
MSJ Adminguide PDF
MSJ Adminguide PDF
Administrator’s Guide
DAA004470-1/0005
Trademarks
AccuDraw, Bentley, the "B" Bentley logo, MDL, MicroStation,
MicroStation/J, MicroStation MasterPiece, MicroStation Modeler,
MicroStation PowerDraft, MicroStation Review, MicroStation SE,
MicroStation Vault, PowerScope, QuickVision, SmartLine, and
TeamMate are registered trademarks; Bentley SELECT is a service
mark of Bentley Systems, Incorporated or Bentley Software, Inc.
Adobe, the Adobe logo, Acrobat, the Acrobat logo, Distiller, Exchange,
and PostScript are trademarks of Adobe Systems Incorporated.
Copyrights
©2000 Bentley Systems, Incorporated.
MicroStation ©1998-2000 Bentley Systems, Incorporated.
IGDS file formats ©1981-1988 Intergraph Corporation.
Intergraph Raster File Formats ©1993 Intergraph Corporation.
Portions ©1992-1994 Summit Software Company.
Portions ©1992-1997 Spotlight Graphics, Inc.
Portions ©1993-1995 Criterion Software Ltd. and its licensors.
Portions ©1992-1998 Sun MicroSystems, Inc.
Portions © Unigraphics Solutions, Inc.
Icc ©1991-1995 by AT&T, Christopher W. Fraser, and David
R. Hanson. All rights reserved.
Portions ©1997–1999 HMR, Inc. All rights reserved.
Portions ©1992–1997 STEP Tools, Inc.
Sentry Spelling-Checker Engine ©1993 Wintertree Software Inc.
Unpublished – rights reserved under the copyright laws of the
United States and other countries. All rights reserved.
Part I: Workspaces
1. Workspace Fundamentals
Workspace Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–1
Setting up the workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–2
Locating the components of the workspace combo boxes . . . . . . . . . . . . . . . . . . . . . . 1–4
User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–4
Project .............................................................................................................................. 1–4
Interface .......................................................................................................................... 1–5
Style ................................................................................................................................. 1–6
Creating your own user interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–6
Selecting workspace components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–6
Supplied Sample Workspace Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1–11
3. Workspace Configuration
Configuration Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–1
How MicroStation processes configuration variables . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–2
Start-up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–2
Determining configuration variable settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–3
Levels of configuration variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–3
Types of configuration variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–4
User Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–5
Project Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–5
Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–6
Working With Configuration Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–7
General Procedure — To Modify User-level Configuration Variables . . . . . . . . . . . . . . . 3–7
User configuration variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–12
User Interface Modification Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–36
User Preference Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–38
Configuration Variable Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–38
The Main Configuration Variable File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–39
Configuration Variable File Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–40
Variable definition references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–42
MicroStation-defined variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–43
Preprocessor directives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–43
Debugging Variable Definition Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–45
7. Engineering Links
Engineering Links tool box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–1
Show Engineering Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–2
Attach Engineering Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–3
Follow Engineering Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–5
Connect to/Disconnect from Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–5
Load RefAgent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–6
Remote Open/Attach . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–7
Entering the URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7–8
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.
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.
MicroStation
Manager
dialog box
All of the options shown on the User, Interface, and Project combo
boxes 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:
User
The User combo box sets the path for saving and loading an
environment or configuration for later design 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
design files. For example, selecting the “tutorials” user changes
the directory tree to “\projects\tutorials\intro\dgn” and
lists the design files in that location.
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 make 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 combo
box
Interface
Another component of the workspace, the Interface combo box 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.
Interface combo
box
Interface: autocad
This option provides AutoCAD command and tool names next to
corresponding MicroStation commands and tools.
Interface: newuser
This option provides a subset of the default graphical interface
to aid the new MicroStation user.
Interface: mde
This option provides graphical access to JMDL development tools.
Style
The Style option menu allows you to select either the older Command
Window method of communicating with MicroStation or the
standard Status bar. Whichever style you select, MicroStation
remembers it from session to session.
Style option
menu
Create User
Interface dialog
box
MicroStation
Manager
dialog box
with the User
combo box
displayed
Create User
Configuration
File dialog
box
2. In the Create User Configuration File dialog box, type the name
of the new workspace (the name for the new user configuration
file). The suffix “.ucf” is automatically added to the name.
3. Click OK.
A second Create User Configuration File dialog box opens.
Create User
Configuration
File dialog
box, after
giving the file
a name
6. Click OK.
The user configuration file is saved and is automatically chosen in
the User combo box in the MicroStation Manager dialog box.
User
Interface
dialog box
Create New
Project dialog
box
2. In the Name field, key in the name of the new project. The
name may be 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 combo box.
Create User
Interface
dialog box
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 combo box.
You can combine any project with any user interface and set
of preferences to create a workspace. For instructions, see
Workspace Components on page 1-1.
Architectural Project
The Architectural project component includes sample architectural
design files, seed files, cell libraries, border files, custom
line styles, as well as a named level structure, glossary,
function key menu, and more. These files are in Bentley’s
“Workspace\projects\examples\arch” directory.
Filename Description
"archseed.dgn" 2D architectural seed file with settings
commonly used by architects, such
as readouts in feet and inches,
fractions, level structures, cell and
style libraries, and menus.
"sdarch2d.dgn " 2D and 3D architectural seed files
"sdarch3d.dgn " historically supplied with MicroStation.
"sdarch.sht" Architectural seed sheet file with
settings commonly used by architects.
"sdarchah.sht" Architectural seed sheet files for A-size
"sdarchav.sht" drawings — horizontal and vertical
orientation, respectively.
"sdarchb.sht" Architectural seed sheet files for B-,
"sdarchc.sht" C-, D-, E-, and F-size drawings.
"sdarchd.sht"
"sdarche.sht"
"sdarchf.sht"
cells are stored at 1" size. Doors, windows, columns, shower stalls,
lights, and vents are designed to be placed using this method.
Architectural
cell library
"arch.cel"
Filename Description
"arch.cel " Cell library with commonly used
architectural symbols. The cells in this
library were created by Technicon, Idea
Graphix, and Intergraph Corporation.
"archpat.cel " Cell library containing commonly used
linear and area pattern cells.
Architectural
pattern
cell library
"archpat.cel"
Filename Description
"building.dgn" 3D model of hi-rise building in
urban setting.
"ddarch.dgn" Sample dimension-driven designs. Can
be placed as dimension-driven cells.
"igi_flrp.dgn" Sample house floor plan developed
by IdeaGraphix, Inc.
Filename Description
"lad_roof.dgn" Sample partial concept model for the
National Science Center. Courtesy,
Leo A. Daly.
"lad_towr.dgn" Sample partial concept model for the
National Science Center. Courtesy,
Leo A. Daly.
"lindal.dgn" House floor plan, courtesy of Lindal
Cedar Homes.
"liv_room.dgn" Interior of residence.
Sample
design file
"sc_fp.dgn"
Filename Description
"border_d.dgn" D size at 1/8" scale
Filename Description
"archset.stg" Provides access to the project’s cells,
dimension styles, and multi-line styles.
Filename Description
"civ2d.dgn" 2D; working units of 1:100:10; origin
at back left x,y — intended for use
in site layout work.
"civ3d.dgn" 3D; working units of 1:100:10; origin at
center “Z” and back left x,y — intended
for use in site modeling work.
"civil.cel" cell
library
Filename Description
"civil.cel" Has cells for civil engineering layout and
detail work.
"civeng.cel" Has cells used with electronic field books.
(English version)
"civmet.cel" Has cells used with electronic field books.
(metric version)
"civeng.cel"
cell library
"civmet.cel"
cell library
Filename Description
"profiles.dgn" Profiles
Filename Description
"civset.stg" Provides access to the project’s area
patterns and cells.
Introductory Project
The Introductory sample project component consists of design files
necessary for working through the tutorials in the Tutorial Workbook.
This project is automatically activated when the workspace User is set
to tutorials in the MicroStation Manager dialog box. The project files
are in Bentley’s “Workspace\projects\tutorials\intro” directory.
Mapping Project
The Mapping project component includes sample mapping design files,
sample seed files, cell libraries, border files, and line style definitions,
a glossary, and level structure for mapping applications. These files
are in Bentley’s “Workspace\projects\examples\mapping” directory.
"mapping.cel"
Filename Description
"mapping.cel" Samples of map border cells.
"control.cel"
"land.cel"
"mappat.cel"
"maputil.dgn"
Filename Description
"contour.dgn" Sample contour map.
Filename Description
"mapcont.dgn" Sample contour map that demonstrates the use
of MicroStation for topographic mapping —
has index, intermediate, hidden and depressed
contours and spot elevations, as well as examples
of horizontal and vertical control points.
"mapbord.dgn" A sample border file.
51 Cable_Text
XFMR Sub-Group
52 XFMR — Transformer
53 XFMR Text
Switch Sub-Group
54 Switch
55 Switch Text
Pole Sub-Group
56 Pole — Utility Pole
57 Pole Text — Utility Pole Text
Fuse Sub-
Group
58 Fuse
59 Fuse Text
60 Pedestal
Filename Description
"mapset.stg " Provides access to the project’s
Linear drawing settings group
components and cells.
Filename Description
"mechdet.dgn" For use in creating detail drawings.
"weld.cel"
"geo.cel"
"finish.cel"
"draft.cel"
Filename Description
"mechpat.cel" ANSI material patterns.
"hexcaphd.cel" Hex slotted cap screw heads, side and top views.
Filename Description
"a0form.dgn" SI Project Border - 84.1 × 118.9
Filename Description
"a3form.dgn" SI Project Border - 29.7 × 42.0
Filename Description
"countwt.dgn" Counter weight design created by
Duo-Fast Corporation.
"engine.dgn" Dimension-driven model of an internal
combustion engine.
"gear.dgn" Gear design created by Intergraph
Corporation.
"pulley.dgn" Pulley design created by Duo-Fast
Corporation.
"rim.dgn" Rim design created by Intergraph
Corporation.
"shaft.dgn " Shaft design created by Duo-Fast
Corporation.
"spindle.dgn" Spindle design created by Duo-Fast
Corporation.
"tool.dgn" Mechanical design example — 3D Model.
"gear.dgn"
Rendered
view of
"tool.dgn"
Level Num-
Name ber
part1 1
part2 2
: :
part20 20
This level structure is defined in "spindle.lvl", which is
used with "spindle.dgn":
Visualization project
The Visualization project component includes sample design files.
Filename Description
"animsets.dgn" Flat-panel monitor.
"windmill.dgn" Windmill.
Configuration Variables
The User Configuration File (see page 3-5) and the Project
Configuration File (see page 3-5) use configuration variables to
select a workspace and to affect MicroStation’s behavior.
Start-up
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.
User configuration files have the suffix “.ucf” and are stored
in Bentley’s “Workspace\users” directory.
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.
Configuration
Variables
dialog box
Select Path
dialog box
Select
Directory
dialog box
Select File
dialog box
Edit
Configuration
Variable
dialog box
Variable Description
CLASSPATH Path to Java/JMDL classes.
Variable Description
MS_BASICEXT_LOAD List of MDL applications
that implement extensions
to the BASIC language
(MS_BASIC_LOAD).
MS_CACH Optional cache ID string
for MicroCSL.
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.
MS_DEFCHARTRAN Default character translation
table.
MS_DGNOUT Directory containing design
files created as a result of
“on the fly” translation from
other file formats.
MS_DY- Server to which on-line help
NAWEB_HELPSERVER requests are directed.
Variable Description
MS_OLDUSERLICENSE File that contains old user license
information. Required for when
installing a product upgrade.
MS_OPENDESIGNFILE- Initial file filter for the
FILTER MicroStation Manager and
Open Design File dialog boxes.
MS_RIGHTLOGICKB If set to 1, keyboard input
is right to left.
MS_RSRC Main MicroStation resource file.
Typically set to “ustation.rsc.”
MS_TUT_UCMS Directory containing user
commands that drive tutorials.
MS_UNDO If set, specifies the amount of
memory, in bytes, allocated to the
undo buffer, thereby overriding
the Undo Buffer (KB) preference.
MS_USERLICENSE File containing MicroStation
license information.
the “default” modification files are different, the files in the active
user interface’s subdirectory override them.
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.
%<preprocessor directive>
Operator Meaning
= Assign new_value to VARIABLENAME.
: Assign new_value to VARIABLENAME only
if that variable does not already exist.
Operator Meaning
+ 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.
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/
Reference Meaning
Reference Returns
dev() device
dir() directory
MicroStation-defined variables
MicroStation defines one of the following configuration variables
to indicate which software is running:
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<filename> Include (process) another configuration
variable 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 <expression> Execute the following lines if the last %if
was false and expression is true.
%endif End of conditional block.
MS_OLDDEF "c:/dgn/"
PROJDGN “$(PROJDIR)dgn/” “\project33\dgn\”
The following aspects of the MicroStation user interface are not parts
of the workspace user interface, but you can also customize them:
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.
Customize
dialog box
with the Tool
Frames tab
displayed
Modification type
Rearranging child tool boxes
(see page 4-8)
Inserting child tool boxes
(see page 4-8)
Modification type
Rearranging tools (see page 4-9)
Inserting tools (see page 4-10)
Modifying tools (see page 4-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) 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
a bolder font than appears in the regular tool boxes.
Customize dialog
box with the
Tool Boxes tab
displayed
Modification type
Rearranging tools (see page 4-9)
Inserting tools (see page 4-10)
Modifying tools (see page 4-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 (Tools > Tool Boxes…). You can open
them using that 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 created a custom icon in Version 5.0, a tool tip and description is
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.
Expanding menus
Rearranging tools
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.
Inserting tools
The above procedure also applies to view controls (see View Control
Bars on page 4-22). (View controls cannot be modified, however.)
Insert Tool
dialog box
If you make a mistake while drawing the icon and want to start
over, click the Reset button in the Insert Tool dialog box.
Modifying tools
You can:
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.”
Insert Tool
dialog box
with tool icon
displayed
If the small version of the icon is in the drawing area 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 drawing area. To modify both the small and large versions
at the same time, turn on Draw Both Icons in the Options menu.
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 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
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 menu > Customize) is used
to customize the main menu bar and its member menus.
Customize
dialog box
with the
Menu Bar tab
displayed
Modification type
Rearranging menus (see
page 4-17)
Modifying menus (see page 4-18)
Inserting menus and menu
items (see page 4-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.
Rearranging menus
Modifying menus
You can:
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.
Modify Menu
dialog box
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.
Modify Menu
Item dialog
box
Select Tool
Box dialog
box
Insert Menu
dialog box
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.
Insert Menu
Item dialog
box
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 4-9)
Inserting view controls (see Inserting
tools on page 4-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.
To restore Key in
View control CUSTOMIZ RESTORE VIEWTOOLS
bar — 2D 2D
designs
View control CUSTOMIZ RESTORE VIEWTOOLS
bar — 3D 3D
designs
View control CUSTOMIZ RESTORE VIEWTOOLS
bar — all BOTH
designs
An alert box opens to confirm the request.
2. Click the Yes button.
Customize dialog
box with the
Interface Settings
tab displayed
About
Workspace
window
For a list of the function keys that are available on your system, see
“Function keys” in the Setup Guide. Definitions can also be created for
pressing the function keys along with the modifier keys áCtrlñ, áAltñ,
and áShiftñ. For information about how to press these modifier keys
on your system, see “Using the Keyboard” in the Setup Guide.
Function
Keys dialog
box
Edit Key
Definition
dialog box
use one you must attach it to the surface of the digitizing tablet (see
Attaching and activating tablet menus on page 4-31).
Deactivating menus
The ATTACH MENU (AM=) key-in is used to deactivate tablet menus.
Sample menus
The following tablet menus are supplied with MicroStation
in electronic form.
Customization terminology
A menu block is an area in a command or a matrix menu that defines
a region that is selected to perform a specific task.
A menu cell is a cell that contains all of the menu control information
— the location, range, type, and function of all menu blocks
and cursor button assignments in a menu.
A menu design file is the design file in which the menu graphical
information is drawn and the menu control information is placed.
Menu cells are created from the information in the menu design file.
16. Select (or place a fence around) the menu and the text
node you placed in step 7.
17. Define the cell origin at the lower left corner of the menu (not the
lower left corner of the fence) with the Define Cell Origin tool.
18. Create the menu cell. Designate the cell as a menu cell by choosing
Menu from the option menu in the Create New Cell dialog box.
See To create a cellin the Using Cells chapter of the User’s Guide.
Tutorials
Tutorials are screen menus that resemble dialog boxes. They can
be used to solicit or display information or instructions. When
a tutorial is activated, it is displayed in a window. The servicing
application for a tutorial is typically a user command (UCM)..
These components of a tutorial are apparent to the user:
Tutorial execution
A tutorial is drawn in a MicroStation design file and defined
as a cell in a cell library.
Control information
The control information in a tutorial cell describes how the tutorial
inputs and outputs are to be handled. Control information is specified
as action strings that are placed in text elements on level 63.
The action string syntax for specifying a key entry field is I,<n>,<m>.
n is the maximum number of characters that can be input or
Display information
The display information in a tutorial cell consists of graphic
elements that display when the tutorial is activated. Display
information cannot be placed on level 63.
To build a tutorial
1. Develop the servicing application, which is typically a UCM.
2. Create a 2D design file.
3. Draw the display information on levels 1-62.
4. Activate the MSTUT user command (“mstut.ucm”). The UCM
is used to create the control information on level 63.
5. The UCM prompts you for the needed information. You can
Reset back one step at a time and exit the UCM with a
final Reset. The prompts are as follows:
7. When all fields have been defined, select or fence the elements in
the tutorial, including the text node that identifies the servicing
application. Define the cell origin with the Define Cell Origin tool.
8. Attach the cell library in which you want to store the tutorial
cell — for example, “msmenu.cel.”
9. Create the tutorial cell. Designate the cell as a tutorial cell
by choosing Tutorial from the option menu in the Create
New Cell dialog box. See To create a cellin the Using
Cells chapter of the User’s Guide.
Once the selection range is set for a graphic selection field, neither
the field nor the text element associated with it can be manipulated
without the selection range being affected. Therefore, if modifications
need to be made to a graphic selection field, the entire field and
its associated text string should be deleted and placed again
to ensure that the element range is correct.
Action Strings
The actions MicroStation performs when you select a tool, choose a
menu item, press a function key, or select a menu block 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, menu blocks, and function keys.
Note that some of the action types cannot be used in IGDS.
1
This action type cannot be used in IGDS.
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.
M,cfPlace 2 Inch Circle Displays the message “Place 2 Inch
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.
1 Bentley Enterprise Developer Program Members around the world offer products and services
that compliment Bentley engineering solutions. An online catalog, located on the World
Wide Web at http://www.bentley.com/developer/catalog.htm, has search capabilities to locate
these products and services by company name, product name, or application area.
The system Clipboard, if one exists, can be used to exchange data with
other applications. See Clipboard Operations on page 5-62.
Finally, you can import the contents of a text file into a MicroStation
design. See Importing Text (see page 5-81) .
Basic terminology
The following terms apply to file exchange in general:
Opening a 3D file
To import a 3D drawing file interactively, the active design file
must be 3D. To open a 3D drawing file from the system command
line, the translation seed file must be 3D.
Log file
A log file is a text file in which translation statistics and
diagnostics — the messages that display in the status box as
a translation is in progress — are saved.
By default, the log file is saved with the same filename and directory
as the file being translated with the extension “.log.”
Versions supported
The following versions of each format can be converted:
2 The Default Translation Seed File is set by the MS_TRANSEED configuration variable (for
3 To interactively import a 3D DWG or DXF file, the active design file must be 3D.
Unless you are sure an IGES file is 2D, the active design file should be 3D (see
Opening a 3D file on page 5-6). Be sure the design file has appropriate working units
(see Keeping units and measurements correct on page 5-6).
Save Design
As dialog box
4. Click OK.
As the file is saved, you can monitor the status by reading
the messages displayed in the Status window.
The settings that were set the last time you saved a design file
as a DWG or DXF, IGES, or CGM file interactively (using the
File menu’s Import or Export item) control how elements in the
design file are converted to entities in the exported file.
4. Click OK.
A dialog box opens which lets you adjust export settings
for the type of file you are exporting.
Import/Export IGES
The following sections discuss the way the Import/Export IGES
facility deals with MicroStation dimension elements.
IGES entities
The fundamental unit of data in an IGES file is the entity.
There are two major categories of entities.
Start section
If desired, a text file can be specified using the Start Section File
dialog box (from the Export IGES File dialog box, choose File >
Start Section File). For example, it might have information such as
notes to the receiving company. If a text file is specified, the text
is reformatted into standard IGES record format.
1. Entity type
2. Pointer to the parameter data for that entity
4. Line font pattern
5. Level
10. Line count from beginning of directory entry section
11. Entity type (same as field 1)
12. Line weight
13. Color
14. Number of fields in the parameter data entry for that entity
15. Form number
18. Entity label; IGESOUT writes the MicroStation
element type the entity was created from
20. Line count from beginning of directory entry
section (same as field 10)
Terminate section
One line long; must be the last line in the IGES file.
The examples here show a design file “output.dgn,” settings set to the
defaults (except for global data as specified in the Export to IGES
File dialog box), and the exported IGES file “output.igs.”
Export IGES
File dialog box
The exported
IGES file
“output.igs.”
You can use the Cell Names dialog box to customize how
cell names are translated.
Cell Names
dialog box
Converting text
The font library “igesfont.flb” has equivalents for the IGES standard
text fonts. The default mappings from the IGES standard text
fonts to the fonts in “igesfont.flb” are as follows:
The default line font pattern to line style mappings for IGES import are:
Levels
An IGES file can have an unlimited number of levels, numbered
with any non-negative integer. A MicroStation design file can
have up to 63 levels, numbered 1-63.
“IGES level mod 63” means “the remainder from the IGES
level divided by 63 (integer division).”
Example:
By default, entities on levels 64 and 127 of the IGES file are put
on level 2 in the MicroStation design file; entities on levels 65 and
128 of the IGES file are put on level 3, and so on.
The Drawings option menu in the Import IGES File dialog box
controls how drawing entities, view visibility, and view symbology
are handled when an IGES file is imported.
An example
of the IGES
drawing entity.
The geometry
of the part is
drawn just
once. The
drawing entity
defines the
multiple views
of the object so
that it can be
viewed from
different sides.
The annotations
and border are
also part of the
drawing entity.
The Exclude IGES Entities dialog box lets you exclude IGES entities.
To open this dialog box, choose Settings menu > Exclude IGES
Entities… in the Export IGES File dialog box.
1
All entities in a CALS Class I file must be 2D. You can flatten in any
standard view. If Flattening is set to None and the design file is 3D, the
IGES file is not CALS Class I-compliant.
2 Custom color definitions are not allowed in CALS Class I IGES files.
3
CALS Class I and II IGES files must have at least one drawing entity.
See Import IGES File dialog box for information about saving a
custom start section file for your project or organization.
All of the 3D entities that are allowed in CALS Class II IGES files.
1 A MicroStation line string or shape element can have a maximum of 101 vertices.
If a copious data entity has more than 101 vertices, it is translated as a complex
chain or complex shape that contains multiple line strings.
2
Only bounded planes with a positive bounded area (form 1) are translated.
In this case, the bounding curve is interpreted as closed. For example,
if the bounding curve is a composite curve it is interpreted as a complex
shape rather than a complex chain.
3
Form 1 ruled surfaces are approximated as form 0. The parameterization of the
ruled surfaces is always taken from the rail curves as specified in form 0.
4
Trimmed parametric surface entities are translated to B-spline surface elements
with boundaries. Since MicroStation supports only polygonal surface boundaries,
curved boundaries are approximated by stroking the curves to polygons.
5
See Importing dimension elements on page 5-15.
6
The Subfigure Output control (IGES Import Settings dialog box) sets
how subfigures are translated. If no cell library is attached, Subfigure
Output is set to shared cells.
7 The Drawings control in the IGES Import Settings dialog box sets how view
visibility is handled. See also Drawing sheets and view visibility (see page 5-26) .
8 The Drawings control in the IGES Import Settings dialog box sets whether
drawing entities are ignored, merged into the design file, or have a
sheet file created with appropriate attached views. See also Drawing
sheets and view visibility (see page 5-26) .
1
See Exporting dimension elements on page 5-15.
Import errors
Message Meaning
Unable to open The specified IGES file does not
IGES file exist or cannot be opened.
Missing terminator The terminator section was not
section found at the end of the IGES
file. This usually indicates that
the specified file is not a valid
IGES file or is in some way
truncated or corrupted.
Invalid terminator The format of the IGES file’s
section terminator section is not valid.
Export error
Message Meaning
Unable to open The parameter data for the IGES
temporary file file is written to a temporary
file (iges.pds) during translation.
This file could not be created
for some reason.
Message Meaning
Settings version The version for the settings file
mismatch does not match the version of
MicroStation’s IGES translator.
Unable to create The specified path does not exist, a
settings file write-protected file with the same
filename exists, or the file cannot be
created for some other reason.
Unable to add An error occurred when updating
settings to file the settings file. This usually
indicates that the settings file
is write-protected.
Unable to open The specification file does not exist
specification file or could not be opened.
Import warnings
Message Meaning
Parameter type does The entity’s parameter data does
not match directory not match the type specified
record in its directory record. The
entity is ignored.
Invalid Copious A copious data (type 106) entity
Data Format of a form not supported by
MicroStation was encountered.
The entity is ignored.
Unsupported entity An entity type in the IGES file
is not supported and is therefore
omitted from the design file.
String constant These errors are caused by data
broken before that does not conform to the IGES
Hollerith character syntax specification. IGESIN
String field too attempts to infer or ignore the
long Hollerith invalid data. However, missing or
character missing incorrect geometry can result.
for string field No
field delimiter
Message Meaning
Invalid directory type These errors are caused by IGES
Invalid PDS Pointer files that are syntactically correct
in directory record yet contain data that is inconsistent
Invalid directory with the IGES specification. In most
sequence Invalid PDS cases IGESIN omits the erroneous
count in directory entities and continues translating.
record
Invalid line font An invalid line font was
(ignored) encountered. The default line
style is used for the entity.
Subfigure instance An error was encountered extracting
error the subfigure definition for the
specified instance. The instance is
omitted from the design file.
Unsupported conic An unsupported conic form
form was encountered. MicroStation
currently supports all of the
conic forms specified in the IGES
standard (ellipses, hyperbolas
and parabolas).
Invalid hyperbolic A degenerate hyperbola definition
conic was encountered. No geometry
is generated in the design file
for the conic entity.
Invalid parabolic A degenerate parabola definition
conic was encountered. No geometry
is generated in the design file
for the conic entity.
Unable to The conic cannot be reduced to
standardize conic standard form through standard
rotation and translation of axis
techniques. No geometry is
generated in the design file for
the conic entity.
Invalid revolution The axis for a surface of revolution
axis (type 120) was not a valid line
(type 110) entity. No geometry is
generated in the design file for
the surface of revolution.
Message Meaning
Invalid entity pointer An invalid entity pointer was
encountered in the parameter
data for the indicated entity.
The entity is ignored.
Invalid viewing The transformation for a view
transformation entity was not orthonormal. The
view definition is ignored.
Unable to create The specified sheet design file
sheet file: <filename> could not be created because the
specified path does not exist, a
write-protected file exists with the
same filename, or the file cannot
be created for some other reason.
The drawing entity associated
with this sheet is ignored.
Unable to open sheet The sheet seed file specified by the
seed: <filename> MS_SHEETSEED configuration
variable could not be opened
in the directory specified by
MS_SEEDFILES. Either the file
does not exist or read access is not
available. The sheet design file is
created by copying the header or
the model design file rather than
using the sheet seed file.
Invalid weight value An invalid line weight value was
encountered for the indicated
entity. The weight of the entity
is set to zero.
Subfigure The name of the IGES subfigure was
name changed: altered to meet the MicroStation
<Subfigure_Name> requirement of six character
=> <Cell_Name> alphanumeric cell names.
Can’t add cell to This error occurs if the active cell
library library is write-protected.
Message Meaning
Can’t find section A section pattern that is not in
pattern <CODEnn> the “igespats.cel” cell library was
encountered. The section pattern
is ignored. You can correct this by
creating a pattern cell for the section
and adding it to “igespats.cel” with
CODEnn as the cell name (nn is
the section code number).
Unable to open The pattern cell library
pattern cell library “igespats.cel” was not found. This
library is required for sectioned
area entities (type 230). The
configuration variable MS_CELL
is used to locate the cell library.
Be sure that “igespats.cel” exists
and that MS_CELL points to the
directory that it is in.
Unsupported An unsupported associativity form
Associativity Form was encountered. The associativity
entity is ignored.
Element off design The geometry for an IGES entity
plane is not included in the design plane
(volume in 3D) of the design file, and
is therefore omitted. This is usually
means that the working units of the
design file are not appropriate for
the IGES file being imported. This
can be corrected by choosing an
appropriate seed file, adjusting the
working units in the Working Units
dialog box, or setting Translation
Units to Sub-Units or Calculate.
Maximum cell MicroStation supports a maximum
size exceeded, cell size of 65,000 words (1 word
Subfigure dropped = 2 bytes). If an IGES subfigure
to components exceeds this limit, it is placed in the
design file as individual components
rather than as a cell or shared cell.
Message Meaning
No UV Curve in A type 142 (curve on surface)
Curve on Surface entity was encountered with zero
pointer for the UV curve entity.
The curve is ignored. This usually
causes a trim boundary to be
omitted from a surface.
Unsupported Line An invalid form for a Line Font
font definition (304) Definition entity was encountered.
form The font definition is ignored.
Export warnings
Message Meaning
Geometry omitted by Entities were omitted from the
exclusion of Entity: IGES file because the indicated
No./No. entities were excluded and there is
no alternate entity type to represent
it. This usually occurs only if the
copious data (type 106) or point
(type 116) entities are excluded.
Degenerate (zero MicroStation design files can
radius) arc omitted contain zero radius arc or circle
elements. The IGES specification
prohibits these entities and they are
therefore not exported to IGES.
Parser/Verifier
Parser/Verifier is a utility that checks IGES files for conformance to
the IGES standard. It generates reports on entity usage and errors.
CALS conformance testing is optional. Parser/Verifier can greatly
speed the identification and resolution of IGES translation problems.
Parser/Verifier is available for PC, Intergraph Workstation, VAX/VMS,
Sun SPARC, and other platforms from IGES Data Analysis, 2001
North Janice Ave., Melrose Park, IL 60160; phone: (708) 344-1815; fax:
(708) 344-2840. Similar utilities may be available from other vendors.
Import STEP
AP203/AP214
File dialog box
AP203/AP214
Import Settings
dialog box
Export STEP
AP203/AP214
File dialog
box
AP203/AP214
Export
Settings
dialog box
VRML Publisher
VRML Publisher provides translation of MicroStation geometry
to VRML (Virtual Reality Modeling Language), including placing
interactive links between geometry in the VRML world and other
Internet locations or VRML worlds. This enables you to publish
truly interactive worlds, rather than just static geometry.
VRML Publisher includes the following features:
• Texture mapping
• Netscape’s Live3D Extensions (headlight, background
color, background image, etc.)
• Exporting text as VRML ASCII text nodes
• Exporting saved views as VRML cameras (viewpoints)
• Exporting MicroStation Modeler solids directly (without
converting to surfaces manually)
• Exporting VRML worlds
Screen Capture
The Screen Capture utility (scrncapt.ma) is used to make a “screen
shot” of all or part of a MicroStation screen and save it in a
specified file format. It is designed to take snapshots of items in
MicroStation’s or an MDL application’s graphical user interface
— such as tool boxes, dialog boxes, and pull-down menus — for
use in documentation or training manuals.
Screen Capture captures an image at the resolution of the
monitor being used, exactly as it appears on screen, except
that the screen pointer is not shown.
7
Must first be assigned to a function key.
Capture
Screen
Output
dialog box
1
Per pixel.
3
The 24-bit PICT output produced by MicroStation uses direct RGB PixMaps
(described in Inside the Macintosh VI). To use these PICTs on the Macintosh, you
must have either System 7.0 or 32-bit QuickDraw version 1.2 under System 6.0.x.
5
Not recommended for raster output, unless there is no other choice, since
the files are very large and difficult to edit.
6
MicroStation can import, display, or attach as a raster reference file either
compressed or uncompressed TIFF files. When creating an image, choose
TIFF (Compressed) to create a compressed TIFF, which is recommended
if the receiving application can handle compressed TIFFs.
7
Often used as a “wrapper” for other formats such as CCITT-Group 4 Fax.
Unless the image is used with a display that supports 24-bit color or is
printed in color, using either 256 color or grey scale mode saves time
and results in smaller image files with no loss of quality, especially if
the final output is monochrome (for example, this guide).
Clipboard Operations
You can use the Clipboard in the Microsoft Windows environment
to exchange data with other applications.
The image is saved in the design file as a type 87/88 raster element.
4. In the dialog box, select the Audio note format and click Paste.
An outline of the image dynamically displays.
5. Enter a data point to place the audio note in the design (marked
by an icon that looks like a microphone).
The source “.wav” file must be available for the audio note to be played.
The reference to the “.wav” file is user attribute data associated with
the microphone bitmap, a type 87/88 raster element.
As you are sending view objects, you must decide if you want
to send them by linking or embedding.
If you select Picture in the As list box, the view object will not be
editable. You will be able only to resize in the container.
OLE Container
MicroStation allows you to serve view objects to other applications (see
Sending views to other applications on page 5-67); you can also link
or embed objects from other applications into design files.
4. Click Paste.
A second Paste Special dialog box opens.
MicroStation only supports True Type fonts. If the True Type fonts
you are using in your source applications are not currently used in
MicroStation, you may want to install them. Otherwise, MicroStation
substitutes the active font (Element > Text). Because the source
application defines the text by the font it is using, substituting
another font may give undesirable results.
For linked objects, you can also edit the source document by opening
it directly from the source application, without having to open
MicroStation. You can update the linked object by double-clicking
it the next time you open the container design file.
Clipboard data
Microsoft Excel only copies a certain amount of complex data to the
Windows clipboard. MicroStation uses this data to recreate the text
and cells. Unfortunately, there is no way in MicroStation to control this
Windows limitation. To find out when you have reached this limitation:
Page size
Microsoft Excel does not copy horizontal complex data that it thinks is
outside the width of a typical printed sheet of paper. This limitation
is not due to the number of columns, just the physical space. To find
out if this limitation applies to a Microsoft Excel spreadsheet:
2 . Hold down the áShiftñ key and choose Edit > Copy Picture. This
option is only available when holding down the áShiftñ key.
Importing Text
You can create a text file using a word processing, text editing,
or other type of application and import the contents of the
text file into a MicroStation design.
Include Text
File dialog
box
The file can include MicroStation key-in strings to set text attributes
(such as the font, text size, line spacing, and line length). Each
key-in string must follow a period (“.”) that begins a line. One
key-in string is allowed per line. All text following a key-in string is
placed with the specified attribute. Other text placement controls
can be included: INDENT # indents by the specified number of
columns. NEWGG begins a new graphic group.
Key-in: REDFILE ON
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:
• Design Files (as samples or for use as reference files).
• Seed Design Files (see page 6-4) and Seed Sheet Files.
• Cell Libraries (see page 6-6) , including those with
Dimension-driven Cells (see page 6-8) .
• Level Structure Files (see page 6-55) .
• Color Tables (see page 6-61) .
• Line Style Libraries (see page 6-65) .
• Settings Files (see page 6-84) .
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.
8. From the File menu, choose Save Settings to save the settings
and view configuration in the design file.
9. Close the design file.
Cell Libraries
Cell libraries are perhaps the most common type of file assembled
as module data. They contain cells, which are small drawings —
usually of frequently-used or complex symbols.
To create an HTML Web page that displays the contents of a cell library,
use the HTML Author dialog box (Utilities menu > HTML Author).
Bentley\Workspace\projects\proj1\cell\master.cel;Bent-
ley\Workspace\system\cell\p*.cel
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”.
Default
cell library
list for the
sample “arch”
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.
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 6-15) .
Important terminology
The following terms are important for understanding
dimension-driven cell creation:
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.”
Constraints are applied using the tools in the Constraint tool box.
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.
Equation syntax
An equation consists of an algebraic expression (or just a variable),
optionally 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.
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.
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
Arithmetic operators
The following arithmetic operators are available:
Constant Means
pi π
Numbers
Variable names
A variable name can have up to 32 characters, beginning with a letter
or underscore, followed by letters, numbers or underscores, with no
embedded blanks. Variable names are case-sensitive.
Geometric Constraints
tool box (see page 6-32)
Evaluate, modify, and re-solve constraints
for dimension-driven profiles.
Evaluate Constraints
tool box (see page 6-42)
Break or trim constrained geometry,
or
Add fillets and chamfers to constrained
geometry, Modify Constraint tool
or box (see page 6-47)
Modify dimension or variable values.
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.
Tool Effect
Setting
Segment Sets the type of segment being sketched: Line,
Arc by Center, Arc by Edge, Curve.
Tool Effect
Setting
Vertex Sets the type of connection at a vertex.
Sharp—Simple intersection point.
Rounded—Creates an arc.
Chamfered—Creates a chamfer.
Tool Effect
Setting
Con- The following constraints are automatically
straints 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.
Tool Effect
Setting
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.
3. Select the Delete Element tool from the Main tool frame
and delete the existing fixed location constraint.
Key-in: SKETCH
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 on the Settings button.
The Convert Element to Profile dialog box expands to
display a constraints list.
5. Turn on the constraints to be applied.
The Convert Element to Profile tool also works with a selection set.
To Select in the
Parameter
Constraints tool box
Convert an associative dimension
into a constraint.
Convert Dimension
to Constraint (see
page 6-24)
To Select in the
Parameter
Constraints tool box
Assign an equation to a model.
Assign Variable
to Dimensional
Constraint (see
page 6-26)
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.
Equation syntax (see page 6-12) follows the rules of algebra. Built-in
functions and pre-defined constants can be used.
Construct Attached
Line String or Shape
(see page 6-28)
Construct an attached arc.
Construct Attached
Arc (see page 6-29)
Construct an attached ellipse or circle.
Construct Attached
Ellipse or Circle (see
page 6-29)
Attach an element’s location to a
construction or constraint.
Attach Element to
Point (see page 6-30)
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 6-33)
Make a variable a constant or
make a construction invariant (not
recalculated when solving).
Make Construction or
Parameter Invariant
(see page 6-38)
Constrain a point (or the center of a circle
or an ellipse) to lie on a construction.
Constrain Point On
Construction (see
page 6-38)
To Select in the
Geometric
Constraints tool box
Constrain a point to the intersection
of two constructions.
Constrain Point at
Intersection (see
page 6-39)
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 6-40)
Fix the location of a point in the design.
Equate Parameters
or Constructions (see
page 6-41)
Constrain Elements
Used to apply tangent, perpendicular, parallel, or fix
angle constraints to profile geometry.
Tool Effect
Setting
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.
Tool Effect
Setting
Fix Angle (Method set to Smart Constrain Elements only)
Snap Tol- Sets the tolerance for constraining a line or the
erance primary axes of an 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.
Angle (Method set to Fix Angle of Line or Ellipse only)
Lock 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.
Tool Effect
Setting
Convert Converts primary elements to construction elements.
to Con-
struc-
tions
Join Extends primary elements to intersection.
Ends at
Junc-
tions
selecting the fifth icon in the Tool Settings window and set
Angle Lock to Horizontal or Vertical.
Key-in: CONSTRAIN ELEMENT
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 6-43)
To Select in the
Evaluate Constraints
tool box
Modify a dimension-driven profile.
Re-solve Constraints
Used to display where constraints are needed for a parametric
profile drawn with the Sketch Profile tool.
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:
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.
that the solver cannot “pull them back together.” In this case, you can
choose Undo from the Edit menu to negate the changes.
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.
Trim Constrained
Geometry (see page
6-49)
Add a fillet between two constrained
elements.
Fillet Constrained
Geometry (see page
6-49)
Chamfer Constrained
Geometry (see page
6-51)
Change the value of a dimensional
constraint or variable.
Modify Value of
Dimension or Variable
(see page 6-53)
Tool Effect
Setting
Radius Sets the size of the radius for the fillet constraint.
Create A radius dimension will be placed with
Dimen- the fillet, when on.
sions
Con- Sets the constraint name for the fillet constraint.
straint
(dialog
setting)
Tool Effect
Setting
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.
Tool Effect
Setting
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.
Con- • (Method set to Distances) Sets the constraint
straint 1 name for the Distance 1 constraint.
(dialog
• (Method set to Distance and Angle) Sets the
setting)
constraint name for the Distance constraint.
• (Method set to Chamfer Length) Sets the
constraint name for the Length constraint.
Con- • (Method set to Distances) Sets the constraint
straint 2 name for the Distance 2 constraint.
(dialog
• (Method set to Distance and Angle) Sets the
setting)
constraint name for the Angle constraint.
Tool Effect
Setting
Param- Sets the value of the variable or dimensional
eter constraint.
Dimension-Driven
Design dialog
box
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.
Level Names
dialog box
showing
the level
structure
“aiaarch.lvl,”
part of which
is shown
in the table
below.
When you create your own level structure, you can group individual
levels and groups of levels hierarchically for easy manipulation.
It is easiest to map out all hierarchical groups before defining the level
structure. MicroStation lets you define the level structure by adding
new levels and groups to existing groups. Therefore, you must create
the highest-level groups first, then create lower-level groups within
those groups, and, last, assign individual levels to existing groups.
Level names and groups are settings that must be saved; choose
Save Settings from the application window’s File menu. If you do
not save settings (or save the level structure in a separate file),
when you close the design file, the level structure is lost.
Level Group
dialog box
To remove a group
1. From the Level Names dialog box’s Display menu,
choose Group Operations.
A “tree” of the group structure is shown in the Group list box.
2. In the Group list box, select the name of the desired group.
3. Click the Delete button.
An alert box is displayed, warning you that deleting the level
group deletes all sub-groups and level names within it.
4. In the alert box, click the OK button.
Level Names
dialog box
with controls
for level
operations.
Select Target
Group dialog
box
2. In the Name field, key in a name for the level structure file.
3. Click the OK button.
Color Tables
An element’s color attribute is stored with the element in the design
file as a number in the range 0-254. The design file color table
determines the correspondence between the 255 color attribute
values and display colors. For example, if according to the design
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 design file. If a design file has a color
table attached, the color table is opened (and its colors used to display
elements) each time the design file is opened. Color tables can be
customized and saved in color table files for subsequent attachment to
multiple design files. (See Customizing a Color Table on page 6-62.)
If a design 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.
Balanced colors
MicroStation uses balanced colors to represent colors in the
design file. Balanced colors are a representative spread of colors,
evenly spaced across the color spectrum. Colors of elements in
the design file are mapped to the colors that the hardware can
display using a “closest match” algorithm.
Color Table
dialog box
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 Design File 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
1. From the Edit menu in the Color Table dialog box,
choose Interpolate Colors.
The Color Interpolation dialog box opens.
2. Use the controls in the Modify Color dialog box to adjust the color.
3. When done, click the OK button.
Manage
Line Style
Definitions
dialog box
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.
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.
Stroke attributes
The following are stroke attributes:
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.
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.
Line Style
Editor dialog
box
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 Create
Design File and Open Design File 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:
Controls for
working with
stroke pattern
components
in Line Style
Editor dialog
box
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.
Dash Caps
(from top):
Arc, Closed,
Extended,
Hexagon,
Open
Corners:
Break,
Bypass
Width: Full,
Left
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.
Effect of Shift
settings based
on dash and
gap at top:
Distance =
0.0 (top);
Distance =
0.2 (center);
Fraction =
0.5 (bottom)
9. From the File menu in the Line Style Editor dialog box, choose Save.
Base Stroke
Pattern
dialog box
Select Point
Symbol dialog box
11. From the File menu in the Line Style Editor dialog box, choose Save.
Controls for
working with
Compound
components
in Line Style
Editor dialog
box
Select
Component
dialog box
9. 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 design file. This
name is used to obtain the resource type and ID of each line style
Settings Files
Of all the types of module data, settings files (“.stg” files)
affect the broadest range of MicroStation operations and
are most dependent on your organization’s design standards
and specifics of individual projects.
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’s Guide.
Edit Settings
dialog box
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.
You can also create settings files from settings group specifications
stored in text files using the ASCII Group utility.
Edit Scale
dialog box
Edit Work
Units Group
dialog box
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.
Modify
component
dialog box
(Linear
component
type)
3. Turn on the check boxes in the Size and Spacing section for
the active text settings that you want to be automatically
adjusted when the component is selected.
Select Dimension
Definition dialog
box
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 6-88, steps 2 and 8.)
3 Actually, a Cell component or an Active Point or Area Pattern component that specifies a cell.
Scale section of
the Modify Cell
component dialog
box
Edit Dimension
Styles dialog box
Edit Multi-line
Styles dialog box
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.
• Design files
• Reference files
• Raster Reference files
• Cell libraries
• Background files (raster images)
• Resource files (fonts, line styles, etc.)
• Material tables
• Material tool boxes
• Materials
• Pattern files
• Bump Map files
• Current workspace files
• All configuration files
• All user interface files
In addition, you can create your own classes to hold additional
resource files such as plotter configuration files, tag templates,
and even non-MicroStation files.
For the current design file, all the resources used are listed by class
(in the Select Archive Classes dialog box’s Class list box). As you
select a resource class, the specific files of that class which are
currently in use are displayed in the Item list box.
For those situations when you may not want to create a compressed
archive file, the Archive utility can be directed to copy the various
resource files into a directory of your own choosing.
Archive
dialog box
4. Click OK.
13. Once all of the classes have been selected, from the Method
option menu, choose Create Archive File.
14. Click OK.
The archive process begins. A progress indicator is displayed
showing the name of the file being processed, as well as the
progress of the entire archive process.
When complete, the added files are displayed in the
Archive dialog box’s list box.
Digital Signatures
A digital signature determines if a document is identical to
the document that was signed and shows the identity of the
signer. Signatures are stored with a compressed copy of the
file inside the archive. A document with a good signature
has the following qualities; it is:
A digital signature does not keep the document from being modified.
It does not lock the document, and it does not prevent others from
signing the document, either modified or unmodified.
• Engineer A signs the file, then sends the file with the signature.
• Engineer B verifies the signature, inspects the file and adds her
signature, then sends the file back to engineer A.
• Engineer A verifies engineer B’s signature, which
verifies the original file.
Key pairs
The encryption tools used for digital signatures use two keys known
as key pairs (large numbers that satisfy certain mathematical
relationships). One is used to encrypt a hash of the document
(the private key), and the other is used to decrypt the signature
to verify the signature (the public key). The public key can be
freely distributed for other encryption needs.
Load Key
Pair dialog
box
2. Click Create.
The Create Key Pair dialog box opens.
Create Key
Pair dialog
box
If you select a file in the Archive dialog box’s list box before you
create the key pair, clicking OK in the Create Key Pair dialog box
signs the selected file in addition to creating the key pair.
Signing Documents
Only the owner of the private key can create a signature that works
with his public key. The signature contains an encrypted hash of
the document, the name of the key pair, the public key, and the
time and date of signing. Certificates (the public key and related
text information) are also stored in the archive.
To sign a file
1. In the Archive dialog box’s list box, select the file(s) you want to sign.
If no files are selected, all files in the list box will be signed.
2. Click the Sign Files icon.
The Load Key Pair dialog box opens.
3. Select a key pair from the Key Pair Name List list box.
or
Click Browse to open the Find Key Pair file dialog box.
Select a key pair and click OK.
4. In the Load Key Pair dialog box, type the password for the
selected key pair in the Password text field.
5. Click OK.
The file is signed and the Signing and Verification
Results text window displays.
Verifying Documents
Anyone can verify a signature by using the public key that is in the
signature. All you need is a file to verify and a signature for that file.
The encrypted hash from the signature is decrypted using the public
key from the signature. A second hash is obtained by hashing the file.
If the two hashes are equal, then the signature is valid.
To verify a file
1. In the Archive dialog box’s list box, select the file(s)
you want to verify.
If no files are selected, all files in the list box will be verified.
2. Click the Verify Files icon.
The Signing and Verification Results text window displays.
Updating files
Save Archive
File As dialog
box
• If the Archive dialog box is open but empty and you drag
non-archived files from Windows Explorer into the dialog box,
the Archive utility interprets this as a command to create
an archive file. After adding the file(s) and selecting the
files’ archive classes in the appropriate dialog boxes, you are
prompted to name the archive file. Once archived, the files
are listed in the Archive dialog box’s list box and the name
of the archive file appears in the title bar.
• If the Archive dialog box is open but not empty and you
drag non-archived files from Windows Explorer into the
dialog box, the Archive utility behaves the same as in the
All but the first option listed here also launches your
default Web browser.
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 7-2)
Create an Internet tag and attach
it to an element.
Attach Engineering
Link (see page 7-3)
Send the browser to the Web page
specified by the Internet tag attached
to an element.
Following Engineering
Link (see page 7-5)
ConnectMicroStation to or disconnect it
from your default Web browser.
Connect to/Disconnect
from Browser (see
page 7-5)
Maintain local copies of remote
reference files.
Tool Effect
Setting
Link Sets the type of link you are creating: HTML or XML.
Type 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.
Tool Effect
Setting
Role (Enabled when Link Type is Xlink:simple) Specifies
what role the object of the link will specify, for
example, that of a reference file 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.
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 tool again to refresh the address in the URL field.
Load RefAgent
Opens the Reference File Agent dialog box, which is used to
maintain local copies of remote reference files.
Reference File
Agent dialog
box
Remote Open/Attach
The Remote Open/Attach function allows you to select a URL as a
design file location instead of a specific local design file. URLs can
also be attached to a remote settings file, archive, reference file, 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:
• Selecting a bookmark
• 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:
Key-in Scripts
The simplest software applications are key-in scripts. A key-in
script is a sequence of MicroStation key-ins that is stored in
a text file. For example, the following script sets the Active
Level, Active Color, and Active Line Weight:
active level 24
active color blue
active weight 2
Macros
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.
Running macros
You can load, run and edit a macro using the Macros
dialog box or a key-in.
Macros
dialog box
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 4-1.
User Commands
User commands (UCMs) are programs that follow the logic and
syntax of the UCM language. Sample UCMs are installed in
Bentley’s “Workspace\system\ucm” directory.
To activate a UCM
1. In the Key-in window, key in USERCOMMAND <ucm>
or
UC= <ucm>
UCM is the UCM file. If the extension is omitted,
“.ucm” is assumed.
Indexed UCMs
A user command (UCM) index file is a text file that contains an
indexed list of up to 999 UCMs. Indexed UCMs can be activated by
index number as well as by name. UCM index files can be created and
edited with the Edit User Command Index File dialog box.
Before you can use an indexed list, you must activate the
UCM index file containing the list.
Edit User
Command
Index File
dialog box
3. Select a file in the list box and click OK. The UCM index
file is not automatically active.
4. Click the Append button to add an entry for each
UCM to index to the list.
5. Save the list in a UCM index file:
To make a new file, in the Edit User Command Index
File dialog box, choose File > Save As. Then specify the
new name and destination of the UCM index file in the
Save UCM Index File dialog box.
To overwrite an existing file, click Save in the Edit User
Command Index File dialog box.
If you save the list to a different UCM index file, that file
is opened for editing. However, UCMs in the list cannot be
activated by index number until the file is activated with
the ACTIVE INDEX (OX=) key-in.
To delete an entry
1. Select the entry.
2. Click the Delete button.
The index number of each entry that was after the
deleted entry is reduced.
MDL dialog
box
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.
Configuration
Variables
dialog box
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.
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
RIS and ODBC are not relational databases; they are generic
interfaces that allow advanced design applications to access
SQL compliant databases.
Database Server
The MicroStation database interface software program for a particular
database package — for example, Oracle — is sometimes called the
database server. The 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:
• Different databases can be used by “plugging in” different servers.
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.
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.
Oracle, Sybase, and RIS are all client server databases. Here the
database engine runs on the server. It receives requests from
client software on each user’s system. A request is 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.
• Will you access the data from different types of systems (for
example, a mix of workstations running Windows NT)?
Oracle
Oracle, by Oracle Corporation, is a very popular database
based on the client-server model.
Product descriptions
These Oracle products are of interest to the MicroStation user:
Product Description
Oracle (base The core of the relational database
product) management system. It includes
features that control data storage,
retrieval, and security.
Oracle
development
tools
Oracle Tools for developing and running
SQL*Forms forms-oriented applications with Oracle.
Oracle A non-procedural application
SQL*Re- development tool advanced report
portWriter generation with pop-up menus and
powerful formatting capabilities.
Oracle A fourth-generation menu development
SQL*Menu tool that provides a common front end to
both Oracle and non-Oracle applications.
Oracle Pro*C Lets developers embed database
manipulation statements into
their applications.
Product Description
Oracle Lets database tables from other sources
SQL*Loader be loaded into Oracle. This tool, used
in conjunction with Oracle’s DB3PREP,
makes it very easy to convert dBASE
III Plus database files to Oracle format.
These tools make it practical to use Xbase
as a prototype development platform for
more complex Oracle applications.
Oracle
database tools
Oracle Provides an interactive interface to
SQL*Plus Oracle with facilities for ad hoc queries
and database manipulations.
Oracle
Network tools
SQL*Net Lets MicroStation access remote Oracle
databases over a network.
Oracle Client
Software
Required MicroStation database server interacts
Support Files with these files to connect to a
remote server.
Sybase database
Sybase, by Sybase, Inc., is based on the client-server model as well.
Product Description
System X or XI Core relational database engine
Open Client Client software for accessing Sybase
SQL Server System X or XI
ISQL Interactive interface for submitting SQL
statements to Sybase SQL Server
This product does not include ODBC drivers for the supported
databases. The user must purchase Intersolv ODBC driver(s) for the
MicroStation ODBC server to function correctly, or you may download
Microsoft drivers from the Microsoft link on the ODBC technote
available on Bentley’s website. This release is only supported for
configurations that follow the above requirements. No databases other
than those listed above have been certified for this release.
RIS
RIS (Relational Interface System) is an Intergraph product. It allows
an application to access a number of different database engines
(including Oracle, INFORMIX) through a common interface. The
application communicates with RIS, and RIS provides the necessary
translation to the protocol understood by the underlying database
engine. This allows applications written for RIS to switch between
different commercial databases without modifying their source code.
The RIS user interface is independent of the connected database.
RIS tools
RIS has a complete set of tools to create and manage databases,
formulate queries, and generate reports.
Product Description
RIS Client needed to run RIS-based applications
and Runtime
Package
RIS needed only by developers creating
Development RIS-based applications.
Platform
RIS Utilities for performing tasks such as schema
(optional) management, ad hoc queries, and
bulk loading of data.
RIS Report allows for writing reports and editing
Writer relational databases. It automates,
standardizes, and simplifies network
reporting. Built on I/FORMS,
Intergraph’s standard graphics
interface, RIS Report Writer lets you
pick functions and values from a menu
to generate SQL commands. Any
non-programmer can quickly learn to
write reports and edit databases.
Connecting to ODBC
ODBC uses a data source to maintain the connection information
for a database. MicroStation uses an 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.
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
“c:\Bentley\Program\MicroStation\database\
odbc\examples\access\gis.mdb”.
Xbase Provide the database directory (the directory
that contains the .dbf and index files.
“Locking” is the level of locking on a dbf
file. The locking field should be set to “File”.
This will ensure that, with multiple users,
active entities will not collide. If your index
files are the same name as your dbf files,
you do not have to click the Define button to
associate the index file to the dbf.
The delivered Dbase IV gis example is
“c:\Bentley\Program\MicroStation\database\
odbc\examples\db4\”. The
delivered FoxPro gis example is
“c:\Bentley\program\MicroStation\database\
odbc\examples\foxpro\”.
Database Action
Oracle Provide the server name, then from the
Advanced tab, the default user name.
‘Server Name’ is the Oracle remote
connection string. If you are connecting
remotely to an Oracle server, enter the
Oracle remote connection string, i.e.,
<username>/<password>@database_alias.
Database alias is the alias created in the Oracle
SQL Net or Net 8 Easy Configuration utility.
If the database is local, leave this field blank.
The DSN (Data Source Name) must be
defined in the ODBC Data Source. The
Server and User ID can also be defined
in the ODBC Data Source; the password
cannot. The password can however be set
as an MS_ODBCPARAMS variable.
Sybase Provide the server name and database
name on the General tab. Provide the
default login name on the Connection tab.
Sybase is case sensitive.
“Server Name” is the server name listed
in the sql.ini file.
dBASE notes
File names cannot be more than eight characters. MSCATLOG
is the name of the mscatalog under the ODBC Xbase interface.
active entity cannot be inserted into a table unless the create table
statement defined the no value column with the NULL option.
The user may alter the default behavior on NULLs in SQLServer
through the SQL Enterprise Manager. The default NULL
setting may be changed by editing the selected database, and
selecting the options tab. The Columns Null by Default check
box may then be set to the desired setting.
The user can also change this value through an SQL stored
procedure. The user must log into the SA account, or be the
owner of the database, and enter the following:
Connecting to Oracle
This section covers how to set up an Oracle database for
use with MicroStation.
Windows Notes
For the batch files loadnt and loadwin to run correctly, the Oracle
7 or Oracle 8 Utilities must be installed.
For Windows 95, search for a file named sqlpad.exe. located in the
“\orawin\bin” directory in the Oracle Utilities software.
Connecting to Sybase
This section covers how to set up a Sybase database for use with
MicroStation. For general information on the Sybase product
family, see Sybase database on page 11-9.
To set up Sybase
1. Start the Sybase server.
2. Modify the supplied mscat.sql file to reflect the correct
database name. (It is delivered as “gis.”)
Connecting to RIS
This section covers how to set up RIS for use with MicroStation.
MS_LINKTYPE
Linkages between design elements and the database can
be of any of the following types:
• ORACLE
• ODBC
• RIS
• SYBASE
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 all types of linkages.
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.
The Visual SQL Query Builder is the default database query tool and
is available when Settings > Database > Query Builder is chosen.
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.
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.
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.
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 will be very useful for visually generating table
joins. The following appears in the SQL Select Statement text box:
SELECT
FROM parcel
FROM parcel
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.
FROM Parcel
FROM Parcel
7. Click the Execute button to review the results based on this query.
If Output > Form is turned on, 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.
To delete the join, click on one of the join graphic nodes, and press Delete.
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
To edit any of the Where clauses, click on 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.
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
FROM parcel
11. To add the OrderBy clause, click the OrderBy tab page.
The OrderBy tab page opens.
FROM parcel
ORDER BY parc_area
Clicking the Review button from the created form allows you to
view a database record linked to an element that you identify on
the screen. Alternatively, if a form is not created, the key-in VSQL
REVIEW automatically generates a form for you.
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.
The Query text field is present because Query Multiline was turned
on in the Standard Form Items dialog box.
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.
2 . In the maps table, you must add a entry for every design file
containing linked graphics and assign that map an mslink number.
In the attribute table, you must add the mslink number that you have
assigned to the map to every row that is linked to graphics in the map.
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 saved in another directory, the full path to
the form must be provided in the key-in.
To save a form dialog, its SQL query must be in the Visual SQL
Query Builder dialog box’s SQL Select Statement text box.
Using SQL
SQL statements can be used to interactively query a database
directly from within MicroStation.
SQL statements
The following sections contain descriptions of some of the more
powerful SQL statements that are supported by the database interface.
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.
So the following SELECT statement would be valid for ODBC:
SELECT
SELECT á* | <column_name_listñ FROM table WHERE
<condition_list>
UPDATE
UPDATE <table> SET <assignment-list>
DELETE
DELETE FROM <table> [WHERE <condition_list>]
INSERT
INSERT INTO table <column_name_list> VALUES <expression_list>
CREATE TABLE
CREATE TABLE table <column_name_type_list>
DROP
CREATE DATABASE
CREATE DATABASE <database_name>
COMMIT
ROLLBACK
Used to undo all statements to the last commit point. See
SESSION AUTOCOMMIT [OFF|ON] .
CONNECT
Used to connect to an Oracle database. Either key in DB= or use
Settings > Database > Setup as described in Database Setup dialog box .
DISCONNECT
RELOAD
The user can also enter SQL commands preceded by the pipe
symbol “|”in the MicroStation key-in window.
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.”
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.
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 value area
num-
ber
1 119-LA 220 BRIDGE- 9000 16,036
9 WATER
RD
14 119-LB 8717 KILDARE 7200 16,668
36 DR
15 119-LB 8713 KILDARE 9000 16,306
35 DR
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 a special
table that tells MicroStation information about the database tables
available. It is opened every time you connect to a database and
contains a row for each table that is linked to the design. There
is only one MSCATALOG table for each database.
mscatalog structure
The MSCATALOG table has the following structure:
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
screenform column
The screenform column in the MSCATALOG row for a particular table
specifies the default screen form, used in conjunction with the Review
Database Attributes of Element tool, to review the database attributes
of elements linked to rows in the table. If the optional formtable column
(see page 13-34) exists in MSCATALOG, that column is examined to
attempt to locate a screen 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
fencefilter column
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.
dastable column
The dastable column in the MSCATALOG row for a particular
table specifies the displayable attributes table that is used to
determine which attributes of elements linked to rows in the
table display in displayable attribute text nodes and whether
screen forms are used to display the attributes.
formtable column
The optional formtable column in the MSCATALOG row for a
particular table specifies the forms table that is used to locate
screen forms for reviewing and editing database attributes of
elements linked to rows in the table.
When you use the Review Database Attributes of Element tool, if Forms
is set to Text screen, the screen form is located by first looking at the
formtable column in MSCATALOG form for the appropriate table. If a
form table is specified and it exists, its contents are searched for the
name of the form to use. If a form name is found for the table for the
current linkage and its type is review, this form is used.
VSQL forms may be saved and the name entered in the formtable
column. When forms are set to text screen (Settings menu > Database
> Dialog), the VSQL saved form will open instead of the SQL Window
when the Review Database Attributes tool is used.
(’<table_name>’,<entity_number>,’<screen_form>’,
’<report_table_name>’).
If using the first syntax, all columns must be inserted; notice
that the last four values are blank.
2. In the SQL Window, submit: RELOAD
This will refresh the MSCATALOG.
For example, to insert a row into MSCATALOG for the sample
assessor table, you might submit (for step 1):
If using the above method, you must reload the database manually
(key in RELOAD) for changes to take effect.
Database Tools
The tool box is operated in the same manner as tool boxes that
contain MicroStation’s drawing tools.
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.
To create a Linkage(s)
1. Define the Active Entity (see Defining the Active
Entity on page 13-39.)
2. In the Database dialog box, set Linkage Mode (see Setting Linkage
Mode on page 13-41.) Use the Attach Active Entity tool to attach
an element(s) to the row designated as 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:
2. From the Linkage Mode option menu, choose the desired mode
— None, New, Information, or Duplicate.
Oracle Notes
This section pertains specifically to using the Oracle database interface.
RIS Notes
This section pertains specifically to using the RIS database interface.
This approach eliminates the need to lock the table, get the
maximum mslink value, insert the record, and unlock the table
(hence, ending the transaction in which the lock was issued). This
approach may also be faster than some max (mslink) operations
on some relational databases, although with proper indexing most
databases perform such operations fairly quickly.
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 screen forms designed with the database software.
This is the default for any sqlreview column with a NULL value.
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.
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.
Detaching Linkages
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.
Database
Linkages
dialog box
Report Tables
Database report output from MicroStation can either be plots of a
design with report information highlighted or report tables.
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.
Naming
Before a report table can be generated, its name must be specified
in the reporttable column of the MSCATALOG table.
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 with the selected elements.
Oracle
Oracle supports report writing both from within the SQL*Plus
interface and with a sophisticated report writing package,
SQL*ReportWriter. 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.