promis•e
®V8i
User Guide
Trademark Notices
promis•e, Bentley and MicroStation are registered or licensed trademarks of Bentley Systems, Inc.
PLC, PLC-2, PLC-3, and PLC-5 are registered trademarks of Allen–Bradley Company, Inc. SLC and SLC 500 are trademarks of Allen–Bradley Company, Inc.
AutoCAD and AutoCAD LT are registered trademarks of Autodesk, Inc.
Microsoft, MS-DOS, and Windows are registered trademarks, and Windows NT is a trademark of the Microsoft Corporation.
All other trademarks are the property of their respective holders and are hereby acknowledged. Cover Photo of Helix Nebula courtesy of NASA and STScI.
Important User Information
This Bentley Systems product is warranted in accord with the product license. The product’s performance will be affected by system configuration, the application being performed, operator control and other related factors.
The product’s implementation may vary among users.
This manual is as up-to-date as possible at the time of printing; however, the accompanying software may have changed since that time. Bentley Systems reserves the right to change any information contained in this manual or the software at any time without prior notice. The instructions in this manual do not claim to cover all the details of variations in the equipment, procedure, or process described, nor to provide directions for meeting every possible contingency during installation, operation, or maintenance.
Technical Support:
Bentley Systems provides technical support to promis•e users currently under warranty or support contracts. Technical Support is available Monday through Friday from 8 am to 5 pm Central Standard Time.
Phone (800) 778-4277
When you call, please have available your software revision number and a brief description of your problem.
Table of Contents
Table of Contents . . . 5
Downloading the Software . . . 13
Installation . . . 13
Starting promis•e . . . 14
Activating the Software License . . . 16
License Activation Procedure . . . 17
Checking Out a License . . . 21
Introduction and Overview . . . 25
The promis•e Concept . . . 25
Software Functionality . . . 26
Using promis•e . . . 27
Using This Manual . . . 28
Purpose . . . 28
Manual Conventions . . . 28
Menus . . . 29
Toolbars . . . 38
Command Line / Text Window . . . 40
Help Screens and User Guide . . . 41
Dialog Boxes . . . 42
Engineering Design Considerations . . . 43
Sample Projects . . . 43
Project Management . . . 45
Project Organization . . . 46
Drawing Sets . . . 47
Installations and Locations . . . 48
Project Manager . . . 49
Favorites Project Folder . . . 54
Balloon Settings . . . 69
Default Grid Settings . . . 70
Default Project Properties . . . 71
Display Formats . . . 74
Display Languages . . . 84
Drawing Standards . . . 86
PLC . . . 88
Region Settings . . . 90
Revision Control . . . 91
Text Settings . . . 98
Wiring Diagram Settings . . . 100
Wire Options . . . 105
Project Backup / Restore . . . 115
Make a Backup . . . 115
Restore a Backup . . . 116
Rebuild Project Database . . . 117
Migration Wizard . . . 118
Starting the Migration Wizard . . . 118
Migrate from Legacy promis•e . . . 119
Migrate from Version 2.0 . . . 133
Migrate Catalog from AutoCAD to MicroStation Version . . . 137
Data Data Manager . . . 139
BOM Explorer . . . 142
BOM Explorer - Edit Parts Data in Existing Project . . . 144
BOM Explorer - Assign Parts Data to New Project . . . 145
BOM Explorer - Using the Parts List . . . 150
Page Management . . . 151
Page Organization . . . 152
Page Storage . . . 154
Displaying Pages . . . 155
Open Page . . . 155
Close Page . . . 156
Next Page, Previous Page . . . 156
Rename Page . . . 170
Move Page . . . 171
Clear Page . . . 174
Refresh Page . . . 175
Update Page . . . 175
Validate Page . . . 175
Viewing Pages . . . 176
Navigate Function . . . 178
Search Tool . . . 180
Page Format Designer . . . 183
Using Drawing Elements . . . 195
Overview . . . 195
Drawing Modes . . . 196
Lines vs. Wires . . . 197
Wires . . . 198
To Draw a Single Wire: . . . 201
To Draw Continuous Wires or Lines: . . . 203
To Draw 3-Phase Wires: . . . 204
To Draw Wires Using 90 Degree Up / Down: . . . 206
Wire Connector Type . . . 206
Draw Ladder . . . 207
Wire Stretch . . . 208
Edit Wire . . . 210
Wire Layers . . . 213
Insert Symbol . . . 214
Insert Symbol by Name . . . 215
Insert Symbol by Part Number . . . 217
Insert Symbol By Device ID . . . 219
Device ID Assignment . . . 221
Single Line Text . . . 248
Multiline Text . . . 249
Editing Text . . . 250
Language Text . . . 250
Cables . . . 254
Assigning Wires to a Cable . . . 254
Cable Cross Reference Symbols . . . 260
Cable Manager . . . 261
Field . . . 262
Wire Link Cross References . . . 266
Types of Wire Links . . . 268
Wire Link Index . . . 269
Placing a Wire Link Symbol . . . 271
Search and Link Function . . . 272
Wire Link Notation Configuration . . . 274
Re-sequence Wire Link Function . . . 274
Wire/Device Connections . . . 276
Connection Search Priorities . . . 276
Wire Numbers . . . 281
Wire Number Format . . . 281
Automatic Wire Number Assignment . . . 281
Manual Wire Number Assignment . . . 286
Modify Wire Number . . . 287
Delete Wire Numbers . . . 288
Find and Replace Wire Properties . . . 290
Align Wire Numbers . . . 293
Part Numbers . . . 294
Drawing Mode Manager . . . 299
Edit an Existing Drawing Mode . . . 299
Create a New Mode . . . 300
Rename a Mode . . . 301
Edit Drawing Elements . . . 302
Delete (Erase) Drawing Elements . . . 302
Copy Drawing Elements . . . 302
Replace Page Format . . . 313
Align Components . . . 314
Edit Components . . . 316
Wiring Diagrams . . . 317
Wiring Diagram Symbols vs. Wiring Diagram Charts . . . 318
Create Wiring Diagram . . . 319
Creating Drawing Elements . . . 321
Managing Symbols and Symbol Catalogs . . . 321
Symbol Catalogs and Directories . . . 321
Catalog Manager . . . 321
Create Symbols . . . 331
Symbol Elements . . . 331
Symbol Creation Procedure . . . 333
Modify an Existing Symbol . . . 350
Creating an Example PLC Parent Symbol . . . 351
Create Wiring Diagram Symbol . . . 360
Create Panel Layout Symbol . . . 375
Create Macro . . . 385
Macro Creation Procedure . . . 385
Create Title Block Macro . . . 387
Create Family . . . 396
Modify Family . . . 404
Options . . . 407
promis•e Setup . . . 407
System Options . . . 418
Command Protection . . . 418
Symbol Texts . . . 422
User Options . . . 423
Language On Dialogs . . . 423
Startup Interface . . . 424
Plot Current Page (MircroStation Version) . . . 435
Project Publisher . . . 437
Starting Project Publisher . . . 438
File Manager . . . 439
Manage External File Links . . . 440
Configure Publisher - Format . . . 443
Configure Publisher - Outputs . . . 452
Publish - Create Package . . . 455
Reports . . . 457
Generate Reports Function . . . 457
Selecting and running a report . . . 458
Select the output type . . . 459
Sorting report contents . . . 460
Filtering report contents . . . 461
Report Options . . . 462
Creating a Report Output Configuration File . . . 463
Compile Connection Information function . . . 464
Standard Reports . . . 465
Report Template Designer . . . 466
Report Template Designer Toolbars . . . 474
Report Template Designer Controls (Toolbox) . . . 474
Report Configuration Examples . . . 475
Engineering Design Considerations Report . . . 482
Graphical Parts List . . . 484
Create page macro . . . 485
Create graphical parts list macro and cross reference macro . . 485
Edit parts database . . . 488
Run the Graphical Parts List . . . 489
Forced Routing Manager . . . 491
Arrangement View tab . . . 492
Wire List View tab . . . 498
Split View tab . . . 501
Import Legacy Connection List . . . 501
Terminal Editing Functions . . . 516
Graphical Terminal Plan . . . 531
Graphical Terminal Plan Generation . . . 532
How the software generates a graphical plan . . . 535
Graphical Plan Template Designer . . . 537
Graphical Plan Variables . . . 541
Panel Layout and Wire Routing . . . 543
Overview . . . 543
Create Panel Layout First . . . 544
Create Panel Layout Later . . . 545
Balloons . . . 551
Create Balloons . . . 551
Assign Balloon Number in Device Properties Dialog . . . 553
Modify or Delete Balloons . . . 554
Set Balloon Appearance . . . 554
Clear All Balloons . . . 554
Panel Layout Design Functions . . . 555
Insert DIN Rail . . . 555
Snap to DIN Rail . . . 558
Mounting Accessories Function . . . 558
Panduit Wire Containment Tools . . . 560
Panduit Wire Containment . . . 560
Panduit Auto Size-Space . . . 571
Configuration File Formats . . . 575
Gauge Table Editor . . . 576
Shortest Distance Routing . . . 579
Shortest Distance Procedure - Standard Method . . . 580
Shortest Distance Procedure - Wiring Rules Method . . . 594
Direct Wiring (Wiring Rules Method) . . . 600
Parts Database Editor Functions . . . 634
Structure of a promis•e parts database Data Record . . . 640
Panduit Part Selection . . . 642
Project API Builder . . . 653
Project API Command File Format . . . 654
Legacy File Format . . . 654
Standard File Format . . . 654
Available Functions . . . 655
Running the Project API Builder . . . 662
Appendices
Engineering Design Considerations . . . 663
Wiring Rules XML File . . . 671
Structure of Wiring Rules File . . . 671
How to define a new rule set . . . 673
Defining Panels . . . 673
Defining Available Terminals For Wiring . . . 674
Defining Rules . . . 675
Specifying Direct Wire Connections . . . 678
Shipping Splits . . . 678
Section and Compartment ID Format in EctRway.xml . . . 680
ProjectWise Plug-in . . . 683
Using ProjectWise with promis•e . . . 684
Logging in . . . 684
Creating new projects . . . 684
Checking in a project . . . 685
Checking out a project . . . 687
Copy In . . . 688
Copy Out . . . 688
Setup . . . 688
Plant Exchange Plug-in . . . 695
Importing Data from Plant . . . 696
1
Installation and Start-up
Downloading the Software
After you purchase the software, you will be sent instructions for logging on to the Bentley web site and downloading the software.
You will have the choice of downloading an executable installation file to your computer or having the files burned to CD and shipped to you.
After installing promis•e you will need to run the software and activate your license (does not apply to evaluation systems).
Installation
To install the software, follow the instructions in the promis•e Installation Guide. Most of the program files for promis•e are installed by default in the Program Files\Bentley\promis-e directory.
Symbols, drawing templates and configurations files for promis•e are stored by default in the directory promis-e Data.
Starting promis•e
Use this procedure to start promis•e.
1. In Windows you can run promis•e from the Start button menu or, if you have created an icon (shortcut) for promis•e on the desktop, you can double click on the icon.
2. The software will start and the following promis•e welcome dialog will be displayed.
This screen allows you to choose a variety of functions:
To restore sample projects, select the Restore Sample Projects link. This will give you a variety of drawings to look at or edit.
To access the promis•e Setup function (see page 407), select the Setup link. For information about the software, go to the Getting Started section of the dialog and select:
• ANSI-IEEE or IEC Tutorial - for a product tutorial
• User Manual - to access the User Guide
• Product Videos - To see a Web page with videos of the product in use
Note: If you prefer, you can set the software to start in the Project Manager rather than in the Welcome dialog. Use the Startup Interface function in the Options dialog to make this setting (see page 424).
Activating the Software License
Product activation is the act of authenticating a product for entitled use. promis•e uses SELECT Server licensing, which is Bentley’s system for organizing and managing software licenses. SELECT Server offers many advantages including pooled licensing, license usage reports, and flexibility in how license servers are deployed.
V8 XM Edition applications, including promis•e, are equipped by default with three behavioral states - Evaluation, Activated, and Deactivated.
The Evaluation period (also called the Pre-Activated period) begins with installation and ends after 30 days or with Activation, which ever comes first. During this Evaluation period, most applications run in full-functioning mode, with no limitations applied to their activated state.
An application is Activated when it is licensed, which is most commonly achieved by connecting to a valid SELECT Server. An application can return to Evaluation mode if its licensing server cannot be found. In this case, the Evaluation period begins again, providing a 30-day window during which to resolve any unintended disconnection.
An application will reach its Deactivated state only when the Evaluation period has lapsed and the product has not been activated. In its Deactivated state, promis•e will not run.
License Activation Procedure
Use the following procedure to activate the software: 1. After installing promis•e, start it (see page 14).
2. Select Manage > License Manager to display the Product Activation Wizard:
You have the following choices:
• SELECT subscriber activating against a hosted (Bentley) SELECT Server - Select this option if your licenses will be stored on a server at Bentley. Select Next and go to step 3.
• SELECT subscriber with a deployed (local) SELECT Server - Select this option if your licenses will be stored on a server at your site. Select Next and go to step 3.
3. If you selected either of the SELECT Subscriber options, the following dialog will appear and prompt you for a server name and a site activation key.
If you selected the hosted (Bentley) server option in the previous step, you will see the entry selectserver.bentley.com in the Server Name field as shown above, and the field will be grayed out.
If you selected the deployed (local) server option in the previous step, enter the name of your SELECT server in the Server Name field.
If you selected NON-SELECT user in the previous step, you will see the entry productactivation.bentley.com in the Server Name field, and the field will be grayed out.
The key is sent from Bentley in the form of a fulfillment document to the site administrator. The site administrator may then distribute the key at his/her discretion. The user just needs to simply copy and paste the key (an alpha-numeric code) into the space provided in the activation dialog.
4. If you selected NON-SELECT User in the first step, the following dialog will appear.
A. Select the I have a license file ready to import option. (You should have been supplied with a license file. This file should be stored on the computer on which you will run promis•e.
C. Select the Browse button and browse to the location where the license file is stored. Select the license file so that it is displayed in the Activation Wizard.
D. Select Next.
Checking Out a License
The Bentley SELECT Server licenses are network-based. You may use a license while disconnected from the network for up to 30 days. However, there may be times when you must use a promis•e license off the network for more than 30 days, for example, when working at a remote site.
For these situations, you may “check out” a license for use on a computer that is not on the network. (This is sometimes referred to as a “commuter license.”) This feature does not apply to the NON-Select or node-locked users, as these licenses are considered to be checked out already.
Note: While a license is checked out it will it will be tracked in the license server usage logs as being continuously used (i.e., 24 hours a day).
To check out a license:
1. The computer on which you wish to use the checked-out license must be connected to the network. On this computer, start promis•e and select the Manage > License Manager function. The Product Activation Wizard dialog will appear.
3. Select Next to continue. The License Checkout dialog will appear. This dialog lists the available Bentley SELECT Server licenses on your system.
4. Select the Use a checked out license checkbox. 5. Enter your email address in the Email Address field.
6. Select the desired promis•e license from the list in the Product Name field. 7. Select the Next button to check out the file.
While a license is checked out, it will not be available to other users on the network. At the end of the check-out period, the checked-out license will expire and it will again be available to users on the network.
4. Select Next to continue. The License Management Tool dialog will appear. The checked out license will be listed at the bottom of the dialog.
Note: If the checked out license has expired, you may get a message dialog indicating this with OK and Cancel buttons. Clicking the OK button here will cause the temporary license string in the local license file to be deleted and the client will then query the server for a license in the normal manner. The Cancel button will cause the local license file to be left alone and promis•e will exit. There is no grace period for checked out licenses.
5. Select the license that you checked out at the bottom of the dialog and select the
2
Introduction and Overview
This section gives an overview of the promis•e software and explains the use and conventions of this user guide.
The promis•e Concept
promis•e is an advanced productivity tool for designers of electrical control systems. Because of its customizable, open architecture, promis•e can also be adapted to other applications such as hydraulics, pneumatics, and process control.
promis•e allows schematic diagrams to be rapidly constructed using pre-defined symbols and macros. Wires are automatically broken at symbol connection points and sections of drawings can be copied and pasted to save time. Many functions are performed automatically by the software including the generation of unique device IDs for each symbol, cross referencing of related symbols (such as contacts and coils), and numbering of wires.
The software recognizes logical interconnections between devices in a schematic. A wire is recognized as a wire and not just a graphic line. The system can check for errors such as duplicate device IDs while a schematic is being created. The software can perform automatic cross referencing and wire numbering. In combination with a parts database, the software can automatically generate a variety of support
documentation such as terminal diagrams, cable plans, panel layouts, bills of material, and a job costing analysis. Because work is divided into projects, all related drawing pages can be included in these automatic functions.
The add-on version of promis•e runs as an application on top of a CAD program to take advantage of that software’s drawing capabilities. There are add-on versions for AutoCAD, AutoCAD LT and MicroStation.
Software Functionality
Using promis•e
Generally, doing a job with promis•e involves the following stages:
1. If the parts database is to be used to allow the automatic generation of support documentation, component (parts) information must be entered or imported into the database. This information includes catalog numbers, manufacturer, price, dimensions, etc. If the same database is to be used for all jobs, this data entry step will not be necessary for subsequent projects unless new components are to be included. Part numbers can be assigned to symbols in the schematics.
Note: Parts databases for many leading component manufacturers are available from Bentley.
2. Create the schematic drawings. For the first project, most promis•e users create custom page formats, title blocks, symbols, etc., to match existing company standards. This customization is not necessary for subsequent projects. You also have the option of creating a parts list or panel layout before creating the schematic drawings. In this case, you select parts from the parts database and place them in a parts list or in a panel layout. This allows you to quote on a job or layout the hardware before designing the control circuits. When you are ready to do the schematics, you can take parts from the previously selected list and place them in the drawings.
3. Generate panel layout drawings. promis•e has an optional semi-automatic panel layout mode that will prompt the user for each component in the schematic diagram. The user then positions the component as desired in the layout drawing. 4. Generate terminal plan. promis•e automatically places terminal connection
information on a graphical diagram page. The user can edit this plan as desired, for example, to assign cables and conduits.
5. Generate documentation lists. Using information in the schematics and in the database, promis•e can automatically generate other useful lists such as bills of material, wire lists, wire labels, component labels, job cost analysis,
Using This Manual
Purpose
This manual is a reference for the operation of the promis•e system. Information provided in this manual is sufficient for learning how to use the majority of the software’s operating functions and advanced customization capabilities. However, to realize the full potential of promis•e it is recommended that you participate in the training programs offered by Bentley. These training programs are accelerated learning courses designed to ensure quick startup for users, and mastery of the software’s advanced customizing and interfacing features for system administrators and key operators.
Manual Conventions
promis•e FunctionsFunctions in promis•e are organized in groups. These groups are displayed somewhat differently depending on which CAD software promis•e is running with. In
AutoCAD, various functions are available from pull-down menus or icon ribbon menus at the top of the screen. In MicroStation, functions are selected from a menu on the left side of the screen. In this manual, the first reference to a promis•e function is shown as a series of commands in bold type separated by arrows that indicate the function group followed by the function itself. For example:
Design > Insert Symbol > Insert Symbol by Name
The above command indicates that one should go to the Design function menu, select the Insert Symbol function and then select the Insert Symbol by Name function on the submenu.
Keyboard Use
If a specific key on the keyboard is to be pressed. The name of the key will be shown enclosed in < > characters. For example:
<Enter> (press the Enter key)
Menus
After installing promis•e, new menu selections are added to the existing CAD software menus. These will vary in appearance depending on the CAD software you are using:
AutoCAD 2009
AutoCAD 2009 uses ribbon menus. These contain a number of ribbon tabs. When you select a ribbon tab, a group of icons are displayed that represent the functions in that tab. The following figure shows the menus as added to AutoCAD.
AutoCAD 2006 - 2008
In AutoCAD 2006 - 2008, promis•e uses pull-down menus. These contain a number of ribbon tabs. When you select a ribbon tab, a group of icons are displayed that represent the functions in that tab. The following figure shows the menus as added to AutoCAD.
MicroStation and MicroStation PowerDraft
When running on MicroStation and MicroStation PowerDraft, promis•e functions are accessed on the left side of the window.
The following is a list of functions under each menu group. Note: the Design menu changes depending on which drawing mode you are in (schematic, hydraulic, etc.). Design menu group (Schematic mode)
Project Manager New Project ---New Page Page Next Page Previous ---Catalog Manager ---Insert Macro
Insert Symbol > Insert Symbol by Name Insert Symbol by Part Number Insert Symbol by Device ID* Symbol on the Fly > Draw Symbol on the Fly
Insert Connection Point Delete Connection Point Insert Field Insert Balloon ---Align Components Edit Components
---Wiring > Wire (Continuous) Wire (Dashed) Wire (Center) 3 Phase Wire Multi-wire Polywire Multi-polywire
Design menu group (Schematic mode continued)
Wire Numbering > Automatic Wire Number Manual Wire Number Align Wire Numbers Delete Wire Number Multi-Line Text
Display Options > Grid Snap Setting Show Grid
Display Connection Points Display Connection Point Texts
Display Terminal Connection Point Texts Display Insertion Point
Display Part Numbers Display Wire Numbers Design menu group (Panel Layout mode)
Project Manager New Project ---New Page Page Next Page Previous ---Catalog Manager ---Insert Macro
Insert Symbol > Insert Symbol by Name Insert Symbol by Part Number Insert Symbol by Device ID* Symbol on the Fly > Draw Symbol on the Fly
Insert Connection Point Delete Connection Point Insert Field
Insert Balloon ---Align Components
Design menu group (Panel Layout mode continued) Insert DIN Rail
Snap to DIN Rail Mounting Accessories
---Shortest Distance > Insert Region Edit Region
Edit Region Connections Multi-Line Text
Display Options > Grid Snap Setting Show Grid
Display Connection Points Display Connection Point Texts
Display Terminal Connection Point Texts Display Insertion Point
Display Part Numbers Display Wire Numbers Design menu group (Hydraulic and Pneumatic modes)
Project Manager New Project ---New Page Page Next Page Previous ---Catalog Manager ---Insert Macro
Insert Symbol > Insert Symbol by Name Insert Symbol by Part Number Insert Symbol by Device ID*
Design menu group (Hydraulic and Pneumatic modes continued) Piping/Hosing > Draw Pipe/Hose
Pipe/Hose (Continuous) Pipe/Hose (Dashed) Pipe/Hose (Center) 3 Pipe/Hose Multi-Pipe/Hose PolyPipe/Hose Multi-PolyPipe/Hose Pipe/Hose 90 Degree Up Pipe/Hose 90 Degree Down Edit Pipe/Hose
Select Pipe/Hose Layer Pipe/Hose Connector Type Insert Pipe/Hose Link
Pipe/Hose Numbering Multi-Line Text
Display Options > Grid Snap Setting Show Grid
Display Connection Points Display Connection Point Texts
Display Terminal Connection Point Texts Display Insertion Point
Display Part Numbers Display Pipe/Hose Numbers
Review / Revise menu group Navigate
Search Data Manager
Forced Routing Manager Shortest Distance Wire Terminations
Terminal/Pin-Plug Manager Re-sequence Wire Links Cable Manager
Replace Symbol Replace Device ID Replace Part Number Replace Text Replace Symbol Text Find/Replace Wire Property Update Symbol
Update Family Replace Title Block Replace Page Format
Engineering Design Considerations promis-e Output menu group
PLC Generator Project API Builder
Project Builder > Template Manager Project Builder
---Update Wiring Diagram Run Reports
Graphical Parts List Run Graphical Plan
Manage menu group Create Macro Create Symbol Create Family Family on the Fly
---Plant Exchange
---Language Database Manager License Manager
Mode Manager
Parts Database Manager Plug-in Manager
---Compile Connections
Rebuild Project Database Refresh Page
Validate Page Update Page Configure menu group
Options Setup
---Page Format Designer
Title Block Designer
---Graphical Plan Designer Report Template Designer ---Gauge Table Editor
Index Table Editor Button Table Editor Termination Editor Panduit Data Editor
promis-e Help menu group Help
Tutorial > ANSI/IEEE IEC
Show Welcome Dialog ---Check For Updates ---About
Toolbars
In AutoCAD 2006-2008, many promis•e functions can be accessed through toolbars (tool boxes in the MicroStation version) with a single click. You can see a tooltip label that describes the function of each button by resting the cursor on the button for a moment. The toolbars correspond to the menu function groups listed on the previous pages. In some cases as large menu function group was split between two toolbars.
You can move the toolbar by pointing at the “handle” on the left side of the toolbar and dragging it to the desired location either floating above the drawing or docked to the edge of the window.
To display or hide toolbars in AutoCAD, use the View > Toolbars function. In the dialog that appears, select the ECADMenu_promis•e menu group and select or de-select the checkbox for a toolbar to display it or hide it.
To display or hide toolbars (tool boxes) in MicroStation, use the Tools > Tool Boxes function. Select or de-select the checkbox for a toolbar to display it or hide it.
In the MicroStation version, the Main Tools toolframe combines the other promis•e toolboxes.
Command Line / Text Window
In the AutoCAD version of the software, the command line is an area at the bottom of the drawing screen where the most recently executed commands are displayed. The software also displays prompts here for certain functions. You can also enter commands on the command line.
By placing the cursor on its border, the command line area can be dragged to the top of the drawing screen or out onto the desktop to become a floating text window. The floating window can display more lines and therefore is useful for such functions as View > List. You can drag the floating window back to the drawing screen to reattach it. You can also display a floating text window without moving the command line by pressing the <F2> key.
In the MicroStation version, prompts appear in the Status Bar located at the lower left corner of the drawing screen.
If you need to enter (type) a command in the MicroStation version, select Utilities > Key-in to display the Key-in dialog where you can enter commands.
Text Window
Command Line
Help Screens and User Guide
Online help information is available to describe promis•e functions. Many of the dialog boxes displayed by promis•e have a Help button which can be selected to display relevant information from the User Guide.
The complete User Guide can be accessed by selecting the menu function promis•e Help > Help.
The User Guide in PDF format can be accessed from the Welcome screen (see page 14). This PDF version of the User Guide is also included on the promis•e disc in the Documentation folder. The PDF User Guide is preferable if you wish to make printouts or if you need to zoom in on a figure.
Dialog Boxes
When the software requires you to make selections or enter information, it will display a dialog box.
Buttons are provided in the dialog boxes to confirm information that has been entered, or to provide additional selections. Generally, selecting the OK button will confirm the information that has been entered, load it into the system and close the dialog box. In many (but not all) dialog boxes, pressing the <Enter> key has the same effect as selecting OK. Selecting the Cancel button will abandon the information that was entered and will exit the current function. In many (but not all) dialog boxes, pressing the <Esc> (Escape) key has the same effect as selecting Cancel. Selecting the Help button will display descriptive text about the functions in the current dialog box. A button with three dots on it [...] is a browse button that will display an additional dialog so that you can select a folder or file on your system or search a database.
Fields that require an entry before you can continue are marked with a red asterisk (*) until you make an entry.
Browse button Required entry marker
Engineering Design Considerations
As you work, the software may display an Engineering Design Consideration dialog. These dialogs call attention to conditions in your project that may cause errors or other undesirable results. You then have an opportunity to take an appropriate action. See Appendix A for more information.
Sample Projects
Several sample projects are provided with the software as backup files. These projects are automatically restored when you install the software.
The sample projects are placed in your default project folder and will be available for viewing or editing using the Project Manager.
3
Project Management
This section explains the concept of projects, which is how work is organized in promis•e. Project organization is presented first followed by sections on how to create, delete, copy, modify, rename and back up projects.
Project Organization
A project is a collection of work done in promis•e, all of which relates to the same job. This work includes both graphical drawings (schematics, layouts, etc.) and support documentation (part lists, labels, connection information).
By associating every drawing and list with a specific project, the software is able to recognize which information to use when performing automatic functions such as list generation, cross referencing, wire numbering, cost analysis, and so on.
Graphical terminal plans Schematic diagrams
Panel layouts Wire listBill of materials
etc.
Terminal list Purchase order list Wire and device labels Job cost analysis Documentation PROJECT
Drawings
Drawing Sets
Drawing sets are used to organize pages within a project into meaningful groups. You can arrange the drawing sets into any order you wish. For example, you may want to have all schematic pages in one drawing set and all panel layout pages in another set. In the Project Manager you can change the order of the sets, which affects the order in which the software indexes the pages. This has an effect on page navigation, cross referencing and print/plot order.
DRAWING SET 1 DRAWING SET 2
4 3 2 1 4 3 2 1
Each page has a page number
PROJECT
INST NAME PAGE 1 LOC NAME
Installations and Locations
Projects optionally can be subdivided into installations and locations. These usually correspond to physical locations. For example, the project could consist of an entire production facility while each production line within the facility is designated as an installation and each control cabinet on a line is a location.
When graphical (drawing) pages are created, they can be assigned a default installation and location. (If the entered installation or location name does not yet exist, it will be created.) When support documentation is generated, it can also be sorted by installation and location.
PROJECT
LOCATION
LOCATION LOCATION LOCATION
I N S T A L L A T I O N I N S T A L L A T I O N
PROJECT 2
INSTALLATION 1 INSTALLATION 2
LOCATION LOCATION LOCATION
(NO INSTALLATION OR LOCATION) 4 3 8 7 4 3 12 11 PROJECT 1
Project Manager
The Project Manager is a central interface similar to Windows Explorer where you can access all project and page management functions. You can create, modify and organize your projects and pages using the pull-down menus, right-click menus and toolbars. Various other project-based features are also available in this interface and are covered in other sections of this manual.
To open the Project Manager, select Design > Project Manager. You can also select the Project Manager toolbar button.
The Project Manager window will open.
Folder/Project Browser
Menu Bars
In the Folder/Project browser area you can select a project to view or edit. The active project will be marked with a special icon. You can have pages from different projects open at the same time. The open page that was most recently selected (i.e., the one that is “on top”) determines the active project.
The type of information shown in the data area can be changed by making selections in the View menu or by clicking on the feature tabs at the bottom of the data area. The following “views” are available:
Details - Drawings are listed in columns of text information. You can customize the columns that are displayed by right clicking in the column heading area and selecting the checkbox for the page information that you wish to appear as shown in the following figure. The order of column headings can be changed by dragging the heading for a column to the left or right. You can also click on a column to sort by the entries in that column.
One of the columns in the detailed view is labeled User. This field identifies the name of the person who has that page currently open. This name comes from the entry made in the User Options - User Name function (see page 424). This is a useful feature for a multi-user environment because it allows you to see which users have which pages open in the same project. Sometimes you might need to have the other users exit the project so that you can run a project-wide function. Thumbnails - Pages are shown as thumbnail images.
Drawing Sets - A list of drawing sets in the selected project is shown. By clicking on the “+” or “-” character next to the drawing set name you can display or hide fields that allow you to enter up to five descriptive texts for the drawing set. Select the Save button to save any descriptions that are entered.
You can also change the order of drawing sets in the project by highlighting the drawing set name and then selecting the Up or Down button.
Installation - A list of installations in the project. As with drawing sets, you can enter and save up to five descriptive texts for each installation. The descriptive texts can be displayed in reports and title blocks by including the appropriate variables.
Location - A list of locations in the project. As with drawing sets, you can enter and save up to five descriptive texts for each location. The descriptive texts can be displayed in reports and title blocks by including the appropriate variables. - Allows you to view, modify and add to the part numbers assigned in the project. See page 142.
Spare Parts - Shows the spare parts that are included in the project. Only part numbers used in the project that have spares assigned will be shown in this tab.
The parts database contains a Percent_Spare field (see page 630) that allows you to automatically add a percentage of spares to the parts that are actually used. This percentage is shown in the Project Manager Spare Parts tab in the Percent Spare column. You can also assign additional spares by making an entry in the Added Spares column. In the above example, 8 parts are actually used in the project. There is a spare percentage of 10 making 0.8 spares which the software rounds up to 1. In addition, there is 1 added spare assigned making a total of 2 spares.
Note: As you work in promis•e you can leave the Project Manager open in the background and quickly return to it by selecting the Project Manager toolbar button.
Favorites Project Folder
There is a function in the Project Manager that allows you to set up a “Favorites” folder where you can create links to projects even if they exist in different places on your system.
To set up the Favorites folder:
1. Select the Favorites function on the left side of the Project Manager.
Note: After you select the Favorites function, the function name changes to “Folders” which you can select to return to the normal view of folders on your system.
2. The display will show a Favorites folder. To configure the content of this folder, select the Organize link.
Favorites function
3. The Favorites dialog will appear. This dialog allows you to create and name subfolders of the Favorites folder. The creation of subfolders is optional.
To create a subfolder, select the Create Folder button. A folder named Folder1 will appear. Create additional subfolders as needed. Each subfolder can hold multiple projects.
5. To add projects your Favorites folder(s), select the Folders function on the left side of the Project Manager to return to the folders view of your system. Right click on the desired project name and select Add to Favorites from the popup menu.
6. The Favorites dialog will reappear. Select the desired folder and select the Add it button to add the project to that folder. You can add projects to subfolders or to the Favorites folder itself.
Note: Once you have added a project to a favorites folder, when you highlight that project, its path is displayed on the lower left side of the Favorites dialog.
7. After you have added links to projects, they are listed in the Favorites view of the Project Manager.
Search Project
The Search Project function in the Project Manager helps you to locate promis•e projects on your system.
1. In the Project Manager, select Tools > Search Project or select the Search Project toolbar button .
2. The Search dialog will appear.
3. If you wish to search for a particular project, enter its name in the Name field. You can make wildcard entries such as D* to search for all projects beginning with “D.” If you leave the field blank the software will search for and list any projects it finds in the selected path.
4. In the Look in field, select the path that you wish to search on your system. By default, the path to the current project is entered. You can click inside the field and make changes to the path.
5. Select the Search Now button to begin the search. As the software searches, it lists any projects that it finds in the lower part of the dialog.
6. You can select one of the listed projects and then the Switch to Project Manager button to display the selected project in the Project Manager.
See Page Pending Status
The See Page Pending Status function in the Project Manager flags pages that have changes that will occur the next time they are opened due to changes elsewhere in the project.
Select the See Page Pending Status toolbar button in the Project Manager.
The same icon on the button will appear next to any page in the project manager that has pending changes in the database that have not yet been updated on the drawing. This handy visual aid lets the user know that certain drawing files are not up to date yet because they were never reopened after changes were made to the project that affect those pages.
Save Project As
You can use the Project Manager to save a copy of a project under another name. 1. In the Project Manager highlight the name of the project you wish to copy. 2. Select File > Save Project As. You can also right-click on the project name and
select Save Project As from the pop-up menu. The Save Project As dialog will appear.
3. Enter a new name for the project in the New Name field.
4. Enter or browse to the desired folder for the copy in the Save Path field. 5. Select OK.
Create New Project
To create a new project:
1. There are two ways to open the New Project dialog:
A. From the main screen select the Design > New Project icon.
B. Or, in the Project Manager select File > New > New Project (or select the “New” icon and then the New Project function from the menu that appears).
3. In the Save in field, enter the name of the directory (folder) where you wish to store the project. Use the browse button to locate and select a folder.
Note: If you highlight the name of the desired folder in the Project Manager before selecting the New Project function, this folder will be entered in the Save in field automatically.
4. If you wish to use the same project settings as an existing project, you can select that project in the Use Project Options From field. Use the browse button to select an existing project (click on the folder name) or a template (xml) file. Sample ANSI-IEEE and IEC project template files are provided in the folder Documents and Settings\All Users\ECT\promis•e\Config\Options.
5. To set project options, select the Options button. See page 67.
6. To enter a description for the project that will appear in title blocks, reports and elsewhere, select the Description button. The following dialog will appear.
In the Entry column, enter the various descriptive texts identified in the Name column. Select OK when finished.
Copy Project
To copy a project:
1. Open the Project Manager.
2. Select (highlight) the name of the project you wish to copy.
3. Select Edit > Copy from the Project Manager menu or right click on the project name and select Copy from the popup menu.
4. The Copy Project dialog will appear. The project you selected in step 2 will be listed in the Project field. If desired, you can use the browse button to select a different project.
5. In the New Path field, use the browse button to select or create the folder where you wish to save the copy.
Rename Project
To copy a project:
1. Open the Project Manager.
2. Select (highlight) the name of the project you wish to rename.
3. Select Edit > Rename from the Project Manager menu or right click on the project name and select Rename from the popup menu.
4. The Rename Project dialog will appear. In the New Name field, enter a new name for the project you selected in step 2.
Modify Project
To modify the settings of a project: 1. Open the Project Manager.
2. Select (highlight) the name of the project you wish to modify.
3. Select Edit > Modify from the Project Manager menu or right click on the project name and select Modify from the popup menu.
4. The Modify Project dialog will appear.
To change project settings, select the Options button. The Project Options dialog will appear (see page 67). Select the desired option, make the desired changes and select OK.
5. To change the project description, select the Description button. The Project
Delete Project
To delete a project:
1. Open the Project Manager.
2. Select (highlight) the name of the project you wish to delete.
3. Select Edit > Delete from the Project Manager menu or right click on the project name and select Delete from the popup menu.
4. The Delete Project dialog will appear.
Project Options
The Options dialog for projects allows you to make a variety of global settings for a project.
You can access the project Options dialog in several ways:
• Select the Options button in the New Project dialog
• Select Configure > Options in promis•e (a drawing page must be open)
• Select Tools > Options in the Project Manager.
• Select the Options toolbar button in the Project Manager.
Select project options
Address File
The address file is a text file containing information such as the user’s street address which the software can automatically place in title blocks, report headings, and so on. You can select, edit and create address files in the Project Options mode.
Select the Address File function in the Project Options dialog. The following fields will appear.
The Address File field allows you to select an existing address file.
To edit an existing file, select the address file, make any changes in the Address field and select the Save button.
To create a new file, select the New button, enter the name of the new file in the dialog that appears. Enter the new information in the Address field. Select the Save button.
To delete an address file, select the address file name and then select the Delete button.
Balloon Settings
In the project Options dialog, select Balloon. The following fields will appear.
This dialog allows you to make settings that determine how balloons appear in various drawing types. A balloon is a numbered circle that marks an item in a panel layout or other type of drawing. The number corresponds to that item’s position in the bill of materials list.
In the Balloon Numbering By field, select whether the balloon numbering will be unique across the entire project, across each installation or across each location. There is also a selection “installation+location” which allows balloon numbers to be duplicated if either the installation or location is different.
Select the Clear All Balloons button to remove all assigned balloon numbers in the project. This will delete the balloons in the drawings and remove the item numbers from the project database.
Select the Display Quantity Number checkbox if you wish a part number quantity value to appear next to each balloon.
Default Grid Settings
Most promis•e drawing modes utilize a grid that causes objects to be aligned properly. For example, the grid ensures that wires make contact with symbol connection points so that the software can recognize these connections. Snap mode causes the cursor to limit its movements to set increments. In the AutoCAD version of the software you can turn the snap mode off and on by pressing the <F9> key or by clicking on SNAP button at the bottom edge of the AutoCAD window.
You can adjust the spacing of the grid and snap mode to suit your requirements. In the project Options dialog, select Default Grid & Snap Settings. The following fields will appear.
Note: The Snap Spacing columns are not available in the MicroStation version of promis•e.
This function allows you to set the X and Y grid line spacing and snap mode intervals for various types of drawings. Enter the desired value for each drawing mode. Select Apply or OK to load the new values.
Note: There is also a Grid Snap toolbar that you can use to make grid settings as you work on drawings.
Default Project Properties
In the project Options dialog, select Default Project Properties. The following fields will appear.
Note: Project Options functions are only available when a project name is selected (highlighted) in the Project Manager or when a page in the desired project is open.
This function allows you to make global settings that determine what will appear automatically on newly created pages. The following fields are provided:
Default Parts Database - In the Default Parts Database field you can select a default parts database for the project. The software will then look at this database instead of the database specified in the setup configuration (see page 407) when searching for part numbers. The available databases are listed in the drop-down menu. (You can add new databases in the promis•e Setup dialog.)
You can use the Edit Filter button to create a project filter for the database. This filter restricts the displayed parts selection in the Select Part Number dialog for the project to those that match user-defined criteria (select the Apply Project Filter checkbox in the Select Part Number dialog). For example, you could limit the parts for the project to certain manufacturers. When you select the Edit Filter button, the Filtering dialog appears.
Use the following procedure to create a filter:
1. In the Field column, select the parts database field whose value you wish to use for filtering.
2. In the Relationship column, select the comparison function to be used in the filter. The available comparisons are:
like equals is greater than
4. Select OK to create the filter.
To remove the filter, select the Clear Filter link in the Filtering dialog. Page Format Options - This group of settings affects the page formats used in the project:
Use the Page Format field to select the page format that will be the default format when creating a new page. Use the browse button to select a format file. Formats are stored by default in the promis•e PageFormat directory.
The # of Digits in Line Number field sets the number of digits that will be displayed for line numbers on the page. Extra zeroes will be added to the line number as needed. For example, if you enter a value of 3, then line number 1 will be displayed as 001.
If you wish to include the page number at the beginning of each line number, select the Include Page Number as a Line Number Prefix checkbox. For example, line number 001 on page 2 will be displayed as 2001.
If you wish line numbering to continue on following pages rather than starting over, select the Continuous Line Numbers checkbox.
Existing pages will be updated when these page format options are changed. Project and Page Descriptions - The descriptions are parameters that are associated with and stored with the page. These descriptions can appear in title blocks and reports. To add another description, use the “+” button. To rename an existing description, place the cursor in the field of the existing description and then click the “R” button. To delete a description, place the cursor in the field of the existing description and then click the “X” button. Use the Reset button to return the descriptions to the state they were in when you entered the dialog.
Display Formats
In the project Options dialog, select Display Formats. The following fields will appear. This function allows you to set the format of device IDs, cross references and part numbers. There are tabs for ID & Cross Reference and Part Number.
Items that can be formatted are divided into groups:
• Device ID Formats
• Device Cross References
• Wire Link Cross References
• Part Numbers
The Device ID Formats group has an expand/contract (double arrow) button that allows you to collapse or display the items in that group. Part Number formatting is accessed through a separate tab.
Expand/Contract button
General Device ID Settings
At the top of the Display Formats dialog (ID & Cross Reference tab) is a group of settings that affect how device IDs are handled by the software.
Select the Adjust device ID when symbol(s) is moved checkbox if you wish a symbol’s ID to be updated when the symbol is moved, for example when the ID format includes the line number and the symbol is moved to a different line.
Select the Make Device ID Uniqueness Case Sensitive checkbox if you wish the case of letters in an ID to make a difference. For example, if you select this checkbox then LS2 and Ls2 will be considered two different IDs. If you do not select the checkbox, then two radio button options are available for making the case of IDs consistent: you can choose to Convert lowercase to uppercase or Convert uppercase to lowercase. Select the Enable Device ID Nesting to allow nested devices IDs. This applies only to symbols that are inside symbols created with the “symbol on the fly” function. Nested IDs allow these symbols to have a device ID that combines the ID of the “symbol on the fly” with the ID of the nested symbol. One application of this feature would be to use the box to represent a circuit board and then insert pin/plug symbols to represent the connectors on the board. The box could also represent a special controller module with terminal symbols inside that are related to that module. Selecting the Partial Tag radio button will display only the device ID of the nested symbol. Selecting the Complete Tag button will display the entire, combined device ID.
Device ID Format
For each format type, the dialog shows the name of the format that defines what the ID is currently based on (page and line number, sequential number, etc.).
Note: The Schematic (PLC Wired Device ID) and Schematic (PLC Wired Terminal ID) device ID formats will only be applied when the Replace Device ID function is used. The PLC Wired Device ID will assign the PLC address to the first non-terminal device connected to the PLC. The PLC Wired Terminal ID will assign the PLC address to the first terminal connected to the PLC.
The Profile Name field in the Device ID Format dialog displays the name of the
Available elements Profile name Currently selected elements Example of current elements
Load or save profiles
Parts of ID that will be displayed
The Complete Device ID area of the dialog allows you to define the elements of the complete device ID for symbols in a drawing. The list box displays the available elements in a complete device ID: Installation, Location, and Device Tag. To add one of these elements to the device ID, select it and click on the Add to Expression button. It will then appear on the right side of the dialog. (also see the figure on page 77). To remove an element from the device ID, select (highlight) it, then either press the <Delete> key or right click on the element and select Delete from the popup menu. Use the Clear button to empty the field of all selected elements. Use the Reset button to reload the combination of variables that you had when you entered the dialog.
The Identifiers area of the dialog allows you to define the characters that separate the device ID elements when displayed in a drawing or report (also see the figure on page 77). The default is “=” for Installations, “+” for locations, and “-” for the device tag. The Display fields allow you to select whether installation and location names will be displayed in device IDs always or only when the installation or location is different from that of the current drawing page.
Use the Device Tag Format area of the dialog to configure the device tag. The “device tag” is that part of the device ID that does not include the installation and location (see the following figure). The device tag consists of a “tag mnemonic” that is applied to every symbol of a given type (such as “K” or “CR” for a relay) and items that are assigned by the software individually for each instance of a symbol (such as page/line numbers and sequential numbers). The tag mnemonic is defined when a symbol is created.
=LINE1+CAB1-PB120
Device ID
Installation Location Device Tag
PB120
Device Tag
Sequential Number [installation based] - A number incrementing from 1. Numbering is unique within each installation.
Sequential Number [location based] - A number incrementing from 1. Numbering is unique within each location name. If you have two locations with the same name in different installations, the numbering will extend across both locations. Use installation/location based numbering if you want locations with the same name to be numbered separately.
Sequential Number [page based] - A number incrementing from 1. Numbering is unique within the same page.
Sequential Number [line based] - A number incrementing from 1. Numbering is unique for each line number.
Tag Mnemonic - A group of alphanumeric characters that indicate the type of device that the device ID represents, such as CR or K for control relay or PB for pushbutton. On the drawing, the mnemonic that appears in the device tag will be taken from that which is defined in the symbol.
Page Number - The page number where the device ID is first used. Line Number - The line number where the device ID is first used.
Zone Number - The drawing zone number where the device ID is first used. PLC Address - (Available for PLC Wired Device ID and PLC Wired Terminal ID) The PLC I/O address to which the item is connected will be used in the device tag.
The right side of the dialog displays the currently selected device tag elements. Below this is an example of what the device tag will look like in an actual drawing. To remove an element from the device tag, select (highlight) it, then either press the <Delete> key or right click on the element and select Delete from the popup menu. Use the Clear button to empty the field of all selected elements. Use the Reset button to reload the combination of elements that you had when you entered the dialog. You can further format the device tag by selecting (highlighting) one of the selected elements. When you do this, additional fields become active.