Escolar Documentos
Profissional Documentos
Cultura Documentos
User's Guide
Copyright
Copyright 1995-2012 Intergraph Corporation. All Rights Reserved. Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret law, and international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph Corporation.
Terms of Use
Use of this software product is subject to the End User License Agreement ("EULA") delivered with this software product unless the licensee has a valid signed license for this software product with Intergraph Corporation. If the licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use of this software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives licensee permission to print a reasonable number of copies of the documentation as defined in the applicable license agreement and delivered with the software product for licensee's internal, non-commercial use. The documentation may not be printed for resale or redistribution.
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip, INtools, ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks of Intergraph Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered trademarks of Microsoft Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product names are trademarks of their respective owners.
Contents
Working with the Administration Module ............................................................................................... 13 SmartPlant Instrumentation Database Setup for Oracle ....................................................................... 15 Oracle Database Server Tablespaces for SmartPlant Instrumentation ................................................ 16 Setting Up a Database for Oracle Common Tasks............................................................................... 17 Set Up a SmartPlant Instrumentation Database for Oracle .................................................................. 18 Clean Up the Oracle Database ............................................................................................................. 23 SmartPlant Instrumentation Database Setup for SQL Server............................................................... 25 SQL Server Database Server Filegroups for SmartPlant Instrumentation ........................................... 26 Setting Up a Database for SQL Server Common Tasks ...................................................................... 27 Set Up a SmartPlant Instrumentation Database for SQL Server .......................................................... 28 Clean Up the SQL Server Database ..................................................................................................... 30 Domain Backup, Initialization, and Deletion ........................................................................................... 31 Domain Backup Common Tasks .......................................................................................................... 32 Back Up a Domain.......................................................................................................................... 32 Back Up a Domain from the Command Line .................................................................................. 33 Back Up a Domain in Thin Client Mode ......................................................................................... 34 Workaround for a Backup Problem in Windows Vista and Windows 7 .......................................... 36 Backing Up Files Containing Audit Trail Data ....................................................................................... 36 Backing Up Audit Trail Data on Oracle ........................................................................................... 37 Backing Up Audit Trail Data on SQL Server .................................................................................. 38 Backing Up Audit Trail Data on Sybase Adaptive Server Anywhere ............................................. 39 Domain Initialization .............................................................................................................................. 40 Prerequisites for Domain Initialization ............................................................................................ 41 Domain Initialization Common Tasks ............................................................................................. 43 Domain Deletion Common Tasks ......................................................................................................... 59 Delete a Domain ............................................................................................................................. 60 Delete an Invalid Domain on Oracle ............................................................................................... 61 Delete an Invalid Domain on SQL Server ...................................................................................... 61 Troubleshooting Domain Initialization Common Tasks......................................................................... 62 Handle an Initialization Failure ....................................................................................................... 63 Workaround for an Initialization Problem in Windows Vista and Windows 7 ................................. 63 Workaround for a Backup Problem in Windows Vista and Windows 7 .......................................... 64 Numeric Character Settings for Oracle .......................................................................................... 65 Workaround for the Grant to View Creation Error .......................................................................... 66 Accessing the Administration Module .................................................................................................... 67 Log on as System Administrator ........................................................................................................... 67 Log on as Domain Administrator........................................................................................................... 68 Switch from System Administration to Domain Administration ............................................................. 68 Switch from Domain Administration to System Administration ............................................................. 68 Users, Departments, and Groups ............................................................................................................ 69 Create and Manage Departments......................................................................................................... 69
Contents
Define a SmartPlant Instrumentation User ........................................................................................... 70 Assign a Domain Administrator ............................................................................................................. 71 User Groups .......................................................................................................................................... 71 Users and Groups Common Tasks....................................................................................................... 72 Create a New Group ....................................................................................................................... 73 Modify the Profile of a Group .......................................................................................................... 73 Delete a Group ............................................................................................................................... 73 Assign Users to Groups.................................................................................................................. 73 Remove Users from Groups ........................................................................................................... 74 Windows Authentication Logon Method ......................................................................................... 74 Create a Group for Windows Authentication Logon Method .......................................................... 75 Remove Deleted Windows Users from SmartPlant Instrumentation User Groups ........................ 75 Switching to a Different Logon Method .......................................................................................... 76 System Administration ............................................................................................................................. 77 System Administration Common Tasks ................................................................................................ 77 Domain Management Common Tasks ................................................................................................. 78 Create an Owner Operator Domain ............................................................................................... 79 Make Domain Definitions................................................................................................................ 80 Enable Cable Type Dependency .................................................................................................... 81 Enable Workflow............................................................................................................................. 82 Activate the Audit Trail Functionality .............................................................................................. 82 Enable Item Registry ...................................................................................................................... 83 Specify a Global Path ..................................................................................................................... 83 Activity Tracking Management Common Tasks ................................................................................... 84 Set the Activity Tracking Mode ....................................................................................................... 84 Clear Activity Tracking Data ........................................................................................................... 85 Generate a Grid-Style Activity Tracking Report ............................................................................. 85 Generate a Graph-Style Activity Tracking Report .......................................................................... 86 Managing Database Security ................................................................................................................ 87 SmartPlant Instrumentation Encryption Mechanism ...................................................................... 87 Set Security Options ....................................................................................................................... 92 Database Locking Mode (for Multi-User Versions) ........................................................................ 92 Set Database Locking Mode .......................................................................................................... 93 Maintaining the SmartPlant Instrumentation Database ........................................................................ 93 General Database Maintenance Common Tasks .......................................................................... 93 Database Maintenance on SQL Server Common Tasks ............................................................... 99 Database Maintenance on Oracle Common Tasks ..................................................................... 101 Using KKS Naming Conventions in SmartPlant Instrumentation ....................................................... 105 Working in KKS Mode in SmartPlant Instrumentation ........................................................................ 107 Flow of Activities for Working in KKS Mode ................................................................................. 109 System Administrator Activities .................................................................................................... 109 Domain Administrator Activities .................................................................................................... 110 Import Utility Activities .................................................................................................................. 110 Define KKS Naming Convention Using KKS Segments .............................................................. 110 Example of a KKS Naming Convention for Loops ....................................................................... 111 Loop Number Representation in the Domain Explorer of SmartPlant Instrumentation ............................................................................................................................. 111 Accounting, Contractors, and Clients Common Tasks ....................................................................... 112 Add and Manage Accounting Information .................................................................................... 112 Add and Manage Contractors ...................................................................................................... 113 Add and Manage Clients .............................................................................................................. 114 Associate Accounting, Client, and Contractor Information with a Domain ................................... 114
Contents
Print Database Connection Information .............................................................................................. 115 Report Generation (System Administration) ....................................................................................... 115 Domain and Project Administration ...................................................................................................... 117 Domain Administration Common Tasks ............................................................................................. 117 Plant Design and Structure ................................................................................................................. 119 Create a Plant Hierarchy .............................................................................................................. 120 Owner ........................................................................................................................................... 120 Create a Plant Hierarchy Item on the Highest Level .................................................................... 121 Create a Plant Hierarchy Item on an Intermediate Level ............................................................. 121 Create a Plant Hierarchy Item on the Lowest Level ..................................................................... 122 Delete a Plant Hierarchy Item ...................................................................................................... 123 Owner Operator Domain (As-Built and Projects) ................................................................................ 123 Flow of Activities for Defining a Project Administrator .................................................................. 124 Owner Operator Domain (As-Built and Projects) Common Tasks ............................................... 125 Project Deletion Common Tasks .................................................................................................. 134 Explorer Windows ............................................................................................................................... 135 Working with Explorer Windows Common Tasks ........................................................................ 136 Search for Items ........................................................................................................................... 137 Find a Specific Item in the Tree View ........................................................................................... 138 Filter the Display of Items in an Explorer Window ........................................................................ 138 Filter Cables ................................................................................................................................. 139 Filter Loops According to Blocks .................................................................................................. 141 Add Items to My List in the Items Pane ........................................................................................ 142 Scoping Data for Projects ................................................................................................................... 142 Settings and Conditions for Claiming Items ................................................................................. 143 Scoping Data for Projects Common Tasks .................................................................................. 147 Merging Project and As-Built Data ...................................................................................................... 157 Open the Project Explorer and Merge Buffer ............................................................................... 158 Item and Sub-Item Selection Options for Merging with As-Built .................................................. 158 Generating Reports for Merging Data Common Tasks ................................................................ 159 Copy Items to the Merge Buffer Common Tasks ......................................................................... 162 Merging Project and As-Built Data Common Tasks ..................................................................... 164 Naming Conventions ........................................................................................................................... 172 Compatibility with Instrumentation Standards .............................................................................. 172 Naming Conventions Common Tasks .......................................................................................... 173 Notes for Creating Naming Conventions for Wiring Items ........................................................... 174 Define Naming Conventions ......................................................................................................... 174 Copy Naming Conventions to Other <Units> ............................................................................... 176 Copy Naming Conventions from Another <Unit> ......................................................................... 177 Document Number Naming Convention Examples ...................................................................... 177 Generate Naming Convention Reports ........................................................................................ 179 Wire End Naming Conventions .................................................................................................... 179 Access Rights ..................................................................................................................................... 182 Access Rights Common Tasks .................................................................................................... 183 Access Rights Descriptions .......................................................................................................... 184 Grant Access Rights for Selected Items or Activities ................................................................... 192 Grant the Same Access Rights for All Items ................................................................................ 193 Workflow Access Rights ............................................................................................................... 194 Copy Access Rights ..................................................................................................................... 195 View the Items in the Current Domain.......................................................................................... 195 Generate Access Rights Report ................................................................................................... 195 Preferences Management ................................................................................................................... 196
Contents
Managing Preferences Common Tasks ....................................................................................... 196 Set Domain Preferences .............................................................................................................. 197 Set Project Preferences................................................................................................................ 197 Copy Project Preferences ............................................................................................................ 198 Export Preferences ....................................................................................................................... 198 Import Preferences ....................................................................................................................... 199 Report Management ........................................................................................................................... 199 Report Management Common Tasks .......................................................................................... 199 Associate a New Title Block with a Report ................................................................................... 200 Title Block Descriptions ................................................................................................................ 200 Set Archiving Options for Report Comparison ............................................................................. 202 Define Report Revision Management Settings ............................................................................ 203 Add-Ins ................................................................................................................................................ 204 Import Hook-Up Libraries ............................................................................................................. 204 Import System Interfaces.............................................................................................................. 205 Import Browser Views................................................................................................................... 206 Import DCS Hardware I/O Library Data ........................................................................................ 206 Import DDP Library Data .............................................................................................................. 207 Export Macros .............................................................................................................................. 207 Import Macros ............................................................................................................................... 208 Import Spec Forms ....................................................................................................................... 208 Miscellaneous Domain Administration Tasks ..................................................................................... 209 Define Panel Location Levels ....................................................................................................... 210 Assign Icons to Telecom Device Types ....................................................................................... 211 Define Custom Fields ................................................................................................................... 212 Sequence Numbers and Process Data Custom Fields ................................................................ 213 Copy Custom Fields ..................................................................................................................... 213 Browsers That Can Contain Custom Fields ................................................................................. 214 Define Custom Tables .................................................................................................................. 216 Generate Domain Administration Reports.................................................................................... 216 Select a Logo ................................................................................................................................ 217 Define Field Personnel Profiles .................................................................................................... 218 Modify Domain Notes ................................................................................................................... 218 Modify Printer Settings ................................................................................................................. 218 Managing Audit Trail Data .................................................................................................................. 219 Managing Audit Trail Data Common Tasks ................................................................................. 219 Load Audit Trail Data .................................................................................................................... 220 Trim Audit Trail Data..................................................................................................................... 221 External Files with Trimmed Audit Trail Data ............................................................................... 221 Define Paths When Using Oracle ................................................................................................. 222 Define Paths When Using SQL Server ........................................................................................ 222 Define Paths When Using Sybase Adaptive Server Anywhere ................................................... 223 Clearing Locking ................................................................................................................................. 223 Clearing Locking Common Tasks ................................................................................................ 224 Clear Locking per User ................................................................................................................. 225 Clear Blocked Sessions on Oracle ............................................................................................... 225 Clear Locking in All Sessions ....................................................................................................... 225 Clear SmartPlant Instrumentation Session Records .................................................................... 225 Copying Data ...................................................................................................................................... 226 Flow of Activities for Copying Data ............................................................................................... 227 Copying Data Common Tasks ..................................................................................................... 228 Select the Source Plant Hierarchy Item for Copying Data ........................................................... 228 Copy Specific Data ....................................................................................................................... 229
Contents
Copy All Module Data ................................................................................................................... 230 Set Wiring Naming Options for Target Plant Hierarchy Item ........................................................ 232 Set Revisions for Target Plant Hierarchy Item ............................................................................. 232 Working with SmartPlant Integration .................................................................................................... 235 Configuring SmartPlant Instrumentation for Integration...................................................................... 236 Integration Common Tasks ................................................................................................................. 236 SmartPlant Instrumentation Configuration Checklist for Integration ............................................ 237 Configure SmartPlant Instrumentation for Integration .................................................................. 237 Item Registry Activities ........................................................................................................................ 239 Register Items .............................................................................................................................. 240 Clean Up Item Registry ................................................................................................................ 240 Define an IDEAL User ......................................................................................................................... 240 Registering Plants ............................................................................................................................... 241 Register a Plant ............................................................................................................................ 241 Retrieve a Plant Hierarchy .................................................................................................................. 242 Define Preferences Settings for an Integrated Environment .............................................................. 243 Tool Requirements for Integrating SmartPlant Instrumentation ......................................................... 243 General Integration Requirements ............................................................................................... 243 Naming Convention Requirements for Integration ....................................................................... 244 Working with SmartPlant P&ID ..................................................................................................... 247 Working with SmartPlant Electrical .............................................................................................. 248 Using Projects in an Integrated Environment ............................................................................... 249 Naming Convention Mapping ....................................................................................................... 250 Configure SmartPlant Instrumentation to Use Minor Revisions ......................................................... 251 SmartPlant Instrumentation Interface Languages ............................................................................... 253 Interface Languages Common Tasks ................................................................................................. 254 Import a New Interface Language....................................................................................................... 254 Replace the Interface Language with a Language from the Database .............................................. 255 Replace the Interface Language with a Language from an External File ........................................... 255 Translate Interface Text Phrases ........................................................................................................ 256 Complementary Resource Files ................................................................................................... 257 Prefixes and Suffixes in the Interface Text ......................................................................................... 257 Windows and Dialog Boxes.................................................................................................................... 259 A .......................................................................................................................................................... 259 Access Rights Window Toolbar .................................................................................................... 260 Access Rights Window ................................................................................................................. 260 Accounting Dialog Box ................................................................................................................. 261 Active Database Connections Dialog Box .................................................................................... 261 Activity Tracking Report Settings (Graph) Dialog Box ................................................................. 262 Activity Tracking Report Settings (Grid) Dialog Box ..................................................................... 263 Add Accounting Dialog Box .......................................................................................................... 263 Add Client Dialog Box................................................................................................................... 263 Add Contractor Dialog Box ........................................................................................................... 264 Add Database Views Dialog Box .................................................................................................. 264 Add Datafiles (SQL Server) Dialog Box ....................................................................................... 264 Add Datafiles (Oracle) Dialog Box ................................................................................................ 265 Administration Window ................................................................................................................. 265 Advanced Domain Preferences Dialog Box ................................................................................. 265
Contents
Advanced Filter Definition (Cables) Dialog Box ........................................................................... 266 Advanced Filter Definition (Loops) Dialog Box ............................................................................. 267 Advanced Project Preferences Dialog Box .................................................................................. 268 Area Properties Dialog Box .......................................................................................................... 269 Assign Groups to Project Dialog Box ........................................................................................... 270 Assign Users to Groups Dialog Box ............................................................................................. 270 B .......................................................................................................................................................... 270 Back Up Domain Dialog Box ........................................................................................................ 271 Backup Repository Dialog Box ..................................................................................................... 272 C .......................................................................................................................................................... 273 Change Admin Schema Password Dialog Box ............................................................................ 273 Change Domain Schema Password Dialog Box .......................................................................... 274 Change Security Schema Password Dialog Box ......................................................................... 274 Change Password Dialog Box ...................................................................................................... 274 Clear Activity Tracking Data Dialog Box....................................................................................... 275 Clear Locking in Selected Sessions Dialog Box .......................................................................... 275 Client Dialog Box .......................................................................................................................... 276 Colors Dialog Box ......................................................................................................................... 276 Comparison List Dialog Box ......................................................................................................... 277 Comparison List Filter Dialog Box ................................................................................................ 278 Comparison List Report Dialog Box ............................................................................................. 279 Contractor Dialog Box .................................................................................................................. 279 Copy Data from Source Dialog Box ............................................................................................. 279 Copy Access Rights Dialog Box ................................................................................................... 283 Copy From Dialog Box ................................................................................................................. 284 Copy from Project Dialog Box ...................................................................................................... 284 Copy from Project Dialog Box ...................................................................................................... 284 Copy Naming Conventions From Dialog Box ............................................................................... 285 Copy Naming Conventions Dialog Box ........................................................................................ 285 Copy to Projects Dialog Box ......................................................................................................... 285 Custom Fields Dialog Box ............................................................................................................ 286 Custom Tables Dialog Box ........................................................................................................... 287 D .......................................................................................................................................................... 288 Data Files to Delete Manually Dialog Box .................................................................................... 288 Delete Invalid Domain Dialog Box ................................................................................................ 288 Delete Projects Dialog Box ........................................................................................................... 289 Department Dialog Box ................................................................................................................ 289 Domain Data and Indexes Dialog Box ......................................................................................... 290 Domain Administration Window ................................................................................................... 291 Domain Definition Window (Domain Administration) ................................................................... 291 Domain Definition Window Toolbar (Domain Administration) ...................................................... 295 Domain Definition Window (System Administration) .................................................................... 295 Domain Definition Window Toolbar (System Administration) ....................................................... 299 Domain Tablespace Definition Dialog Box ................................................................................... 299 E .......................................................................................................................................................... 300 Export Macros Dialog Box ............................................................................................................ 300 F .......................................................................................................................................................... 301 Field Personnel Profile Dialog Box ............................................................................................... 301 Filegroup List Dialog Box.............................................................................................................. 301 Filter Definition Dialog Box ........................................................................................................... 301 Find Item Dialog Box .................................................................................................................... 303 G ......................................................................................................................................................... 303 Generate Access Rights Report Dialog Box ................................................................................ 303
Contents
Global Access Rights Dialog Box ................................................................................................. 304 Group Dialog Box ......................................................................................................................... 305 I ........................................................................................................................................................... 306 Import Browser Views Dialog Box ................................................................................................ 306 Import Spec Forms Dialog Box .................................................................................................... 307 Import DCS Hardware I/O Library Dialog Box .............................................................................. 308 Import DDP Library Data Dialog Box ............................................................................................ 308 Import Hook-Up Library Dialog Box .............................................................................................. 308 Import Interface Language Dialog Box ......................................................................................... 309 Import Macros Dialog Box ............................................................................................................ 309 Import System Interfaces Dialog Box ........................................................................................... 309 Initialize (Oracle) Dialog Box ........................................................................................................ 310 Initialize (SQL Server) Dialog Box ................................................................................................ 311 Initialize (Sybase Adaptive Server Anywhere) Dialog Box ........................................................... 313 Items and Activities for Access Rights Dialog Box ....................................................................... 314 L .......................................................................................................................................................... 315 List of Duplicate Items Dialog Box ................................................................................................ 315 Load Audit Trail Data Dialog Box ................................................................................................. 315 Log File Dialog Box ...................................................................................................................... 316 M ......................................................................................................................................................... 316 Microsoft SQL Server Connection Dialog Box ............................................................................. 316 N .......................................................................................................................................................... 317 Naming Conventions Dialog Box .................................................................................................. 317 O ......................................................................................................................................................... 320 Open Administration Module Dialog Box...................................................................................... 320 Optimize Indexes (Oracle) Dialog Box ......................................................................................... 320 Optimize Indexes (SQL Server) Dialog Box ................................................................................. 320 Oracle Server Connection Dialog Box .......................................................................................... 321 Owner Dialog Box ......................................................................................................................... 322 P .......................................................................................................................................................... 322 Page Setup Dialog Box ................................................................................................................ 322 Panel Location Levels Dialog Box ................................................................................................ 323 Plant Hierarchy Dialog Box .......................................................................................................... 324 Plant Hierarchy Explorer............................................................................................................... 325 Plant Properties Dialog Box ......................................................................................................... 326 Preferences for Scoping and Merging Data Dialog Box ............................................................... 328 Preferences Management Dialog Box .......................................................................................... 332 Print Options ................................................................................................................................. 335 Print Preview Dialog Box .............................................................................................................. 335 Project Activities Dialog Box ......................................................................................................... 336 R .......................................................................................................................................................... 392 Rebuild Catalog Tables Dialog Box .............................................................................................. 392 Rebuild Default Views in Domains Dialog Box ............................................................................. 393 Rebuild Projects in Domain Dialog Box ........................................................................................ 393 Rebuild Stored Procedures and Triggers Dialog Box .................................................................. 394 Remove Deleted Windows Users Dialog Box .............................................................................. 394 Report Management Dialog Box .................................................................................................. 395 Required Wiring Equipment Report Dialog Box ........................................................................... 397 Reserve Item ID Ranges for Projects Dialog Box ........................................................................ 398 Reserve Tags and Loops Dialog Box ........................................................................................... 398 S .......................................................................................................................................................... 400 Scope Definition Dialog Box ......................................................................................................... 400 Search Dialog Box ........................................................................................................................ 401
Contents
Security Options Dialog Box ......................................................................................................... 402 Security Schema Password Encryption Dialog Box ..................................................................... 402 Select Columns for Sorting Dialog Box ........................................................................................ 403 Select Columns for Viewing Dialog Box ....................................................................................... 403 Select Item Types for Comparison Dialog Box ............................................................................ 403 Select Item Types for Reports Dialog Box ................................................................................... 404 Select Logo Dialog Box ................................................................................................................ 404 Select (Copy Unit Data) Dialog Box ............................................................................................. 404 Select (Naming Conventions) Dialog Box .................................................................................... 405 Select Plant (for Registering) Dialog Box ..................................................................................... 405 Select Plant (for Retrieving Documents) Dialog Box .................................................................... 405 Select Source Database Dialog Box ............................................................................................ 405 Select Source for Claiming Dialog Box ........................................................................................ 406 Set Color Dialog Box .................................................................................................................... 407 Source Data Connection Dialog Box ............................................................................................ 407 System Administration Window .................................................................................................... 409 Schema Grid ................................................................................................................................. 409 T .......................................................................................................................................................... 410 Tablespace List Dialog Box .......................................................................................................... 410 New Database Definitions Dialog Box .......................................................................................... 410 Target Database Parameters (SQL Server) Dialog Box .............................................................. 412 Target Revisions Dialog Box ........................................................................................................ 413 Telecom Device Panel Icons Dialog Box ..................................................................................... 414 To Do List Dialog Box ................................................................................................................... 415 Trim Audit Trail Data Dialog Box .................................................................................................. 415 U - V .................................................................................................................................................... 416 Unit Properties Dialog Box ........................................................................................................... 416 Update Statistics Dialog Box ........................................................................................................ 418 User-Defined Database Views Dialog Box ................................................................................... 418 User (Domain Administration) Dialog Box .................................................................................... 418 User (System Administration) Dialog Box .................................................................................... 419 W ......................................................................................................................................................... 420 Wire End Naming Conventions Dialog Box .................................................................................. 420 Wire End Naming Convention Properties Dialog Box .................................................................. 420 Wiring Item Naming Options Dialog Box ...................................................................................... 422 Z .......................................................................................................................................................... 423 Zoom............................................................................................................................................. 423 Owner Operator Domain Explorer Windows ........................................................................................ 425 As-Built Explorer ................................................................................................................................. 425 Claim Buffer ........................................................................................................................................ 426 Claimed Items ..................................................................................................................................... 427 Merge Buffer ....................................................................................................................................... 428 Project Explorer................................................................................................................................... 429 Source Project Explorer ...................................................................................................................... 430 Target Project Buffer ........................................................................................................................... 432 Item Indicators..................................................................................................................................... 433 Cable Hierarchy Example ................................................................................................................... 433 Panel by Category Hierarchy Example ............................................................................................... 434 Panel by Location Hierarchy Example ................................................................................................ 435
10
Contents
Glossary ................................................................................................................................................... 437 Index ......................................................................................................................................................... 441
11
SECTION 1
13
14
SECTION 2
15
However, you may need to create either larger tablespaces or indexes. During the lifetime of the instrumentation data, you may also need to increase the size of existing index tablespace. The following table lists important statistical data which you can use as a guide when selecting the domain tablespace and index sizes: Item Types Instruments Loops CAD drawing blocks Device panels Junction boxes Marshaling racks Cabinets DCSs and PLCs Channels Quantity (Average) 45058 16616 1381 11384 504 45 36 108 16880
16
The above item type quantities populate a domain whose tablespace and index sizes are as follows: Admin Data Tablespace 30 MB Admin Index Tablespace 10 MB Domain Data Tablespace 350 MB Domain Index Domain Temporary Data Tablespace Data Tablespace 180 MB 100 MB (auto-extended)
Later on, you may receive an indication that the available free space in the tablespace is low, or you may encounter a message that there is insufficient space while working in SmartPlant Instrumentation. If this happens, SmartPlant Instrumentation System Administrator can increase the size of the tablespace for the specific domain. For details, see Add Datafiles to Oracle Tablespaces (on page 102). For better performance, it is highly recommended that you locate the data tablespaces and index tablespaces on different physical disks. You can also locate the system file, database tables and the index data on different physical drives to speed up your work in the Oracle Database. See your Oracle User Guide for more information. Each of the file names must be a legal name. Each tablespace name must be unique within your database.
See Also
SmartPlant Instrumentation Database Setup for Oracle (on page 15)
17
SmartPlant Instrumentation Database Setup for Oracle Clean Up the Oracle Database
Use this procedure to clean up the Oracle database by deleting SmartPlant Instrumentation database objects created during a specific database setup session. You must perform this procedure if a database setup did not complete successfully and you want to run the same setup again. You clean up the database using Oracle tools. For more information, see Clean Up the Oracle Database (on page 23).
18
SmartPlant Instrumentation Database Setup for Oracle Database Creation - Tablespaces Creation Modes
The user now creates the database and tablespaces for the Admin and the Domain or Domains. The user may use existing tablespaces or create new ones. To create tablespaces the user has the following modes: Automatic The tablespaces for the administration and domain or domains are created automatically. The user then has to define the tablespaces for the Domain or Domains. Customized The user is able to configure the tablespace name, data file name and path, and the tablespace size of the Admin schema data, Admin schema indexes, and Temporary tablespaces. The user then has to define the tablespaces for the Domain or Domains. Predefined The user predefines a list of tablespaces as desired. The user then selects the desired Admin schema data from the predefined list. The Temporary tablespaces names, data file name and path, and the tablespace size are created automatically. The user then has to define the tablespaces for the Domain or Domains. 1. In dbsetup click Connect to connect to your Oracle database server.
2.
Accept the default Administration schema login name and Administration schema login password values in_dbamn.
If you want to modify the login name or password, verify that the login name is unique in the Oracle database server. The login name and password can only start with a letter and contain no spaces. You can use an underscore instead of a space. If you wish to encrypt the password, see Encrypt the Admin Schema Logon Password. 3. Continue to either the Automatic, or Customized, options as described in the Automatic mode of tablespaces creation and Customized mode of tablespaces creation. Else, if the Predefined mode is required, continue to Predefined mode of tablespaces creation.
19
SmartPlant Instrumentation Database Setup for Oracle Customized mode of Tablespaces creation
1. On the New Database Definitions dialog box, from the Tablespaces options, select Customize, and click Create.
2. Under Administration schema data, do the following: a. From the Tablespace name list, select the desired tablespace name. b. In the Data file name and path field, insert the desired path details. c. In the Tablespace size field, insert the desired tablespace size. 3. Under Administration schema indexes, do the following: a. Accept the Tablespace name or type in a desired tablespace name. b. In the Data file name and path field, insert the desired path details. c. In the Tablespace size field, insert the desired tablspace size. 4. Under Temporary Tablespaces, do the following: a. Accept the Tablespace name or type in a desired tablespace name. b. In the Data file name and path field, insert the desired path details. c. In the Tablespace size field, insert the desired tablespace size. 5. Click Create. 6. Continue to section Defining Domain Tablespaces in Oracle (on page 57). If you want to create more than four SmartPlant Instrumentation domains, for the Admin data tablespace, specify a size larger than 25 MB, and for the Admin index tablespace, specify a size larger than 10 MB.
20
Administration Schema
1. Administration data tablespace: a. Create tablespace ZED007 datafile 'ZED007.db' size 15M autoextend on next 10M maxsize 3000M; b. Create tablespace ZED007i datafile 'ZED007i.db' size 15M autoextend on next 10M maxsize 3000M; 2. Temporary tablespace: Create Temporary tablespace ZED007temp tempfile 'ZED007temp.db' size 2M autoextend on next 2M maxsize 3000M;
Domain Schema
Domain tablespace: a. Create tablespace ZED007demo datafile 'ZED007demo.db' size 20M autoextend on next 10M maxsize 3000M; b. Create tablespace ZED007demoi datafile 'ZED007demoi.db' size 20M autoextend on next 10M maxsize 3000M; Repeat the above process for each domain schema as desired.
1. On the New Database Definitions dialog box, from the Tablespaces options, select Predefined, and click Create.
21
2. Under Administration schema data, from the Tablespace name list, select the desired tablespace name. 3. Under Administration schema indexes, from the Tablespace name drop-down list, select the desired tablespace name. 4. Under Temporary Tablespaces, from the Tablespace name drop-down list, select the desired tablespace name. 5. Click Create. 6. The user may, if desired, continue to section Defining Domain Tablespaces in Oracle (on page 57).
1. Each domain requires two tablespaces. 2. Once predefined tablespaces is selected in Dbsetup.exe, Init will work with predefined tablespaces by default. This is controlled through the predefinedtablespaces flag in the License table.
See Also
Setting up a Database for Oracle Common Tasks (on page 17) SmartPlant Instrumentation Database Setup for Oracle (on page 15) Oracle Database Server Tablespaces for SmartPlant Instrumentation (on page 16)
22
See Also
Setting Up a Database for Oracle Common Tasks (on page 17) SmartPlant Instrumentation Database Setup for Oracle (on page 15) Oracle Database Server Tablespaces for SmartPlant Instrumentation (on page 16)
23
24
SECTION 3
25
Administration data (admin data files and index data files), SmartPlant Instrumentation database log file and history data are based on four filegroups: two SmartPlant Instrumentation default filegroups and two SQL Server filegroups. The SQL Server filegroups cannot be edited. The default total file size in these filegroups is 70 MB. Each filegroup is based on an auto-extended data file. Such a file automatically extends to the limits of your disk. The following table lists important statistical data that you can use as a guide when selecting the domain file sizes (the disc space required for such a domain is 650 MB): Item Types Instrument tags Loops CAD loop drawing blocks Device panels Junction boxes Marshaling racks Cabinets DCSs and PLCs Quantity (Average) 45058 16616 1381 11384 504 45 (208366 total number of terminals) 36 108
26
The above item type quantities populate a domain whose file sizes are as follows: Admin Datafile Admin Index Datafile 15 MB 5 MB Domain Datafile Domain Index Datafile 350 MB 180 MB Log Datafile 50 MB
Later, if you receive an indication that the available free space in the filegroup is low, or encounter a message that there is insufficient space while working in SmartPlant Instrumentation, you need to increase the filegroup size for the appropriate domain. For details, see Add a Filegroup (on page 100). Make sure the total file size that you specify does not exceed the available empty space on your selected disks. The default is 70 MB, which includes the size of the file for the recommended initial size of the Admin data and indexes, and SmartPlant Instrumentation database Log file Each of the file names must be a legal name. Each file name must be unique within your database. Special characters are not supported.
27
SmartPlant Instrumentation Database Setup for SQL Server Clean Up the SQL Server Database
Use this procedure to clean up the SQL Server database by deleting SmartPlant Instrumentation database objects created during a specific database setup session. You must perform this procedure if a database setup did not complete successfully and you want to run the same setup again. You clean up the database using SQL Server tools. For more information, see Clean Up the SQL Server Database (on page 30).
See Also
SmartPlant Instrumentation Database Setup for Oracle (on page 15) SmartPlant Instrumentation Database Setup for SQL Server (on page 25)
28
29
30
SECTION 4
31
Back Up a Domain
This procedure enables the System Administrator to select an existing domain on the server database on SQL Server or Oracle and then back up this domain to the backup repository. The backup repository is the INtools_Backup.db database, which is a Sybase Adaptive Server Anywhere database, created automatically during SmartPlant Instrumentation setup. For more information, see Back Up a Domain (on page 32).
Workaround for the INtools_Backup.db Connection Problem in Windows Vista and Windows 7
This workaround enables you to resolve the problem of connecting to the INtools_Backup.db database in Windows Vista and Windows 7. This problem occurs if the User Account Control in Windows Vista and Windows 7 is set to On. To resolve this problem, you need to temporarily set the User Account Control in Windows Vista and in Windows 7 to Off. For more information, see Workaround for an Initialization Problem in Windows Vista and Windows 7 (on page 63).
Back Up a Domain
If you work in thin client environment, for example, Citrix, you must copy the INtools.ini file to the SmartPlant Instrumentation home folder on the server machine to be able to perform a backup procedure. On backup completion, remove the Intools.ini file from the server machine. If you want to back up a domain in Windows Vista or in Windows 7, you might need to temporarily turn off the User Account Control in Windows Vista. For details, see Workaround for an Initialization Problem in Windows Vista and Windows 7 (on page 63). 1. With the System Administration window open, click File > Backup. 2. On the Backup Repository dialog box, click Browse to select the Intools_backup.db database file, and display it in the Target database name and path box.
32
See Also
Managing Audit Trail Data (on page 219)
33
The Yes/No parameter for copying user definitions Y or N from the source domain to the target Sybase Adaptive Server Anywhere database file. The software can only copy those users who are assigned to groups. The Yes/No parameter for copying the department definitions from the source domain to the target Sybase Adaptive Server Anywhere database file. Y or N
The Yes/No parameter for saving the ID of the last Y or N item that was created in the domain. Set this parameter to Y (yes) if you later intend to merge items in the Merger utility. Set this parameter to N (no) if you previously backed up the domain and you want to merge data that was modified since this previous backup. The name of the domain that you use as a source for backup. The full path to INtools_Backup.db, which is the only database you can use as a target database for a domain backup. INtools_Backup.db is a Sybase Adaptive Server Anywhere database that comes shipped with SmartPlant Instrumentation. IN_DEMO d:\Program Files\SmartPlant\ Instrumentation\ INtools_Backup.db
Example
Init.exe BKC,Y,Y,N,IN_DEMO, d:\Program Files\SmartPlant\Instrumentation\INtools_Backup.db After completing the backup process, you can check the InitLog.txt file for errors that might have occurred during the domain backup. The InitLog.txt file appears in the SmartPlant Instrumentation home folder. In this log file, the software automatically records errors that do not cause the backup process to fail.
See Also
Initialize a Domain from the Command Line (on page 55)
34
Y or N
The Yes/No parameter for saving the ID of the last item that was Y or N created in the domain. Set this parameter to Y (yes) if you later intend to merge items in the Merger utility. Set this parameter to N (no) if you previously backed up the domain and you want to merge data that was modified since this previous backup. The Domain name of the schema that you use as a source for backup. The full path to INtools_Backup.db on the Citrix server. INtools_Backup.db is the only database you can use as a target database for a domain backup. INtools_Backup.db is a Sybase Adaptive Server Anywhere database that comes shipped with SmartPlant Instrumentation. The full path to the Intools.ini file located on the thin client. IN_DEMO d:\Program Files\SmartPlant\ Instrumentation\ INtools_Backup.db u:\Program Files\SmartPlant\ Instrumentation
Example
Init.exe BKC,Y,Y,N,IN_DEMO, d:\Program Files\SmartPlant\Instrumentation\INtools_Backup.db,u:\Program Files\SmartPlant\Instrumentation After completing the backup process, you can check the InitLog.txt file for errors that might have occurred during the domain backup. The InitLog.txt file appears in the SmartPlant Instrumentation home folder. In this log file, the software automatically records errors that do not cause the backup process to fail.
See Also
Initialize a Domain from the Command Line (on page 55)
35
In Windows 7
1. Click the Start button and in the Search box type UAC. 2. Click Change User Control Change Settings. 3. Move the slider down to the Never notify position to set the UAC OFF or up to select when you want to be notified to turn the UAC ON. 4. Click OK. When setting the UAC to OFF you will need to restart the computer and when setting the UAC to ON you will need to insert a password and provide a confirmation.
In Windows Vista
1. 2. 3. 4. 5. 6. Before backing up a domain, in your Windows Vista Control Panel, click User Accounts. Click Turn User Account Control on or off. Clear Use User Account Control (UAC) to help protect your computer . Restart the computer. Back up the domain. Turn the UAC on if needed. Instead of turning UAC off, it is also possible to manually update the content of the PATTERN_wat key in your Windows Registry. In the Registry Editor, the key appears in the path HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI. You need to define the correct parameters for the Intools_backup.db database in the key strings. When the User Account Control in Windows Vista or Windows 7 is set to On, you cannot initialize a domain either. The same workaround applies.
36
See Also
Backing up Audit Trail Data on SQL Server (on page 38) Backing up Audit Trail Data on Sybase Adaptive Server Anywhere (on page 39) Managing Audit Trail Data (on page 219)
See Also
Managing Audit Trail Data (on page 219)
See Also
Managing Audit Trail Data (on page 219)
37
Back Up Files When Moving a Database from One Oracle Server to Another
1. On your target Windows server, select a disk drive with 300 MB free disk space for the storage of about 1 million records. 2. Create a folder INtoolStorage. 3. Create a subfolder <drive>:\INtoolStorage\<name of new Oracle database server>. The name of the new Oracle database appears as the value of the db_name parameter in the Oracle Instance Configuration file. For example, orc2. 4. Open the Oracle Instance Configuration file init.ora. 5. In the Oracle Instance Configuration file, add the following parameter line: utl_file_dir=<drive>:\INtoolStorage \orc2 6. Copy the content of the folder orc1 in the source path <drive>:\INtoolStorage to the folder orc2 in the target path <drive>:\INtoolStorage. 7. Restart your computer.
See Also
Managing Audit Trail Data (on page 219)
See Also
Managing Audit Trail Data (on page 219)
38
See Also
Managing Audit Trail Data (on page 219)
39
See Also
Managing Audit Trail Data (on page 219)
See Also
Managing Audit Trail Data (on page 219)
Domain Initialization
In SmartPlant Instrumentation, the working environment for your instrumentation activities is known as a domain. The domain type can be either Engineering company or Owner operator. The System Administrator is responsible for initializing (creating) domains. After initializing a domain, it is possible to define users, access rights, naming conventions, and so forth. When initializing a domain, the software creates the Domain schema, which contains all the database objects that allow you to work with SmartPlant Instrumentation. On Oracle or SQL Server, you can initialize a domain only after completing the SmartPlant Instrumentation database setup. You can create several domains (one domain at a time). These domains share the Admin schema, created during the database setup. The Admin schema already contains the SmartPlant Instrumentation database tables, but you cannot use these tables until the software creates a Domain schema, with various object references necessary for working in SmartPlant Instrumentation. For example, the Admin schema contains the table USERS but you cannot create users, assign them to groups, and grant access rights until a Domain schema exists because you can only perform these activities at a domain level. When initializing a domain, the Domain schema, receives the INTOOLS_ENGINEER role, which is created during the database setup. This role has system privileges and privileges for database objects included in the Admin schema. These objects are shared for all domains you initialize.
40
41
Domain Backup, Initialization, and Deletion Domain Initialization in Sybase Adaptive Server Anywhere
We recommend that you initialize only one domain in a given Sybase Adaptive Server Anywhere database. Therefore, make copies of the target database file so that you can use one copy per initialization. You can copy the target database file to another location, and then use this file as a standard database for initialization of new domains. You can use as a target database any Sybase Adaptive Server Anywhere database supplied with SmartPlant Instrumentation, apart from INtools_Backup.db, which you must only use for backing up an existing domain. However, it is recommended that you use INtools.db because this database it does not contain any Domain schemas, only the Admin schema.
See Also
Domain Backup (see "Domain Backup, Initialization, and Deletion" on page 31)
42
Initialize a Domain in Sybase Adaptive Server Anywhere Using Another Domain as a Source
Use this procedure to initialize a domain in a Sybase Adaptive Server Anywhere database using another domain as a source, provided that you have a full version of Sybase Adaptive Server Anywhere database engine. The source domain can reside in any database platform that SmartPlant Instrumentation supports. For more information, see Initialize a Domain in Sybase Adaptive Server Anywhere Using Another Domain as a Source (on page 46).
43
Domain Backup, Initialization, and Deletion Initialize a Domain from the Command Line
This topic describes how to initialize a domain without using the Administration module options of SmartPlant Instrumentation. To do so, you, you need to specify additional parameters. When initializing a domain without using SmartPlant Instrumentation, you do not use any source domain, and, therefore, the software creates a new empty domain in your database platform (that is, Oracle or SQL Server). For more information, see Initialize a Domain from the Command Line (on page 55).
See Also
Initialization Log Files (on page 56)
See Also
Troubleshooting Domain Initialization Common Tasks (on page 62)
44
See Also
Troubleshooting Domain Initialization Common Tasks (on page 62)
45
Initialize a Domain in Sybase Adaptive Server Anywhere Using Another Domain as a Source
Before initializing a domain, familiarize yourself with domain initialization prerequisites. For details, see Prerequisites for Domain Initialization (on page 41). 1. Start the Administration module to open the Logon Information dialog box with DBA displayed in the User name box. This user name is the default user name that enables you to log on to the Admin schema. 2. In the Password box, type DBA, which is the default password you use to log on to the Admin schema. 3. Click OK to open the System Administration window. 4. Click File > Initialize. 5. On the Initialize dialog box, in the Domain box, type the target domain name, which must start with a letter, and contain only alphanumeric characters without spaces. You can use an underscore (_) to indicate a space. You are allowed to use a name of previously deleted domain. You can modify the domain name after completing the initialization. For details, see Make Domain Definitions (on page 80). 6. In the Domain schema name box, type the logon name of the domain schema, which must start with a letter, and contain only alphanumeric characters without spaces. You can use an underscore to indicate a space. The software needs to use this name internally to connect to this domain. 7. In the Domain schema password box, type the logon password of the Domain schema, which must start with a letter, and contain only alphanumeric characters without spaces. You can use an underscore ( _ ) to indicate a space. The domain schema password is case-sensitive. The schema password must be different from the domain name. We recommend that you write down the schema password and keep it in a safe place. When initializing a domain, the software changes all the password characters to upper case. This means that if the Domain schema name is MY_DOMAIN, you cannot use my_domain as the password string. 8. In the View-Only Domain schema password box, accept the default password of the View-Only Domain schema or change it as appropriate, provided that the setting starts with a letter, and contains only alphanumeric characters without spaces. You can use an underscore (_) to indicate a space. The default password and the characters that you type when changing the password appear masked. 9. Click Source. 10. On the Source Data Connection dialog box, from the Database type list, select one of the following options: Sybase Adaptive Server Anywhere Allows you to click Browse and select another Sybase Adaptive Server Anywhere database as a source (a file with the .db extension). Oracle 9i or Oracle 10g Allows you to use a domain residing in Oracle. After selecting the Oracle version, the Server box becomes available. You must type the source Oracle instance alias name.
46
The source and target versions of the SmartPlant Instrumentation database must be the same. 11. Click Connect to connect to the source database. 12. From the Domain list, select a domain to be used as a source. 13. Select the Copy users to target domain if you want to copy all the existing SmartPlant Instrumentation user definitions to the new domain. The software can only copy those users who are assigned to groups. 14. Select the Copy departments to target domain if you want to copy all the existing SmartPlant Instrumentation department definitions to the new domain. 15. In the Source Data Connection dialog box, click OK to return to the Initialize dialog box. The domain type of the source and target domain must be the same. After you connect to the source database, the software automatically detects the source domain type and selects the appropriate option on the Initialize dialog box, under Domain type. During the initialization process, the software might display various error messages that do not cause the initialization process to fail. If want to prevent the software from displaying these message, select the Do not display error messages check box. After completing the initialization process, you can view the error messages recorded in the InitLog.txt file, which appears in the SmartPlant Instrumentation home folder. 16. Click OK to start the initialization process.
See Also
Troubleshooting Domain Initialization Common Tasks (on page 62)
47
48
See Also
Troubleshooting Domain Initialization Common Tasks (on page 62)
1.
2. 3. 4. 5.
You are allowed to use a name of previously deleted domain. You can modify the domain name after completing the initialization. For details, see Make Domain Definitions (on page 80). 6. In the Domain schema name box, type the logon name of the domain schema, which must be unique in the current database, start with a letter, and contain only alphanumeric characters without spaces. You can use an underscore ( _ ) to indicate a space. The software needs to use this name internally to connect to this domain. 7. In the Domain schema password box, type the logon password of the Domain schema, which must be unique in the current database, start with a letter, and contain only
49
11.
The software can only copy those users who are assigned to groups. 15. Select the Copy departments to target domain if you want to copy all the existing SmartPlant Instrumentation department definitions to the new domain. 16. In the Source Data Connection dialog box, click OK to return to the Initialize dialog box. The domain type of the source and target domain must be the same. After you connect to the source database, the software automatically detects the source domain type and selects the appropriate option on the Initialize dialog box, under Domain type. During the initialization process, the software might display various error messages that do not cause the initialization process to fail. If want to prevent the software from displaying these message, select the Do not display error messages check box. After completing the initialization process, you can view the error messages recorded in the InitLog.txt file, which appears in the SmartPlant Instrumentation home folder.
50
See Also
Troubleshooting Domain Initialization Common Tasks (on page 62)
51
c.
52
See Also
Troubleshooting Domain Initialization Common Tasks (on page 62)
53
12. 13.
54
c.
The values in the Index file name and Filegroup boxes must be unique in the database. For example, if you have six domains in one database, you must have six different index file names. 21. Click OK to start the initialization process. If, during the process, you receive a Grant to view Creation Error message, see Workaround for the Grant to View Creation Error (on page 66). After completing the initialization process, it is strongly recommended that you update the current database statistics for the initialized domain. Updating statistics improves the database performance. Start the Query Analyzer and run the SP_UPDATESTATS procedure.
See Also
Troubleshooting Domain Initialization Common Tasks (on page 62)
55
The initial parameter, which allows you to start INIT.EXE the database engine. Stands for the name of the operation The name of your target domain The name of the target Domain schema The password of the target Domain schema INT DEMO DEMO DEMO
Example
INIT.EXE INT,DEMO,DEMO,DEMO After completing the initialization process, you can check the InitLog.txt file for errors that might have occurred during the domain initialization. The InitLog.txt file appears in the SmartPlant Instrumentation home folder. In this log file, the software automatically records errors that do not cause the initialization process to fail.
See Also
Troubleshooting Domain Initialization Common Tasks (on page 62)
56
See Also
Troubleshooting Domain Initialization Common Tasks (on page 62)
57
6. Under Domain data, Index data, insert the desired parameters and click OK.
58
6. Under Domain data, from the Tablespace name drop-down list, select the desired Tablespace name as configured in the Domain Schema configuration process and click OK.
Delete a Domain
Use this procedure to delete a domain that is no longer in use. When deleting an owner operator domain, the software deletes all the project schemas and the As-Built schema. You do not have to delete the projects first. For more information, see Delete a Domain (on page 60).
59
Domain Backup, Initialization, and Deletion Delete an Invalid Domain on SQL Server
An invalid domain is a domain whose initialization process failed to complete. You can use this option to delete an invalid domain and also automatically delete all database files associated with this domain. You must exercise an extreme caution when performing this procedure. For more information, see Delete an Invalid Domain on SQL Server (on page 61).
Delete a Domain
Deletion is an operation you should consider very carefully before attempting to perform it. If you delete a domain, the software deletes the Domain schema with all the database objects associated with it. Since this operation is irreversible, you should consider backing up your domain first. 1. Do one of the following to open the Domain Definition window: Click File > Domain Definition. Click . 2. Do one of the following Click Options > Delete. Click .
When deleting a domain in Oracle, if the software detects a rollback segment problem, an appropriate message appears. In this case, click OK and then click Delete again. If this kind of message reappears, click OK each time and then restart the deletion process until you receive a message notifying you that the domain has been deleted successfully. The possible problems that cause the occurrence of the error messages are insufficient disk space, non-optimal storage clause, or insufficient number of rollback segments. After deleting a domain in Oracle, a message is displayed with a list of physical tablespace data files you need to delete manually. In SQL Server, deleting a domain automatically deletes the filegroup and data files associated with the domain. In Sybase Adaptive Server Anywhere, after a domain is deleted, the Sybase Adaptive Server Anywhere database engine automatically optimizes the database size of INtools.db.
See Also
Domain Backup Common Tasks (on page 32)
60
61
See Also
Domain Initialization (on page 40) Prerequisites for Domain Initialization (on page 41) Initialization Log Files (on page 56)
62
63
In Windows 7
1. Click the Start button and in the Search box type UAC. 2. Click Change User Control Change Settings. 3. Move the slider down to the Never notify position to set the UAC OFF or up to select when you want to be notified to turn the UAC ON. 4. Click OK. When setting the UAC to OFF you will need to restart the computer and when setting the UAC to ON you will need to insert a password and provide a confirmation.
In Windows Vista
1. 2. 3. 4. 5. 6. Before backing up a domain, in your Windows Vista Control Panel, click User Accounts. Click Turn User Account Control on or off. Clear Use User Account Control (UAC) to help protect your computer . Restart the computer. Back up the domain. Turn the UAC on if needed. Instead of turning UAC off, it is also possible to manually update the content of the PATTERN_wat key in your Windows Registry. In the Registry Editor, the key appears in the path HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI. You need to define the correct parameters for the Intools_backup.db database in the key strings. When the User Account Control in Windows Vista or Windows 7 is set to On, you cannot initialize a domain either. The same workaround applies.
64
See Also
Initialize a Domain in Oracle Using Another Domain as a Source (on page 49) Initialize an Empty Domain in Oracle (on page 47) Prerequisites for Domain Initialization (on page 41)
65
See Also
Initialize a Domain in SQL Server Using Another Domain as a Source (on page 53) Initialize an Empty Domain in SQL Server (on page 51)
66
SECTION 5
67
See Also
System Administration Common Tasks (on page 77) Working with Administration Module (see "Working with the Administration Module" on page 13)
See Also
Domain Administration Common Tasks (on page 117) Working with Administration Module (see "Working with the Administration Module" on page 13)
See Also
System Administration Common Tasks (on page 77)
See Also
Domain Administration Common Tasks (on page 117)
68
SECTION 6
The software creates a default department with each new domain. If required, you can assign all your users to this department.
See Also
Log on as System Administrator (on page 67) System Administration Common Tasks (on page 77)
69
70
See Also
Log on as System Administrator (on page 67) System Administration Common Tasks (on page 77)
See Also
System Administration Common Tasks (on page 77) Log on as System Administrator (on page 67)
User Groups
A SmartPlant Instrumentation user group is a group in which all users share the same access rights. After the System Administrator defines new users, the Domain Administrator needs to assign the users to groups so that they can be granted access rights to various items or activities. As access rights are defined at the level of a group, the Domain Administrator needs to define user groups and then assign appropriate users to these groups. A user can belong to several groups with different access rights. In a project of an owner operator domain, access rights granted on the domain level do not apply. If you want to grant access rights to a group assigned to a project, you must also assign this group to As-Built. When you or back up an existing domain or initialize a domain using another domain as a source, you can set the software to copy the source domain users. The software only copies those users who are assigned to groups. If the System Administrator enables the use of Windows authentication logon method, the software can create and assign users to groups automatically. For more information, see Windows Authentication Logon Method (on page 74).
71
Delete a Group
This procedure enables the Domain Administrator to delete a group that has no users. For more information, see Delete a Group (on page 73).
See Also
Domain Administration Common Tasks (on page 117)
72
See Also
Access Rights (on page 182)
Delete a Group
1. 2. 3. 4. You can only delete a group that has no users. Start the Administration module and log on as Domain Administrator. Click Activities > Group. From the Group list, select the group that you want to delete. Click Delete.
73
If a user does not see the plant hierarchy after starting SmartPlant Instrumentation, this means that this particular user is not assigned to any group in the domain.
See Also
Access Rights (on page 182)
1. 2. 3. 4. 5. 6. 7.
74
The System Administrator can enable or disable the use of Windows authentication logon method when setting security options. After switching from the Windows authentication logon method back to the SmartPlant Instrumentation logon method, all the users remain in SmartPlant Instrumentation but each user must provide a personal SmartPlant Instrumentation user name and password when logging on. To be able to access SmartPlant Instrumentation using Windows authentication logon method, a user must be connected to the appropriate Windows domain. Only after the user receives the Windows group privileges can the software match the user's Windows domain name with the SmartPlant Instrumentation domain name. Users who do not belong to any Windows user group or who are not defined in any SmartPlant Instrumentation group cannot access the domain. After the software creates users in a SmartPlant Instrumentation group by using Windows authentication logon method, these users remain in the SmartPlant Instrumentation group even if they are removed from the Windows group. These users can no longer access SmartPlant Instrumentation. The System Administrator needs to remove deleted Windows users from SmartPlant Instrumentation.
See Also
Access Rights (on page 182)
See Also
Access Rights (on page 182)
75
76
SECTION 7
System Administration
System Administration is a set of activities that provide for the management of the database infrastructure. These activities include creating and defining a working environment, creating and managing user profiles (including the Domain Administrator), setting audit trail options, setting up database security, generating certain reports, and managing user sessions on multi-user versions.
77
78
Enable Workflow
This procedure explains how to activate the SmartPlant Instrumentation workflow setup. When activated, the software displays the Workflow Browser in SmartPlant Instrumentation to enable instrument engineers to implement the workflow setup. For more information, see Enable Workflow (on page 82).
79
System Administration
Clear Merge without deleting from project to set the software to delete the item from the project when merging this item with As-Built.
If you selected both the Excusive claim mode and Merge without deleting from project check boxes, after a Project Administrator merges project items with As-Built, it is still possible to claim these item for a another project even though there are copies of these items remaining in the project from which the items were merged with As-Built. 8. Set or update the remaining domain definitions as you require. For a detailed description of domain features, see the Help topic Domain Definition Window (see "Domain Definition Window (System Administration)" on page 295). 9. On the window toolbar, click .
See Also
Owner Operator Domain (As-Built and Projects) (on page 123)
80
System Administration
9. In the Plant hierarchy separator box, enter a single- character separator for all or part of a plant hierarchy is displayed as a string. For example, if the separator character is &, and you have plant hierarchy items My Plant, My Area, and My Unit, in the Properties dialog box for the My Unit item, the software displays the parent hierarchy as follows: My Plant&My Area 10. Under Global path, click Browse to navigate to a folder which you want to set as a global path folder. For more information, see Specify a Global Path (on page 83). 11. On the window toolbar, click .
See Also
Log on as System Administrator (on page 67) Title Block Descriptions (on page 200)
81
System Administration
7. Under Domain features, select the Cable type dependency check box. 8. Click to save the current domain data to the database.
See Also
Log on as System Administrator (on page 67)
Enable Workflow
Your Domain Administrator needs to define access rights at the level of individual instrument tags in order to implement workflow. For details, see Workflow Access Rights (on page 194). 1. Start the Administration module and log on as System Administrator. 2. With the System Administration window open, do one of the following to open the Domain Definition window: Click File > Domain Definition. Click . 3. From the Domain list, select a domain. 4. Do one of the following: Click Options > Edit. Click . 5. In the Workflow section, from the Instrumentation and Process Data list, select the required workflow from the following: Full - the software activates all the workflow options, and marks instrument tags for release as a formal issue in a binder package. The Release to Spec option becomes available in the Document Binder module and in the Spec Change Notification Options dialog box. Without Document Binder - the software activates all the workflow options except for the option to release instrument tags as a formal issue in a binder package. None - No workflow options are activated. 6. Click to save the current domain data to the database.
See Also
Log on as System Administrator (on page 67)
82
System Administration
See Also
Item Registry Activities (on page 239) Log on as System Administrator (on page 67)
83
System Administration
Select Allow to overwrite the global path if you want to allow users to set user-defined paths in addition to the specified global path. When this check box is selected, users are not restricted to setting new paths in SmartPlant Instrumentation only within the global path folder. to save the current domain data to the database.
6. Click
See Also
Log on as System Administrator (on page 67)
84
System Administration
85
System Administration
7. Click OK to open the Print Preview dialog box, from where you can view and print the report. If Domain and User are selected as the main and secondary categories, the hours shown in the third column are divided per module. In all other cases, only the total number of hours is shown.
5.
6.
7.
8.
86
System Administration
Logon Process
The logon process in SmartPlant Instrumentation operates at the following levels: 1. The intools.ini file holds the security schema password that provides access to the intools_login schema. 2. The intools_login schema holds the INTOOLS_Login table, which holds the Admin schema user password and logon name. 3. The Admin schema holds the PROJECT table, which in turn holds the names of the existing domains and all the passwords of SmartPlant Instrumentation users.
Admin Schema
Yes
87
System Administration
Schema Domain Schema Password Change Yes Encryption Encrypts all passwords in the following tables: project, engineering_project, sap_project. These are all the domain passwords. Encrypts all passwords in Intools_login table (the table that holds all the SPI usernames & their passwords).
Yes
SQL Server: Schema Security Schema Password Change Yes Encryption The encrypted password is saved in the intools.ini file. This file has to be distributed to all client machines. Note that this password is same for all the databases in a particular instance that is hosted on a given server. The encrypted password and user name are saved in the INTOOLS_LOGIN table. The password and user name are deleted from the intools.ini file. Encrypts all passwords in the following tables: project, engineering_project, sap_project. These are all the domain passwords. Encrypts all passwords in Intools_login table (the table that holds all the SPI usernames & their passwords).
Admin Schema
Yes
Domain Schema
Yes
Yes
Sybase Adaptive Server Anywhere: Schema Security Schema Admin Schema Password Change Not applicable Encryption Not applicable
Changes the password in Not applicable the in the intools.ini file. Changes the password if the Admin schema. Yes Encrypts all passwords in the following tables: project, engineering_project, sap_project. These are all the domain passwords.
Domain Schema
88
System Administration
Schema SmartPlant Instrumentation Users Password Change Yes Encryption Encrypts all passwords in Intools_login table (the table that holds all the SPI usernames & their passwords).
Encryption Results
Security Schema: Unencrypted In the intools.ini file: SecuritySchemaPassword=intools_login Encrypted In the intools.ini file: SecuritySchemaPassword=#2f###RG##T
Admin Schema: Unencrypted In the intools.ini file: The LogId, LogPass, and Dbparm parameters display these values. The intools.ini file is accessible by all users. Encrypted In the intools.ini file, the LogId, LogPass, and Dbparm parameters no not display any values. The LogId and LogPass values are encrypted in the INTOOLS_LOGIN table.
Domain Schema: All the Domain schema passwords are encrypted in the PROJECT, ENGINEERING_PROJECT, and SAP_PROJECT tables. All the user passwords are encrypted in the INTOOLS_USER table. Consequently, none of the passwords are visible to employees with database access rights. SmartPlant Instrumentation User Passwords: All the user passwords are encrypted in the INTOOLS_USER table. Consequently, none of the passwords are visible to employees with database access rights.
89
System Administration
2. In the Current password field, type the current System Administrator logon password. 3. In the New password field, type the new System Administrator logon password. 4. In the Confirm new password field, retype the new password, and click OK. The passwords that you type appear masked. The System Administrator logon password is case-sensitive.
90
System Administration
With the System Administration window open, click DBA > Security Options > Encrypt Admin Schema Password. This option is not available in Sybase Adaptive Server Anywhere. After you select to encrypt the Domain schema logon password the values of the LogId and LogPassword are automatically cleared from the [Database] section of intools.ini file on the System Administrators workstation. For example, where the parameters are displayed as shown: LogId=IN_DBAMN LogPassword=IN_DBAMN you should delete the string =IN_DBAMN in each of the lines. After the encryption, the System Administrator also has to distribute the intools.ini file among all the client machines. The encryption process is irreversible.
91
System Administration
2. Click OK to encrypt the password in the intools.ini file. The encryption process is irreversible.
See Also
Database Maintenance on SQL Server Common Tasks (on page 99) Working with Administration Module (see "Working with the Administration Module" on page 13) Domain Administration (see "Domain and Project Administration" on page 117) System Administration (on page 77)
92
System Administration
93
94
Define Databases
1. In the Intools.ini file, create a [Profiles] section and define the list of databases you want to display on the Logon Information dialog box in the Database list: [Profiles] Database1=My_Database1 Database2=My_Database2 Database3=My_Database3 Default=My_Database1 The Database<number> parameter does not have to be the actual name of the database (or profile names if the database type is SQL Server or Sybase Adaptive Server Anywhere). This value is a display name that appears in the Database list on the Logon Information dialog box. The Default parameter value is the database that appears selected by default in the Database list on the Logon Information dialog box. 2. For each database that appears in the [Profiles] section, create a separate section with the appropriate profile name and define the connection parameters. Do not delete the original [Database] section. The following table shows one example for each database type. Example for Oracle [My_Database1] DBMS=O10 LogId=IN_DBAMN LogPassword=IN_DBAMN ServerName=Oracle Database=ORC1 UserId= DatabasePassword= TableDir=0 StayConnected=1 AutoCommit=0 DBParm='DisableBind=1' Prompt=110 Commit=100 Example for SQL Server 2005 [My_Database2] DBMS=MSS LogId=SPI_DBAMN LogPassword=SPI_DBA ServerName= Database= UserId= DatabasePassword= TableDir=0 StayConnected=1 AutoCommit=0 DBParm="ConnectString='DSN= MSS2005;UID=SPI_DBAMN;PW D= SPI_DBA',DisableBind=1" DSN=MSS2005 Prompt=110 Commit=100 Example for Sybase Adaptive Server Anywhere [My_Database3] DBMS=ODBC LogId=IN_DBAMN LogPassword=IN_DBAMN ServerName= Database= UserId= DatabasePassword= TableDir=0 StayConnected=1 AutoCommit=0 DBParm=ConnectString='DSN= IN_DEMO;UID=IN_DBAMN;PWD= IN_DBAMN' Prompt=110 Commit=100
95
System Administration
When the database type is SQL Server, the DisableBind=1 is not the only value of the DbParm parameter. Make sure that it is not enclosed by single quotes and is separated from other values by a comma, as shown in the example in the table. The LogId parameter value corresponds to the default Admin schema logon name. When your database resides in SQL Server, the default Admin schema logon name is SPI_DBAMN. This setting must be different from the Admin schema logon password, which is the value of the LogPassword parameter. For SQL Server 2008 replace the DSN= value with MSS2008. 3. Save and close the Intools.ini file. 4. Test the software by opening Logon Information dialog box and checking the Database list values. The databases that appear in the Logon Information dialog box are specific to the platform to which you have connected; databases belonging to other platforms do not appear. The database that users select on the Logon Information dialog box becomes the default database.
See Also
Working with Administration Module (see "Working with the Administration Module" on page 13) Domain Administration (see "Domain and Project Administration" on page 117) System Administration (on page 77)
96
System Administration
You can change the password only once, when initializing a new domain. If you did not change the password when initializing the selected domain, enter the default logon password, which is <Domain schema logon name>_VIEW. 4. If working on SQL Server, type the SQL Server System Administrators password. 5. Click OK to start rebuilding the views of the selected domain.
In Windows 7
1. Click the Start button and in the Search box type UAC. 2. Click Change User Control Change Settings. 3. Move the slider down to the Never notify position to set the UAC OFF or up to select when you want to be notified to turn the UAC ON. 4. Click OK. When setting the UAC to OFF you will need to restart the computer and when setting the UAC to ON you will need to insert a password and provide a confirmation.
In Windows Vista
1. 2. 3. 4. 5. 6. Before backing up a domain, in your Windows Vista Control Panel, click User Accounts. Click Turn User Account Control on or off. Clear Use User Account Control (UAC) to help protect your computer. Restart the computer. Back up the domain. Turn the UAC on if needed. Instead of turning UAC off, it is also possible to manually update the content of the PATTERN_wat key in your Windows Registry. In the Registry Editor, the key appears in the path HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI. You need to define the correct parameters for the Intools_backup.db database in the key strings. When the User Account Control in Windows Vista or Windows 7 is set to On, you cannot initialize a domain either. The same workaround applies.
97
98
System Administration
Add a Filegroup
Filegroups are used as containers for datafiles. A filegroup can be connected to one database only. Usually, two filegroups are used for each domain: one for data tables and the other for table indexes. You can backup and restore data for a filegroup. A primary filegroup contains stored procedures and triggers. When deleting a domain, the entire filegroup and the datafiles it contains are deleted, resulting in cleaner data, without causing damage to the database. For more information, see Add a Filegroup (on page 100).
Optimize Indexes
This procedure enables you to optimize fragmented SQL Server indexes. The SQL Server indexes become fragmented during the domain lifetime and contribute to database under-performance. In this case you can rearrange your SQL Server indexes to optimize them. As you keep storing and deleting domain data, the SQL Extents become disordered thus slowing down SQL command execution. SmartPlant Instrumentation solves this problem by reordering the indexes stored in these Extents. For more information, see Optimize Indexes (on page 101).
99
System Administration
Add a Filegroup
1. With the System Administration window open, click DBA > Add Datafiles. 2. Click the Filegroup tab. 3. In the System Admin. Password field, type the password to log on as the Database System Administrator (this field is empty by default). 4. In the New file information section, type the datafile name, the datafile location, and the initial size (in MB). 5. Click Add to add the filegroup.
100
System Administration
Optimize Indexes
Before starting the optimization process, make sure that no other user is using the currently selected domain. If you attempt to optimize the indexes of a domain which is currently being used by another user, the software displays a message warning you that the domain is currently in use. 1. With the System Administration window open, click DBA > Optimize Indexes. 2. From the Domain list, select the required domain. 3. Do one of the following to define the tables you want to include in the optimization process: Click All tables to optimize the indexes of all the existing tables in the defined domain. Click Selected tables to display the database indexes in the Table Name data window and optimize the indexes of the highlighted tables in the defined domain. 4. Do one of the following to define the index source on which you base the optimization: Click Current database to optimize indexes using the current database indexes. Click Template database to optimize indexes using the IN_TEMPL.DB template database indexes. Use the Template database option if your current database indexes have been deleted or become unusable. 5. Click OK. To enable better performance after completing the index optimization process, you need to update statistics. Start the Query Analyzer and run the SP_UPDATESTATS procedure.
Optimize Indexes
You can use this option to optimize fragmented Oracle database indexes. Oracle database indexes become fragmented during the domain lifetime and contribute to database under-performance. In this case, you can rearrange your database indexes to optimize them. The domain index data is generated during the initialization phase. The index data is grouped into one or more Extents which may account for the index fragmentation level. As you keep storing and deleting domain data, the Oracle Extents become disordered thus slowing down SQL command execution. SmartPlant Instrumentation solves this problem by reordering the indexes stored in these Extents. For more information, see Optimize Indexes (on page 102).
101
Optimize Indexes
Before optimizing indexes in SmartPlant Instrumentation tables, make sure that in the Oracle Instance Configuration file, the OPTIMIZER_MODE parameter value is either CHOOSE (default) or COST. This way, you activate the Oracle Cost-based Optimizer, which determines the quality of the SmartPlant Instrumentation database performance. Before starting the optimization process, make sure that no other user is using the currently selected domain. If you attempt to optimize the indexes of a domain which is currently being used by another user, the software displays a message warning you that the domain is currently in use. 1. With the System Administration window open, click DBA > Tuning >Optimize Indexes. 2. From the Domain list, select the domain in which you want to optimize indexes. The Fragmentation column displays the number of Extents of each index. It is recommended to optimize all database indexes whose fragmentation level is higher than 4.
102
System Administration
3. Do one of the following: Click All tables to optimize the indexes for all the tables in the selected domain. Click Selected tables to display in the data window all the tables in the current domain and optimize the indexes for the required tables. 4. Click OK to start the optimization process. To enable better performance after completing the index optimization process, you need to update statistics. Without updating statistics, the Oracle Cost-based Optimizer cannon use the reordered indexes.
Update Statistics
With the System Administration window open, click DBA > Tuning > Update Statistics. This option is available to both System and Domain Administrator when using SmartPlant Instrumentation on Oracle.
103
System Administration
104
SECTION 8
Equipment Unit Numbering Equipment Unit Additional Code Component Code Component Classification
105
System Administration
KKS Level Name Property Description Single digit (0-9) representing the application area of a cable (voltage levels).
Cable Number (digits 2 Two-digit number. and 3) Cable Suffix The fourth position of the cable number, a numeric character, mostly used for grouping purposes.
SmartPlant Instrumentation does not auto-increment the numbering of the various segments in the process identification. The software does not automatically add leading zeros to imported items whose names include spaces. You must manually add the leading zeros to the source before importing KKS data.
Examples
For a medium voltage panel (excluding device panels), only the System Code segments are required in most cases. Thus a suitable KKS name would be 1 0BBA01, where the values are designated as follows: Property Total Plant System Code Prefix System Classification System Numbering Equipment Unit Classification Equipment Unit Numbering Value 1 0 BBA 01 (Not used) (Not used) MV distribution board Description
For a flow transmitter, the KKS identification 1 0PAE01 CF013 B01 could be used, where the values are designated as follows: Property Total Plant System Code Prefix System Classification System Numbering Equipment Unit Classification Equipment Unit Numbering Value 1 0 PAE 01 CF 001 Open flow loops Circulating (main cooling) water pump system Description
106
System Administration
Property Component Classification Component Numbering Value -B 01 Description Transducer
When creating a new instrument, the associated loop inherits the relevant segments of the instrument names and vice versa. Also, KKS naming is propagated to cables when you connect them to panels that already have KKS naming. Cables inherit the KKS naming of the panel whose system code is first in alphabetic order. Not all items use all the described segments. For example, DCS and PLC panels do not use equipment unit code and component code segments. Marshaling racks, junction boxes, process equipment, and lines do not use component code segments. When editing a name using the KKS naming conventions, do not remove any segments from the name. Removing segments from the KKS name causes problems when creating new instruments. You can though add more segments to the KKS name created in SmartPlant Instrumentation. You can change the terminology of a key on a project-specific basis provided that the contents remain unchanged. Make sure that you do not select a code that is designated as Blocked. Blocked coding letters are reserved for future technologies and new systems engineering configurations. They may only be allocated and released by the VGB Technical Committee on Technical Classification Systems.
Total Plant
This property is a single character (numeric or alphabetic).
System Code
System Code Prefix (optional) Single digit. System Classification Three-character alphabetic key, selected from a standard list, that represents the type of system in use in the plant.
107
System Administration
System Numbering Two-digit number with leading zeros.
Component Code
Component Classification Two-character alphabetic key, selected from a standard list, that represents the type of component. Component Numbering Two-digit number with leading zeros.
Examples
For a medium voltage panel (excluding device panels), only the System Code segments are required in most cases. Thus a suitable KKS name would be 1 0BBA01, where the values are designated as follows: Property Total Plant System Code Prefix System Classification System Numbering Equipment Unit Classification Equipment Unit Numbering Value 1 0 BBA 01 (Not used) (Not used) MV distribution board Description
For a flow transmitter, the KKS identification 1 0PAE01 CF013 B01 could be used, where the values are designated as follows:
108
System Administration
Property Total Plant System Code Prefix System Classification System Numbering Equipment Unit Classification Equipment Unit Numbering Component Classification Component Numbering Value 1 0 PAE 01 CF 001 -B 01 Transducer Open flow loops Circulating (main cooling) water pump system Description
When creating a new instrument, the associated loop inherits the relevant segments of the instrument names and vice versa. Also, KKS naming is propagated to cables when you connect them to panels that already have KKS naming. Cables inherit the KKS naming of the panel whose system code is first in alphabetic order. Not all items use all the described segments. For example, DCS and PLC panels do not use equipment unit code and component code segments. Marshaling racks, junction boxes, process equipment, and lines do not use component code segments. When editing a name using the KKS naming conventions, do not remove any segments from the name. Removing segments from the KKS name causes problems when creating new instruments. You can though add more segments to the KKS name created in SmartPlant Instrumentation.
109
System Administration
110
System Administration
111
System Administration
When creating a loop, you can also create instrument tags on the fly, using the loop naming as a source. Also, when you connect a cable to a panel, the cable inherits the naming from the panel according to KKS convention rules. In both cases, the software copies the naming from the source item segments to the appropriate target item segments. For these reasons, in the naming convention of a target item, you should not delete segments that are likely to receive values by propagation. Non-relevant segments in the target item are left blank or not displayed.
112
System Administration
9. Click Close when done. 10. To associate an accounting item with the current domain, in the Add Accounting dialog box, select the required accounting in the General list and drag it to the Domain list. To edit the properties of existing accounting information, select the required accounting from the Accounting name list and click Edit. To delete existing accounting information from the system, select the required accounting from the Accounting name list and click Delete.
See Also
Log on as System Administrator (on page 67) System Administration Common Tasks (on page 77)
See Also
Log on as System Administrator (on page 67) System Administration Common Tasks (on page 77)
113
System Administration
See Also
Log on as System Administrator (on page 67) System Administration Common Tasks (on page 77)
To dissociate an accounting, client, or contractor item from a domain, select the item in the Domain pane and drag it back to the General list pane.
See Also
Log on as System Administrator (on page 67) System Administration Common Tasks (on page 77)
114
System Administration
The Administration module is not included in the Activity Tracking report options.
See Also
Generate a Grid-Style Activity Tracking Report (on page 85) Generate a Graph-Style Activity Tracking Report (on page 86) System Administration Common Tasks (on page 77)
115
System Administration
116
SECTION 9
Naming Conventions
This set of procedures deals with naming conventions. Naming conventions define the parameters which will be the rule for building tag, loop, device panel, and device cable names. For more information, see Naming Conventions (on page 172).
117
Access Rights
After assigning users to groups, one of the key roles of the Domain Administrator is to define user access rights. This set of procedures deals with setting and managing access rights for all the users in the current domain on the appropriate access rights level. For more information, see Access Rights (on page 182).
Preferences Management
This set of procedures deals with the management of preferences in SmartPlant Instrumentation. The Domain Administrator can control the management of preferences in the current domain as well as in all the projects if the domain type is Owner operator. For more information, see Preferences Management (on page 196).
Report Management
This set of procedures deals with tasks like associating a new title block with a report, selecting archiving options, and defining revision management settings. For more information, see Managing Reports (see "Report Management" on page 199).
Miscellaneous Tasks
This set of topics deals with various miscellaneous tasks that are performed by the Domain Administrator. For more information, see Miscellaneous Domain Administration Tasks (on page 209).
Clearing Locking
This option enables the Domain Administrator to clear locking in multi-user databases SQL Server or Oracle. For more information, see Clearing Locking (on page 223).
Item Registry
This set of procedures deals with item registry activities for the integrated environment. For more information, see Item Registry Activities (on page 239).
118
119
Owner
You define owners of <plants> prior to creating plant hierarchy items in the Plant Hierarchy Explorer. When creating a new <plant> on the highest plant hierarchy level, you need to assign this <plant> to an owner. 1. Start the Administration module and log on as Domain Administrator. 2. With the Domain Administration window open, do one of the following: Click Activities > Owner. Click . 3. Click New. 4. In the boxes, for the new owner profile, enter data as required. 5. Click Apply to save the new owner profile in SmartPlant Instrumentation. To edit the profile of an existing owner, from the Owner list, select an owner and click Edit. To delete an owner, from the Owner list, select an owner and click Delete.
See Also
Log on as Domain Administrator (on page 68)
120
To modify properties of an existing highest level item, right-click the item itself, which is indicated by the icon , and then, on the shortcut menu, click Properties. To delete an item, right-click the item itself, and then, on the shortcut menu, click Delete. To delete an item that has child items, you must first delete the child items. 5. In the General tab of the Plant Properties dialog box, in the <Plant> box, type the new <plant> name. The name must contain at least one character that is not space. The maximum name length is fifty characters. 6. From the Owner list, select the appropriate owner for the new <plant>. 7. In the boxes, enter data as required. 8. If needed, click the Custom Fields tab to define custom field values to be associated with the current <plant>.
The highest plant hierarchy level items are indicated by the icon . To delete an item, right-click the item itself, and then, on the shortcut menu, click Delete. To delete an item that has child items, you must first delete the child items. 5. From the Plant list, select a plant.
121
Intermediate level items are indicated by the icon . To modify properties of an existing item, right-click the item itself, and then, on the shortcut menu, click Properties. To delete an item, right-click the item itself, and then, on the shortcut menu, click Delete. To delete an item that has child items, you must first delete the child items.
Make sure you select the appropriate plant hierarchy node before you click New. After creating a <unit>, you cannot move it to another plant hierarchy node. 5. On the shortcut menu, click New. 6. In the General tab of the <Unit> Properties dialog box, in the Name box, type a unit name which is unique within the current node of the parent level. The name must contain at least one character that is not space. The maximum name length is fifty characters. 7. In the Number field, type a unit number which is unique within the current node of the parent level. The value you type in the Number data field is generally used in the prefix part of the tag number naming conventions. For further information, see Define Naming Conventions (on page 174). You do not have to define the unit number if you plant to define naming conventions without using the <unit> number segment. However, you must define the <unit> number if you want to copy data from another <unit> even if in the source <unit>, naming conventions do not include the <unit> number segment.
122
123
1. Create a Project
In your owner operator domain, create a project, with or without the project schema. For details, see Create a Project (on page 126).
2. Create a User
Create a new user you want to define as Project Administrator for the project the Domain Administrator created. A procedure for creating a Project Administrator user is the same as for any other user. User creation is performed by System Administrator. For details, see Define a SmartPlant Instrumentation User (on page 70).
5. Grant Full Access Rights for Project Definition to the User Group
Project Administrators in the user group that you created must have full access rights for project definition. In the Access Rights window, the Project Definition access right setting appears at the domain level. For details about granting access rights, see Grant Access Rights for Selected Items or Activities (on page 192).
See Also
Users and Groups Common Tasks (on page 72)
124
Create a Project
After System Administrator creates an owner operator domain, the first stage of revamping an owner operator facility is defining a project within which the revamping engineering activities will take place. Each project has to be defined within a specific plant, but may overlap several areas and units. More than one project can be defined for the same plant, and several projects may cover the same areas or units. In projects, you can create new items and also claim As-Built items. Prior to creating a project, your System Administrator needs to define a domain and specify the domain type as Owner operator. For more information, see Create a Project (on page 126).
125
Rebuild a Project
Use this procedure to rebuild a project after performing any of the following activities: Initializing an owner operator domain. This procedure is required because, during the initialization process, the As-Built and Project schemas are not fully created in Sybase Adaptive Server Anywhere. Upgrading an owner operator domain. Restoring an owner operator domain from an Oracle .dmp file or SQL Server .bak file. Rebuilding projects is also required when an existing project is damaged or there is a change in a process that requires the original basic project. For more information, see Rebuild a Project (on page 133).
Create a Project
You may also want to define a <plant> before creating a project. For details, see Create a Plant Hierarchy Item on the Highest Level (on page 121). 1. Start the Administration module and log on as Domain Administrator. 2. Do one of the following: Click Activities > Project Activities. Click . 3. In the Project Activities dialog box, click New.
126
6. 7. 8.
9. 10. 11.
12. 13.
Creation of the project schema can take a considerable time, therefore, if you do not need to implement your project right away, click No when prompted. You can then create the project schema when you claim items for the project. 14. Click Close
See Also
Scoping Data for Projects Common Tasks (on page 147) Scoping Data for Projects (on page 142)
127
See Also
Users and Groups Common Tasks (on page 72) Flow of Activities for Defining a Project Administrator (on page 124)
128
See Also
Merging Project and As-Built Data (on page 157) Specify an Action for Merging a Group of Items (on page 169)
129
2. 3. 4. 5. 6. 7.
See Also
Display Formats of Item Categories (on page 129)
130
See Also
Naming Conventions Common Tasks (on page 173) Wire End Naming Conventions Common Tasks (on page 180)
1. 2. 3. 4. 5. 6.
131
If the profile of your Sybase Adaptive Server Anywhere database is not available you must create a new ODBC profile using the Internal Setup Utility. 7. In the Admin schema logon name box, accept or type the required user name to connect to the admin schema of the source domain. When using Sybase Adaptive Server Anywhere, the Admin schema login boxes are read-only. 8. In the Admin schema logon password box, accept or type the required password. 9. Click Connect. 10. From the Domain list, select a source domain. After selecting the source domain, the software detects the source project with the same database ID as in the target project, and automatically displays the source project in the Project box.
11. Before importing data, click Log File to open the Log File dialog box and specify the log file name and path.
132
See Also
Configuring SmartPlant Instrumentation for Integration (on page 236) Integration Common Tasks (on page 236) Item Registry Activities (on page 239)
Rebuild a Project
1. As Domain Administrator, enter the owner operator domain. 2. Click DBA > Rebuild Projects in Domain. 3. In the data window, select As-Built and those projects for which you want to rebuild the schemas. Selecting As-Built is required after initializing an owner operator domain in Sybase Adaptive Server Anywhere (full engine version). 4. Click OK to rebuild the selected projects.
133
134
Explorer Windows
In an owner operator domain, the Project Administrator uses Explorer windows to claim items for projects or merge items with As-Built. The Explorer windows display instrumentation items according to hierarchical structure. You can arrange the hierarchical structure of the data according to item types or according to the physical location of the items. The Explorer toolbar enables you to find a specific or multiple items, or to filter the display of items. All the Explorer windows are accessible from the Project Activities dialog box. The following Explorer windows are available: As-Built Explorer Opens when defining a scope of items for a project using As-Built as a claim source. Displays all items that exist in As-Built.
135
136
137
138
Filter Cables
1. In an Explorer window, select the Cables or the Cross Cables folder and do one of the following: Right-click the folder, and then click Filter. On the Explorer window toolbar, click . 2. To filter according to an item name in the folder that you selected, under Item name, type a valid name or part of a name. You can use wildcard characters to specify partial strings: asterisk (*) or percent (%) for multiple characters and underscore (_) for single characters. The value that you enter in this box overrides all other filter criteria in this dialog box. 3. Type a filter name. 4. Do one of the following: Select Selected node definition to filter the child items that belong to a folder or the items at any hierarchy level that you selected in the Explorer tree view. Select Global definition to define a filter for the entire tree view of the active Explorer. The software applies this definition to the item type you selected. If you defined a filter definition for a specific folder, the filter for the folder overrides the settings for the global filter definition. 5. In the Filter definition group box, define the criteria that you use to filter the items displayed: Property select a property to use for filtering the items. Operator select the required comparison operator to determine how the header selected under Property will relate to the expression you select for Value.
139
6. 7. 8.
9.
10.
11.
140
5.
6. 7. 8.
9.
141
In the Administration module, Explorer windows do not include blocks. Blocks only appear in the Domain Explorer, which you can open in SmartPlant Instrumentation. In the Domain Explorer, blocks associated with instruments using the manual block assignment method are marked with the icon . Blocks associated with tags using the automatic block assignment method are marked with the icon . 10. Click OK in the Advanced Filter Definition (Loops) dialog box. 11. Click OK in the Filter Definition dialog box.
Claim Modes
You can claim items using one of the two modes: exclusive or non-exclusive. System Administrator specifies a claim mode when making domain definitions. After creating the first project in the domain, the defined claim mode becomes fixed in that domain.
142
143
In Project1, the strip appears as a fully-functional item and its parent panel appears as a dummy item.
Selected
N/A
In Project2, both the strip and the The same strip exists in Project1 panel appear as dummy items. as a fully-functional item and its parent panel exists in Project1 as a dummy item. The strip and its panel already exist in Project1 as dummy items. Neither of them exist in Project2. The strip and its panel already exist in Project1 as dummy items. The strip and its panel exist in Project2 as fully-functional items. In Project1, the strip is converted to a fully-functional item. The software updates the strip properties using the As-Built strip properties as a source. The strip panel remains as a dummy item. There is no change in Project1. This action is not allowed because only one project can contain a fully-functional strip when working in exclusive claim mode.
Selected
N/A
Selected
N/A
Selected
Selected
Reclaim a strip The strip exists in for Project1. Project1 as a fully- functional item and its panel exist in Project1 as a dummy item. Reclaim a strip Both the strip and for Project1. its panel exist in Project1 as fullyfunctional items.
In Project1, the strip remains a fully- functional item, with the properties updated using the As-Built strip properties as a source. The strip panel remains as a dummy item without any changes. In Project1, the strip remains a fully- functional item, with the properties updated using the As-Built strip properties as a source. The strip panel remains as a fully-functional item without any changes. The Claim parent items as dummy check box does not apply.
Selected
Selected
144
In Project1, both the strip and the panel appear as fully-functional items.
Cleared
N/A
In Project2, the strip appears as The same strip exists in Project1 a dummy item and the panel as a appears as a fully-functional item. fully-functional item and its parent panel exists in Project1 as a dummy item. The strip and its panel already exist in Project1 as dummy items. In Project1, both the strip and its panel are converted to fully-functional items. The software updates the item properties using the As-Built item properties as a source. There is no change in Project1. This action is not allowed because only one project can contain fully-functional strip and panel when working in exclusive claim mode.
Cleared
N/A
Cleared
N/A
The strip and its panel already exist in Project1 as dummy items. The strip and its panel exist in Project2 as fully-functional items.
Cleared
Selected
Reclaim a strip The strip exists in for Project1. Project1 as a fully- functional item and its panel exists in Project1 as a dummy item.
In Project1, the strip remains a fully- functional item, with the properties updated using the As-Built strip properties as a source. The strip panel is converted to a fully-functional item, with the properties updated using the As-Built panel properties as a source. There is no change in Project1. This action is not allowed because reclaiming a dummy item converts it to a fullyfunctional item. You cannot have the same fully-functional strip in more than one project when working in exclusive claim mode.
N/A
Selected
Reclaim a strip The strip exists in for Project1. Project1 as a dummy item and as a fully-functional item in Project2.
145
In Project1, the strip appears as a fully-functional item and its parent panel appears as a dummy item.
Selected
N/A
In Project2, the strip appears as The same strip exists in Project1 a fully-functional item and its as a fully-functional panel as a dummy item. item and its parent panel exists in Project1 as a dummy item. The strip and its panel already exist in Project1 as dummy items. The strip and its panel exist in Project2 as fully-functional items. In Project1, the strip is converted to a fully-functional item. The software updates the strip properties using the As-Built strip properties as a source. The strip panel remains in Project1 as a dummy item. In Project1, the strip is converted to a fully-functional item. The software updates the strip properties using the As-Built strip and panel properties as a source. The panel remains in Project1 as a dummy item. In Project1, both the strip and its panel appear as fully-functional items.
Selected
N/A
Selected
Selected
Reclaim a strip Both the strip and for Project1. its panel exist in Project1 as dummy items and as fully- functional items in Project2. Claim a strip for Project1. The strip does not exist in either Project1 or Project2.
Cleared
N/A
146
In Project1, both the strip and its The strip and its panel already exist panel appear as fully-functional in Project1 as items. dummy items. The strip and its panel exist in Project2 as fully-functional items. In Project2, the strip and its The same strip exists in Project1 panel appear as fully- functional as a fully-functional items. item and its parent panel exists in Project1 as a dummy item. In Project1, both the strip and its panel are converted to fully-functional items. The software updates the strip and panel properties using the As-Built strip and panel properties as a source.
Cleared
N/A
Cleared
Selected
Reclaim a strip Both the strip and for Project1. its panel exist in Project1 as dummy items and as fully- functional items in Project2.
When you claim instruments directly from the Instruments folder of the As-Built Explorer or Source Project Explorer, the source loop is always claimed as a dummy item. In this case, the Claim parent items as dummy preference does not apply.
147
Domain and Project Administration Display Items in the Source Project Explorer
Use this procedure to display source project items that you can claim for another project, provided that the System Administrator cleared the Exclusive claim mode check box when making the current domain definitions. After you open the Source Project Explorer, you can define a scope of items for the target project by claiming the items that the source project contains. It is either possible to claim items directly from the Source Project Explorer, or copy the appropriate items to the Target Project Buffer first. The Target Project Buffer opens automatically together with the Source Project Explorer. For more information, see Display Items in the Source Project Explorer (on page 150).
148
Claim Items Directly from the As-Built Explorer or Source Project Explorer
This topic deals with claiming specific As-Built items from the As-Built Explorer or project items from the Source Project Explorer. If you want to use this procedure, make sure the buffer does not contain any items. For more information, see Claim Items Directly from the As-Built Explorer or Source Project Explorer (on page 154).
Claim Documents
The Project Administrator uses this procedure to claim documents from As-Built for a project when defining the scope of a project. The software claims documents together with associated revision data. Claiming documents is different from claiming items. Even if you do not claim any documents that exist in As-Built, the software claims the documents automatically whenever users in projects of the same domain generate reports. Claiming documents manually enables you to select multiple documents and then claim them all at once. Also, when claiming documents manually from the Administration module, you do not experience any locking problems, while in SmartPlant Instrumentation, it is possible for a document to be unavailable for claiming when locked by another user. For more information, see Prerequisites for Claiming Documents (on page 155) and Claim Documents (on page 156).
149
See Also
As-Built Explorer (on page 425)
6. 7.
8. 9.
150
7. 8.
See Also
Settings and Conditions for Claiming Items (on page 143)
151
152
153
Claim Items Directly from the As-Built Explorer or Source Project Explorer
1. Claiming items from the As-Built Explorer is only possible if the Claim Buffer has no items. Claiming items from the Source Project Explorer is only possible if the Target Project Buffer has no items. Depending on a claim source, do one of the following: If the claim source is As-Built, in the As-Built Explorer, expand the hierarchy to display folders of item types. If the claim source is a project, in the Source Project Explorer, expand the hierarchy to display folders of item types. In the tree view pane, click an item type folder to display the items in the Items pane. In the Items pane, select and right-click one or more items. On the shortcut menu, click Claim. If you claimed a loop or instrument together with the wiring items, the software only claims those wiring items that have a signal propagated to the loop or instrument. If you placed a device panel inside a cabinet or junction box, when claiming the loop, this device panel is not claimed together with the cabinet or junction box because this device panel does not have a signal propagated to the loop. You must select and claim such a device panel manually.
2. 3. 4.
See Also
As-Built Explorer (on page 425) Source Project Explorer (on page 430) Item Indicators (on page 433)
154
The name of the user with full Project User1 Activities access rights. The user group must be assigned to the target project. The user password defined by System Administrator. The name of the owner operator domain in which you copied items from the As-Built Explorer to the Claim Buffer. The name of the project for which you want to claim As-Built items from the Claim Buffer. The C parameter that allows you to claim items you copied to the Claim Buffer. User1 SPI1
<user password> <Owner operator domain name> <target project name> <claim flag>
Project1 C
Example
Main User1,User1,SPI1,Project1,C
155
Claim Documents
Prior to claiming documents we recommend that you read the Prerequisites for Claiming Documents (on page 155) topic. 1. Depending on a claim source, do one of the following: If the claim source is As-Built, in the As-Built Explorer, expand the hierarchy to display folders of item types. If the claim source is a project, in the Source Project Explorer, expand the hierarchy to display folders of item types. 2. Click the Documents folder to display the source documents in the Items pane. 3. In the Items pane, select one or more documents. 4. Right-click the selected documents and then, on the shortcut menu, click Claim. Claiming documents or any other items from the As-Built Explorer is only possible if the Claim Buffer has no data. Claiming documents or any other items from the Source Project Explorer is only possible if the Target Project Buffer has no data. You can copy documents to the buffer first, and then, claim all the documents together with all other items that you copied to the buffer. When claiming a cable block diagram, you must also claim panels the cable block diagram references. These panels must be claimed as fully-functional items.
156
See Also
As-Built Explorer (on page 425) Item Indicators (on page 433) Create an Owner Operator Domain (on page 79)
Merge Modes
You can merge items using one of the two modes: with deletion from the project or without deletion from the project. System Administrator specifies a merge mode when making domain definitions. After creating the first project in the domain, the defined merge mode becomes fixed in that domain. If System Administrator set the software to merge items without deleting them from the project, on merging project data with As- Built view-only copies of the merged items remains in the project. You cannot delete these copies or update their properties. It is possible, however, to claim these items for another project even if you are working in exclusive claim mode. Existence of view- only copies does not prevent you from deleting the project.
157
158
Tag Wiring item (Panel, Rack, Wiring Equipment, and so forth Terminal Strip Cable Wire
You cannot select basic engineering data manually or set the software to merge tags without including the associated basic engineering data.
159
160
See Also
Owner Operator Domain (As-Built and Projects) (on page 123) Owner Operator Domain (As-Built and Projects) Common Tasks (on page 125)
161
162
See Also
Item and Sub-Item Selection Options for Merging with As-Built (on page 158) Remove Items from the Merge Buffer (on page 164)
See Also
Item and Sub-Item Selection Options for Merging with As-Built (on page 158) Remove Items from the Merge Buffer (on page 164)
See Also
Item and Sub-Item Selection Options for Merging with As-Built (on page 158) Remove Items from the Merge Buffer (on page 164)
163
See Also
Scoping Data for Projects Common Tasks (on page 147) Merge Buffer (on page 428)
164
Domain and Project Administration Copy Items to the Merge Buffer Common Tasks
Copying items from the Project Explorer to the Merge Buffer is the first step of merging current project with As-Built. After that, the Project Administrator can merge the current project items with As-Built. When you make item selections, the software automatically applies preferences that you set in the Preferences for Scoping and Merging Data dialog box. These preferences determine how the software copies to the Merge Buffer sub-items that are associated with the items you select. You can set a merge action for the items that you copy, that is Merge Now or Release Claim. In the Merge Buffer, these actions take effect when you start merging the items. For more information, see Copy Items to the Merge Buffer Common Tasks (on page 162).
165
Domain and Project Administration Merge Items Directly from the Project Explorer
After modifying existing items or creating new items in your project in SmartPlant Instrumentation, you can merge some or all of the items with As-Built. Several merging actions are available for each item. Also, you can change a merging action for all items and sub-items in batch mode, regardless of a specified item type. For more information, see Merge Items Directly from the Project Explorer (on page 170).
See Also
Item and Sub-Item Selection Options for Merging with As-Built (on page 158)
166
See Also
Generating Reports for Merging Data Common Tasks (on page 159) Generate Comparison List Reports (on page 160) Item Comparison Options (on page 167)
167
See Also
Owner Operator Domain (As-Built and Projects) (on page 123) Compare Project Data with As-Built Data (on page 166) Prerequisites for Claiming Documents (on page 155) Owner Operator Domain (As-Built and Projects) Common Tasks (on page 125)
168
See Also
Merging Project and As-Built Data (on page 157) Copy Items to the Merge Buffer Common Tasks (on page 162) Owner Operator Domain (As-Built and Projects) Common Tasks (on page 125)
See Also
Owner Operator Domain (As-Built and Projects) (on page 123) Merging Project and As-Built Data (on page 157) Owner Operator Domain (As-Built and Projects) Common Tasks (on page 125)
169
See Also
Merging Project and As-Built Data (on page 157) Merge Buffer (on page 428) Item Indicators (on page 433)
See Also
Merging Project and As-Built Data (on page 157) Merging Project and As-Built Data Common Tasks (on page 164) Project Explorer (on page 429) Item Indicators (on page 433)
170
<user password> <Owner operator domain name> <target project name> <merge flag>
User1 SPI1
Project1 M
Example
Main User1,User1,SPI1,Project1,M
See Also
Merging Project and As-Built Data (on page 157) Merge Buffer (on page 428)
171
Naming Conventions
Naming conventions define the parameters which the software uses when creating tags, loops, device panels, cables, or other items in SmartPlant Instrumentation. Each of these items has its own instrument type to which you manually set the naming conventions from the Admin module. The naming conventions are flexible and follow no limitations, so you can build and maintain the instrumentation data according to your specific instrumentation needs. The maximum length of a naming convention is 50 characters. Before you start defining naming conventions, we recommend that you familiarize yourself with the following general guidelines: You define naming conventions on a per <unit> basis. Therefore, if you want certain items (for example, panels) to share naming conventions on the highest plant hierarchy level, for example, you can define a naming convention for panels in a specific <unit>, and then, copy this convention to all other units available in the same <plant>. The naming is performed according to item types. For an item type, it is only possible to define one naming convention. You set the naming for each item type and thus affect the creation of new items in SmartPlant Instrumentation. All items inherit the naming convention of the item type they belong to. Examples for item types are Instrument, Loop, Cabinet, DCS, Control System Tag, and so forth. You can define the naming convention freely without any limitation, or set it to include different segments, separators, dashes and any other character that serves your purposes. The maximum length of a naming convention is 50 characters, including separators. This length applies for all naming convention standards. You can copy naming conventions only on the lowest plant hierarchy level, for example, from Unit1 to Unit2, within the same domain. When defining a naming convention for wiring equipment, note the following limitation: you cannot include a slot name or an I/O card name together with the rack name. The software can only retrieve the name of the actual parent item. For example, when a card is a child item of a slot, only the slot name can be retrieved but not the rack name.
172
173
See Also
Define Panel Location Levels (on page 210)
174
If you already defined a naming convention for instrument tags or loops and want to modify an existing convention, do not click the ISA Standard or Loop Standard button again. Clicking any of these buttons resets your instrument or loop naming convention to the default settings for the current standard. 11. When defining a naming convention for wiring items, control system tags, or document numbers, do one of the following:
175
The software does not remove spaces that are part of separators or appear at the beginning or in the middle of a segment. When a wiring item or control system tag naming convention includes free segments, the software removes spaces only from the first and last free segment. 12. When defining a naming convention for a document number, for documents you intend to save as files, do one of the following: Select Remove spaces in file names to removes spaces from the name of the document files. Clear Remove spaces in file names to save documents with the name of the source document item. A document file has spaces if the source document item has spaces. For example, when you generate a loop drawing without opening the drawing, the software automatically saves the drawing file with the name of the source loop number. If the source loop number has spaces and you selected this check box, the software removes the spaces from the drawing file name when saving the drawing as a file. 13. If you are prompted to change the naming convention (if a naming convention already exists for the unit), do one of the following in the displayed message: Click Yes to modify the current unit naming conventions. Click No to retain the current unit naming conventions without modifying them. 14. When done, click Apply to save the naming conventions to the database. 15. Click Close to close the dialog box.
See Also
Log on as Domain Administrator (on page 68)
176
See Also
Log on as Domain Administrator (on page 68)
See Also
Log on as Domain Administrator (on page 68)
177
If you do not define a naming convention for instrument specification document numbers, the software creates the default document number <tag number>-SP.
178
Unlike user-defined naming conventions, default naming conventions of document numbers cannot be updated automatically in SmartPlant Instrumentation when users rename instruments. Suppose you want to rename a tag number FT-100 to FT-101 and the source tag has a spec FT- 100-SP. After renaming, the default document number of the renamed instrument specification remains as FT-100-SP, even though this number contains the 100 segment, which was renamed for the instrument.
See Also
Domain Administration Common Tasks (on page 117)
179
180
181
Access Rights
One of the key roles of the Domain Administrator is to define user access rights. In an owner operator, domain, access rights are also defined at the level of individual projects. To grant access rights to each SmartPlant Instrumentation user group, the Domain Administrator chooses the items and activities, and the level of access granted. When the domain type is Owner operator, in a project, access rights granted on the domain level do not apply. If you want to grant access rights to a group assigned to a project, you must also assign this group to As-Built. For the description of the items and activities, see Access Rights Descriptions (on page 184). In SmartPlant Instrumentation, items (for example, tags, cables, loops, and so forth) and activities (for example, modules) are defined on a specific level: highest or lowest plant hierarchy level (for example, plant or unit), or on the level of the entire domain. When data is defined on a specified level, it contains data which is unique on the specified level. For example: The cable item type is defined per <plant>. This means that any cable data is described in the current domain on the <plant> level. This is so because tag numbers associated with wiring can propagate to more than one <unit> or <area>. On each level you can grant to a group one of the following access rights: Full users in the corresponding group can add, delete, and update the data of the selected item type. Modify users in the corresponding group can only add or update the data of the selected item type (deletion is prohibited). View Only users in the corresponding group can only view the data of the selected item type without being able to modify it. Access Denied users in the corresponding group cannot access the data of the selected item type. If you assign a user to more than one group, you can specify whether to grant maximum or minimum access rights for that user over all the groups, by respectively selecting or clearing Grant maximum access rights.
182
See Also
Domain Administration Common Tasks (on page 117)
183
Administration Reports
Access rights for various reports that can be Domain generated in the Administration module. Domain
Assign Groups to Access rights for the assignment of user Projects groups to As- Built and projects existing in the owner operator domain (Domain Administrator or Project Administrator activity). Assign Users to Groups
Access rights for the assignment of users to Domain groups. (Domain Administrator activity, or Project Administrator activity when the domain type is Owner operator). Access rights for the Automatic Cross-Wiring feature in the Wiring module. Plant Wiring Module Access
Auto Cross Wiring Auto Wiring Binder Package Deletion Browser Buffer Use Browser Manager
Access rights for the auto wiring tasks in the Plant Wring module. Access rights to delete binder packages in the Document Binder module. Access rights to copy to and paste data from a browser buffer in any browser view. Plant Unit
Access rights for the Browser Plant Manager. Users with View Only access rights can expand browser groups, display filter, sort, and style settings, and open a browser view. Users with the Access Denied setting can only expand browser groups, and then select and open a browser view.
184
Domain
Access rights to include the User Name and Unit Change Date fields in a browser view. Access rights for the Wiring module Associations menu commands related to cable routing and cable drum, and for the appropriate supporting tables accessible on the Tables of the Wiring module. These access rights do not apply to the Cable Routing Options command available on the Associations menu. Access rights for Cable Routing Options command available on the Associations menu of the Wiring module. Access rights to perform calculations. To enable calculations, set this option to Full (Add / Delete / Update) and the 'Calculation Module Access' option to Full (Add / Delete / Update) or Modify (Add / Update). Access rights for the Calculation module. Access rights for editing data in the Calibration History window of the Calibration module. To grant full access rights, under Mode in the Item or activity section of the Access Rights window, select Full (Add / Delete / Update). To grant view-only access rights, select View Only. Note that the Modify (Add / Update) option functions as full, while the Access Denied option functions as view- only. Plant
Plant
Unit
185
Calib. & Maint. Access rights for the calibration supervisor Event Supervisor activities in the Calibration module and for completing and deleting maintenance even records in the Instruments folder of the Domain Explorer. Calib. Options & Maint. Events
Access rights for the Calibration module and Unit for creating and editing maintenance event records in the Instruments folder of the Domain Explorer. Access rights to modify calibration results or Unit enter calibration data. Access rights for claiming items from SmartPlant Instrumentation when the domain type is Owner operator. These access rights do not apply to claiming options available in the Administration module. Access rights for the Clear Locking option on the DBA menu (Oracle and SQL Server only). Domain Calib. Options & Maint. Events
Clear Locking
Domain
Connection Type Access rights for the definition of connection Plant types in the Wiring module. Construction Module Access Construction Revision Cables Construction Revision - Instr. Access rights for the Construction module. Access rights to define Formal Issue for project cables in the Construction module. Access rights to define Formal Issue for project instruments in the Construction module. Unit Plant
Construction Module Access Construction Module Access Construction Module Access Construction Module Access Construction Module Access
Plant
Access rights to define Formal Issue for Construction Revision - Panels project panels in the Construction module. Construction Revision - Wires Construction Supporting Tables Control System Tag Operations
Plant
Access rights to define Formal Issue for the Plant project wires in the Construction module. Access rights for the Construction module supporting tables. Domain
Access rights for all I/O assignment options Plant in the Wiring module and also for modifying information associated with control system tags in the Instrument Index module.
186
Plant
Document Binder Access rights for the Document Binder Module Access module. Domain Definition Notes Drawing Block Management Access rights for the Notes section in the Domain Definition window - Domain Administrator activity. Access rights to create block types and group CAD drawing blocks in these block types.
Plant Domain
Domain
Enhanced Report Access rights for changes to enhanced Chg. (Layout) reports at the layout level (macro attributes, redlining). Enhanced reports are reports generated by the Enhanced Report Utility. Enhanced Report Access rights for changes to enhanced Chg. (Report) reports at the report level (repositioning of drawing objects, SmartText, redlining). Enhanced reports are reports generated by the Enhanced Report Utility.
Plant
Plant
Access rights for the Equipment supporting Plant Equipment Supporting Table table in the Instrument Index module. Field Personnel Access rights for the Field Personnel Profile option in the Domain Administration window. Access rights for managing form data templates in the Specifications module. Access rights to manage global revisions using the options of the Global Revisions dialog box. Access rights to create, edit, or modify hook-ups in the Domain Explorer. Domain
Domain Unit
Plant
187
Hook-Ups Module Access Import Utility Access Install. Index Manager Instr. Index Supporting Tables
Access rights for the Instrument Index Domain module supporting tables that allow you to modify information associated with tag numbers. These access rights also apply to typical loop management. These access rights do not apply to the supporting tables Lines, P&ID, and Equipment. Access rights for the Instrument Index module. Unit
Access rights to define selected users as Unit instrumentation engineers who will work in the workflow mode provided that the System Administrator has selected the Instrument/Process Data Workflow check box in the Domain Definition window. Access rights for intrinsic safety definition in the Wiring module. Access rights to create, edit, or modify lines in the Instrument Index and Process Data modules. Access rights for the domain logo definition (Domain Administrator activity), or a project log definition if the domain type is Owner operator. Access rights to connect to an external macro source and use external macros during loop drawing generation. Access rights to create, modify, or delete a loop number in the Instrument Index module. Plant Plant Wiring Module Access
Logo Definition
Domain
Unit
Unit
188
Macro Definitions Access rights for managing macro definitions for loop drawings and hook- up drawings. Maintenance Module Access Maintenance Supporting Tables Management of Local Revisions Access rights for the Maintenance module. Access rights for modifying information associated with the Maintenance module supporting tables. Access rights for adding, updating, and deleting revisions in a Revisions dialog box. These access rights do not apply to revision management options available in the Global Revisions dialog box. Access rights for defining and managing item naming conventions (Domain Administrator activity). Access rights for the P&ID drawing number supporting table in the Instrument Index module. Access rights for managing cables in the Domain Explorer.
Unit
Naming Convention Definition P&ID Supporting Table Plant Cable Management Plant Hierarchy Management Plant Panel Management Plant Owner Definition Prevent. Maint. Supervisor Prevent. Maint. Technician
Domain
Plant
Plant
Access rights for creating and managing Domain plant hierarchy items in the Plant Hierarchy Explorer (Domain Administrator activity). Access rights for managing panels in the Domain Explorer. Access rights for the Owner option in the Domain Definition window - Domain Administrator activity. Access rights for the Preventive Maintenance supervisor activities in the Maintenance module. Access rights for the Preventive Maintenance technician activities in the Maintenance module. Plant Domain Wiring Module Access
Unit
Unit
Process Data Access rights to change process data Change in Specs values in an instrument specification. (Specifications module.) Process Data Definition Access rights to create, modify, or delete a process data sheet.
Unit
Unit
189
Access rights for the Process Data module Domain supporting tables, that is, Cases, Insulation Types, Pipe/Orifice Materials, and Fluid Components. Access rights to define selected users as Unit process engineers who will work in the workflow mode provided that the System Administrator has selected the Instrument/Process Data Workflow check box in the Domain Definition window.
Project Definition Access rights that apply to all activities that Domain you can perform on the Project Activities dialog box in the Administration module. For example, project creation, scope definition, tag and loop number reservation, merging items with As-Built, and so forth. These access rights also apply when claiming or merging items using the command line parameters. Publish Access rights for publishing documents. Plant Domain Domain
Reference Cable Access rights for managing reference cables in the Reference Explorer. Management Reference Panel Management SmartPlant Registration Access rights for managing reference panels in the Reference Explorer.
Access rights that enable the Domain Domain Administrator to register plants. This option enables or disables the Register menu command on the SmartPlant menu on the Domain Administration window menu bar. Access rights for the Repair Maintenance supervisor activities in the Maintenance module. Access rights for retrieving documents. Access rights for the Repair Maintenance technician activities in the Maintenance module. Unit Maintenance Module Access
Revision Deletion Access right to delete saved revisions. SAP Interface Access Access rights for the SAP interface.
Unit Domain
190
Plant
Plant
Access rights for running tasks in the To Do Domain List after retrieving a document. Access rights for the options available in the Domain Units of Measure and Accuracy dialog box in SmartPlant Instrumentation. Domain
Update Statistics Access rights for the Update Statistics option on the DBA menu (System (Oracle) Administrator activity). Wire Group Wiring Connections Access rights for signal re- propagation. Access rights for the connection options in the Wiring module, including batch connection and cross-wiring.
Plant Plant
191
Access rights for the Wiring module. These Unit access rights also disable various wiring options that you can access from without the Wiring module, for example, when right-clicking an instrument in the Browser View window of the Instrument Index module. Access rights for wiring supporting tables accessed using the Tables menu of the Wiring module. These rights do not affect telecom, cable routing and cable drum options available on the Tables menu. Access rights for the Work Request supervisor activities in the Maintenance module. Access rights for the Work Request technician activities in the Maintenance module. Domain Wiring Module Access
Unit
Unit
192
193
4. Click to open the Access Rights window. 5. Select the instrument engineering group in the left area and expand the tree by double-clicking it. 6. Double-click the Unit level icon to expand the list of units and select the unit where you want to grant workflow access. 7. From the Name column, select Instrumentation Workflow Flag. 8. From the Mode column, select Full (Add / Delete / Update). 9. From the Name column, select Process Data Workflow Flag. 10. From the Mode column, select Access Denied. 11. Select the process engineering group in the left area and expand the tree by double-clicking it. 12. Double-click the Unit level icon to expand the list of units and select the required unit where you want to grant access. 13. From the Name column, select Process Data Workflow Flag. 14. From the Mode column, select Full (Add / Delete / Update). 15. From the Name column, select Instrumentation Workflow Flag. 16. In the Mode column, select Access Denied. 17. When done, do one of the following: Click Options > Save. Click .
194
3. On the Access Rights window toolbar, click to open the Copy Access Rights dialog box. 4. Under Project and group selection, select source and target groups. If the domain is an owner operator domain, select source and target projects before selecting groups. To copy access rights within one project, from the Source project and Target project lists, select the same project. Under Access rights level, do the following: Select a check box to specify the level at which you want to copy access rights. According to your level selection, select source and target domains, highest plant hierarchy level items, or lowest plant hierarchy level items. Click Apply.
5. 6. 7. 8.
195
Preferences Management
The software allows the Domain Administrator to manage SmartPlant Instrumentation preferences in the current domain, or in As-Built and projects in an owner operator domain.
Export Preferences
Use this procedure to export domain preferences (or project preferences when the domain type is Owner operator) to an external .dmp file. For more information, see Export Preferences (on page 198).
Import Preferences
Use this procedure to import preferences from an external .dmp file to the current domain or a specific project if the domain type is Owner operator. For more information, see Import Preferences (on page 199).
See Also
Domain Administration Common Tasks (on page 117)
196
We recommend that you do not disable the temporary folder path option. This is because in the temporary folder, the software creates temporary files during various activities that users perform in SmartPlant Instrumentation, for example, when creating specifications, generating CAD drawings, hook-up drawings, reports, and so forth. If you prevent users from specifying individual temporary folder paths, the temporary folder path becomes shared among several users. This can cause problems with data display when users perform the same activity at the same time, for example, when creating two specifications at the same time. 6. Click OK to save the settings and close the Advanced Domain Preferences dialog box.
197
4. 5.
6.
7. 8.
Export Preferences
1. Start the Administration module and log on as Domain Administrator. 2. With the Domain Administration window open, click Activities > Preferences Management. 3. If the domain type is Owner operator, from the Project list, select a source project. 4. Click Export. 5. On the dialog box that opens, enter the name of the target .dmp file, and then, click Save to export the current preferences to the .dmp file. It is only possible to export preferences to a .dmp file. In the created .dmp file, you can modify preferences as you require, and then, import them to a domain or project residing in another database.
198
Import Preferences
1. Start the Administration module and log on as Domain Administrator. 2. With the Domain Administration window open, click Activities > Preferences Management. 3. If the domain type is Owner operator, from the Project list, select a target project. 4. Click Import. 5. On the dialog box that opens, select the .dmp file that contains previously exported preferences, and then, click Open. 6. On the Preferences Management dialog box, click OK to save the settings.
Report Management
The Domain Administrator can manage SmartPlant Instrumentation reports. This activity involves associating a customized title block with a report, and setting archiving options for report comparison within the SmartPlant Instrumentation environment. Using these options, you manage all the available reports in most of SmartPlant Instrumentation modules. When managing reports, you filter and sort the report data as needed. Also, you can define revision management settings. In the database, each report is assigned to the report type, which can be list or non-list. The report type determines how SmartPlant Instrumentation users can manage revisions created for a specific report, for an item, or a group of items. For list-type reports, the Domain Administrator can enable users to manage revisions either per document or per item. In accordance with the revision management setting, users can either create a revision whose document number and revision number become shared for a specific item and for reports generated for that item (when the setting is per-item), or create a unique revision for a particular report (when the setting is per-document).
199
See Also
Domain Administration Common Tasks (on page 117)
See Also
Generating Reports for Merging Data Common Tasks (on page 159)
200
See Also
Generating Reports for Merging Data Common Tasks (on page 159)
201
1. 2. 3.
4. 5.
To return from the filtered view to the normal view, clear the Apply check box. 6. For a specific report displayed in the Report Name column, select the desired archiving option from the list in the Archiving Options column. If you have selected the Save to database or Do not save option, skip this step. To use the Save as File, or Compress as Zip file options, you need to set an archive path (as described in the next step). 7. To define the default archive path for all the report revisions to be saved as files or compressed as .zip files, click box, and enter the required path. next to the Path field in the Default archive path group
If needed, you can define a different path for a particular report by entering the required path in the Archive Path field of the data window.
202
Per Document Allows users to apply a unique document number and revision to a specific report generated for a specific item, and also allows to make global revisions.
After creating two reports for a particular strip: a report with adjacent connections and a report without adjacent connections, the document and revision numbers of the two reports cannot be shared. Likewise, after creating two panel-strip reports for two different strips, each report has a unique document number and revision. As a result, the document number and revision added from the report print preview is different from the document number and revision added in the Revisions dialog box opened from the item properties dialog box.
A revision management setting of all list-type reports is always per document. A revision management setting of certain non-list-type reports is set permanently as per item, while for other non-list-type reports you can define the revision management setting as either per item or per document. In an owner operator domain, after you change the revision management setting from per item to per document, the report becomes available for claiming. The project Administrator can claim the document using the Project Activities dialog box options.
203
Add-Ins
After the System Administrator initiates a domain, a number of item resources (for example, hook-up items, links, and so forth) become available in the software. These items allow you to get started with building your domain without having to create all the required items from scratch. However, these resources are rather limited and do not provide for all your needs. You can enhance your item resources by appending add-ins to your domain. Add-ins are available on purchasing the appropriate SmartPlant Instrumentation license. Contact your local SmartPlant Instrumentation dealer or Intergraph for further information.
5.
6.
7. 8.
The software does not allow you to import a hook-up item library which already exists in the database. If you attempt to import such a hook-up item library, the software displays an appropriate message.
204
5. 6.
7. 8. 9.
205
206
Export Macros
This option enables you to export macros from a current SmartPlant Instrumentation database or domain to a text file. Then, from another database or domain, you import data contained in this file. Note that you can also include all the existing typical tags in the target text file. Exporting macros requires the existence of an sppid_macro component table in the source database or domain, Domain Administrator access rights, and a database target .txt file. 1. Start the Administration module and log on as Domain Administrator. 2. With the Domain Administration window open, click Add-Ins > Import/Export Macros> Export Macros. 3. In the Export Macros dialog box, click Browse. 4. In the Select file for Export dialog box, select a target .txt file from the list or create a new file. 5. Click Save to return to the Export Macros dialog box. If there are typical tags in the current source database or domain, you can select Include typical tags to export all typical tags to their target .txt files. Clearing Include typical tags results in just the loop data being exported. 6. Click OK in the Export Macros dialog box. 7. Click OK in the notification box that appears if macros have been exported successfully. 8. Click Close in the Export Macros dialog box.
207
Import Macros
This option enables you to import macros into SmartPlant Instrumentation from a predefined intermediate text file that already contains macros exported from another database or domain to the current database or domain. When importing macros, this text file serves as the source file. Note that you can also import all the typical tags that have been included in the text file. Importing macros requires the existence of an sppid_macro component table in the target database or domain, Domain Administrator access rights, and a predefined source .txt file. 1. Start the Administration module and log on as Domain Administrator. 2. With the Domain Administration window open, click Add-Ins > Import/Export Macros> Import Macros. 3. In the Import Macros dialog box, click Browse. 4. In the Select file for Export dialog box, select a .txt file from the list. 5. Click Save to return to the Export Macros dialog box. Select the Include typical tags check box to import all typical tags to the current database or domain from the source .txt file, if required. Before selecting Include typical tags, ensure that the source .txt file contains the required typical tags; otherwise, the macro import process will fail. 6. Click OK in the Import Macros dialog box. 7. Click OK in the notification box that appears if macros have been imported successfully. 8. Click Close in the Import Macros dialog box.
208
The new spec form names and numbers must be unique in your plant. 7. Click Import to append the selected views to the database. After importing the spec forms, you must rebuild the catalog tables. Switch to System Administration and then click DBA > Rebuild catalog tables. You can import only those spec forms for which you purchased an appropriate license. In order to use these forms in SmartPlant Instrumentation, you must regenerate the specifications that are based on these forms. You can do it for a single specification page or for multiple ones in batch mode, For more information, see the SmartPlant Instrumentation Help, Specifications > Specification Pages > Regenerate a Specification Page or Regenerate Pages in Batch Mode.
209
Select a Logo
You can select a .bmp format graphic file which will appear as a logo in most printed documents such as some reports and specifications. You can build a number of domains in your database, each having a different logo. In this case, when you switch to a domain, the software retrieves the logo assigned to that domain from the database. If all your domains use the same logo, you can make the logo retrieval operation faster by selecting the PROJLOGO.bmp file located in the <SmartPlant Instrumentation home folder>\Temp folder as the default source logo file for all domains in the database. This file is automatically generated by the software during the Setup process. For more information, see Select a Logo (on page 217).
See Also
Domain Administration (see "Domain and Project Administration" on page 117)
210
See Also
Panel Location Levels Dialog Box (on page 323)
211
212
213
Cable Set
Document
214
Line
Loop
Panel
215
Terminal
Wire
A custom table name must be unique. Do not use the single quote () character in custom table names because doing so causes the label to be displayed incorrectly in the Tag Number Properties dialog box. 5. Click Apply and, if needed, repeat the procedure for another plant.
See Also
Miscellaneous Domain Administration Tasks (on page 209)
216
Access Rights
Instruments instrument tags in calculation sheets, process data sheets, and specs. Records in supporting tables I/O Type, Location, Model, Status. Wiring data cables, panels, terminals, wires, connections, and I/O channels. Panels by categories marshaling racks, PLCs, DCSs, junction boxes, device panels, and cabinets. Other items loop drawings, CAD drawing blocks, P&ID drawing references, hook- ups, lines, and spec forms. Maintenance statistical data calibration settings, and calibration results. A list of signals per largest group sequence number.
Displays access rights information for selected user groups. This information includes a list of selected user groups, the items for which those user groups were granted access rights, and the access type to every item. You can generate this report on the domain, plant, and unit levels. Displays a list of all reference cables that do not comply with the cable type dependency requirements. If the report contains any data, the System Administrator cannot enable cable type dependency in the domain. For details about cable type dependency, see Enable Cable Type Dependency (on page 81).
See Also
Miscellaneous Domain Administration Tasks (on page 209)
Select a Logo
1. Start the Administration module and log on as Domain Administrator. 2. With the Domain Administration window open, do one of the following: Click File > Domain. Click . 3. Do one of the following: Click Options > Select Logo. Click . 4. Click Browse to open the Select Logo File dialog box. You can only select the .bmp (Bitmap) file format. You can create a Bitmap file using a graphic editing application such as Windows Paintbrush. Since most reports are printed out in black-and-white, it is recommended that you select Bitmap files in black-and-white to save system resources. 5. Navigate to the .bmp file to which you want to assign as the domain logo and click OK. 6. In the Browse Logo Files dialog box, click Assign to assign the selected bitmap to the current domain. 7. Click 8. Click to save the new domain logo to the database. to close the Domain Definition window.
See Also
Miscellaneous Domain Administration Tasks (on page 209)
217
See Also
Miscellaneous Domain Administration Tasks (on page 209)
See Also
Miscellaneous Domain Administration Tasks (on page 209)
218
See Also
Log on as Domain Administrator (on page 68)
219
Domain and Project Administration External Files with Trimmed Audit Trail Data
This topic explains how the Domain Administrator can define a file to which the system saves the trimmed audit trail data. For more information, see External Files with Trimmed Audit Trail Data (on page 221).
220
221
222
Clearing Locking
This option enables the Domain Administrator to clear locking in Oracle databases. Clearing locking is useful in the following cases: A SmartPlant Instrumentation user has locked a certain item for use in other sessions and remains connected to the database for a long time. There in an inactive locking session. For example, there is a session in which SmartPlant Instrumentation stopped responding, or a user has closed the locking session from the Window Task Manager, or the locking session closed down as result of an application error. These session records remain on the server database and keep locking other sessions. There is an external application whose session is locking a SmartPlant Instrumentation session in the current domain.
223
See Also
Print Database Connection Information (on page 115) Domain Administration Common Tasks (on page 117)
224
See Also
Print Database Connection Information (on page 115)
225
Copying Data
When creating a new lowest plant hierarchy item, you can copy data from another existing lowest plant hierarchy item within the same domain. In the plant hierarchy, the lowest source item can belong to any highest item in the current domain. The default lowest plant hierarchy item is <unit>. The default highest plant hierarchy item is <plant>. When the domain is an owner operator domain, you can select a specific project to which you want to copy <unit> data from the source project. It is only possible to copy data to a <unit> that has no naming conventions. In the target <unit>, the software creates naming conventions according to the naming convention definitions in the source <unit>. Therefore, after you copy data to a particular <unit>, it is not possible to copy any additional data to the same unit again. When copying <unit> data, the software does not copy the access right definitions set for the source <unit>. After copying data from one <unit> to another within a <plant> that is registered with Integration, it is possible to publish data from the new <unit>. When copying data to a <unit> in another <plant>, the Integration registration information is not copied. You copy <unit> after making source data selections on the Copy Data from Source dialog box. Your module data selection is retained when you reopen the Copy Data from Source dialog box apart from the following options: Selection of specification item types Selections on the Wiring Item Naming Options dialog box Revision copying options The following table lists the modules and the module data available for selection on the Copy Data from Source dialog box. Module Instrument Index Module Data Tag numbers Loop numbers P&ID drawing references Lines Equipment Document associations Calibration Custom tables Process data sheets with or without revisions Calculation sheets with or without revisions Notes and Restrictions Instruments belonging to Test Equipment tag class are not copied. Calibration data only includes calibration settings. Custom field values are not copied to another <plant>, only within the same <plant>.
When copying revisions, you can set a different revision method for the target <unit>. Document numbers of process data and calculations sheets are not updated in the target unit even if they have been created in the source using according to naming conventions. When copying revisions, you can set a different revision method for the target <unit>. Document numbers of specifications are not updated in the target unit even if they have been created in the source using according to naming conventions. Cross wiring is not copied.
Specifications
All module data. You can copy specifications with or without revisions.
Wiring
226
Hook-Ups
227
228
4. 5.
6. 7. 8.
229
230
5.
6. 7. 8. 9.
When the source and the target <units> belong to the same <plant>, you can select either the highest or the lowest plant hierarchy level. However, if you select to copy data on the lowest level, you have to modify the name strings to avoid duplicate names in the Wiring module (see steps 5 through 7 in this procedure to learn how to modify the name string). 10. In the left section, select another module, and repeat this procedure. 11. If needed, click Options to set naming options for wiring items in the target <unit>. For details, see Set Wiring Naming Options for Target Plant Hierarchy Item (on page 232). Make sure that you define the settings described in this procedure for all the required modules and module items before clicking OK. After you click OK, canceling the copying process can corrupt the data in the target <unit> and render the <unit> unusable. 12. Click OK to close the Copy Data from Source dialog box and monitor the progress of copying the source data.
231
232
3.
4. 5. 6. 7. 8. 9.
Make sure to set the copying options for all the required modules and module items before clicking OK. After you click OK, canceling the copying process can corrupt the data in the target unit and render the unit unusable. 10. If you have finished setting all other copying options, on the Copy Data from Source dialog box, click OK to assign the new revision settings to the copied module data.
233
SECTION 10
235
See Also
Item Registry Activities (on page 239)
Register a Plant
Use this procedure as a one-time operation, to register each highest level plant hierarchy item (for example a SmartPlant Instrumentation plant) using the SmartPlant Registration Wizard. For more information, see Register a Plant (on page 241).
236
237
and define an IDEAL user. For details, see Define an IDEAL User (on
238
16.
If you create a new plant, you should rename it and all of its plant hierarchy items to exactly match the plant hierarchy items that you want to map to in SmartPlant Foundation (the names are case-sensitive). After that, you just need to register SmartPlant Instrumentation, retrieve the plant hierarchy from SmartPlant Foundation, and correlate the two plant hierarchies. 17. Log on to SmartPlant Instrumentation as the IDEAL user and define the necessary settings for working in an integrated environment. For details, see Define Settings for an Integrated Environment (see "Define Preferences Settings for an Integrated Environment " on page 243).
See Also
Set the Project Status for an Integrated Environment (on page 133)
See Also
Domain Administration Common Tasks (on page 117) Merging Project and As-Built Data (on page 157) Enable Item Registry (on page 83)
239
Register Items
The System Administrator needs to enable the item registry options as a prerequisite to this procedure. The System Administrator has rights to switch the item registry on or off as required at any stage of the plant life-cycle. If the System Administrator switched the item registry off after you registered the items, and then switched it on again, you must re-register the items. This is required so that the software can update the references to the items in the item registry table. When updating the table, the software registers all the changes that were made to the items in SmartPlant Instrumentation, including the period when the item registry options were switched off. Prior to registering items, make sure that no users are connected to the SmartPlant Instrumentation database. It is recommended that you clear all SmartPlant Instrumentation sessions before performing item registration. The Domain Administrator must have access rights to the item registry options in order to perform this procedure. 1. Start the Administration module and log on as Domain Administrator. 2. With the Domain Administration window open, click DBA > Data Maintenance > Register Items.
See Also
Enable Item Registry (on page 83) Clear Locking in All Sessions (on page 225)
240
Registering Plants
Before you can publish and retrieve information from any of the authoring tools, you must register each plant in SmartPlant Instrumentation with a SmartPlant Foundation database. The connection allows SmartPlant Instrumentation to use the SmartPlant integration commands. A SmartPlant Instrumentation Domain Administrator typically performs the registration. The software maps a plant and all its projects to a single SmartPlant Foundation URL, which points to one, and only one, SmartPlant Foundation plant database and its projects. When you use the Register command in any of the authoring tools, you are registering an authoring tool plant with a SmartPlant Foundation URL and plant that you specify. The Domain Administrator must register each plant in the authoring tool once; this action takes place in the Administration module. After the plant is registered, you can publish and retrieve documents. Tool registration information is not upgraded in SmartPlant Foundation; therefore, each tool must re-register with SmartPlant Foundation after upgrading SmartPlant Foundation. Since it is not possible to re-register a SmartPlant Instrumentation plant using the interface options, if you must re-register a SmartPlant Instrumentation plant, contact Intergraph Customer Support.
Register a Plant
1. Log on as Domain Administrator and select the desired domain, configured for an integrated environment. 2. Click SmartPlant > Register. You cannot unregister a plant after it is registered. 3. On the Select Plant dialog box, select the plant that you want to register. 4. On the SmartPlant Foundation URL page of the SmartPlant Registration Wizard, type the node name and virtual directory of the SmartPlant Foundation database to which you want to register your project. Use the following format: http://<SPFServer>/<VirtualDirectory>. For example: http://<SPFServer>/SPFASP. You can click the Browse button to search for the node name. However, you must append the virtual directory to that node name by typing it in the SmartPlant Foundation URL box. Replace <SPFServer> with the name of your SmartPlant Foundation Web server. Replace <VirtualDirectory> with the name of the virtual directory for the SmartPlant Foundation Web Client. By default, the virtual directory for the first instance of the Web Client that you install is SPFASP. However, if you install multiple instances of the Web Client to connect to multiple databases, the virtual directory name may be different. 5. Click Next.
241
You cannot defer tasks or view To Do List task properties when retrieving a plant hierarchy in the Administration module. 15. Click Close to close the To Do List dialog box.
242
243
Instrument Retrieval
When you retrieve an instrument, the software populates the tag number segments from the retrieved instrument object properties according to the following mapping: Segment 1 2 3 4 Property InstrTagPrefix MeasuredVariable+InstrFuncModifier InstrTagSequenceNo InstrTagSuffix
Segment 1 is populated with the InstrTagPrefix Segment 2 is populated with the concatenation of MeasuredVariable and InstrFuncModifier Segment 3 is populated with the InstrTagSequenceNo Segment 4 is populated with the InstrTagSuffix The segments are then trimmed and put together according to the naming convention to create the tag number. If the naming convention in other tools (for example, SmartPlant P&ID) does not include a prefix, the first segment length needs to be set to 0.
Loop Retrieval
When you retrieve a loop, the software populates the loop name segments from the retrieved instrument object properties according to the following mapping: Segment 1 2 3 4 5 LoopSequenceNo LoopSuff Property LoopPrefix LoopIdentifier
Segment 1 is populated with the LoopPrefix Segment 2 is populated with the LoopIdentifier Segment 4 is populated with the LoopSequenceNo Segment 5 is populated with the LoopSuff Segment 3 is not populated and needs to be set to length 0
244
The object name is populated by the tag number with all spaces removed. If the length of prefix is more than 0, the prefix will be part of the object name. Other applications that publish instruments (for example, SmartPlant P&ID) need to be configured to publish the instrument object name with the prefix. The MeasuredVariable and InstrFuncModifier are both populated be the second segment. If the first two characters of segment 2 are included in the TwoLetterMeasuredVariable list that was defined in the SmartPlant Instrumentation mapping file, then the MeasuredVariable gets these two letters; if not then the MeasuredVariable gets the first character of segment 2. In both cases, the InstrFuncModifier gets the rest of the characters of segment 2. This allows correct publishing of instruments such as PDT or DPT. TwoLetterMeasuredVariable DP PD FQ FF TD WD ZD FO
Loop Publishing
When you publish a loop, the software populates the published object properties by the naming convention segments as follows: Property LoopPrefix LoopIdentifier LoopSequenceNo LoopSuff Segment 1 2+3 4 5
245
246
247
Publishing Data
You are not allowed to publish data from As-Built. Doing so results in items appearing more than once (for As-Built and for each project where the item is claimed). Instead, you must open the specific project from which you want to publish the data.
248
249
250
251
252
SECTION 11
253
254
255
If you leave any fields blank for the target language, text from the Original Phrase column (English) will appear in those fields in the interface after switching languages. This is useful for terms that are the same in your language as in English. Make sure that you add the same prefixes, suffixes and punctuation marks that appear in the corresponding original phrases of that interface language, for example: ~, &. For details, see Prefixes and Suffixes in the Interface Text (on page 257). 4. Do one of the following: Click Update to save the changes to the database. (If you want to save the changes to an external language file and not to the database, do not click Update.) Click Save File to save the translated interface text to an external language file with a .psr extension. 5. Click Close to close the Edit Translation Text dialog box. You must exit and then restart the application for your text changes to take effect. 6. Select the language that you have translated by means of one of the following options: To select a language from the database, see Replace the Interface Language with a Language from the Database (on page 255). To select a language from an external file, see Replace the Interface Language with a Language from an External File (on page 255).
256
&& ~n ~r
~t
&Action~tCTRL+A
257
258
SECTION 12
A
Topics
Access Rights Window Toolbar ..................................................... 260 Access Rights Window .................................................................. 260 Accounting Dialog Box ................................................................... 261 Active Database Connections Dialog Box ..................................... 261 Activity Tracking Report Settings (Graph) Dialog Box ................... 262 Activity Tracking Report Settings (Grid) Dialog Box ...................... 263 Add Accounting Dialog Box ........................................................... 263 Add Client Dialog Box .................................................................... 263 Add Contractor Dialog Box ............................................................ 264 Add Database Views Dialog Box ................................................... 264 Add Datafiles (SQL Server) Dialog Box ......................................... 264 Add Datafiles (Oracle) Dialog Box ................................................. 265 Administration Window .................................................................. 265 Advanced Domain Preferences Dialog Box .................................. 265 Advanced Filter Definition (Cables) Dialog Box ............................. 266 Advanced Filter Definition (Loops) Dialog Box .............................. 267 Advanced Project Preferences Dialog Box .................................... 268 Area Properties Dialog Box ........................................................... 269 Assign Groups to Project Dialog Box ............................................ 270 Assign Users to Groups Dialog Box .............................................. 270
259
Toolbar (see "Access Rights Window Toolbar" on page 260) Group list
Displays all the user groups defined in the current domain. For each group, access rights are defined on three levels: domain, highest plant hierarchy level , and lowest plant hierarchy level. The Domain Administrator defines plant hierarchy level name in the Plant Hierarchy dialog box. The default highest level is Plant. The default lowest level is Unit. Double-click a group to display the access levels. Domain level Allows you to grant or deny access to the domain administration tools and global items, such as supporting tables, default cable and panel managers, UOM definitions, and so forth. When the domain type is Owner operator, in a project or As-Built, access rights granted on the domain level do not apply. <Plant> Level Allows you to grant or deny access to specific items and activities that are defined on the highest plant hierarchy level. The label <Plant> changes dynamically according to your highest plant hierarchy level definition.
260
Item or activity
Displays all the items and activities that are associated with the selected access rights level. Each item or activity is then associated with a specific access mode. For more details about the available items and activities, see Access Rights Descriptions (on page 184). Name Displays the items and activities for which you are defining access rights. The contents of this list depend on the level you selected. Mode Allows you to select the appropriate access mode to the selected item or activity for the user group you chose in the Group list pane. You can select one the following access modes to grant access per item or activity: Full Allows group users to add, delete, and modify data for the item that you selected. Modify Allows group users to add and modify data for the item that you selected. Deletion is prohibited. View Only Allows group users to view data for the item that you selected, but does not allow editing the item in any way. Access Denied Prevents group users from accessing the item that you selected. You can apply this mode at the domain level if you need to deny access to an entire module.
Command Buttons
Apply Saves all the changes you have made. New Allows you to define a new account. Clicking this button makes all the fields accessible for editing. Edit Allows you to modify the current account properties. Delete Deletes the selected account.
261
Print
Prints the list of the connected users without opening a print preview.
262
263
Filegroup
This tab allows you to add new datafiles to a filegroup. Filegroup Allows you to select the filegroup to which you want to add a new datafile. Data Window Displays the read-only filegroup, file name, and data file location information. New file information Allows you to specify name and location, and the initial size of the datafile. The options are: Datafile name Allows you to enter the name of the new datafile that you want to add. Datafile location Allows you to specify the path on the file server where the new datafile will be located. The file path must include the drive and the datafile name. Initial size Allows you to enter the initial size of the new datafile, in MB.
Log Group
This tab folder allows you to add new datafiles to the Log group. For the option descriptions, see the information for the Filegroup tab.
Tempdb
This tab folder allows you to add new datafiles to the Tempdb group. For the option descriptions, see the information for the Filegroup tab.
264
Administration Window
Enables you to end the Administration module session or to re-enter the module either as System Administrator or Domain Administrator. Clicking the toolbar icon re- opens the Open Administration Module dialog box.
Data Window
Module/Feature Contains a list of SmartPlant Instrumentation modules and features whose preferences the user can customize, within the SmartPlant Instrumentation environment, on the Preferences dialog box. Category Contains a list of categories. On the Preferences Management dialog box, the category names correspond to the names of pages displayed after you expand the hierarchy in the tree view pane. For example, the New Tag category corresponds to the New Tag page of the Instrument Index preferences.
265
Connection criteria
Allows you to filter the cables according to their connections. Look for connections Allows you to include the connection criteria in the filter condition. This activates the check boxes under Connection and under Connected to. Clear this check box if you do not want to include any of the connection criteria in the filter condition. Clearing this check box disables the Connection and the Connected to check boxes.. Connection Allows you to define a filter according to the cable connection: No connections on either end Includes the cables that are not connected to anything on both ends. At least one wire connected on one end only Includes the cables that contain at least one wire that is only connected on one of its ends. At least one wire connected to both ends Includes the cables that contain at least one wire that is connected on its both ends. Connected to Allows you to define a filter according to the type of panel that is connected to the cable. This selection sets connection criteria for cables that have at least one wire connected to one or both ends. Junction boxes Includes all the cables that are connected to junction boxes. Marshaling racks Includes all the cables that are connected to marshaling racks. Cabinets Includes all the cables that are connected to cabinets. Device panels Includes all the cables that are connected to device panels.
266
Cable associations
Allows you to filter the cables according to their associations. Fieldbus segment Allows you to filter for cables associated with a specific Foundation Fieldbus or Profibus segment. Display telecom cables only Allows you to filter for cables connected to telecom items.
267
Data Window
Module/Feature Contains a list of SmartPlant Instrumentation modules and features whose preferences the user can customize, within the SmartPlant Instrumentation environment, on the Preferences dialog box. Category Contains a list of categories. On the Preferences Management dialog box, the category names correspond to the names of pages displayed after you expand the hierarchy in the tree view pane. For example, the New Tag category corresponds to the New Tag page of the Instrument Index preferences. Sub Category Name Contains a list of preference options that users can customize within the SmartPlant Instrumentation environment, on the Preferences dialog box. The sub category names correspond to the names of the options within a specific page of the Preferences Management dialog box. Enabled When selected, indicates that users in the current project can customize the option that is displayed beside this check box. You can select as many check boxes as you require. By clearing a certain check box, you disable the adjacent preference option customization in the current project, so that the users working in this project will view these options as read-only. When you clear the Enabled check box for an property in a particular project, the user is unable to change the value of that item. If you enable the same item in another project and the user opens that project, the user sees the value that was set in the project where the property was disabled, and not the value from the current project. We recommend that you do not disable the temporary folder path option. This is because in the temporary folder, the software creates temporary files during various activities that users perform in SmartPlant Instrumentation, for example, when creating specifications, generating CAD drawings, hook-up drawings, reports, and so forth. If you prevent users from specifying individual temporary folder paths, the temporary folder path becomes shared among several users. This can cause problems with data display when users perform the same activity at the same time, for example, when creating two specifications at the same time. Enable all Makes all the preference options available for customization in the current project. Copy To Opens the Copy to Projects dialog box, where you can copy the current project preference settings to other projects in the owner operator domain. Copy From Opens the Copy from Projects dialog box, where you can overwrite the current project preference settings with other project preferences.
268
269
B
Topics
Back Up Domain Dialog Box ......................................................... 271 Backup Repository Dialog Box ...................................................... 272
270
Enables you to specify the target folders to which the software backs-up reports, and select the documents you wish to include in the backup. To open this dialog box, in the Back Up Domain dialog box, click Files.
271
Windows and Dialog Boxes Specify target folder for saving external files
Target path for saving files Specify the target folder in which the software saves the backup zip files. You can click Browse... and browse to the folder. Include in backup Reports Select to Include SmartPlant Instrumentation reports in the backup. CAD loop drawings Select to backup your AutoCAD loop drawings. Hookup drawings Select to backup your hookup drawings.
272
C
Topics
Change Admin Schema Password Dialog Box ............................. 273 Change Domain Schema Password Dialog Box ........................... 274 Change Security Schema Password Dialog Box ........................... 274 Change Password Dialog Box ....................................................... 274 Clear Activity Tracking Data Dialog Box ........................................ 275 Clear Locking in Selected Sessions Dialog Box ............................ 275 Client Dialog Box ........................................................................... 276 Colors Dialog Box .......................................................................... 276 Comparison List Dialog Box .......................................................... 277 Comparison List Filter Dialog Box ................................................. 278 Comparison List Report Dialog Box............................................... 279 Contractor Dialog Box .................................................................... 279 Copy Data from Source Dialog Box ............................................... 279 Copy Access Rights Dialog Box .................................................... 283 Copy From Dialog Box ................................................................... 284 Copy from Project Dialog Box ........................................................ 284 Copy from Project Dialog Box ........................................................ 284 Copy Naming Conventions From Dialog Box ................................ 285 Copy Naming Conventions Dialog Box ......................................... 285 Copy to Projects Dialog Box .......................................................... 285 Custom Fields Dialog Box ............................................................. 286 Custom Tables Dialog Box ............................................................ 287
273
274
275
Command Buttons
Apply Saves all the changes you have made. New Allows you to define a new client. Clicking this button makes all the fields accessible for editing. Edit Allows you to modify the current client definition. Delete Deletes the selected client definition.
276
Command Buttons
Filter Opens a dialog box where you can filter items for the comparison list. View Opens a dialog box where you can display data columns for the current item. Sort Opens a dialog box where you can sort the list of items by specified data columns. Report Opens a Comparison List Report print preview. Info Displays summary information about the number of rows for each mode, and the number of rows for each action to be performed (Merge Now or Release Claim). Options Opens a pop-up window for selecting sub-items (where available) for which additional comparison reports can be generated. For sub-items, the specified merge action is the same as the action set for the main item.
277
278
Command Buttons
Apply Saves all the changes you have made. New Allows you to define a new contractor. Clicking this button makes all the fields accessible for editing. Edit Allows you to modify the current contractor definition. Delete Deletes the selected contractor definition.
279
Command Buttons
OK Copies the <unit> data to the target <unit>. Before clicking OK, you must select all the module data that you want to be copied, make the required item name modifications, revision and level settings. Click this button only after you have finished making data selection. After you click OK, canceling the copying process can corrupt the data in the target <unit> and render the <unit> unusable. Clear All Clears the copying settings for all the modules. Also, you need to click this button if you have previously copied data to another <unit>, and access the Copy Data from Source dialog box again. The software displays the previously defined settings in the upper-right and lower-right sections. Options Opens a dialog box where you can set new naming options for wiring items. Wiring item naming settings are not retained when you reopen the Copy Data from Source dialog box.
280
281
282
283
284
285
Data Window
Contains all custom fields available in the SmartPlant Instrumentation database. Number Displays the custom field sequence numbers in the data window. For process data custom fields, the values in the Number column do not correspond to the custom fields sequentially. For details, see Sequence Numbers and Process Data Custom Fields (on page 213). Visible (only available when you select Process Data from the Item type list) Enables or disables custom fields used in process data sections. Section Name (only available when you select Process Data from the Item type list) Displays the default custom field definition in process data sections.
286
Command Buttons
Apply Saves the current custom field selection to the database. Copy From Opens a dialog box where you can select a <plant> from which you can copy custom field definitions. Print Prints out all custom field available for the selected item or data type.
287
D
Topics
Data Files to Delete Manually Dialog Box ..................................... 288 Delete Invalid Domain Dialog Box ................................................. 288 Delete Projects Dialog Box ............................................................ 289 Department Dialog Box .................................................................. 289 Domain Data and Indexes Dialog Box ........................................... 290 Domain Administration Window ..................................................... 291 Domain Definition Window (Domain Administration) ..................... 291 Domain Definition Window Toolbar (Domain Administration) ....... 295 Domain Definition Window (System Administration) ..................... 295 Domain Definition Window Toolbar (System Administration) ........ 299 Domain Tablespace Definition Dialog Box .................................... 299
288
Data Window
Displays all projects available in the current owner operator domain. If, in the owner operator domain, activities for working in an integrated environment are enabled, this data window displays only projects with Canceled or Merged status. Project Allows you to select one or more projects for deletion. Project Administrator Displays the names of the Project Administrator. Plant Displays the name of the plant associated with the project.
OK
Deletes engineering data for projects selected in the data window.
Command Buttons
Edit Allows you to edit the profile of the department you selected from the Department list. New Allows you to create a new department. Delete Deletes the department you selected from the Department list.
289
Domain data
Domain file name Accept the displayed value or type another unique domain file name. The name must be unique within the SmartPlant Instrumentation database. Datafile name and path Accept the displayed value or type the full path and name of the domain file. The default file extension is .mdf. You can change the file extension as you require. Initial size (MB) Accept the displayed size of the domain file. The displayed size is 40 MB. The SQL Server Auto-extend feature automatically increases the size of this file if needed. Filegroup Accept the displayed name or type another unique filegroup name. The name must be unique within the SmartPlant Instrumentation database. You cannot use an existing filegroup when initializing a domain, but you can add additional domain files to this filegroup from the Administration module.
Index data
Index file name Accept the displayed name or type another unique index file name. The name must be unique within the SmartPlant Instrumentation database. For example, if you have six domains in one database, you must have six different index file names. Datafile name and path Accept the displayed value or type the full path and name of the domain file. The default file extension is .mdf. You can change the file extension as you require. Initial size (MB) Accept the displayed size of the index file. The displayed size is 20 MB. The SQL Server Auto-extend feature automatically increases the size of this file if needed. Filegroup Accept the displayed name or type another unique filegroup name. The name must be unique within the SmartPlant Instrumentation database. You cannot use an existing filegroup when initializing a domain, but you can add additional domain files to this filegroup from the Administration module.
OK
Starts the initialization process.
290
Domain type
Displays the domain type defined by the System Administrator for the current domain.
291
Domain features
Activity tracking Indicates whether activity tracking options are enabled by the System Administrator. Audit trail options Indicates whether the audit trail options are enabled by the System Administrator. Item registry Indicates whether the Domain Administrator can use the item registry options available on the DBA menu (Data Maintenance sub-menu). Cable type dependency Indicates whether cable type dependency is enabled by the System Administrator. Single mode (on Oracle or SQL Server only) When the check box is selected, all the items are unlocked. This improves the software performance, but enables multiple users to work with the same item simultaneously. When the check box is cleared, all the items are locked so that only one user at a time can work with the same item.
292
Workflow
Instrumentation and process data Displays the workflow status selected by the System Administrator. Workflow only applies where the selected domain type is Engineering company. When the domain type is Owner operator, Domain Administrator defines workflow in the Project Activities dialog box, at the level of the projects in the domain. The available workflow options are:
293
Global path
Global path box Displays the global path set by the System Administrator. Allow to overwrite the global path Indicates whether the System Administrator has enabled users to set user-defined paths in addition to the specified global path. When the check box is selected, users are not restricted to setting new paths in SmartPlant Instrumentation within the global path folder only. Path for SmartPlant XML files Displays the location of the SmartPlant Instrumentation map files: ContextMap.xml and IntoolsMap.xml, which are needed for working in an integrated environment or using the point-to-point interfaces between tools. The System Administrator can specify the XML path when making domain definitions.
Miscellaneous Options
Notes Type notes or comments if needed.
294
Domain type
Select the domain type depending on the activities you want to perform in your engineering plants. We do not recommend working in an owner operator domain if it resides in a stand-alone database. It is known that when using the Sybase Adaptive Server Anywhere database engine, certain options in an owner operator domain are liable to work incorrectly. Engineering company Such a domain is usually contracted to design and build plants based on process information. These are 'grass-roots' projects that usually involve one set of data which may be revised extensively during the life-cycle of the plant. In this case, the data for each project is maintained within a single database schema. Once a plant is operational, the domain type can be changed to Owner operator if needed, and the owner can perform the necessary maintenance and modernization.
295
Domain features
Activity tracking Enables the use of activity tracking. Audit trail options Enables the use of audit trail options. Item registry Enables the Domain Administrator to use item registry options. Cable type dependency Enables cable type dependency. You can only select this option if all reference cables comply with the dependency requirements. You can generate a Cable Type Dependency Validation report to display a list of all reference cables that do not comply with the dependency requirements. Also, make sure that in the current domain, the properties of plant cables in the Domain Explorer match the properties of the reference cables in the Reference Explorer. Single mode (on Oracle or SQL Server only) Improves the software performance and switches to single mode. Switching to single mode unlocks all the database objects. Therefore, more than one user can have access to the same item simultaneously. There is no mechanism that prevents the occurrence of sharing violation problems. Using the same database resource by more than one user can cause database problems.
296
297
Global path
Global path box Displays the global path that you set for all users. If you change the existing global path, all user-defined paths remain linked to the previous global path. For example, if you change the global path from \\APP_SERVER\SmartPlant Instrumentation to \\APP_SERVER_1\SmartPlant Instrumentation, and a user has already specified a path to the PSR folder, in the appropriate box, the user-defined path is displayed as a full path \\APP_SERVER\SmartPlant Instrumentation\PSR. A global path does not apply to individual temporary folder settings. Browse Allows you to navigate to the folder that you want to specify as the global path folder. We recommend that you specify a path that complies with universal naming conventions (that is, it starts with \\). If you want to use mapped drives, make sure that all SmartPlant Instrumentation users have the same drive mapping. Allow to overwrite the global path Allows users to set user-defined paths in addition to the specified global path. When the check box is selected, users are not restricted to setting new paths in SmartPlant Instrumentation within the global path folder. Path for SmartPlant XML files Allows you to specify the location of the SmartPlant Instrumentation map files: ContextMap.xml and IntoolsMap.xml, needed for working in an integrated environment. These files are also needed when you are working with interfaces to other tools. Click Browse to select the folder where the SmartPlant Instrumentation map files are located.
298
Domain data
Tablespace name Accept the displayed value when working in Automatic / Customized modes or type an appropriate domain tablespace name. When working in Predefined mode select a tablespace name from the drop-down list. See more details in SmartPlant Instrumentation Administration User's Guide. Datafile name and path Accept the displayed value or type the full path and name of the domain tablespace database file. The default file extension is .dbf. You can change the file extension as you require. Tablespace size (MB) Accept the displayed value or type the required domain tablespace size.
299
OK
Starts the initialization process.
E
Topics
Export Macros Dialog Box ............................................................. 300
300
F
Topics
Field Personnel Profile Dialog Box ................................................ 301 Filegroup List Dialog Box ............................................................... 301 Filter Definition Dialog Box ............................................................ 301 Find Item Dialog Box ..................................................................... 303
301
Command Buttons
Add Adds a new line for specifying a filtering condition. Delete Deletes the selected filtering condition. Verify Verifies the correctness of the entire filtering expression. Reset Removes all filtering conditions so that you can re-enter a new filter definition. Advanced Allows you to define a special filter for cables or loops.
302
G
Topics
Generate Access Rights Report Dialog Box .................................. 303 Global Access Rights Dialog Box .................................................. 304 Group Dialog Box .......................................................................... 305
All Levels
Allows you to select specific user groups and generate a report on the access rights granted to them on the domain level and also on all levels of your plant hierarchy. Data Window The Group Name data window displays all the existing user groups in the current domain. Select groups that you want to include in the report.
Domain
Allows you to select specific user groups and generate a report on the access rights granted to them on the domain level. Data Window The Group Name data window displays all the existing user groups in the current domain. Select groups that you want to include in the report.
303
<Plant>
Allows you to select specific user groups and generate a report on the access rights granted to them on the <plant> level. Data Window Displays all the existing user groups and the plants to which they are assigned. Select groups that you want to include in the report.
<Unit>
Allows you to select specific user groups and generate a report on the access rights granted to them on the <unit> level. Data Window Displays all the existing user groups, <plants>, and <units> to which user groups are assigned. Select groups that you want to include in the report.
304
305
I
Topics
Import Browser Views Dialog Box ................................................. 306 Import Spec Forms Dialog Box ...................................................... 307 Import DCS Hardware I/O Library Dialog Box ............................... 308 Import DDP Library Data Dialog Box ............................................. 308 Import Hook-Up Library Dialog Box ............................................... 308 Import Interface Language Dialog Box .......................................... 309 Import Macros Dialog Box ............................................................. 309 Import System Interfaces Dialog Box ............................................ 309 Initialize (Oracle) Dialog Box ......................................................... 310 Initialize (SQL Server) Dialog Box ................................................. 311 Initialize (Sybase Adaptive Server Anywhere) Dialog Box ............ 313 Items and Activities for Access Rights Dialog Box ........................ 314
Source database
File name and path Allows you to specify the source database file. You can type the file name and path or click Browse. The default file is IN_CTLOG.DB. Connect Connects to the source database file.
Miscellaneous Options
Target plant Allows you to select the plant to which you want to add the imported predefined browser views. View Displays all available predefined browser views after you click Connect. Select a view and click Import. Import Imports the selected predefined browser views from the source database file to your database. This button becomes accessible only after you click Connect.
306
Source database
File name and path Allows you to specify the source database file. You can type the file name and path or click Browse. The default file is In_ctlog.db. Connect Connects to the source database file.
Import
PSR folder path Allows you to specify the location of the PSR files in your domain. You can type the file name and path or click Browse. You have to select the Spec_PSR folder located in the path 'Program Files\SmartPlant\Instrumentation\'. Also, make sure that you include a file name in the path that you set.
307
Source database
File name and path Allows you to specify the source database file. You can type the file name and path or click Browse. The default file is IN_CTLOG.DB. Connect Connects to the IN_CTLOG.DB file and displays the Foxboro - I/A FBMs in the Select panel library pane.
Miscellaneous Options
Select panel library Displays the Foxboro - I/A FBMs library after you connect to the IN_CTLOG.DB file and allows you to select the library for import. Import Imports the content of the Foxboro - I/A FBMs library to the database.
Source database
File name and path Allows you to specify the source database file. You can type the file name and path or click Browse. The default file is IN_CTLOG.DB. Standard Allows you to import standard SmartPlant Instrumentation hook-ups. SHELL Allows you to import Shell Oil compatible hook-ups. Connect Connects to the source database file.
Miscellaneous Options
Hook-up drawing path Allows you to specify the path to the drawings (if you have a folder for the drawings) to avoid typing it each time you open a drawing in the Hook- Ups module. Plant Name Allows you to select a target plant in which SmartPlant Instrumentation users will be able to work with the imported hook-up item library. Import Imports the selected hook-up library from the source database file to your database. The button becomes accessible after you click Connect.
308
Source database
File name and path Allows you to specify the source database file. You can type the file name and path or click Browse. The default file is IN_CTLOG.DB. Connect Connects to the source database file.
Miscellaneous Options
Language Displays the languages available in the language database file after you click Connect. Import Allows you to add the selected language to the database. This button stays disabled until you click Connect. Overwrite previously imported items Allows you to overwrite the existing terms and phrases of a language that you imported previously. You need to clear the check box if you want to add new terms and phrases to the previously imported language without overwriting any existing terms or phrases.
Source database
File name and path Allows you to specify the source database file. You can type the file name and path or click Browse. The default file is In_ctlog.db. Connect Connects to the source database file.
309
310
Miscellaneous Options
Date Displays the date of the initialization process. Start time Displays the start time of the initialization process. End time Displays the end time of the initialization process. Do not display error messages Allows you to run the initialization process without displaying any error messages that can appear during the process. The software records errors into the InitLog.txt file, located in the SmartPlant Instrumentation home folder. This file can contain records from previous backup or initialization sessions.
Command Buttons
OK Opens the Domain Data and Indexes dialog box, where you need to perform the next step of defining initialization settings for your domain data and indexes prior to starting the initialization process. Source If you initialize a new domain from an existing source domain, click this button to open a dialog box where you can connect to the source domain residing in Sybase Adaptive Server Anywhere or in an Oracle database.
311
312
Command Buttons
OK Opens the Domain Data and Indexes dialog box, where you need to perform the next step of defining initialization settings for your domain data and indexes prior to starting the initialization process. Source If you initialize a new domain from an existing source domain, click this button to open a dialog box where you can connect to the source domain residing in Sybase Adaptive Server Anywhere or in a SQL Server database.
313
Miscellaneous Options
Date Displays the date of the initialization process. Start time Displays the start time of the initialization process. End time Displays the end time of the initialization process. Do not display error messages Allows you to run the initialization process without displaying any error messages that can appear during the process. The software records errors into the InitLog.txt file, located in the SmartPlant Instrumentation home folder. This file can contain records from previous backup or initialization sessions.
Command Buttons
OK Starts the initialization process. Source If you initialize a new domain from an existing source domain, click this button to open a dialog box where you can connect to the source domain residing in Sybase Adaptive Server Anywhere, Oracle, or SQL Server.
314
Data Window
Display Sets the software to display of a particular item in the Access Rights window. Item name Displays an inventory list of the items that exist within a particular project. You can click the header to display the items in alphabetical order. Item level Displays the level of a particular item: the whole project, or just to a specific unit or plant. You can click the header to display the items by level.
L
Topics
List of Duplicate Items Dialog Box ................................................. 315 Load Audit Trail Data Dialog Box................................................... 315 Log File Dialog Box ........................................................................ 316
(Data Window)
Contains the items that are in use in other projects of the target domain, and also appear in the source project. The data window does not display the As-Built items. Item Displays the names of each duplicate item. Target Project Displays the name of the target project in which each item will be duplicates.
Command Buttons
Print Prints a report showing the list of items that will become duplicates after import. Save As Allows you to save the data in the dialog box to an external file.
315
Period
From Allows you to type the initial date (month/day/year) of the audit trail data trimmed from the audit trail repository in the source domain. To Allows you to type the last date (month/day/year) of the audit trail data trimmed from the audit trail repository in the source domain.
Miscellaneous Options
Load from file Allows you to type the user-defined file name segment as it appears in the external file to which you have saved this data. Load Loads the audit trail data to the audit trail repository in the current domain.
M
Topics
Microsoft SQL Server Connection Dialog Box ............................... 316
316
N
Topics
Naming Conventions Dialog Box ................................................... 317
317
Data Window
Segment Category Displays segment categories for which you can select specific segments that comprise the naming convention string. The segment categories change according to the item you select from the Convention list. The Segment Category list of the always includes three default levels of the plant hierarchy, even if you defined more than three levels in the Plant Hierarchy dialog box. The default segment categories are Plant, Area, and Unit, where Plant stands for the highest hierarchy level item of the parent hierarchy, Unit for the current <unit>, and Area for the intermediate level item under which you created the <unit> in the Plant Hierarchy Explorer. When several prefix segments are defined, the last segment on the list will be considered as the name prefix. Seq. (Sequence) Displays the position of the segment in the naming convention string. You cannot change this setting.
318
Command Buttons
Apply Saves the naming conventions for the selected <unit>. Copy From Allows you to select a source unit and copy its naming conventions to the current <unit>. This button is only available when the current <unit> is empty. Copy To Opens a dialog box where you can copy the current naming conventions to another <unit>. Add Adds an empty row at the bottom. Insert Inserts an empty row above the cell that you click. If you do not click any cell, the Insert button functions like the Add button: the software adds an empty row at the bottom. Delete Deletes the row in which you clicked a cell. Move Up Moves the row up. Move Down Moves the row down.
319
O
Topics
Open Administration Module Dialog Box ....................................... 320 Optimize Indexes (Oracle) Dialog Box .......................................... 320 Optimize Indexes (SQL Server) Dialog Box .................................. 320 Oracle Server Connection Dialog Box ........................................... 321 Owner Dialog Box .......................................................................... 322
320
321
Command Buttons
Edit Allows you to edit the current owner definition. New Allows you to define a new owner for the current plant. Clicking this button makes all the fields accessible for editing. Delete Deletes the current owner definition.
P
Topics
Page Setup Dialog Box .................................................................. 322 Panel Location Levels Dialog Box ................................................. 323 Plant Hierarchy Dialog Box ............................................................ 324 Plant Hierarchy Explorer ................................................................ 325 Plant Properties Dialog Box ........................................................... 326 Preferences for Scoping and Merging Data Dialog Box ................ 328 Preferences Management Dialog Box ........................................... 332 Print Options .................................................................................. 335 Print Preview Dialog Box ............................................................... 335 Project Activities Dialog Box .......................................................... 336
322
323
In the Plant Hierarchy Explorer, after creating a first <plant>, you cannot change the plant hierarchy levels until you delete that plant. Therefore, it is recommended that you first create your plant hierarchy levels using the options in this dialog box, and only then proceed to creating specific plant hierarchy items using the Plant Hierarchy Explorer. If you are planning to create more than three levels in your plant hierarchy, you cannot then use the default plant even if the System Administrator has enabled the use of the default plant. If more than three levels are defined, the software automatically clears the Default plant use check box in the Domain Definition window. Level Displays the level hierarchy number. Level 1 is the highest level. The hierarchical manner of levels is displayed in the Plant Hierarchy Explorer. Name Allows you to change the existing level name or enter a name for a new level. The name must contain at least one character that is not space. The maximum name length is fifty characters. The default level names that are supplied with SmartPlant Instrumentation are Plant, Area, and Unit. Add Appends a new level at the bottom of the list. This level becomes the lowest level of the plant hierarchy. You can only use this option before creating the first plant in the Plant Hierarchy Explorer. Insert Inserts a new level above the level that you select. You can only use this option before creating the first plant in the Plant Hierarchy Explorer. Delete Deletes a level that you select. You can only use this option before creating the first plant in the Plant Hierarchy Explorer. You can delete any level, as long as the minimum of three levels remains in the dialog box.
324
Explorer Icons
Indicates the plant hierarchy root. Below this level, you can create highest level items. Indicates the highest level items in the plant hierarchy. The default highest level name is Plant. On this level, you can edit properties or delete highest level items. Below this level, you can create intermediate levels items. Indicates intermediate levels items in the plant hierarchy. The default intermediate level name is Area. You can have more than one intermediate level, depending on your level definitions you made in the Plant Hierarchy dialog box. On this level, you can edit properties or delete intermediate levels items. Below the lowest intermediate level, you can create lowest levels items. Indicates the lowest level items in the plant hierarchy. The default lowest level name is Unit. On this level, you can edit properties or delete lowest level items.
325
326
327
General Tab (Preferences for Scoping and Merging Data Dialog Box)
Determines how the software claims, merges, or copies to the buffer the sub-items and parent items associated with the items you select in the As-Built Explorer, Source Project Explorer, or Project Explorer. For example, you can set the software to claim, merge, or copy to the buffer items with or without the associated sub-items. The Domain Explorer is not available in the Administration module. The following table shows the related data or items that the software can claim, merge, or include in the buffer for claiming or merging items when you select a main item belonging to a specific item type. Main Item Loop Related Items/Data Included with the Main Item Tags with basic engineering data (process data, calculation, calibration, dimensional data for piping, and specification sheets, hook-up associations), wiring items that have a signal propagated to the loop or tag. If you placed a device panel inside a cabinet or junction box, when claiming the loop, this device panel is not claimed or merged together with the cabinet or junction box because this device panel does not have a signal propagated to the loop. You must claim or merge such a device panel manually. Basic engineering data, wiring items that have a signal propagated to the instrument. All wiring sub-items and control system tags that appear in the appropriate wiring item folder in the Domain Explorer.
Instrument Wiring item (panel, rack, wiring equipment, and so forth Terminal strip Cable Wire
328
329
Claim Tab (Preferences for Scoping and Merging Data Dialog Box)
On this tab, you can set preferences for including revisions of the items that you claim. Also, you can define preferences for claiming or copying to the Claim Buffer the parent items as dummy items. In the project, dummy items appear as view-only. In the Domain Explorer, the dummy items are marked by a specific color and appear with the indicator. These options only apply to revisions for documents that the software claims automatically, together with the associated items that you select. These documents are process data, calculation, calibration, and dimensional data sheets, specifications, and loop drawings. These options do not apply to documents that you can select in the As-Built Explorer or Source Project Explorer. Copy revision data Includes revision data of the documents associated with items that you claim. Reclaim items Allows you to claim the same items again. When an item exists in a project, reclaiming the item results in an automatic update of the project item properties, connections and associations. If you deleted an item, this item reappears in the project after reclaiming. Path for .psr files and log file Allows you to specify the path for a log file that contains details of the claim process. In addition, the software uses this path to generate .psr files that include a list of claimed items. The software groups the items in .psr files according to item types. You can enter the path of the target file, or click Browse to specify the path. In the folder that you specify, in addition to the log file and individual .psr files, the software also creates a .zip file that includes the log file and the .psr files. The software names the .zip file as follows: claim<project ID number>_<incrementing number>, for example, CLAIM21215_12. The incrementing number of the file name is incremented by one each time you claim items. This way, you do not overwrite the previous .zip file. All the individual .psr files are overwritten automatically after each claim session.
330
Merge Tab (Preferences for Scoping and Merging Data Dialog Box)
On this tab, you can set preferences for merging revision data of the items you merge with As-Built. Also, you can define preferences for handling parent items that remain in the project after you merge their sub-items items or copy the sub-items to the Merge Buffer. When merging documents, these options do not apply. Merge option for revisions Allows you to select a desired option to specify how to process revisions when merging data. This list contains the following options: Ignore Does not merge revisions associated with the items. If you select this option, you cannot generate Changed Documents reports (report generation is available from the Project Explorer). Copy Deletes revisions that exist in As-Built and then copies revisions from the current project. This option does not allow you to generate Changed Documents reports. Merge by revision ID Merges revisions with As-Built by using the internal revision ID that appears in the database. Existing revisions in As-Built are updated with revision data merged from the project. Merge by revision number Merges revisions with As-Built by using the revision numbers defined in the current project. Existing revisions in As-Built are updated with revision data merged from the project. If you set the software to save revisions as files, the software does not delete the files in the revision archive folder you specified for the project in the Report Management dialog box (the software deletes the revision records from the project successfully). This, however, does not affect report comparison procedures you can perform in As-Built after merging revisions. Path for .psr files and log file Allows you to specify the path for a log file that contains details of the merge process. In addition, the software uses this path to generate .psr files that include a list of merged items. The software groups the items in .psr files according to item types. You can enter the path of the target file, or click Browse to specify the path. In the folder that you specify, in addition to the log file and individual .psr files, the software also creates a .zip file that includes the log file and the .psr files. The software names the .zip file as follows: merge<project ID number>_<incrementing number>, for example, MERGE21215_12. The incrementing number of the file name is incremented by one each time you merge items. This way, you do not overwrite the previous .zip file. All the individual .psr files are overwritten automatically after each merge session.
331
If, in the project, you created a single item that has a parent item, and you merge that single item into the As-Built, the parent item remains in the project as a fully-functional item, regardless of the value of this setting.
332
Command Buttons
Advanced Opens a dialog box where you can enable or disable preferences in the project selected from the Project list, or in the current domain. Import Imports the domain or project preferences from a .dmp file that contains previously exported preferences. Before importing preferences, you can open the .dmp file and modify preferences definitions in the file itself. Export Allows you to save the domain or project preferences to an external .dmp file.
333
334
Print Options
This dialog box allows you to print out a report. The dialog box options are as follows: Printer Allows you select a printer. Copies Allows you to enter the number of copies you want to print. Page range Determine whether the software prints the entire report or specific pages of the report. All Prints the entire document. Current page Prints the currently displayed page. Ranges Prints the pages you type in this box. For example, to print pages 2, 3, and 4, type 2-4. Print Select the portion of the report or document that you want to print. Print to file Prints your report to a file instead of to a printer. Collate copies Prints the copies of the document in proper binding order. OK Prints the page range of the report. Printer Allows you to define your default printer if needed.
Command Buttons
Print Opens a dialog box where you can send the report to a printer or a file. Save As Saves the report in a format you specify. Zoom Allows you to change the magnification of the report preview.
335
336
337
338
339
Validations
Validate mandatory fields for data entry Select to generate warning messages where the user does not enter data values in mandatory fields; clear to ignore any data that is missing in those fields.
Reports
Display AF and AL graphs in the Instrument Calibration Result report to print all pages of this report including the As Found and As Left graphs that appear on the second page of the report. Clear the check box to print only the tabular data that appears on the first page of the report.
340
341
Instrument Wiring item (panel, rack, wiring equipment, and so forth Terminal strip Cable Wire
The Claim Buffer and Merge Buffer are only accessible from the Administration module. For more information about the Claim Buffer, see the Administration module Help, Claim Buffer (on page 426) in the Administration User's Guide. For more information about the Merge Buffer, see the Administration module Help, Merge Buffer (on page 428) in the Administration User's Guide. Preferences that you set do not affect preferences the Project Administrator defines on the Preferences for Scoping and Merging Data dialog box of the Administration module.
342
343
Windows and Dialog Boxes When merging items, leave parent items in project as
Specifies the way the software handles parent items when you merge items created in a project back to the As-Built. Dummy items When the Project Administrator merges back to the As-Built items that were created in the project, and this option is selected, the software removes the merged items from the project and leaves the parent items in the project as dummy items. For example, when merging a terminal strip, the terminal strip is removed from the project and the parent panel remains in the project as a dummy panel. However, if after merging the terminal strip, the panel has no other sub-items in the project, the software also removes the panel. Fully-functional items When the Project Administrator merges back to the As-Built items that were created in the project, and this option is selected, the software removes the merged items from the project and leaves the parent items in the project as fully-functional items. If, in the project, you created a single item that has a parent item, and you merge that single item into the As-Built, the parent item remains in the project as a fully-functional item, regardless of the value of this setting. Copy revision data Includes revision data of the documents associated with items that you claim. Reclaim items Allows you to claim the same items again. When an item exists in a project, reclaiming the item results in an automatic update of the project item properties, connections and associations. If you deleted an item, this item reappears in the project after reclaiming.
344
Revision options
When removing specifications, delete associated specification binder revisions When you remove a specification from a Specification Binder package, select this check box to specify deletion of Specification Binder package revisions. Clear the check box to keep the revisions when you remove the specification. View specification and specification binder revisions independently Select to view separate listings for revisions of a specification when it was independent and when it was part of a Specification Binder package. This means that in the Document Binder module, a specification displays only revisions created since you added it to the Specification Binder package, and in the Specifications module, the specification displays only revisions created before you added it to the Specification Binder package. Clear to view a unified revision listing. This means than in either module, when you open a given specification, it displays all revisions that you created for that specification.
345
Display options
Use these options to display a tag list and an associated item list on your hook-ups drawing. Tag list Select this check box to display the tag list on your hook-ups drawing. Clear the check box not to show the tag list. Associated item list Select this check box to display the associated item list on your hook-up drawing. Clear the check box not to show the associated item list.
Format
Item Allows you to select the type of wiring item for which the formatting definitions apply, for example, cable, cable set, wire, jumper. Reset Resets the formatting definitions to their default values for the selected item. Style Allows you to specify the line style for the connector representation. The box beside this list indicates the visual appearance of the style that you select. You should not change the default style used for jumpers; if you do so, the software will not display the jumpers. Color Displays the current color that the software uses for the connector representation. To change the connector color, click the ellipsis to open the Color dialog box. Units Select the units to specify for the connector width: inches, millimeters, or twips. Width Specifies the connector width in the selected units. If you are working with commas (,) instead of a period (.) as a decimal separator, for example in a German environment, you must make sure that the Width of every item in the Item list, of every category in the Enhanced Reports preferences, is set to 0.1 or lower. To do this select the Item Type from the Item List and then change the width in the Width field. You can also click Reset (not Reset All). to change the width to 0.005 for the selected Item. Failure to reset the connector width causes the generated drawing to appear distorted and impossible to read.
346
Generation method
Select the default generation method to use when you do not specify a generation method on the Generate Loop Drawings dialog box for a particular loop. By Loop Displays items such as strips that are common to a number of signals once only on the drawing. By Signal Displays each signal path separately on the drawing so that common items such as strips appear repeatedly; once in each signal representation. Custom by Loop Displays Enhanced SmartLoop or Fieldbus Loop reports using custom symbols that you define for each item and allows you to specify the placement of the symbols on the drawing sheet by displaying the Domain Explorer in the Enhanced Report Utility and dragging items from it onto the drawing sheet. Custom by Signal Displays Enhanced SmartLoop or Fieldbus Loop reports using custom symbols and showing separate signal paths. Display each signal on separate page (available for By Signal and Custom by Signal options only) Select to display each signal path on a separate drawing sheet. Group by location (available for By Signal and Custom by Signal options only) Select to organize panels or strips that belong to the same location in the same column of the drawing, if possible. Drawing area parameters When you select the Custom by Loop or Custom by Signal generation method for a particular loop, the drawing area parameters allow you to specify the optimum spacing between separate graphical elements on the drawing sheet. The optimum spacing can vary according to the sizes of the symbols that you use. Units Select the units to specify for the spacing values: inches, millimeters, or twips. Row spacing Type a value to specify the spacing between rows on the drawing sheet. Column spacing Type a value to specify the spacing between columns on the drawing sheet. Reset Resets the drawing area parameters with default values of 0.79 inches and 1.77 inches for row and column spacing respectively.
347
Title block for default layout Allows you to select the .sym file that you want to use as the default title block in the template. Type the path and file name in the box or click Browse to navigate to the file. For example: C:\SmartPlant\Instrumentation\RAD\Templates\Types\Loop\ Loop_Wide.sym Logo file Allows you to select the .sym file that you want to use as the logo in the default title block. This logo does not appear on enhanced reports automatically. You need to perform a procedure in the Enhanced Report Utility to save the logo as part of the default layout. Type the path and file name in the box or click Browse to navigate to the file. Viewer output folder Allows you to enter the path and folder to which the Enhanced Report Utility prints PDF's when using the SmartPlant PDF 4.51 Converter. If no path is entered then SmartPlant PDF Converter 4.51 publishes PDF's to the Temp folder.
348
349
General
Show generation status window Select to show the generation status window when generating enhanced reports. Note that the items that appear in the window do not reflect the actual items that in the reports after generation. Display warning message when closing document Select to display a warning message in the Enhanced Report Utility whenever you close a report. Clear this option if you do not want to receive a warning message every time you close a report.
View
View-only mode Select to open the report in view-only mode. Clear to allow editing of the report, redlining, saving, and so forth. Display color property of cross wires (regular mode only) Select to display labels indicating the colors of cross wires where defined. Clear to hide the color labels. Sort wires by wire sequence in set (regular mode only) Select to sort wires according to the sequence number in the cable set. Clear to sort wires according to the wire IDs. If you are not sure that the wire IDs match the actual sequence of the wires, for example, if you imported cable data or added wires manually, it is recommended that you select this option. Split strip display between sheets Select to display strips in a split manner between two sheets where those strips would otherwise appear on the margin of one of the drawing sheets. Works with Panel-strip, panel signal, and panel strip signal reports only. Enlarge terminals with multiple connections (regular mode only) Select to enlarge terminals with multiple connections so that you can view all the multiple connections separately. When a terminal has several connections, the software duplicates this terminal as many times as there are connections and displays this terminal as one item that contains several terminals attached underneath each other. Replace missing symbols with default terminal symbol Select to replace all terminal symbols that the software cannot find with the default terminal symbol term.sym. Clear this check box to display the text Symbol is missing for all terminal symbols that the software cannot find.
Drawing
Disable macro generation and annotation options Select to disable macro generation in enhanced reports and also to disable macros, SmartText and redlining. Disabling these options speeds up report generation. This option does not disable the default macros, they still appear on the drawing even with this option selected. Any macros other than the default macros are disabled and do not appear on the drawing. Gap connectors on intersection Select to specify that connector lines that are crossed appear in generated enhanced reports with gaps on intersections. The connector that appears with a gap is the connector that is generated second. Clear this option to speed up report generation. By-pass strips Select to re-draw any connector lines that intersect strips so that those connector lines by-pass the strips. Clear this option to speed up report generation.
350
Layers
Shows a list of the enhanced report layers. Name Describes the use of the layer [Connector, Macro, Redline, SmartText, Symbol, Titleblock]. Value Type your own names for each layer as desired. If you leave a field value empty, the layer will not be available for selection. Any items that would be created on the unnamed layer are created on the default layer instead.
351
Revision options
Revision macro order Select the relation between the order of revisions and the order of the macros that you have set in the title block. The options are: Ascending In ascending order, macro number 1 contains the first added revision, so that the last added revision appears at the bottom of the list in the title block. Descending In descending order, macro number 1 contains the last added revision, so that the last added revision appears at the top of the list in the title block.
352
Display options
All jumpers Select to display all the jumpers between the entry and exit points of a signal on a cabinet. Clear to display one line for all the midway jumpers. When generating a loop in Custom Mode, with the terminal strip associated to a custom symbol, all jumpers are displayed on the loop drawing irrespective of the All Jumpers preference or layout properties settings. Overall shield connected to another strip (without signal) Select to display the overall shield (without signal) connected to another strip. If you clear the check box this strip is not displayed, unless it has a signal in which case it is displayed whether the check box is selected or cleared. DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag, channels, number of slots and cabinet name. Unconnected DCS / PLC terminals Select to display unconnected DCS / PLC terminals. If you clear the check box, the software replaces the terminals with a break- in-sequence symbol. Only displays those DCS/PLC terminals that have been assigned channels.
353
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of the following:
354
Display options
All jumpers Select to display all the jumpers between the entry and exit points of a signal on a cabinet. Clear to display one line for all the midway jumpers. When generating a loop in Custom Mode, with the terminal strip associated to a custom symbol, all jumpers are displayed on the loop drawing irrespective of the All Jumpers preference or layout properties settings. Overall shield connected to another strip Select to display the overall shield connected to another strip. If you clear the check box, this strip is not displayed. DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag, channels, number of slots and cabinet name. Only displays those DCS/PLC terminals that have been assigned channels. Unconnected DCS / PLC terminals Select to display unconnected DCS / PLC terminals. If you clear the check box, the software replaces the terminals with a break- in-sequence symbol. Only displays apparatus terminals per position. Unconnected Apparatus terminals Select to display unconnected Apparatus terminals. If you clear the check box, the software replaces the terminals with a break- in-sequence symbol. Panel location Select to display the panel location in its unit, on the drawing layer (for example Field, Control room, and so forth). Vertical orientation Select to display the drawing vertically. Terminal discontinuities Select to display a gaping symbol which indicates discontinuity in a sequence of terminals. A gapping symbol appears between terminal symbols wherever there is a gap in a terminal sequence. Loop drawing reference Select to display on the report a reference to an external drawing.
355
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of the following: Diagonal Represents connectors as straight diagonal lines between the short horizontal lines that come from the terminals. Orthogonal Represents connectors as lines consisting of horizontal and vertical sections. For a visual comparison of these representations, see Connector Representation Examples. Cross wiring Set the desired connector representation for cross - wiring connections. Select one of the following: Diagonal Represents connectors as straight diagonal lines between the short horizontal lines that come from the terminals. Orthogonal Represents connectors as lines consisting of horizontal and vertical sections.
356
357
358
Windows and Dialog Boxes Drawing block file name and path
Click Browse to navigate to the required file or enter the required file name as follows, depending on the CAD application installed on your machine: For Enhanced Report Utility Type the exact path of a .dwg file. For SmartSketch Type the exact path to a .sym .dwg or .dgn file. For AutoCAD Type the exact path of a .dwg file. For MicroStation Type the exact path of a cell library (.cel file). Global path Displays the global path set by the System Administrator. Use global border/logo Select this check box when you do not have your own border and logo, in order to use the Default General Blocks dialog box options to specify the border and logo for all of your hook-up drawings. Note that if you already have your own border and logo in the hook-up drawings, selecting the check box and defining the border and logo in the Default General Blocks dialog box cause the software to display two borders and two logos in the same hookup drawing. Clear this check box to insert the border and logo using your CAD application. This check box is only available after selecting Enable hook- up drawing generation. Use macro symbol (&) to retrieve data For SmartSketch If you use SmartSketch, you must select this check box because in SmartSketch all macros have the & prefix. If you clear the check box, the software displays only macro properties in the drawings. For AutoCAD Select this check box if you manually added the & prefix to the macros. Note that in this case, macros that do not have the & prefix do not retrieve any data in AutoCAD drawings but are displayed only as macro properties. Revision macro order Select the relation between the order of revisions and the order of the macros that you have set in the title block. Ascending In ascending order, macro number 1 contains the first added revision, so that the last added revision appears at the bottom of the list in the title block. Descending In descending order, macro number 1 contains the last added revision, so that the last added revision appears at the top of the list in the title block. Tag association Selects the allowed assignments of tags to hook-ups. Limit to a single hook-up Restricts the assignment of each tag number to one particular hook-up only. Limit to a single hook-up type Restricts the assignment of each tag number to one hook-up type only. Do not limit Allows you to assign each tag to any hook-up without restriction.
359
Bill of Material
Hide item number row when total quantity is zero Allows you not to include in BOM the item number whose quantity is zero. Enable the use of edit mode Allows you to select the Edit mode check box in a BOM print preview.
360
361
362
363
364
Tag number
Display old tag number automatically Enables automatic display of the old tag number in the Old tag number field of the Tag Number Properties dialog box. Clear the check box to leave the Old tag number field empty.
Loop number
Display old loop number automatically Enables automatic display of the old loop number in the Old loop number field of the Loop Number Properties dialog box. Clear the check box to leave the Old loop number field empty. Apply loop number segment and suffix changes to tags Enables you to apply new loop segments to tags associated with this loop. After you change loop segments in the Rename Loop Number dialog box, you can view both the old and the new list of tag numbers for tags associated with this loop. Then, you can select those tags whose segments will be changed automatically according to the loop segments. Rename drawing file name when renaming the loop Allows you to rename the associated CAD drawing file names when renaming loop numbers. After you rename a loop number, the software opens the Rename Loop Drawing File dialog box, where you can change the drawing file names.
Propagate options
Propagate P&ID drawing when assigning tags to lines After selecting this option, on the Tag Number Properties dialog box, the software automatically displays the P&ID drawing reference that is associated with the line for the current tag number. Propagate line pipe spec when assigning tags to lines After selecting this option, if a line has been assigned to the current tag number on the Tag Number Properties dialog box, the software automatically displays the line pipe spec for that line in the Index Browser view.
365
366
367
368
369
Display options
DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag, channels, number of slots and cabinet name. Panel location Select to display the panel location in its unit, on the drawing layer (for example Field, Control room, and so forth). Terminal discontinuities Select to display a gaping symbol which indicates discontinuity in a sequence of terminals. A gaping symbol appears between terminal symbols wherever there is a gap in a terminal sequence. Channel items Select to display channels with the channel names at the appropriate positions on the strip.
370
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of the following: Diagonal Represents connectors as straight diagonal lines between the short horizontal lines that come from the terminals. Orthogonal Represents connectors as lines consisting of horizontal and vertical sections. For a visual comparison of these representations, see Connector Representation Examples. Cross wiring Set the desired connector representation for cross- wiring connections. Select one of the following: Diagonal Represents connectors as straight diagonal lines between the short horizontal lines that come from the terminals. Orthogonal Represents connectors as lines consisting of horizontal and vertical sections. When generating an enhanced report with many connectors, where the layout settings for the connectors are set to diagonal, the connector names do not appear directly over their respective connectors.
Display options
All jumpers Select to display all the jumpers between the entry and exit points of a signal on a cabinet. Clear to display one line for all the midway jumpers. When generating a loop in Custom Mode, with the terminal strip associated to a custom symbol, all jumpers are displayed on the loop drawing irrespective of the All Jumpers preference or layout properties settings. Overall shield connected to another strip Select to display the overall shield connected to another strip. If you clear the check box, this strip is not displayed. DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag, channels, number of slots and cabinet name. Unconnected DCS / PLC terminals Select to display unconnected DCS / PLC terminals. If you clear the check box, the software replaces the terminals with a break- in-sequence symbol. Only displays those DCS/PLC terminals that have been assigned channels. Unconnected Apparatus terminals Select to display unconnected Apparatus terminals. If you clear the check box, the software replaces the terminals with a break- in-sequence symbol.
371
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of the following: Diagonal Represents connectors as straight diagonal lines between the short horizontal lines that come from the terminals. Orthogonal Represents connectors as lines consisting of horizontal and vertical sections. For a visual comparison of these representations, see Connector Representation Examples. Cross wiring Set the desired connector representation for cross-wiring connections. Select one of the following: Diagonal Represents connectors as straight diagonal lines between the short horizontal lines that come from the terminals. Orthogonal Represents connectors as lines consisting of horizontal and vertical sections. When generating an enhanced report with many connectors, where the layout settings for the connectors are set to diagonal, the connector names do not appear directly over their respective connectors.
372
Display options
All jumpers Select to display all the jumpers between the entry and exit points of a signal on a cabinet. Clear to display one line for all the midway jumpers. When generating a loop in Custom Mode, with the terminal strip associated to a custom symbol, all jumpers are displayed on the loop drawing irrespective of the All Jumpers preference or layout properties settings. Overall shield connected to another strip Select to display the overall shield connected to another strip. If you clear the check box, this strip is not displayed. DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag, channels, number of slots and cabinet name. Unconnected DCS / PLC terminals Select to display unconnected DCS / PLC terminals. If you clear the check box, the software replaces the terminals with a break- in-sequence symbol. Only displays those DCS/PLC terminals that have been assigned channels. Unconnected Apparatus terminals Select to display unconnected Apparatus terminals. If you clear the check box, the software replaces the terminals with a break- in-sequence symbol. Only displays apparatus terminals per position. Panel location Select to display the panel location in its unit, on the drawing layer (for example Field, Control room, and so forth). Terminal discontinuities Select to display a gapping symbol which indicates discontinuity in a sequence of terminals. A gaping symbol appears between terminal symbols wherever there is a gap in a terminal sequence. Leftmost strip descriptions on the left Select to place all the descriptions of the leftmost strips to the left of the strips. Clear this check box to retain all the descriptions of the leftmost strips above the strips. Channel items Select to display channels with the channel names at the appropriate positions on the strip. Show one instance of each cable in drawing If a cable appears on a drawing more than once, select this option to display only one instance of the cable (all connections are still displayed). Generating a report when this option is selected, can result in the report being displayed differently each time it is generated.
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of the following: Diagonal Represents connectors as straight diagonal lines between the short horizontal lines that come from the terminals.
373
General options
Convert units of measure automatically Select this check box to automatically convert numerical data when changing the units of measure. Enable velocity auto recalculation Select this check box to automatically recalculate the velocity parameters for flow equipment. Highlight required process data properties Select this check box to automatically highlight the required fields in the Process Data window. In the Calculation module, the software also highlights the same fields in a calculation sheet.
374
Display options
All jumpers Select to display all the jumpers between the entry and exit points of a signal on a cabinet. Clear to display one line for all the midway jumpers. When generating a loop in Custom Mode, with the terminal strip associated to a custom symbol, all jumpers are displayed on the loop drawing irrespective of the All Jumpers preference or layout properties settings.
375
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of the following: Diagonal Represents connectors as straight diagonal lines between the short horizontal lines that come from the terminals. Orthogonal Represents connectors as lines consisting of horizontal and vertical sections. For a visual comparison of these representations, see Connector Representation Examples. Cross wiring Set the desired connector representation for cross-wiring connections. Select one of the following: Diagonal Represents connectors as straight diagonal lines between the short horizontal lines that come from the terminals. Orthogonal Represents connectors as lines consisting of horizontal and vertical sections. When generating an enhanced report with many connectors, where the layout settings for the connectors are set to diagonal, the connector names do not appear directly over their respective connectors.
376
Display options
All jumpers Select to display all the jumpers between the entry and exit points of a signal on a cabinet. Clear to display one line for all the midway jumpers. When generating a loop in Custom Mode, with the terminal strip associated to a custom symbol, all jumpers are displayed on the loop drawing irrespective of the All Jumpers preference or layout properties settings. DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag, channels, number of slots and cabinet name. Panel location Select to display the panel location in its unit, on the drawing layer (for example Field, Control room, and so forth). Terminal discontinuities Select to display a gaping symbol which indicates discontinuity in a sequence of terminals. A gaping symbol appears between terminal symbols wherever there is a gap in a terminal sequence. Report end point level Select to specify whether to report the end point level from Amplifier or DCS.
377
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of the following: Diagonal Represents connectors as straight diagonal lines between the short horizontal lines that come from the terminals. Orthogonal Represents connectors as lines consisting of horizontal and vertical sections. For a visual comparison of these representations, see Connector Representation Examples. Cross wiring Set the desired connector representation for cross- wiring connections. Select one of the following: Diagonal Represents connectors as straight diagonal lines between the short horizontal lines that come from the terminals. Orthogonal Represents connectors as lines consisting of horizontal and vertical sections. When generating an enhanced report with many connectors, where the layout settings for the connectors are set to diagonal, the connector names do not appear directly over their respective connectors.
378
379
PSR options
PSR working folder Click Browse to select a working folder in which to keep specification page files (in .psr format). For best performance, define a folder on your client computer. If you do not define a PSR working folder, the software keeps the files in the temporary folder path that you specify under the general preferences. The .psr files that the software generates when opening a print preview do not get saved in this folder but in the temporary folder. You specify the temporary folder path on the General page of the Preferences dialog box. Global path Displays the global path set by the System Administrator.
380
ISF export/import
Default export/import folder Click Browse to select a folder that you want to set as your default .isf file folder. The software will display this folder automatically in all dialog boxes where you need to select a folder for importing data from .isf files, or for exporting data to .isf files.
381
382
383
Windows and Dialog Boxes Moving and removing tags from multi-tag list
This option enables you specify how the software behaves when you remove a tag from a multi-tag list, or move a tag from a multi-tag to a single-tag specification. Skip individual confirmation Sets the software to skip a confirmation message each time you remove a tag from a multi-tag list, or move a tag from a multi-tag list to a single-tag specification. If you clear the check box, the software displays a confirmation message each time you remove a tag from a multi-tag list, or move a tag from a multi-tag list to a single tag specification.
Display options
All jumpers Select to display all the jumpers between the entry and exit points of a signal on a cabinet. Clear to display one line for all the midway jumpers. When generating a loop in Custom Mode, with the terminal strip associated to a custom symbol, all jumpers are displayed on the loop drawing irrespective of the All Jumpers preference or layout properties settings.
384
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of the following: Diagonal Represents connectors as straight diagonal lines between the short horizontal lines that come from the terminals. Orthogonal Represents connectors as lines consisting of horizontal and vertical sections. For a visual comparison of these representations, see Connector Representation Examples. Cross wiring Set the desired connector representation for cross- wiring connections. Select one of the following: Diagonal Represents connectors as straight diagonal lines between the short horizontal lines that come from the terminals. Orthogonal Represents connectors as lines consisting of horizontal and vertical sections. When generating an enhanced report with many connectors, where the layout settings for the connectors are set to diagonal, the connector names do not appear directly over their respective connectors.
385
Display options
Origin point Select this check box to display the origin point of any symbol that you open in the Symbol Editor. Clear the check box to hide the origin point.
386
DCS uniqueness
The following options allow you to set the required uniqueness level for a Distributed Control System (DCS): Plant Set uniqueness at the plant level. Per panel Set uniqueness at the panel level. Per terminal strip Set uniqueness at the terminal strip level. Not unique Allow use of the same Control System tag name at any level.
387
Unassigned CS tag
The following options allow you to set the required uniqueness level for Control System tag names of tags that are not assigned to I/O cards: Unique Allow the use of a CS tag name of an unassigned tag only once. Not unique Allow the use of the same CS tag name for any tag that is not assigned to an I/O card.
Display options
All jumpers Select to display all the jumpers between the entry and exit points of a signal on a cabinet. Clear to display one line for all the midway jumpers. When generating a loop in Custom Mode, with the terminal strip associated to a custom symbol, all jumpers are displayed on the loop drawing irrespective of the All Jumpers preference or layout properties settings. Overall shield connected to another strip Select to display the overall shield connected to another strip. If you clear the check box, this strip is not displayed. DCS / PLC attributes Select to display the attributes of DCS / PLC devices when placing them on the drawing layer. The displayed attributes are: whether it is connected to a CS tag, channels, number of slots and cabinet name. Only displays those DCS/PLC terminals that have been assigned channels. Only displays apparatus terminals per position.
388
Connector representation
Default layout Set the desired connector representation for the default layout. Select one of the following: Diagonal Represents connectors as straight diagonal lines between the short horizontal lines that come from the terminals. Orthogonal Represents connectors as lines consisting of horizontal and vertical sections. For a visual comparison of these representations, see Connector Representation Examples. Cross wiring Set the desired connector representation for cross- wiring connections. Select one of the following: Diagonal Represents connectors as straight diagonal lines between the short horizontal lines that come from the terminals. Orthogonal Represents connectors as lines consisting of horizontal and vertical sections. When generating an enhanced report with many connectors, where the layout settings for the connectors are set to diagonal, the connector names do not appear directly over their respective connectors.
Naming options
Enforce unique names for wiring items Select this check box to enforce the name uniqueness for wiring items. For more information, see Name and Sequence Uniqueness of Wiring Items.
Connection screen
Display terminal type name Check this option to display the terminal type name on the Connection Screen.
389
Automatic naming
Name jumpers automatically Allows you to select name jumpers automatically. Select this check box in the following cases: When making connections using connection types whose definitions contain jumpers. In this case, the software automatically names the created jumpers using the following default format: J<first terminal name>/<second terminal name>. For example, J1+/3sh. You cannot modify the default format.
390
391
R
Topics
Rebuild Catalog Tables Dialog Box ............................................... 392 Rebuild Default Views in Domains Dialog Box .............................. 393 Rebuild Projects in Domain Dialog Box ......................................... 393 Rebuild Stored Procedures and Triggers Dialog Box .................... 394 Remove Deleted Windows Users Dialog Box ............................... 394 Report Management Dialog Box.................................................... 395 Required Wiring Equipment Report Dialog Box ............................ 397 Reserve Item ID Ranges for Projects Dialog Box .......................... 398 Reserve Tags and Loops Dialog Box ............................................ 398
392
Data Window
Project Contains the list of projects in the active domain. Select projects that you want to rebuild. Project Administrator Displays the name of the Project Administrator. You assign Project Administrators with projects in the Project Activities dialog box. Plant Displays the highest plant hierarchy item assigned to the project. You assign <plants> to projects in the Project Activities dialog box.
393
394
Data Window
Report Name Displays the full name of the report available in SmartPlant Instrumentation. Module Name Displays the name of the module that includes the report. Report Type Displays the report type. The report type determines whether the revision management setting of a particular report is per document or per item. A revision management setting of all list-type reports is always per document. A revision management setting of certain non-list-type reports is set permanently as per item, while for other non-list-type reports you can define the revision management setting as either per item or per document.
List
A report that displays a list of items. Examples of such reports are supporting-table reports and browser views. If you created a report for a list of items using a browser view style, or item search parameters, the software applies a unique document number and revision to this report according to the specified browse view style or to the item search parameters. For example, in the Wiring module, in the Cable Selection for Cable Schedule Report dialog box, after creating a report for a list of cables filtered according to search parameters, the software applies the unique document number and revision only when selecting the same search parameters again.
Non-List
A report that is generated for a specific main item. Such a report displays the main item data and associations. An example of a non-list-type report is a panel-strip report, which you can generate for a specific strip. Such a report can display the main strip, two additional strips, numerous cables, and wires. In SmartPlant Instrumentation, you cannot apply global revisions to reports belonging to the list report type because for a global revision, you can only use reports generated for a specific item. Revision Management Displays the revision management setting determined by the report type. A revision management setting of all list-type reports is always per document. A revision management setting of certain non-list-type reports is set permanently as per item, while for other non-list-type reports you can define the revision management setting as either per item or per document.
395
Per Document
The document number and revision are unique to each specific document created or report generated for a particular item. For example, if you create two reports for a particular strip: a report with adjacent connections and a report without adjacent connections, the document and revision numbers of the two reports are not shared. As a result, the document number and revision added from the report print preview is different from the document number and revision added via the Revisions dialog box opened from the item Properties dialog box. Title Block Allows you to use a title block in the report. This can be a title block designed by the user, or one of the defaults supplied with SmartPlant Instrumentation. If you want to display the report without a title block, clear this check box. In this case, the macros that appear in the title block appear at the top of the report. For those reports that must contain a title block, the check box is selected by default, and you cannot clear it. Title Block Location Displays the location of the title block in the report. Title Block Customization (available when selecting the Title Block check box) Allows you to assign a custom title block to a particular report, or a default title block that is supplied with SmartPlant Instrumentation. Note that some reports do not support custom title blocks. For these reports, the value Default appears, and the option to select a custom title block from this list is disabled. For more details of the title block description, see Title Block Descriptions (on page 200). If, in the Report Name column, you selected Specification but the list of options in the Title Block Customization column is disabled, this means that the System Administrator, in the Domain Definitions window, selected the block assignment method Special (used in the Specifications module only). In this case, SmartPlant Instrumentation users can associate individual title blocks with specifications using the options available in the Specifications module itself. Save Document Data Allows you to save all revision data for all reports of the specified type when using the Changed Documents feature (accessed from the Tools menu in SmartPlant Instrumentation. If you clear the check box, the software performance is improved when creating revisions. Clearing this check box does not affect the report comparison functionality (which is controlled by the Archiving Option settings). Archiving Option Allows you to assign an archiving option to a particular report, needed if you want to enable report comparison. The following options are available: Do not save (not available for the Document Binder module reports) Sets the software not to keep a revision archive. After saving the report revision, SmartPlant Instrumentation users cannot see the information contained in that report at the time of revision, and the report comparison is not available. This is the default selection. Save to database Sets the software to keep a revision archive in the database. This way you eliminate the need for file sharing and management. Note, however, that selecting this option can slow down your work.
396
When changing an archiving option for a Document Binder module report, the software assigns the same archiving option to all the other Document Binder reports as well. This is because in the Document Binder module, you can only create revisions for the entire binder package). You can, however, apply a different custom title block to any Document Binder module report. Archive Path Allows you to define a different path for a specific report to be saved as a file, or compressed as a .zip file. You can use this option in addition to defining the default archiving path. When selecting the archiving options Save as File, or Compress as Zip file, click a path. and enter
Filter by
These following options allow you to filter reports by a specific module. Module Contains a list of SmartPlant Instrumentation modules that you can select for filtering. Apply Applies filtering.
Sort by
These following options determine the sorting order of the reports: Report Lists all the reports in alphabetical order. Module Lists the reports in alphabetical order per module.
Find
Report Allows you to find a specific report by entering a text string corresponding to the name of the desired report.
397
Command Buttons
Print Prints the report using the current settings of your printer. Save As Allows you to save the report in the format that you require.
398
Command Buttons
Apply Sets the reservations as defined. Add Adds another data row for a new range definition. Delete Deletes the current definition.
Command Buttons
Apply Sets the reservations as defined. Add Adds another data row for a new range definition. Delete Deletes the current definition.
399
S
Topics
Scope Definition Dialog Box .......................................................... 400 Search Dialog Box ......................................................................... 401 Security Options Dialog Box .......................................................... 402 Security Schema Password Encryption Dialog Box ...................... 402 Select Columns for Sorting Dialog Box ......................................... 403 Select Columns for Viewing Dialog Box ........................................ 403 Select Item Types for Comparison Dialog Box .............................. 403 Select Item Types for Reports Dialog Box ..................................... 404 Select Logo Dialog Box ................................................................. 404 Select (Copy Unit Data) Dialog Box............................................... 404 Select (Naming Conventions) Dialog Box ..................................... 405 Select Plant (for Registering) Dialog Box ...................................... 405 Select Plant (for Retrieving Documents) Dialog Box ..................... 405 Select Source Database Dialog Box ............................................. 405 Select Source for Claiming Dialog Box .......................................... 406 Set Color Dialog Box ..................................................................... 407 Source Data Connection Dialog Box ............................................. 407 System Administration Window ..................................................... 409
400
Command Buttons
Add Appends a new line in the Item properties data window. Delete Deletes a selected line in the Item properties data window. Verify Verifies the definition you made in the Item properties data window. Results Lists the items that software found. Select all Selects all the items listed in the Results data window. Add to My List Adds the selected items to the My List pane in a window. Go to Item In the tree view, selects the item you highlighted in the Results data window.
401
402
403
404
405
Source project
Domain Allows you to select a source domain from the list. Project Displays the name of the project from which you want to import data. After selecting a domain, the software displays the source project automatically provided that the database ID of the source and the target projects are identical. Import only items marked as 'Merge Now' in the satellite For a project in an Owner operator domain, imports from the selected project only those items that are marked as 'Merge Now'. Delete items from target if not found in source Select this option if you want to delete items in the target database where they do not exist in the source. Clear this check box if you do not want to delete the items from the target database. Log File Opens a dialog box where you can define the log file name and path. Click this button after connecting to the source database, and before importing data. Report Opens a dialog box where you can view the list of items in the projects of the target domain that will appear as duplicate in the target project after import. Click this button after connecting to the source database, selecting the source domain, and before importing data. Mapping This command opens the Map Plant Hierarchy Items dialog box, which allows you to map <units> in the source plant hierarchy to one or more target <units>. This option only applies where the source domain type is Engineering company. Import Starts the import process.
406
407
408
This dialog box allows you to upgrade schemas, monitor the upgrade procedure, and view the procedure log. To select a schema, select its check box.
Schema Grid
Schema name Displays the names of the available domain schemas. Status Current schema status: Requires upgrade Schema not selected for upgrade (denoted by ). Pending Schema in cue for upgrade (denoted by ). In progress The schema currently being upgraded (denoted by ). Upgraded Schema successfully upgraded (denoted by . Upgraded with errors Schema upgraded with errors (denoted by ). Upgrade failed Schema not upgraded (denoted by ). Schema type Specifies schema type: Administrator, Owner Operator or Engineering Company. RTM Displays the current version for each schema. Service pack Displays the service pack of each domain schema. Hot Fix Displays the current hot fix number (if applicable) for each domain schema. Build Displays the current build number of each domain schema. Started Displays the starting time of the upgrade session. Ended Displays the end time of the current upgrade session. Select All Selects all the check boxes to upgrade all schemas. Log Displays the upgrade log in a Notepad. When an upgrade is either finished or stopped the relevant schema log icon is highlighted. Log files are stored in:%Temp%\SpiUpgradeLog directory. Upgrade to Version Starts the upgrade process to version XXX for the selected schemas.
409
T
Topics
Tablespace List Dialog Box ........................................................... 410 New Database Definitions Dialog Box ........................................... 410 Target Database Parameters (SQL Server) Dialog Box ............... 412 Target Revisions Dialog Box ......................................................... 413 Telecom Device Panel Icons Dialog Box ....................................... 414 To Do List Dialog Box .................................................................... 415 Trim Audit Trail Data Dialog Box ................................................... 415
Administration schema
The options in this section are used to define the Admin schema name and password. For more information about the Admin schema and other SmartPlant Instrumentation database schemas, see SmartPlant Instrumentation Configuration and Maintenance Guide, SmartPlant Instrumentation Database Technical Review > Logon Data and Database Connection Security > SmartPlant Instrumentation Database Schemas. Administration schema login name Accept the default Admin schema logon name IN_DBAMN or enter another name if you need. The logon name must be unique in the Oracle server. The logon name can only start with a letter and contain no spaces. You can use an underscore ( _ ) to replace a space. Administration schema login password Accept the default Admin schema logon password IN_DBAMN or enter another password if you need. The logon password can only start with a letter and contain no spaces. You can use an underscore ( _ ) to replace a space. Estimated number of domains - Displays the number of domains.
410
Temporary Tablespaces
This box appears when the user selects the Customized or the Predefined options. Tablespace name When working in Customized mode, accept the default value or type the required Admin index tablespace name. When working in Predefined mode, use the combo box to select a desired tablespace.
411
Admin schema
The options in this section are used to define the Admin schema name and password. For more information about the Admin schema and other SmartPlant Instrumentation database schemas, see SmartPlant Instrumentation Configuration and Maintenance Guide, SmartPlant Instrumentation Database Technical Review > Logon Data and Database Connection Security > SmartPlant Instrumentation Database Schemas. Logon name Displays the default Admin schema logon name SPI_DBAMN. You can type a different name if needed. The logon name can only start with a letter and may not contain spaces. You can use an underscore ( _ ) to indicate a space. The Admin schema logon name must be different from the Admin schema logon password. If this is the first database setup session for SmartPlant Instrumentation 2009 in the current SQL Server database, the logon name must be unique in the SQL Server database server. If this is not the first database setup session, you can use an existing Admin schema logon name but in this case, you must also use the existing Admin schema logon password. You can only use an existing Admin schema logon name if the password in that Admin schema is different. For example, if in another SmartPlant Instrumentation database, the Admin schema logon name is IN_DBAMN, and the password is also IN_DBAMN, you cannot use IN_DBAMN for the Admin schema in the new SmartPlant Instrumentation database. If you want to define a new logon name, you must also define a new logon password, different from the logon name.
412
Admin data
Admin file name Accept the default value or type the required Admin file name. Datafile name and path Accept the default settings or type the required Admin datafile name and path. The default file extension is .mdf. You can change the file extension as you require. Initial size (MB) Accept the default value or type the required initial size value of the Admin datafile.
Admin index
Index file name Accept the default value or type the required Admin index file name. Datafile name and path Accept the default settings or type the required Admin index datafile name and path. The default file extension is .mdf. You can change the file extension as you require. Initial size (MB) Accept the default value or type the required initial size value of the Admin index datafile. Filegroup Accept the default filegroup to which the Admin index datafile belongs, or type the required filegroup name.
Command Buttons
OK Starts the database setup process. Cancel Closes this dialog box and discards all the values you have entered.
413
Data Window
Define your revision settings to be used in SmartPlant Instrumentation documents you create in the selected module. When in the left section of the Copy Data from Source dialog box you select a different module, and access the Target Revisions dialog box again, the data window is empty. Click a desired revision method option, and click New to add a row in the data window. No (number) Displays the revision value, depending on the revision method option you use. If your revision method is Other, type your revision value. If you did not select Other, every time you click New, the software adds a new line with the next logical value and date. If required, for methods P0, P1, P2..., 0, 1, 2..., and A, B, C..., you can change the default revision number values as well. By Type the name or initials of the person who created the revision (optional). Date Type the date of creating a revision. The default is the current date. If required, type a different date, using the format of the default date. Description Type a revision description as required.
conventional device panels, and for plug-and-socket device panels. A new icon can only appear after a SmartPlant Instrumentation user creates a telecom tag belonging to the device type to which you have assigned the icon. Telecom Device Type Displays all the telecom device types defined in the current domain. Users can manage telecom device types in the Instrument Index module. Description Displays the telecom device type description. Icon File Name and Path Displays the icon assigned to the telecom device type. You can click Browse to assign the appropriate icon. If you do not assign any icon, the software uses the default icon. You can only select icon files with the extension .ico.
414
Period
Enables you to define the user operation period for which to trim the audit trail data. The time of user operation appears in the audit trail repository. The audit trail repository contains time data (year, month, day, hour, minutes, and seconds) about each user operation performed in a particular domain. From Allows you to type the initial date (month/day/year) of the audit trail data you want to trim. To Allows you to type the last date (month/day/year) of the audit trail data you want to trim.
Miscellaneous Options
Save to file Makes the File name box accessible for typing a file name segment for the target file. If you want to remove the audit trail data permanently from the current domain, clear this check box. File name Allows you to type a file name segment that will appear as part of a complete file name in an external file where you save the audit trail data. This file will contain the entire audit trail data trimmed from the audit trail repository within the defined period. Trim Removes the audit trail data contained in the audit trail repository within the defined period.
415
U-V
Topics
Unit Properties Dialog Box ............................................................. 416 Update Statistics Dialog Box ......................................................... 418 User-Defined Database Views Dialog Box .................................... 418 User (Domain Administration) Dialog Box ..................................... 418 User (System Administration) Dialog Box ..................................... 419
416
417
418
Command Buttons
Edit Allows you to edit the profile of the user you selected from the User list. New Allows you to create a new user profile. Delete Allows you to delete the user you selected from the User list. If you enabled the use of Windows authentication logon method, it is possible to remove all Windows users from SmartPlant Instrumentation if these users have been deleted from the corresponding Windows groups.
419
SECTION
W
Topics
Wire End Naming Conventions Dialog Box ................................... 420 Wire End Naming Convention Properties Dialog Box ................... 420 Wiring Item Naming Options Dialog Box ....................................... 422
Command Buttons
Properties Opens a dialog box where you can modify properties of a naming convention that you selected in the data window. New Opens a dialog box where you can define properties for a new naming convention. Duplicate Opens a dialog box where you can duplicate a naming convention that you selected in the data window. Delete Deletes a naming convention that you select in the data window.
Segment definitions
Sample Shows a preview of the naming convention according to the definitions that you have made in the data window.
420
Data Window
Sequence Represents the position of the segment in the naming convention string. You can change the sequence using the Up and Down buttons. Separator Type or modify a separator between the segments in the naming convention string. A separator can contain up to 30 characters of any kind. Segment Select a segment from the list. A segment can be ether free or can designate properties of certain wiring items. If you select a free segment as part of a naming convention, in the Wiring module, users can type any string up to the length allocated for the free segment. Start Type or modify a number to designate the starting character in the segment from which the segment value appears in the naming convention. The default value is 1, which represents the first character in the segment. If you select the Trim Trailing Spaces check box, the software resets the value to 1 and makes it view-only. Length (not available when selecting the Trim Trailing Spaces check box) Type or modify the number of characters allocated for the selected segment string in the naming convention (starting from the position defined in the Start field). When you select a segment, the software automatically displays the maximum length that can be used for the segment. If the total length exceeds the maximum permitted value of 50 characters, the software automatically truncates the number of characters in the last segment to maintain the permitted total length or displays a message if the total length of the segment has already reached the maximum value. Trim Trailing Spaces Select if you want all or part of the naming convention string to be determined by the actual name of the item that appears in the segment that you selected. For example, if you selected the segments Panel at wire end and Strip at wire end and select the check boxes in both segment rows, the software creates wire end names as follows: If the panel name is FT 0001 and strip name is TS 1, the wire end name is FT 0001TS 1.
Command Buttons
Add Adds a new row in the data window. Delete Deletes a selected row in the data window. Up and Down Change the order of the segments in the naming convention.
421
422
Z
Topics
Zoom .............................................................................................. 423
Zoom
Enables you to select the magnification level of the print preview of a generated report. You can select a pre-set magnification level or enter the exact magnification level that you require. The magnification level does not affect the report printout. Magnification Allows you to use one of the following magnification levels: 200% 100% 65% 30% Custom Allows you to enter a desired magnification level manually. The number must be between 10 and 500. OK Displays the report print preview with the magnification that you selected.
423
424
SECTION 13
As-Built Explorer
Displays all items available in As-Built. You use the As-Built Explorer to select items for claiming for a project you selected in the Project Activities dialog box. You can either claim specific items directly from the As-Built Explorer, or copy items to the Claim Buffer first, and then, from the Claim Buffer, claim the copied items in batch mode. The As-Built Explorer displays instrumentation items according to hierarchical structure. You can arrange the hierarchical structure of the data according to item types or according to the physical location of the items. You cannot add, edit, or delete items in the As-Built Explorer. The As-Built Explorer opens and closes together with the Claim Buffer, and the Claimed Items window. You can claim items directly from the As-Built Explorer only if the Claim Buffer is empty. The main features of the As-Built Explorer are as follows.
Toolbar
Search with. Refresh Filter Opens the Search dialog box where you can look for items that you want to work Updates the display of items. Allows you to filter the display of items.
View Toggles through each view of the items in the Items pane. You can click the arrow and select the desired view. Find view. Opens the Find Item dialog box where you can look for a specific item in the tree
425
Items Pane
The Items pane displays the individual items that comprise the hierarchy of the item or the folder that you selected in the tree view. The name of the pane changes from Items to Projects, for an item selected in the tree view, when you click Claimed For. The Projects pane lists projects that already contain the item you selected. The Items pane has the following display views: List displays the individual items that comprise the hierarchy of the item or the folder that you selected in the tree view. If needed, you can claim items or copy them to the Claim Buffer directly from the List view. My List allows you to create a special view of the Items pane where you can keep items that belong to various folders in the tree view. The software retains all the items in the My List view until you remove them from that list.
Claim Buffer
You use the Claim Buffer to claim items in batch mode. The Claim Buffer contains items that you coped from the As-Built Explorer for the current project. Before copying items, the Claim Buffer only contains empty item type folders. After you copy the items, it is possible to claim all the items available in the Claim Buffer. Before claiming items, it is possible to generate a report of the items available in the Claim Buffer. When copying items to the Claim Buffer, the software applies preferences that you set in the Preferences for Scoping and Merging Data dialog box. These preferences determine how the software copies to the Claim Buffer sub-items and parent items that are associated with the items you select in the As-Built Explorer. The Claim Buffer displays items according to hierarchical structure, the way they appear in the As-Built Explorer. You can arrange the hierarchical structure of the data according to item types or according to the physical location of the items. The Claim Buffer does not show engineering data associated with instrument tags. The Claim Buffer opens and closes together with the As-Built Explorer, and the Claimed Items window. When you close the Explorer windows, the software saves the display of items in the Claim Buffer for the project you selected in the Project Activities dialog box. Items that you claim are removed from the Claim Buffer automatically. The main features of the Claim Buffer are as follows.
426
View Toggles through each view of the items in the Items pane. You can click the arrow and select the desired view. Find view. Opens the Find Item dialog box where you can look for a specific item in the tree
Items Pane
The Items pane (list view) displays the individual items that comprise the hierarchy of the item or the folder that you selected in the tree view. You cannot claim items from the list view. The Items pane has the following display views: List displays the individual items that comprise the hierarchy of the item or the folder that you selected in the tree view. My List allows you to create a special view of the Items pane where you can keep items that belong to various folders in the tree view. The software retains all the items in the My List view until you remove them from that list.
Claimed Items
Displays items that you have claimed from the current project. The displayed items are view-only. When you close the Claimed Items window, the software saves the display of items claimed during the current claim session. After you run another claim session for the same project, the software adds the claimed items to the tree view. In the Claimed Items window, the software marks items that you claimed with the indicator . You cannot delete items from the Claimed Items window.
427
Merge Buffer
You use the Merge Buffer to merge items with As-Built in batch mode. You can merge items belonging to different types, merge the associated sub-items, and the parent items, depending on the preferences you set in the Preferences for Scoping and Merging Data dialog box. Before copying items, the Merge Buffer only contains empty item type folders. Before merging data, you can generate a report of items you copied to the Merge Buffer from the Project Explorer. The Merge Buffer contains items that you coped whether directly from a project opened in SmartPlant Instrumentation or from the project you selected on the Project Activities dialog box. When copying items to the Merge Buffer, you specify a merge action for all or selected items; the software applies the merge action to the items and also applies the preferences options that you have set. Several merge actions are available for each item. You can either change a merge action for a specific item or for all items and sub-items in batch mode, regardless of the item type. After you copy the items, it is possible to merge all the items available in the Merge Buffer. The Merge Buffer displays items according to hierarchical structure, the way they appear in the Project Explorer. You can arrange the hierarchical structure of the data according to item types or according to the physical location of the items. The Merge Buffer does not show engineering data associated with instrument tags. The Merge Buffer opens and closes together with the Project Explorer. When you close the Explorer windows, the software saves the display of items in the Merge Buffer for the project you selected in the Project Activities dialog box. Items that you merge are removed from the Merge Buffer automatically. The main features of the Merge Buffer are as follows.
Toolbar
Search with. Refresh Filter Opens the Search dialog box where you can look for items that you want to work Updates the display of items. Allows you to filter the display of items.
View Toggles through each view of the items in the Items pane. You can click the arrow and select the desired view. Find view. Opens the Find Item dialog box where you can look for a specific item in the tree
428
Items Pane
The Items pane (list view) displays the individual items that comprise the hierarchy of the item or the folder that you selected in the tree view. You cannot merge items from the list view. The Items pane has the following display views: List displays the individual items that comprise the hierarchy of the item or the folder that you selected in the tree view. My List allows you to create a special view of the Items pane where you can keep items that belong to various folders in the tree view. The software retains all the items in the My List view until you remove them from that list.
Project Explorer
Displays all items available in the project you selected in the Project Activities dialog box. Also, the Project Explorer displays items that have been deleted from the current project but appear in As-Built. You use the Project Explorer to define items for merging with As-Built, and to assign merge actions to these items. You can either merge specific items directly from the Project Explorer, or copy items to the Merge Buffer first, and then, from the Merge Buffer, merge the copied items in batch mode. The Project Explorer displays instrumentation items according to hierarchical structure. You can arrange the hierarchical structure of the data according to item types or according to the physical location of the items. You cannot add, edit, or delete items in the Project Explorer. The Project Explorer opens and closes together with the Merge Buffer. You can merge items directly from the Project Explorer only if the Merge Buffer is empty. The main features of the Project Explorer are as follows.
Toolbar
Search with. Refresh Filter Opens the Search dialog box where you can look for items that you want to work Updates the display of items. Allows you to filter the display of items.
429
Items Pane
The Items pane displays the individual items that comprise the hierarchy of the item or the folder that you selected in the tree view. The Items pane has the following display views: List displays the individual items that comprise the hierarchy of the item or the folder that you selected in the tree view. If needed, you can merge items or copy them to the Merge Buffer directly from the List view. My List allows you to create a special view of the Items pane where you can keep items that belong to various folders in the tree view. The software retains all the items in the My List view until you remove them from that list.
430
Toolbar
Search with. Refresh Filter Opens the Search dialog box where you can look for items that you want to work Updates the display of items. Allows you to filter the display of items.
View Toggles through each view of the items in the Items pane. You can click the arrow and select the desired view. Find view. Opens the Find Item dialog box where you can look for a specific item in the tree
Items Pane
The Items pane displays the individual items that comprise the hierarchy of the item or the folder that you selected in the tree view. The name of the pane changes from Items to Projects when you click Claimed For, for an item selected in the tree view. The Projects pane lists projects that already contain the item you selected. The Items pane has the following display views: List displays the individual items that comprise the hierarchy of the item or the folder that you selected in the tree view. If needed, you can claim items or copy them to the Target Project Buffer directly from the List view. My List allows you to create a special view of the Items pane where you can keep items that belong to various folders in the tree view. The software retains all the items in the My List view until you remove them from that list.
431
Toolbar
Search with. Refresh Filter Opens the Search dialog box where you can look for items that you want to work Updates the display of items. Allows you to filter the display of items.
View Toggles through each view of the items in the Items pane. You can click the arrow and select the desired view. Find view. Opens the Find Item dialog box where you can look for a specific item in the tree
432
Items Pane
The Items pane (list view) displays the individual items that comprise the hierarchy of the item or the folder that you selected in the tree view. You cannot claim items from the list view. The Items pane has the following display views: List displays the individual items that comprise the hierarchy of the item or the folder that you selected in the tree view. My List allows you to create a special view of the Items pane where you can keep items that belong to various folders in the tree view. The software retains all the items in the My List view until you remove them from that list.
Item Indicators
The software uses the following icons to indicate the status of various folders and items in your project. The icons appear beside the folders and items in the tree view of an Explorer window. Icon Description An item that belongs to the current project. An item that belongs to As-Built. A dummy item. An item that does not belong to the current project or As-Built. Also, an item that belongs to As-Built and all the projects, for example, a hook-up type. Access denied. View only. An As-Built item that has been claimed for a project.
433
Example 2:
Example 3:
Example 4:
Example 5:
434
435
436
SECTION 14
Glossary
Select the letter that the term starts with, then select the term. ABCDEFGHIJKLMNOPQRSTUVWXYZ A Admin schema Administrator (Domain) Administrator (System) area As-Built audit trail repository automatic block assignment method B backup repository C cable block diagram cable type dependency case claiming items conventional tag numbers custom fields custom table customized title block D default plant document item document number document numbers (default) domain domain administration Domain Administrator Domain schema dummy item E engineering company electrical tag exclusive claim mode F fully-functional item
437
Glossary
G global path global revision I item item registry L link group list-type report M manual block assignment method N non-exclusive claim mode non-list-type report O owner operator P password plant PowerBuilder units Project Administrator R report title block revision (global) revision management per document revision management per item S specification title block supporting table system administration System Administrator T title block typical loop typical tag U unit V View-Only Domain schema virtual tag W wildcard Windows authentication logon method wire end naming convention workflow
438
Glossary
439
Index
A
access rights 72, 73, 74, 124, 182, 183, 184, 192, 193, 194, 195, 216 all items 193 assigning users to groups 73 common tasks 72, 183 copying 195 creating a group 73 deleting groups 73 descriptions 184 editing a group 73 overview 182 project administrators 124 removing users from groups 74 report 195, 216 specific items 192 viewing items on levels 195 workflow 194 accounting 112, 114 adding 112 associating with a domain 114 common tasks 112 deleting 112 editing 112 activity tracking 84, 85, 86 clearing data 85 common tasks 84 graph-style activity report 86 grid-style activity report 85 setting 84 add-ins exporting macros 207 importing browser views 206 importing DDP Library data for PDS 207 importing hook-up libraries 204 importing macros 208 importing system interfaces 205 overview 204 Admin schema 90 logon password encryption 90 Administration module overview 13 apostrophe in custom fields 214 As-Built 123, 125, 128, 130, 133, 134, 135, 142, 143, 147, 149, 150, 152, 153, 154, 155, 156, 157, 158, 161, 164, 166, 167, 168, 169, 170, 171 actions for merging items 168 claiming common tasks 147 claiming documents 156 claiming from As-Built Explorer 154 claiming from buffer 153 claiming from command line 154 common tasks 125 comparing with project data 166 deleting project data 135 deleting projects 134 displaying items 149 displaying items for merging 158 item comparison options 167 items in Claim Buffer 152 making definitions 128 merging data common tasks 164 merging data overview 157 merging items from command line 171 merging items from Merge Buffer 170 merging items from Project Explorer 170 overview 123 preferences for claiming 150 preferences for merging 166 prerequisites for claiming documents 155 project deletion common tasks 134 rebuilding projects 133 reports of changed documents 161 reports of changed items 161 reserving tags and loops 130 scoping data overview 142 setting merge actions 169 settings and conditions for claiming 143 audit trail data 36, 82, 219, 220, 221, 222, 223 activating 82 backing up 36 common tasks 219 defining paths (MS SQL Server) 222 defining paths (Oracle) 222 defining paths (Sybase Adaptive Server Anywhere) 223 external files 221 loading 220 overview 219 trimming 221
B
backing up a domain 31, 32, 33, 34, 36, 37, 38, 39, 40
441
Index
audit trail data 36 common tasks 32 domain backup procedure 32, 37, 38, 40 from the command line 33 in Windows Vista 36 overview 31, 37, 38, 39 via Citrix 34 browsers 206, 214 defining custom fields 214 importing browser views 206 showing projects with claimed items 156 clients 112, 114 adding 114 associating with a domain 114 common tasks 112 deleting 114 editing 114 colors of displayed items 129 command line 33, 56, 154, 171 claiming items for project 154 domain backup 33 domain initialization 56 merging items 171 comparison list report generation 160 connection to database 115 list of connections 115 contractors 112, 113, 114 adding 113 associating with a domain 114 deleting 113 editing 113 conventions 105 KKS 105 copying items 158 copying items for merging 162, 163 copying all as Merge Now 162 copying all as Release Claim 163 copying as Merge Now 163 copying as Release Claim 163 selection for merging 158 custom 44 custom fields 212, 213, 214 apostrophe in browsers 214 browsers 214 copying 213 defining 212 item types 214 length 212 plant hierarchy fields 212 process data sequence numbers 213 custom tables 216 defining 216 custom title blocks 200 associating with specs 200 database views 44 description 200 PowerBuilder units 200
C
cable block diagrams 156 cable type dependency 81 cables 81, 139, 156, 433 claiming cable block diagrams 156 enabling cable type dependency 81 filtering 139 hierarchy in explorer windows 433 catalog tables 98, 392 INtools.ini settings 392 rebuilding 98 character set for Oracle 41, 49 database character set 49 initialization prerequisites 41 national character set 49 Citrix 34 domain backup 34 claim mode 79, 142, 143 defining 79 exclusive 142 non-exclusive 142 settings and conditions for claiming 143 claiming 79, 142, 147, 150, 151, 152, 153, 154, 155, 156 claim modes 142 claiming common tasks 147 copying items to Claim Buffer 151 copying items to Target Project Buffer 152 documents 156 exclusing claim mode 79 fieldbus tags 142 from another project 154 from As-Built 154 from buffer 153 from command line 154 items claimed for multuple projects 156 items in buffer 152 preferences 150 prerequisites for claiming documents 155
D
data comparison 160, 166, 167 comparing project data with As-Built 166
442
Index
comparison list reports for merging 160 item comparison options 167 data copying options 226, 227, 228, 229, 230, 232 all module data 230 CAD drawing blocks 230 common tasks 228 flow of activities 227 overview 226 restrictions 226 revisions 232 setting wiring naming options 232 source unit selection 228 specific data 229 database 49, 87, 92, 93, 94, 97, 98, 99, 100, 101, 102, 103, 109, 115, 223, 224, 225 database setup 15, 16, 17, 23, 25, 26, 27, 28, 30 common tasks 27 common tasks in Oracle 17 for Oracle 15 for SQL Server 25 Oracle database clean up 23 Oracle tablespaces 16 prerequisite for rerunning on Oracle 23 prerequisite for rerunning on SQL Server 30 running for SQL server 28 SQL Server 2005 password security 28 SQL Server database clean up 30 SQL Server filegroups 26 database views 44, 96 adding for initialization 44 clearing locking common tasks 224 clearing locking in all sessions 225 clearing locking on Oracle 225 clearing locking overview 223 clearing locking per user 225 clearing session records 225 defining for logging on 94 general maintenance 93 list of database connections 115 locking mode 92 maintenance on Oracle 101 maintenance on SQL Server 99 maintenance overview 93 optimizing indexes on Oracle 102 optimizing indexes on SQL Server 101 printing filegroup information 100 rebuilding 96 rebuilding catalog tables 98 rebuilding stored procedures and triggers 97 security 87 setting locking mode 93 supported character set 49 updating Oracle statistics 103 viewing Oracle tablespaces 102 datafiles 100, 102 adding filegroups 100 adding log file for SQL Server 100 adding to tablespaces 102 adding to TEMPDB for SQL Server 100 dbeng10.exe 31 DCS hardware I/O data 206 Foxboro - I/A FBMs 206 DDP Library data for PDS 207 importing 207 default 96, 200 rebuilding default views 96 title block descriptions 200 departments 69, 70 assigning users 70 creating 69 deleting 69 departments and users common tasks 69 editing 69 dialog boxes 261, 262, 263, 264, 265, 266, 267, 268, 269, 270, 271, 272, 273, 274, 275, 276, 277, 278, 279, 280, 282, 283, 284, 285, 286, 287, 288, 289, 290, 299, 300, 301, 303, 304, 305, 306, 308, 309, 310, 311, 313, 314, 315, 316, 317, 320, 321, 322, 323, 324, 326, 328, 332, 333, 335, 336, 392, 393, 394, 395, 397, 398, 399, 400, 401, 402, 403, 404, 405, 406, 407, 410, 412, 413, 414, 415, 416, 418, 419, 420, 422, 423 Accounting 261 Activity Tracking Report Settings (Graph) 262 Activity Tracking Report Settings (Grid) 263 Add Accounting 263 Add Client 263 Add Contractor 264 Add Database Views 264 Add Datafiles (Oracle) 265 Add Datafiles (SQL Server) 264 Admin Schema Password Encryption 273 Advanced Domain Preferences 265 Advanced Filter Definition (Cables) 266
443
Index
Advanced Filter Definition (Loops) 267 Advanced Project Preferences 268 Area Properties 269 Assign Groups to Project 270 Assign Users to Groups 270 Back Up Domain 271, 300 Backup Repository 272 Change Password 274 Clear Activity Tracking Data 275 Clear Locking in Selected Sessions 275 Client 276 Colors 276 Comparison List 277 Comparison List Filter 278 Comparison List Report 279 Connected Users 261 Contractor 279 Copy Access Rights 283 Copy Data from Source 279 Copy Data from Source (Left Section) 280 Copy Data from Source (Lower-Right Section) 282 Copy Data from Source (Upper-Right Section) 280 Copy From 284 Copy from Project 284 Copy Naming Conventions 285 Copy Naming Conventions From 285 Copy to Projects 285 Custom Fields 286 Custom Tables 287 Customize Toolbar 287 Data Files to Delete Manually 288 Delete Invalid Domain 288 Delete Projects 289 Department 289 Domain Data and Indexes 290 Domain Tablespace Definition 299 Export Macros 300 Field Personnel Profile 301 Filegroup List 301 Filter Definition 301 Find Item 303 Generate Access Rights Report 303 Global Access Rights 304 Group 305 Import Browser Views 306 Import DCS Hardware I/O Library 308 Import DDP Library Data for PDS 308 Import Hook-Up Library 308 Import Interface Language 309 Import Macros 309 Import System Interfaces 309 Initialize (Oracle) 310 Initialize (SQL Server) 311 Initialize (Sybase Adaptive Server Anywhere) 313 Items and Activities for Access Rights 314 List of Duplicate Items 315 Load Audit Trail Data 315 Log File 316 Microsoft SQL Server Connection 316 Naming Conventions 317 Open Administration Module 320 Optimize Indexes (Oracle) 320 Optimize Indexes (SQL Server) 320 Oracle Server Connection 321 Owner 322 Page Setup 322 Panel Location Levels 323 Plant Hierarchy 324 Plant Properties 326 Preferences for Scoping and Merging Data 328 Preferences Management 332 Preferences Management (General) 333 Print Options 335 Print Preview 335 Project Activities 336 Rebuild Catalog Tables 392 Rebuild Default Views in Domains 393 Rebuild Projects in Domain 393 Remove Deleted Windows Users 394 Report Management 395 Required Wiring Equipment Report 397 Reserve Project Loop Numbers 399 Reserve Project Tag Numbers 399 Reserve Tags and Loops for As-Built 398 Reserve Tags and Loops for Project 398 Scope Definition 400 Search 401 Security Options 402 Select 404, 405 Select Columns for Sorting 403 Select Columns for Viewing 403 Select Item Types for Comparison 403 Select Item Types for Reports 404 Select Logo 404 Select Source Database 405 Select Source for Claiming 406 Set Color 407
444
Index
Source Data Connection 407 Tablespace List 410 Target Database Parameters (Oracle) 410 Target Database Parameters (SQL Server) 412 Target Unit Revisions 413 Telecom Device Panel Icons 414 To Do List 415 Trim Audit Trail Data 415 Unit Properties 416 Update Statistics 418 User (Domain Administration) 418 User (System Administration) 419 User-Definied Database Views 418 Wire End Naming Convention Properties 420 Wire End Naming Conventions 420 Wiring Item Naming Options 422 Zoom 423 disconnecting users 225 documents 155, 156, 161, 174, 177 claiming cable block diagrams 156 default document numbers 177 document number naming conventions 177 prerequisites for claiming 155 reports of changed documents 161 spaces in file names 174 Domain Administration access rights 182 access rights common tasks 72, 183 accessing Administration module 67 activities 117 add-ins overview 204 assigning a Domain Administrator 71 audit trail data common tasks 219 audit trail data overview 219 common tasks 117 copying data common tasks 228 copying data overview 226 logging on 68 managing preferences common tasks 196 managing reports common tasks 199 miscellaneous common tasks 209 naming conventions - common tasks 173 overview 117 plant design 119 preferences management overview 196 report management overview 199 selecting logo 217 switching from system administration 68 switching to system administration 68 wire end naming conventions 179 wire end naming conventions - common tasks 180 domain deletion 59, 60, 61 common tasks 59 deleting invalid domain on Oracle 61 deleting invalid domain on SQL Server 61 on Oracle 60 on SQL Server 60 on Sybase Adaptive Server Anywhere 60 domains 31, 32, 33, 34, 36, 37, 38, 39, 40, 41, 43, 44, 46, 47, 49, 51, 53, 56, 60, 63, 65, 66, 71, 78, 80, 82, 84, 96, 97, 98, 101, 197, 198, 199 activity tracking common tasks 84 assigning a Domain Administrator 71 backup 37, 38, 40 backup common tasks 32 backup from the command line 33 backup procedure 32 backup via Citrix 34 defining 80 defining domain common tasks 78 deleting 60 domain backup overview 31, 37, 38, 39 empty domain initialization in a .db file 44 empty domain initialization in Oracle 47 empty domain initialization in SQL Server 51 enabling workflow 82 exporting preferences 198 importing preferences 199 initialization common tasks 43 initialization from the command line 56 initialization in a .db file from a source 46 initialization in Oracle from a source 49 initialization in SQL Server from a source 53 initialization log files 56 initialization overview 40 initialization prerequisites 41 numeric character settings for Oracle 65 optimizing indexes on SQL Server 101 rebuilding catalog tables 98 rebuilding default views 96 rebuilding stored procedures and triggers 97
445
Index
setting domain preferences 197 workaround for backing up in Vista 36 workaround for Grant to view Creation Error 66 workaround for initialization in Vista 63 files 174 removing spaces 174 filtering 139, 141 filtering items 138 cables 139 cross cables 139 loops according to blocks 141 Foxboro - I/A FBMs 206
E
encryption 90, 92 Admin schema logon password 90 all user passwords 92 examples 110, 177, 433, 434, 435 cable hierarchy 433 document number naming conventions 177 loop KKS naming convention 110 panels by category 434 panels by location 435 exclusive claim mode 79 disabling 79 enabling 79 explorer windows 135, 136, 137, 138, 142, 425, 426, 427, 428, 429, 430, 432, 433 As-Built Explorer 425 Claim Buffer 426 Claimed Items 427 common tasks 136 descriptions 135 filtering items 138 finding a specific item 138 finding multiple items 137 item status indication icons 433 Merge Buffer 428 overview 135 Project Explorer 429 Source Project Explorer 430 Target Project Buffer 432 using in owner operator domain 135 using My List 142 exporting 198 exporting project data preferences 198
G
global path 83 specifying 83 glossary 437 Administration module 437 Grant to view Creation Error 66 groups 71, 73, 74, 75 assigning users 73 creating 73 deleting 73 editing 73 for Windows authentication 75 overview 71 removing deleted Windows users 75 removing users 74 SmartPlant Instrumentation groups 74 Windows global groups 74
H
hierarchy 119 hierarchy levels 120, 123 creating 120 deleting 120 deleting items 123 designing plant hierarchy 119 history 219 hook-up libraries 204 importing 204
I
icons 211, 433 assigning to telecom device types 211 descriptions of item indicators 433 in explorer windows 433 IDEAL user 70 importing 199, 204, 205, 206, 207, 208, 254 browser views 206 DCS hardware I/O library data 206 DDP Library data for PDS 207 Foxboro - I/A FBMs 206 hook-up libraries 204
F
field personnel 218 defining 218 fieldbus tags 142, 157 claiming 142 merging with As-Built 157 filegroups 26, 100 adding 100 filegroup descriptions 26 printing filegroup information 100
446
Index
interface language 254 macros 208 preferences 199 system interfaces 205 indicators of items 433 initialization 40, 43, 44, 46, 47, 49, 51, 53, 56, 63 initialization prerequisites 41 for Oracle 41 for SQL Server 41 for Sybase Adaptive Server Anywhere 41 for Windows Vista 41 language environments 41 NLS_NUMERIC_CHARACTERS 41 supported character set 41 initialization troubleshooting 62, 63, 65, 66 common tasks 43, 62 empty domain initialization in a .db file 44 empty domain initialization in Oracle 47 empty domain initialization in SQL Server 51 from the command line 56 Grant to view Creation Error 66 handling an initialization failure 63 in .db file from a source 46 in Oracle from a source 49 in SQL Server from a source 53 log files 56 ORA-01722 error 65 overview 40 restarting 63 restarting initialization 63 resuming 63 resuming initialization 63 user-defined database views 44 Windows Vista 63 InitLog.txt 56 integration 133, 134, 157, 235, 236, 237, 239, 240, 241, 243 common tasks 236 configuring 237 configuring SmartPlant Instrumentation 236 define IDEAL user 240 deleting projects 134 forbidden actions for projects 157 item registry overview 239 overview 235 project deletion common tasks 134 registering plants 241 requirements 243 setting project status 133 settings definitions 243 interface language 253, 254, 255, 256, 257 common tasks 254 importing 254 overview 253 prefixes and suffixes 257 replacing from database 255 replacing from file 255 translating interface text phrases 256 intools.ini file 94 [DATABASE] section 94 [PROFILES] section 94 DBMS parameter requirement 94 defining databases 94 INtools_Backup.db 31, 36, 37, 38, 39, 41 backing up a domain 31 connection problem in Windows Vista 36 prerequisites for working in backed up domain 41 INTOOLS_ENGINEER role 15, 25, 40 database setup for Oracle 15 database setup for SQL Server 25 domain initialization 40 INtoolStorage 222, 223 Oracle 222 SQL Server 222 Sybase Adaptive Server Anywhere 223 item display colors 129 item registry 83, 239, 240 cleaning up 240 enabling 83 overview 239 registration procedure 240 items 129, 130, 138, 149, 150, 151, 152, 153, 158, 160, 162, 163, 164, 166, 167, 168, 169, 184, 195, 433 access rights descriptions 184 comparison list reports for merging 160 comparison options 167 copying all as Merge Now 162 copying all as Release Claim 163 copying as Merge Now 163 copying as Release Claim 163 copying display format 130 copying for merging common tasks 162 copying to Claim Buffer 151 copying to Target Project Buffer 152 displaying As-Built items 149 displaying categories 129 displaying for merging 158
447
Index
displaying source project items 150 filtering in explorer windows 138 merge actions 168 modifying display format 129 preferences for claiming 150 preferences for merging 166 removing from buffer 153 removing from Merge Buffer 164 selecting sub-items for merging 158 setting merge actions 169 status indication icons 433 viewing access rights levels 195 as Domain Administrator 68 as System Administrator 67 defining databases 94 groups for Windows authentication 75 ODBC profile for SQL Server 94 switching to dirrerent logon method 76 Windows authentication 74 logos 128, 217 selecting for a domain 217 selecting for projects 128 loop numbers 130, 131, 141 filtering according to blocks 141 reserved loops report 131 reserving for As-Built 130 reserving for projects 130
K
KKS 105, 109, 110 naming conventions 110 overview 105 requirements 109
M
macros 207, 208 exporting 207 importing 208 maintenance 92, 93, 98, 99, 100, 101, 102, 103 catalog tables 98 database locking mode 92 database maintenance on Oracle 101 database maintenance on SQL Server 99 database maintenance overview 93 general database maintenance 93 optimizing indexes on Oracle 102 optimizing indexes on SQL Server 101 printing filegroup information 100 updating Oracle statistics 103 viewing Oracle tablespaces 102 merge actions 168 Merge Later 168 merge mode for Merge Now 168 Merge Now 168 Release Claim 168 merge modes 157 merging 158 merging with As-Built 79, 157, 159, 160, 161, 162, 164, 166, 168, 169, 170, 171 comparing project data with As-Built 166 comparison list report generation 160 data copying common tasks 162 fieldbus tags 157 from command line 171 from Merge Buffer 170 from Project Explorer 170 item and sub-item selection 158 items in Merge Buffer 161
L
language 253, 254, 255, 256, 257 importing interface language 254 interface language common tasks 254 interface language overview 253 prefixes and suffixes 257 replacing from database 255 replacing from file 255 translating interface text phrases 256 length 87, 172, 179, 212 custom field characters 212 naming conventions 172 passwords 87 wire end naming convention 179 locations 210 location level separators 210 location levels for panels 210 locking 92, 93, 115, 223, 224, 225 clearing - common tasks 224 clearing - overview 223 clearing in all sessions 225 clearing on Oracle 225 clearing per user 225 clearing session records 225 database connections 115 database locking mode 92 setting database locking mode 93 log files 56, 153, 170 domain backup 56 domain initialization 56 items claimed from buffer 153 merged items 170 logging on 67, 68, 74, 75, 76, 94
448
Index
merge action descriptions 168 merge modes 157 merging data common tasks 164 overview 157 preferences 166 reports common tasks 159 reports of changed documents 161 reports of changed items 161 setting merge actions 169 without deleting from project 79 My List 142 database connections 115 database maintenance 101 datafiles 102 deleting an invalid domain 61 domain initialization from a source 49 empty domain initialization 47 modifying on Oracle 9.2 222 national character set 49 optimizing indexes 102 paths for trimming audit trail data 222 tablespaces 102 updating Oracle statistics 103 viewing tablespaces 102 owner operator domain 79, 123, 125, 126, 128, 133, 134, 135, 147, 149, 158, 164, 168 actions for merging items 168 As-Built 123 claiming common tasks 147 common tasks 125 creating 79 creating a project 126 deleting project data 135 deleting projects 134 displaying As-Built items 149 displaying project items 158 making As-Built definitions 128 merging data common tasks 164 overview 123 project deletion common tasks 134 projects 123 rebuilding projects 133 selecting a project logo 128 owners 120 defining a plant owner 120 deleting 120 editing 120
N
naming conventions 105, 110, 130, 172, 173, 174, 176, 177, 179, 180, 181, 182 common tasks 173 copying from another unit 177 copying to existing units 176 copying to new units 176 defining 110, 174 defining wire end naming conventions 180 deleting wire end naming conventions 182 document numbers 177 duplicating wire end naming conventions 181 enabling wire end conventions 180 examples 110 generating reports 179 item types supporting KKS 105 maximum length 172 modifying wire end naming conventions 182 overview 172 separators 110 spaces in file names 174 tag and loop reservation 130 trailing spaces 174 wire end common tasks 180 wire end naming conventions overview 179 wiring items 174 notes 218 modifying 218
P
panel locations 174, 210 defining levels 210 naming conventions 174 separators 210 passwords 87, 89, 90, 92 Admin schema logon password encryption 90 changing System Administrator password 89 encrypting all user passwords 92 length 87 paths 222 audit trail data in Oracle 222 audit trail data in SQL Server 222
O
ORA-01722 error 65 Oracle 47, 49, 61, 101, 102, 103, 115, 225 Oracle Instance Configuration File 222 clearing blocked sessions 225 database character set 49
449
Index
plant design overview 119 plant hierarchy 119 plant hierarchy 80, 119, 120, 121, 122, 123, 212, 226, 242 copying data overview 226 creating levels 120 deleting items 123 deleting levels 120 designing 119 highest level items 121 intermediate level items 121 lowest level items 122 modifying custom field definitions% 212 retrieving from SmartPlant Foundation 242 separator 80 plants defining an owner 120 modernization overview 123 PowerBuilder units 200 preferences 150, 166 preferences management 196, 197, 198, 199 common tasks 196 copying project preferences 198 exporting preferences 198 for merging items with As-Built 166 for project scope 150 importing preferences 199 overview 196 setting domain preferences 197 setting project preferences 197 printer settings 218 project administrator 124 access rights 124 assigning to project 124 defining 124 project deletion 134, 135 common tasks 134 deleting empty project 134 deleting project data 135 deleting project data and schema 135 prerequisites 134 project statuses 134, 336 for project deletion 134 status descriptions 336 projects 79, 125, 126, 127, 128, 130, 131, 133, 135, 142, 143, 149, 150, 153, 154, 155, 156, 157, 158, 161, 166, 167, 168, 169, 170, 171, 197, 198 actions for merging items 168 assigning user groups 127 claim modes 142 claiming documents 156 claiming from buffer 153 claiming from command line 154 claiming items from another project 154 claiming items from As-Built 154 comparing data for merging 166 copying project preferences 198 creating 126 deleting project data 135 displaying As-Built items 149 displaying items for merging 158 displaying source project items 150 item comparison options 167 items claimed for multuple projects 156 items in Merge Buffer 161 making As-Built definitions 128 merging data overview 157 merging items from command line 171 merging items from Merge Buffer 170 merging items from Project Explorer 170 owner operator domain 79 owner operator domain common tasks 125 preferences for claiming 150 preferences for merging 166 prerequisites for claiming documents 155 Project schema creation 126 rebuilding 133 reports of changed documents 161 reports of changed items 161 reserving tags and loops 130 restoring 131 scoping data overview 142 selecting a logo 128 setting merge actions 169 setting project preferences 197 setting status for integration 133 settings and conditions for claiming 143 showing claimed items 156
R
registering 241 plant 241 reports 85, 86, 115, 131, 152, 159, 160, 161, 179, 195, 199, 200, 202, 203, 216 access rights 195, 216 archiving options 202 associating a new title block 200 changed documents 161 changed items 161
450
Index
common tasks 199 comparison list for merging 160 domain statistics 216 generating system admin reports 115 graph-style activity report 86 grid-style activity report 85 items copied to Claim Buffer 152 items copied to Merge Buffer 161 items copied to Target Project Buffer 152 list-type reports 203 naming conventions 179 non-list-type reports 203 report management overview 199 reports for merging data common tasks 159 reserved items 131 revision management overview 199 revision management per document 203 revision management per item 203 settings for claiming documents 203 users list 216 users list per group 216 requirements 109, 243 Domain Administration 109 integrated environment 243 source database 109 System Administration 109 reservation of items 130, 131 for As-Built 130 for project 130 reserved items report 131 Reserve Project Loop Numbers Dialog Box 399 Reserve Project Tag Numbers Dialog Box 399 restoring projects 131 importing data 131 revamps 123 revisions 199, 203, 232 copying 232 per document 203 per item 203 report management overview 199 settings for claiming documents 203 claim modes 142 copying items to Claim Buffer 151 copying items to Target Project Buffer 152 exclusive claim mode 79 preferences for claiming 150 removing items from buffer 153 scoping data common tasks 147 scoping data overview 142 searching for items 137, 138 multiple items for claiming 137 multiple items for merging 137 specific item for claiming 138 specific item for merging 138 security 87, 89, 92, 93, 173, 180 changing System Administrator password 89 database locking mode 92 database security 87 encrypting all user passwords 92 setting database locking mode 93 setting security options 92 separators 80, 110, 174, 180, 210 control system tag names 174 device cable names 174 in panel location levels 210 plant hierarchy 80 wire end naming conventions 180 sessions 115, 223, 224, 225 clearing in all sessions 225 clearing locking common tasks 224 clearing locking overview 223 clearing on Oracle 225 clearing per user 225 clearing records 225 database connections 115 SmartPlant Foundation 242 SmartPlant Foundation Web Client 241 retrieving plant hierarchy 242 SmartPlant Instrumentation Server 240 define IDEAL user 240 SmartPlant integration 133, 236 configuring for 236 setting project status 133 special characters in custom fields 214 specification title blocks 80 SQL Server 39, 51, 53, 61, 66, 94, 99, 100, 115 adding datafiles to filegroups 100 adding datafiles to TEMPDB 100 audit trail data backup 39 database connections 115 database maintenance 99
S
Schema Component 237 schema mapping 250 naming conventions 250 scope of a project 79, 142, 147, 150, 151, 152, 153
451
Index
deleting an invalid domain 61 domain initialization from a source 53 empty domain initialization 51 Grant to view Creation Error 66 ODBC profiles 94 prerequisites for defining databases 94 printing filegroup information 100 stored procedures 97 rebuilding 97 sub-items for claiming 151, 152, 153, 164 copying to Claim Buffer 151 copying to Target Project Buffer 152 removing from buffer 153 removing from Merge Buffer 164 sub-items for merging 158 automatic selection 158 manual selection 158 Sybase Adaptive Server Anywhere 44, 46 domain initialization from a source 46 empty domain initialization 44 System Administration 67, 68, 69, 71, 77, 78, 82, 84, 87, 89, 92, 112, 115 accessing Administration module 67 accounting/clients/contractors common tasks 112 activities 77 activity tracking common tasks 84 assigning a Domain Administrator 71 changing password 89 common tasks 77 database locking mode 92 database security 87 defining domain common tasks 78 enabling workflow 82 generating system admin reports 115 logging on 67 overview 77 switching from domain administration 68 switching to domain administration 68 users and departments common tasks 69 system interfaces 205 importing 205 reserving for projects 130 telecom device types 211 assigning icons 211 TEMPDB 100 thin client 34 domain backup 34 title blocks 80, 200 associating a new title block 200 default 200 defining for specs 80 descriptions 200 plant hierarchy name truncation 200 suitable for specs 200 toolbars 260, 295, 299 Access Rights 260 Domain Definition (System Administration) 299 Domain Definition Window (Domain Administration) 295 trailing spaces 174, 180 control system tags 174 document numbers 174 wire end names 180 wiring item names 174 triggers 97 rebuilding 97 troubleshooting initialization 62, 63, 65, 66 common tasks 62 Grant to view Creation Error 66 ORA-01722 error 65 restarting initialization 63 resuming initialization 63 Windows Vista 63
U
user groups 71, 124, 126, 127, 195 access rights report 195 assigning to project 127 copying from As-Built 126 overview 71 project administrators 124 user-defined database views 44 adding for initialization 44 users 69, 70, 73, 74, 75, 76, 115 assigning to departments 70 assigning to groups 73 creating 70 creating a group 73 database connections 115 deleting 70 editing 70 IDEAL user 70 logon options 74
T
tablespaces 16, 102 adding datafiles 102 tablespace descriptions 16 viewing 102 tag numbers 130, 131 reserved tags report 131 reserving for As-Built 130
452
Index
removing deleted Windows users 75 removing from groups 74 switching to dirrerent logon method 76 users and departments common tasks 69 Windows authentication 74 Windows groups 75
V
views 44, 96 adding for initialization 44 rebuilding default views 96
W
windows 260, 265, 291, 295, 325, 409 Windows authentication logon method 74, 75 Access Rights 260 Administration 265 creating groups 75 Domain Administration 291 Domain Definition (Domain Administration) 291 Domain Definition (System Administration) 295 overview 74 Plant Hierarchy Explorer 325 removing deleted Windows users 75 System Administration 409 wire end naming conventions 179, 180, 181, 182 common tasks 180 defining 180 deleting 182 duplicating 181 enabling 180 modifying 182 overview 179 trailing spaces 180 wiring items 174, 210 naming convention examples 174 panel location levels 210 workflow 82, 194 access rights 194
453