Академический Документы
Профессиональный Документы
Культура Документы
User’s Guide
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartSketch, FrameWorks, INtools, MARIAN, and IntelliShip
are registered trademarks and SupportModeler and SupportManager are trademarks of Intergraph Corporation.
Microsoft and Windows are registered trademarks of Microsoft Corporation. MicroStation is a registered trademark
of Bentley Systems, Inc. ISOGEN and SPOOLGEN are registered trademarks of Alias Limited. Other brands and
product names are trademarks of their respective owners.
Preface
Table of Contents
Preface...............................................................................................................................44
Guidelines for Customizing PSR Files for Save as Excel .............................................. 579
Create an Invisible Vertical Zero Line............................................................................ 581
Replace Double Lines with Thick Single Lines.............................................................. 581
Correct a Line Discontinuity........................................................................................... 582
Correct Horizontal and Vertical Divergence of Grid Lines ............................................ 582
Set Value Display Precision for Save as Excel Globally................................................ 583
Set Value Display Precision for Individual Fields.......................................................... 583
Save as Excel Troubleshooting.................................................................................585
Resolve Spec Accessing Problem in a Common Excel File ........................................... 587
Remove the Protection from a Spec Saved as Excel ...................................................... 588
Resolve a Data Saving Problem...................................................................................... 588
Resolve Grid Line Overlap Problems ............................................................................. 588
Correct Undershooting and Overshooting of Grid Lines................................................ 589
Prevent Truncation of Labels and Values ....................................................................... 590
Fix Displaced Labels....................................................................................................... 590
Fix Text Display in Excel Cells ...................................................................................... 592
Fix Function Conversion Problems ................................................................................ 592
Set Value Display Precision............................................................................................ 593
Fix Display of Vertical Fields......................................................................................... 593
Fix Display of Select Lists.............................................................................................. 594
Prepare Problematic Excel Files for Intergraph Support ................................................ 594
Auto-Wiring: An Overview...........................................................................................872
Defining and Executing Auto-Wiring Tasks: An Overview ....................................873
Flow of Activities for Auto-Wiring..........................................................................875
Auto-Wiring Connections Common Tasks ..............................................................876
Pre-Assign Junction Boxes to Device Panels ................................................................. 877
Auto-Wire Pre-Assigned Junction Boxes ....................................................................... 878
Auto-Wire Two Panels ................................................................................................... 879
Auto-Wire Control Systems............................................................................................ 881
Auto-Wire Control Systems Connected to Pre-Assigned Junction Boxes...................... 883
Auto-Wiring Task Statuses ............................................................................................. 885
Change an Auto-Wiring Task Status .............................................................................. 886
FirstVue Interface........................................................................................................1601
Flow of Activities for Working with FirstVue .......................................................1602
FirstVue Field Conversion Conventions ................................................................1603
Prerequisites for Exporting Data to FirstVue .........................................................1605
Exporting FirstVue Data.........................................................................................1606
Export FirstVue Data .................................................................................................... 1606
Prerequisites for Importing FirstVue Data .............................................................1609
Importing FirstVue Data.........................................................................................1610
Import FirstVue Data Automatically ............................................................................ 1611
Import FirstVue Data Manually.................................................................................... 1612
Index..............................................................................................................................1779
Preface
This user's guide describes concepts, procedures, and interface features of SmartPlant
Instrumentation.
This guide provides instructional, procedural, and reference material to help you get
the most from SmartPlant Instrumentation. Use it to learn the basics and later as a
reference to perform specific tasks.
• The Import Utility provides the means to import data into SmartPlant
Instrumentation from the most common database file formats such as
Microsoft Access, DBF files, Oracle, SQL Server, Sybase Adaptive
Server Anywhere, ASCII delimited files, and other ODBC compatible
files.
• The Merger Utility provides the means of merging the data of either
two <units> or two <plants> for the purpose of creating one common
database for either the two <units> or the two <plants>.
Related Topics
• Getting Started Common Tasks, page 50
User Assistance
SmartPlant Instrumentation user assistance supplies command information as you
perform tasks. You can access different kinds of information any time you are
running the software. This information could include reference topics, narrative
descriptions or overviews.
Installation Guide — This document provides you with step-by-step procedures for
installing SmartPlant Instrumentation on Oracle or SQL Server database platforms, or
on Sybase Adaptive Server Anywhere. It also contains important configuration
information, useful tips, and troubleshooting advice. The Installation Guide is
presented in the .pdf file format and can easily be printed out. Adobe Reader,
required for the .pdf files, is available from the SmartPlant Instrumentation
installation CD or from the Internet.
Tutorial — The tutorial helps novice users acquire the skills necessary to start using
SmartPlant Instrumentation, create a minimal setup for your plant, and all the basic
instrument engineering activities for each module. You will acquire the fundamental
understanding, skills, and practical experience that you need to use the software with
confidence. The tutorial is presented in the .pdf file format and can easily be printed
out. Adobe Reader, required for the .pdf files, is available from the SmartPlant
Instrumentation installation CD or from the Internet.
• ToolTips help you find command names. When you pause the pointer
on a toolbar icon, a yellow label displays the command name.
Caution
• Indicates a caution to which you should pay attention.
Important
• Important information which supplements the main text.
Note
• General information which supplements the main text.
Tip
• Indicates a tip, pointing out a useful feature which makes life easier for
the user.
Keyboard Conventions
Common functions of some keys are described below:
Mouse Conventions
The left mouse button is the one referred to, unless otherwise stated.
To Do this
Point Position the pointer on an item.
Click Point to an item, then quickly press and release the mouse button.
Double- Point to an item, then quickly press and release the mouse button twice.
click
Drag Point to an item, and while holding down the mouse button on the item,
move the item to a new location. When the pointer is at the desired
location, release the mouse button.
Open a Module
Use this procedure to open a specific SmartPlant Instrumentation module. You can
open any module whether or not other modules are already open. Access to a
particular module is subject to your having appropriate access rights. For more
information, see Open a Module, page 53.
Related Topics
• Working with SmartPlant Instrumentation: An Overview, page 45
Important
• Access to SmartPlant Instrumentation modules is available only after
the System Administrator has created a domain and the Domain
Administrator has set up its resources. See the initialization section
appropriate for your database platform (that is, Oracle, SQL Server or
Sybase Adaptive Server Anywhere) for details.
• User names and passwords are not case-sensitive. The software
displays the password as asterisks.
• If you purchased SmartPlant Instrumentation with an evaluation
license, there is no limit of the number of times that you can log on to
SmartPlant Instrumentation before the expiration date of the license,
however after that date, you will be denied access to SmartPlant
Instrumentation.
Related Topics
• Navigating in SmartPlant Instrumentation, page 51
• Working with SmartPlant Instrumentation: An Overview, page 45
Also, you perform various action from SmartPlant Instrumentation modules using the
menu items or clicking the appropriate toolbar icons in the main SmartPlant
Instrumentation window. A number of other options are available when you are in
this window. The window itself consists of the following areas:
Menu bar — The menu bar contains access to all the actions you will perform in
the module, and also to standard Windows features such as window layouts and
Online Help.
Toolbar — The application toolbar provides you with quick access to each module.
The module toolbars enable you to access the most common actions for the modules.
Application work area — The central region where the main module window
appears.
Status bar — The status bar provides you with quick access to information on the
selected icon or menu item (Microhelp) or the status of a particular process (for
example, exporting data). In addition, it shows the plant hierarchy items and the
current date and time.
Related Topics
• Open a Different Domain, page 52
4. If the project icon appears (only when the domain type is Owner operator),
double-click the icon to select the project you want to work with (As-Built or a
project).
5. Navigate to a desired <unit> by double-clicking the <plant> and <area>
icons to expand the view and display the <units>.
6. Select a <unit> by doing one of the following:
Tip
• You can use alphanumeric values in either upper or lower case. The
maximum length of your password can be 15 characters.
4. In the Confirm new password field, retype the new password.
5. Click OK.
Related Topics
• Getting Started Common Tasks, page 50
• Navigating in SmartPlant Instrumentation, page 51
• Working with SmartPlant Instrumentation: An Overview, page 45
Open a Module
1. Start SmartPlant Instrumentation.
2. Do one of the following:
• Click the appropriate toolbar icon for the module you want to open.
• On the Modules menu, click a desired module name.
Related Topics
• Getting Started Common Tasks, page 50
• Navigating in SmartPlant Instrumentation, page 51
• SmartPlant Instrumentation Explorer: An Overview, page 206
Filter Setting — When you specify a filter setting such as a data range, and then
restart the software, the software updates the date range in every SmartPlant
Instrumentation module in which you use the same filter.
ID of the <Unit> Selected Last — When you select a specific <unit> on the Open
dialog box, the software records the <unit> ID in the Intools.ini file under the
[Project] section. The next time you start SmartPlant Instrumentation and display the
Open dialog box, the software displays the <unit> you selected last.
Smartloop.ini
Hiding Macro Items when Generating Enhanced Reports — If, for a default
macro such as a panel name, you define a filter that hides a particular macro, a dot
appears in place of the macro. The dot is needed to allow editing of the macro filter,
adding new macros to the item associated with the hidden macro, or editing of the
item. If you want to hide the dots, for example when printing the report or saving it
in a different format, you need to define the parameter HideItems = Y in the
Smartloop.ini file.
Related Topics
• Setting General Preferences Common Tasks, page 54
The Domain Administrator can restrict the ability of other users to set their
preferences. Therefore, you can find that certain options are disabled. If you want to
enable these options, contact your Domain Administrator, who can manage
preferences from the Administration module.
Tree view — Click beside a desired module to expand the hierarchy, and then
click an option to open a specific page where you can set your preferences.
Pages — Using the options on the pages, you can view the default preferences set
by the Domain Administrator. Also, you can overwrite certain default preferences
with you own settings, provided that the Domain Administrator has not disabled these
preferences.
Reset — Resets all the properties for the selected module to their default values.
This option appears when you select a module or some of the other categories such as
Enhanced Reports, Interfaces, or SmartPlant, at the highest level of the tree view.
Reset all — Resets all the properties in the Preferences dialog box to their default
values.
General (Preferences)
The options on the General page of the Preferences dialog box enable you to
customize the SmartPlant Instrumentation interface and set general application
preferences. These settings do not affect the preferences that were defined by other
SmartPlant Instrumentation users in the current domain or working in the current
project, if the domain type is Owner operator.
• Set the default locations of the main toolbar and the module toolbar.
• Set the toolbar and icon display.
• Automatically start SmartPlant Instrumentation with the unit and
module you last worked in.
• Set print preview options.
• Overwrite the default logo.
Note that the Domain Administrator can restrict your ability to set various
preferences. Therefore, you can find that certain options are disabled. If you want to
enable these options, contact your Domain Administrator, who can manage
preferences from the Administration module.
Select toolbar — Allows you to select the toolbar whose display options you want
to define: Main Toolbar or Module Toolbar.
Show toolbar — Makes the currently selected toolbar visible in the application.
Clear the check box to hide the toolbar.
Show toolbar text — Displays text with the icons in the currently selected toolbar.
Clear the check box to hide the text.
Toolbar position — The following options enable you to set the toolbar the position
on your screen. Click the desired option:
• Top— Places the selected toolbar along the top of the screen right
under the menu bar.
• Bottom— Places the selected toolbar along the bottom of the screen.
• Floating— Makes the selected toolbar float on your screen.
• Right— Places the selected toolbar along the right edge of the screen.
• Left— Places the selected toolbar along the left edge of the screen.
Overwrite logo — Retrieves automatically the current logo from the database and
overwrites the projlogo.bmp file in the [SmartPlant Instrumentation home
folder]\temp folder. The projlogo.bmp file is from where SmartPlant Instrumentation
takes the logo which is used in documents and reports. If you clear the check box, the
software retrieves the logo from the original bitmap file – in this way the
projlogo.bmp file is not changed when switching to another domain, so that you use
the same logo. Clearing the check box also speeds up your work.
Print preview options — The following options enable you to set a print preview
option for report generation.
Temporary folder path — Allows you to specify the path to the SmartPlant
Instrumentation temporary folder where the software stores the temporary logo and
custom files. Click Browse to navigate to the path.
For example:
C:\Program Files\SmartPlant\Instrumentation\TEMP
In the temporary folder, the software creates temporary files during various activities
that you perform in SmartPlant Instrumentation. For example, when you create
specifications, generate CAD drawings, hook-up drawings, or reports, and so forth.
Notes
• In the Specifications module, when you generate the Spec Forms
report, the software generates the report as the specprn.psr file and
saves this file to the folder you specify in the Temporary folder path
box. If you leave this box blank, the software saves the specprn.psr
file to the SmartPlant Instrumentation home folder and not to the PSR
working folder path preference (on the Specifications >
Export/Import page).
• If your CAD application is MicroStation, make sure the path string
does not exceed fifty two characters. A longer path prevents
MicroStation from generating or displaying drawings or cells from
SmartPlant Instrumentation.
• If the System Administrator specified a global path in your domain,
the global path does not apply to the temporary folder path.
Output document folder — Enables you to specify the path to the folder where the
software generates IDEAL report files. Click Browse to navigate to the path.
Copy from — Choose from the list the enhanced report that you want to copy the
file locations from.
Copy to — Choose from the list one or more enhanced reports that you want to
copy the file locations to.
Select all — Select this option when you want to copy the file locations from one
enhanced report to all the enhanced reports.
Define new tag name template — These options determine how SmartPlant
Instrumentation displays new tag number names in the New Tag Number dialog box
in relation to the previously created tag number.
• No default — The data field in the New Tag Number dialog box
will not display any default tag, letting you type the number you need.
• Same as the last created tag — The data field in the New Tag
Number dialog box displays the last created tag. You can accept the
displayed number, modify it, or type the number you need.
• Same as the last created tag + 1 — The data field in the New Tag
Number dialog box displays the last created tag plus 1 (one). You can
accept the displayed number, modify it, or type the number you need.
Note
• This option is available for numeric tag names only. If your tag names
are not numeric, the data field in the New Tag Number dialog box
will display the last created tag.
Ignore loop creation when creating new virtual tag — Allows you to create a
virtual tag without being prompted to create a loop associated with the new virtual
tag.
Use loop suffix in instrument tag — Allows you to include the loop suffix in the
name of a newly created instrument tag.
Define new loop name template — These options determine how SmartPlant
Instrumentation displays new loop number names in the New Loop Number dialog
box in relation to the previously created tag number.
• No default — The data field in the New Loop Number dialog box
does not display any default loop, letting you type the number you
need.
• Same as the last created loop — The data field in the New Loop
Number dialog box displays the last created loop. You can accept the
displayed number, modify it, or type the number you need.
• Same as the last created loop + 1 — The data field in the New
Loop Number dialog box displays the last created loop number
incremented by one. You can accept the displayed number, modify it,
or type the number you need.
• The last existing loop in the unit + 1 — The data field in the New
Loop Number dialog box displays the last existing loop number in the
current unit incremented by one. You can accept the displayed
number, modify it, or type the number you need.
• The last existing loop in the domain + 1 — The data field in the
New Loop Number dialog box displays the last existing loop number
in the current domain incremented by one. You can accept the
displayed number, modify it, or type the number you need.
Note
• The last three options are available for numeric loop names only. If
your loop names are not numeric, the data field in the New Loop
Number dialog box will display the last created loop.
Apply loop service to drawing description — Specifies that in the Loop Drawings
module, a loop service which you define for a loop appears in the Loop Drawing
List dialog box under the Description column. If you clear the check box, the
Description column remains empty.
For example, if you clear the Specifications check box, when creating a tag number,
the software ignores specification creation options defined on the General tab of the
Instrument Type Profile dialog box and creates the tag without any specification. If
you then manually generate a specification for the created tag, the software applies
the existing instrument type profile options.
Activate instrument type profile options — The following options allow you to
activate or deactivate instrument type profile options on the Instrument Type Profile
dialog box.
Open the Browser Manager to define a default view before opening — Select
this check box to require the user to select a view in the Instrument Index Standard
Browser or a suitable PowerSoft Browser before opening this browser view. Clear
this check box to open automatically the browser view set as the default in the
specified browser.
Fluid phase for process data — Selects the fluid phase to use as default when
generating new process data sheets for the tags selected in the browser view. The
available fluid phase options are Liquid, Water, Gas/Vapor, Steam, Solid/Powder.
• Create new tags based on the properties of the selected source tag
number, and when running batch loop creation, create new tags based
on the properties of the typical tags defined for the selected typical
loop in the Typical Tag Number Properties dialog box.
Instrument tag duplication and batch creation options
Create new tags according to profile options — Select this option to do the
following:
• Create new tags based on the properties of the selected source tag
number.
• Create new tags based on the properties of the typical tags defined for
the selected typical loop in the Typical Tag Number dialog box.
When duplicating a tag number, you can also include additional data associated with
source tag numbers. Select the appropriate check boxes below.
Note
• The following check boxes are not applicable when running batch loop
creation.
CAD blocks — Includes all the CAD blocks assigned manually to the source tag,
page numbering in the loop drawing where the blocks are located, and the X, Y, Z
offset coordinates of the block in the loop drawings. In the Loops folder of the
Domain Explorer, manually assigned blocks are shown under instruments as .
Note
• The CAD blocks preference does not apply to blocks assigned to
instruments using the automatic block assignment method. In the
Loops folder of the Domain Explorer, these blocks are shown under
instruments as . Such blocks are always duplicated under the target
instruments.
Specifications — Includes the specifications associated with the source tag. You
can include the process data information in the source specification only if you select
the Process Data check box as well.
Notes
• Instrument specifications are duplicated only if you select the Process
data check box too.
• When duplicating an instrument tag associated with a composite spec,
the software never duplicates the composite spec, regardless of the
preferences that you specify.
• When duplicating a loop, the software always duplicates the loop
composite spec.
Process data — Includes the process data information of the source tag. This
option is required if you want include tag source instrument specifications as well.
Include custom fields when copying (applicable for tag duplication and batch loop
creation) — Duplicates the tag and loop number with the custom fields of the source
loop, tag, or both.
Delete device cables — Deletes all the device cables associated with the tag number
that you select to delete.
Delete associated control system tags — Deletes all the control system tags
associated with the tag you select to delete.
Change sequence of remaining tags after deletion — Allows you instruct the
software to automatically update tag sequence values in a loop when deleting a tag
number.
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, on the Tag Number Properties dialog box, the software automatically
displays the line pipe spec that is associated with the line for the current tag number.
For example, if you are moving Tag 101-FE – 100 to a <unit> that has a line number
segment in its tag naming convention, the software names the tag number in the target
<unit> as it was named in the source <unit> and retrieves the line number from the
tag properties to complete the line number segment.
Show notes — For specification and form data template reports, to include notes —
or reference to the notes — on the first page, select Show notes. To omit notes —
or reference to the notes — from the first page, clear Show notes.
Edit fieldbus columns in specs — Allows you to edit data displayed in fieldbus
columns in specification sheets. If you clear the check box, all columns related to
fieldbus data become non-editable in specifications.
Note
• Although you can include fieldbus instruments in a multi-tag spec, the
software does not support editing of fieldbus columns in a multi-tag
spec. In a single-tag spec, you can only edit fieldbus columns if the
instrument type of the spec tag number is Fieldbus.
Print notes on a separate sheet — For specification and form data template
reports, to print the notes section on a separate page, select this check box. To print
notes as displayed, clear this check box. This setting also affects specifications that
you print as part of Binder Packages.
We recommend that you select this check box if the text in the Note box on the spec
data page is long, and the software displays a scroll bar in the Note box.
• Not allowed (default) — The user cannot create new tags from the
Specifications module.
• Allowed— The user is able to create new tags in the Specifications
module.
Data copying options
This set of options allows you to specify how the software copies or imports data in
the following situations:
Use default print layout — This option affects the layout of the individual tag list
page printout for multi-tag specifications. If you select the check box, the default grid
layout, with one header per column, is applied. If you clear the check box, a multi-
line layout is applied to the specification format, if defined. It is possible to
customize a multi-line layout to display several headers per column. Also, you can
modify the font and column size.
Note
• Where no other format is defined, the default print layout will be used
whether or not this check box is selected.
Show master tag — Allows you to show the master tag number (in parentheses)
next to the multi-tag list in the Tag Number column of a multi-tag specification.
Use only governing case for multi-tag specs — Allows you to specify that only
one tag in a multi-tag specification can be assigned to a case (the governing case).
This preference only applies to new multi-tag specifications that you create. After
you select the check box, when creating a multi-tag specification, only one record of
the same tag appears in the Multi-Tag tab of the specification.
Selecting this check box affects the way SmartPlant Instrumentation displays tag
records of the same tag that is assigned to multiple process data cases. For example,
in the Find Items dialog box of the Specifications module, when a tag is assigned to
multiple cases, the software only displays the governing case.
If you clear the check box, when you create a multi-tag specification, you can add of
the cases in the Multi-Tag tab of the specification.
Customize the SEE LIST label — Allows you to change the default label SEE
LIST, which appears in the main pages of a multi-tag specification. In a multi-tag
specification, the SEE LIST label appears in every field that the multi-tag list format
contains. You can enter any combination of alpha-numeric characters (up to 20
characters) or leave the box blank.
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.
Global path — Displays the global path set by the System Administrator.
Saving method — These options affect both batch mode and individual mode of
saving specifications in Excel format.
• Common Excel file for tags with the same form — Creates a
unified Excel file for all of the specifications based on a given form.
This is the default setting.
• Separate file for each tag— Creates an individual Excel file for each
specification.
Accuracy level — Allows you to define the number of digits that appear after the
decimal point in the Excel file. You can use the spinners or type the number of digits.
Delete temporary Excel files — Deletes working files that the software creates in
the process of exporting specifications in Excel format.
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.
Note
• 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.
Overwrite PSR files — For best performance, make sure that this check box is
cleared. In some network configurations, however, a .psr working file may not be
properly updated from the database. In such a case, select this check box to overwrite
.psr files every time that you save specifications. Note that when you select this
check box, the performance of the software can slow down.
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.
If, in the Report Management dialog box of the Administration module, the Domain
Administrator assigned the template title block Specs default TB with PB Units to
specifications, you need to place the title block correctly in the layout of a spec page.
To do so, enter the TitleFooterHeight parameter and define a value.
If you use the template title block Specs default TB with PB Units in specifications
you create using SmartPlant Instrumentation options, the optimal value is 798. If you
created a spec page in InfoMaker, you may need to enter a different value, depending
on your page layout settings.
Naming options
Enforce unique names for wiring items — Select this check box to enforce the
name uniqueness for wiring items.
To access these preferences, in the Preferences dialog box, in the tree view pane,
click beside Wiring and then click I/O Card.
Note that after you effect an I/O assignment and your preference was set to the Same
I/O type for tag and I/O card, you can still change the I/O type of the I/O card if
you need to do so. The software does not verify the compatibility of a changed I/O
type with instrument tags already associated with I/O cards.
To access these preferences, in the Preferences dialog box, in the tree view pane,
click beside Wiring and then click I/O Assignment.
To access these preferences, in the Preferences dialog box, in the tree view pane,
click beside Wiring and then click CS Tags.
CS tag name uniqueness — Use these options to determine at what level in the
Wiring module the software prevents duplication of a Control System tag name.
• Custom— Allows access to the following options where you can set
the Control System tag name uniqueness level separately for each
Control System, or for tag names not assigned to I/O cards.
• Per plant— Allows the use of a specific CS tag name in the plant
only once.
• Not unique— Allows the use of the same CS tag name more than
once at any level in the plant.
DCS uniqueness
The following options allow you to set the required uniqueness level for a Distributed
Control System (DCS):
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:
To access these preferences, in the Preferences dialog box, in the tree view pane,
click beside Wiring and then click Copy Items.
Retain cable length — Select this check box to retain the cable length property
when copying or duplicating a cable. Clear this check box (default value) not to
retain the cable length of the source cable.
Copy internal connections — Select this check box to preserve the internal
connections within a copied item. This means that the software will retain the cables
and cross wires that connect among the various terminal strips within the item that
you are copying or duplicating.
To access these preferences, in the Preferences dialog box, in the tree view pane,
click beside Wiring and then click Jumpers.
Automatic naming
Name jumpers automatically — Allows you to select name jumpers automatically.
Select this check box in the following cases:
To access these preferences, in the Preferences dialog box, in the tree view pane,
click beside Wiring and then click Reports.
Include unclaimed As-Built items — Includes in the reports not only items
claimed for a specific engineering project, but also the items that have not been
claimed.
Restart pagination for each terminal strip when not previewing the report —
When not previewing a report before printing, restarts the pagination of the report for
each terminal strip. (This preference is available for reports with adjacent
connections only.)
Channels — Includes all the channels that are not child items of terminal strips
under I/O cards.
To access these preferences, in the Preferences dialog box, in the tree view pane,
click beside Wiring and then click Cross Wiring.
To access the general Process Data module preferences, in the Preferences dialog
box, in the tree view pane, click beside Process Data and then click General.
General options
Convert units of measure automatically — Select this check box to automatically
convert numerical data when changing the units of measure.
• Always— Always opens a process data sheet for the tag selected in
the browser view when you open the Process Data module.
• Never— Never opens a process data sheet for the tag selected in the
browser view when you open the Process Data module.
• Ask user (default) — Prompts you whether you want to open a
process data sheet for the tag selected in the browser view when you
open the Process Data module.
Tag creation — Select an option to determine whether users are allowed to create
new instrument tags in the Process Data module.
To access the general Calculation module preferences, in the Preferences dialog box,
in the tree view pane, click beside Calculation and then click General.
• Always— Always opens a calculation sheet for the tag selected in the
browser view when you open the Calculation module.
• Never— Never opens a calculation sheet for the tag selected in the
browser view when you open the Calculation module.
• Ask user (default) — Prompts you whether you want to open a
calculation sheet for the tag selected in the browser view when you
open the Calculation module.
Tag creation — Select an option to determine whether users are allowed to create
new instrument tags in the Calculation module.
Plot drawing — Enables you to set the default option for printing CAD loop
drawings at the time of generation. After you select this check box, the software
automatically prints loop drawings you generate using your CAD application. This
preference affects the Send to plotter or printer check box selection on the CAD
Options tab of the Generate Loop Drawings dialog box.
Notes
• This preference does not affect printing loop drawings generated using
the Enhanced Report Utility.
• If you do not want to print CAD loop drawings but save them
automatically at the time of generation, clear this check box and then
specify the output drawing folder path on the Preferences > Loop
Drawings > CAD File Locations page.
• Regardless of this check box setting, when generating a batch of CAD
loop drawings, the software only opens the CAD drawing generated
last in the batch. It is not possible to set the software to open a print
preview of every CAD loop drawing when generating multiple loop
drawings.
Generate null macro list — Select this check box to generate a list of macros that
are used in the Macro report but which do not return a value when executed.
Generate undefined macro list — Select this check box to generate a list of macros
that are used in the Macro report but are not found in the SmartPlant Instrumentation
database.
Use macro functions — Select this check box to enable the use of macro functions
with macros in CAD drawings. You define macro functions in the Loop Drawings
module, in the User-Defined Macro Functions dialog box.
Explode block in AutoCAD — Enables you to edit the loop drawing by separating
the drawing block into elements.
Create error.log file — Select this check box to create the error.log file in the
location specified on the General preferences page under Temporary folder path.
This file is created during the loop generation process.
Use macro symbol (&) to retrieve data — Select this option according to the CAD
program you are using:
AutoCAD macro result type — Select the required macro result from the list. This
way you determine the macro result type in AutoCAD while generating a loop
drawing. You can set the macro result type as Text or as Attribute.
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:
Generation options — Select your default preferences for generating new loop
drawings. You can change these preferences manually when defining loop drawing
generation settings in the Generate Loop Drawings dialog box. From the list, select
one of the following:
CAD folder — Click Browse to navigate to the folder containing the executable file
of the CAD application installed on your computer. For example:
C:\Program Files\SmartSketch\program
CAD configuration folder — Click Browse to navigate to the folder containing the
CAD configuration file of the CAD application installed on your computer.
CAD function folder — Click Browse to navigate to the folder containing the CAD
function files. For example:
C:\Program Files\SmartPlant\Instrumentation\CAD\CADFunc
Note
• If your CAD application is SmartSketch, the CADFunc folder contains
a shipped file pid.igr. This is a template file on which all your
SmartSketch drawings are based. The default print sheet size is
defined in the pid.igr file as A3 Wide. If you want to generate
drawings using a different print sheet size, you must open the pid.igr
file in SmartSketch and modify the sheet settings as you require.
Changes that you make in the pid.igr file affect both loop drawings
and hook-up drawings you generate in SmartSketch. If you want the
print sheet size of loop drawings not to affect the print sheet size of
hook-up drawings, duplicate the CADFunc folder with all its content
and define a different path setting preference for hook-up drawings on
the Hook-Ups > CAD File Locations page.
Important
• If your CAD application is MicroStation, make sure the path string
does not exceed fifty two characters. A longer path prevents
MicroStation from generating or displaying drawings or cells from
SmartPlant Instrumentation. If your CAD function folder path is
longer than allowed, you need to copy the CADFunc folder and its
content to another location, for example, C:\CAD\CADFunc.
Open drawing files from — Click Browse to navigate to the default folder from
which saved loop drawings are to be opened. For example:
C:\Program Files\SmartPlant\Instrumentation\CAD\DWG
Drawing block folder — Click Browse to select the path to be used as the default
for new block files. For example:
C:\Program Files\SmartPlant\Instrumentation\CAD\Blocks
Save drawings automatically — Enables you to define the default path for saving
CAD loop drawings automatically as files at the time of generation.
The file format of the saved files depends on the CAD application you have selected.
Print all columns if exceeding page width — Select this option if the width of
your paper cannot accommodate all the columns of the report. When you select this
option, the software prints out subsequent pages containing the additional columns
that do not fit the width of the first page. If you do not select this option and your
report has more columns than the width of your paper can allow for, only the columns
that fit the paper width are printed out.
Show first column on each page — If you selected Print all columns if exceeding
page width, you can select this option to print out the first column on every page of
the report. This is helpful for showing on each printed page which items the rest of
the data belongs to.
Font style — Select a font style from the list of available styles: Regular, Italic,
Bold, or Bold Italic.
Size — Select a font size from the list of available font sizes.
Sample — Indicates the appearance of the font according to the properties that you
have selected.
Reset — Resets the SmartPlant Instrumentation font defaults for body text in the
Browser view and in the Print Preview window in the Instrument Index module.
The font defaults are:
General drawing preferences — You use these options to define your general
drawing that appears on the second and all other subsequent sheets of any multi-sheet
hook-up drawings that you generate. You must define these options to enable the
General drawing option in CAD tab of the Generate Hook-Up Drawings dialog
box.
Enter the required block name as follows, depending on the CAD application
installed on your machine:
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
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 hook- up 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.
Select the relation between the order of revisions and the order of the macros that you
have set in the title block.
Select this check box if you want the software to prompt you before removing a
hook-up type from an instrument type.
Units of measure for hook-up items — Determines whether you can assign a unit
of measure name or code to a hook-up item when defining or modifying hook-up item
properties. The software displays codes or names of hook-up item units of measure
in the Item Properties dialog box, in the Units of measure list.
CAD folder — Click Browse to navigate to the folder containing the executable file
of the CAD application installed on your computer. For example:
C:\Program Files\SmartSketch\program
CAD configuration folder — Click Browse to navigate to the folder containing the
CAD configuration file of the CAD application installed on your computer. For
example:
C:\Program Files\SmartSketch\program
CAD function folder — Click Browse to navigate to the folder containing the CAD
function files. For example:
C:\Program Files\SmartPlant\Instrumentation\CAD\CADFunc
Note
• If your CAD application is SmartSketch, the CADFunc folder contains
a shipped file pid.igr. This is a template file on which all your
SmartSketch drawings are based. The default print sheet size is
defined in the pid.igr file as A3 Wide. If you want to generate
drawings using a different print sheet size, you must open the pid.igr
file in SmartSketch and modify the sheet settings as you require.
Changes that you make in the pid.igr file affect both hook-up drawings
and loop drawings you generate in SmartSketch. If you want the print
sheet size of hook-up drawings not to affect the print sheet size of loop
drawings, duplicate the CADFunc folder with all its content and define
a different path setting preference for loop drawings on the Loop
Drawings > CAD File Locations page.
Important
• If your CAD application is MicroStation, make sure the path string
does not exceed fifty two characters. A longer path prevents
MicroStation from generating or displaying drawings or cells from
SmartPlant Instrumentation. If your CAD function folder path is
longer than allowed, you need to copy the CADFunc folder and its
content to another location, for example, C:\CAD\CADFunc.
Open drawing files from — Click Browse to navigate to the default folder from
which saved hook-up drawings are to be opened. For example:
C:\Program Files\SmartPlant\Instrumentation\CAD\DWG
Drawing block folder — Click Browse to select the path to be used as the default
for new block files. For example:
C:\Program Files\SmartPlant\Instrumentation\CAD\Blocks
Save drawings automatically — Enables you to define the default path for saving
CAD hook-up drawings automatically as files at the time of generation.
The file format of the saved files depends on the CAD application you have selected.
Tag display level — You can set the software to display tag numbers on the highest
or lowest level of your plant hierarchy. This setting apply to BOM, Hook-Up Tag list
report, and hook-up drawings. Note that in the Domain Explorer or Hook-Up
Explorer, tag numbers and other items are always displayed on the lowest plant
hierarchy level. The default highest level is Plant. The default lowest level is Unit.
The Domain Administrator makes plant hierarchy level definitions in the Plant
Hierarchy dialog box of the Administration module.
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.
Select specification list display — These options determine the specification list
layout setup in a print preview and how it is printed. The options are:
• Fixed columns— Use to display the specification list with a fixed set
of pre-defined columns. The orientation of the list is portrait when
printed.
• User defined columns from Browser module— Use to display the
specification list with the columns defined in the default view for the
Document Binder Browser group. The orientation of the list is
landscape when printed.
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.
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.
Changes report options — These options determine how the software compares
the current report with previous revisions. The options are:
The Domain Administrator can restrict the ability of other users to set their
preferences. Therefore, you can find that certain options are disabled. If you want to
enable these options, contact your Domain Administrator, who can manage
preferences from the Administration module.
To access these preferences, on the Preferences dialog box, in the tree view pane,
click Calibration and Maintenance > General.
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.
• Tag number, then event date— The maintenance event records are
displayed as follows: 101 -FT -100 02-03-07.
• Event date, then tag number— The maintenance event records are
displayed as follows: 02-03-07, 101 -FT -100. We recommend that
you select this option if you instrument tag number strings are long.
When you create a maintenance event record, the record name
characters that exceed sixty characters are truncated.
• Event date only— The maintenance event records are displayed as
follows: 02-03-07.
Note
• If you set the software to create maintenance event record names using
a combination of tag number and date, the software automatically
inserts a space character between the tag number and date. The date
format depends on the Maintenance event date format preference.
Maintenance event date format — Allows you to specify a date format that the
software uses when defining names of maintenance event records. The valid date
formats are the same as the formats you use in Windows, for example, dd/mm/yy,
mm/dd/yyyy, and so forth).
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.
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 — 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 — 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.
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.
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.
Redraw all connections — Select to redraw all the connectors on the sheet to
minimize the number of connector overlaps and intersections. Clear this option to
speed up report generation.
Optimize overlapping wires and cable sets — Select to separate the lines that
represent different sets and wires of a particular cable where they overlap one
another. Clear this option to speed up report generation.
Set loop drawing orientation from right to left (top to bottom, custom mode
only) — Select to generate the drawing with field devices drawn at the right edge of
the drawing sheet, or from top to bottom (vertical orientation) of the drawing sheet.
Clear to generate the drawing in the conventional way with the with field devices
drawn at the left edge of the drawing sheet.
Copy file locations — Opens the Copy file locations dialog box to allow you to
copy the data on the File Locations tab of a specific enhanced report type to one or
more other enhanced report types.
Use these options to customize the names of the layers used in enhanced reports.
Layers
Shows a list of the enhanced report layers.
Note
• 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.
Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.
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.
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 checkbox is checked 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.
Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).
CS block when tag has no wiring — Select to display Control System tags that are
assigned to the generated loop where those Control System tags do not have wiring
connections.
Instrument list — Select to display a list of instruments on the report that do not
have wiring. When displaying the list, the following options are available:
Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:
Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.
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.
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.
Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).
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.
Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:
Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.
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.
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.
Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).
Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.
Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:
Cross wiring — Set the desired connector representation for cross- wiring
connections. Select one of the following:
Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.
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.
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.
Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).
Virtual tags — Select to display the existing virtual tags in a generated segment
wiring report.
Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.
Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:
Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.
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).
Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.
Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:
Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.
Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:
Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.
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.
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.
Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).
CS block when tag has no wiring — Select to display Control System tags that are
assigned to the generated loop where those Control System tags do not have wiring
connections.
Instrument list — Select to display a list of instruments on the report that do not
have wiring. When displaying the list, the following options are available:
Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:
Note
• 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.
Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.
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).
Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.
Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:
Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.
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.
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.
Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).
Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.
Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:
Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.
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.
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).
Report end point level — Select to specify whether to report the end point level
from Amplifier or DCS.
Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.
Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:
Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.
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).
Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.
Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:
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.
Retrieve last saved position — Select to enable the Save Position command in the
Enhanced Report Utility and display drawing elements in the positions where they
appear on the drawing before this command is implemented. Clear this check box to
display generated drawing elements in their default positions.
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.
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.
Panel location — Select to display the panel location in its unit, on the drawing
layer (for example Field, Control room, and so forth).
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.
All terminals on each strip — Select to display all the terminals on all strips that
appear in the drawing. Clear this check box to display all the terminals on the main
(selected) strip and only wired terminals that carry signals on the other strips.
Signal path up to selected panel only — Select to display the signal path from the
field devices up to the selected panel only. Clear this check box to display the entire
signal path from the field devices up to the control system.
Channel items — Select to display channels with the channel names at the
appropriate positions on the strip.
Connector representation
Default layout — Set the desired connector representation for the default layout.
Select one of the following:
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.
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.
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.
Global path — Displays the global path set by the System Administrator.
Template for default layout — Allows you to select the .sma file that you want to
use as the page template for the selected report. Type the path and file name in the
box or click Browse to navigate to the file. For example:
C:\SmartPlant\Instrumentation\RAD\Template\A4wide.sma
The following is a list of standard .sma files that SmartPlant Instrumentation supplies:
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.
Save without printing — This option becomes available when you select Save
reports automatically. When you select this option, the software automatically
saves reports that you generate without a print preview but does not print them at
your printer. If you clear the check box, the software saves and prints the reports at a
printer when you generate them without a print preview.
Output report folder — Click Browse to navigate to the default folder where you
want the software to save all your enhanced reports automatically. For example:
C:\SmartPlant\Instrumentation\RAD\My Drawings\
Save as type — Select the file type for saving enhanced reports automatically.
Symbol folder — Allows you to define the default folder for all the .sym files that
appear as items on generated enhanced reports. Type the folder name in the box or
click Browse to navigate to the folder. For example:
C:\SmartPlant\Instrumentation\RAD\Symbols\
Custom symbol folder — Allows you to define the default folder for all the .sym
files that you use for Enhanced SmartLoop and Fieldbus Loop reports when using the
Custom by Loop or Custom by Signal generation method. Type the folder name in
the box or click Browse to navigate to the folder. For example:
C:\SmartPlant\Instrumentation\RAD\Symbols\Custom\
Global path — Displays the global path set by the System Administrator.
Symbol file for instrument list table header — Allows you to select the .sym file
that you want to use as the header symbol for the table used to display a list of
instruments on the report. Type the path and file name in the box or click Browse to
navigate to the file.
Symbol file for instrument list table details — Allows you to select the .sym file
that you want to use as the symbol for the table rows used to display a list of
instruments on the report. Type the path and file name in the box or click Browse to
navigate to the file.
Font — Select a font from the list of available Windows fonts. Note that if you
select a font other than a TrueType font (indicated by a TT symbol), the text appears
in the Enhanced Report Utility with a yellow-green font, regardless of any subsequent
change you try to make to the font color in the Enhanced Report Utility. It is
therefore recommended to choose a TrueType font.
Font style — Select a font style from the list of available styles: Regular, Italic,
Bold or Bold Italic.
Size — Select a font size from the list of available font sizes.
Sample — Indicates the appearance of the font according to the properties that you
have selected.
Reset — Resets the SmartPlant Instrumentation font defaults. These defaults are:
Alignment — Displays the position of the title block origin and the edges of the
drawing area on the page, when you use a symbol file (.sym) as the title block. Drag
the title block icon to the position you require. You can position the title block in any
corner of the drawing or at the center of any of its edges. Note that the alignment
does not change the orientation of the title block.
Horizontal — Select the horizontal alignment for the title block origin: left, center,
or right. Note that you cannot select center for both the horizontal and vertical
alignments.
Vertical — Select the vertical alignment for the title block origin: top, center, or
bottom. Note that you cannot select center for both the horizontal and vertical
alignments.
Drawing area relative to title block — Specifies where the drawing area should be
located in relation to the title block origin. For example, if you place the title block at
the bottom left corner, you can place the drawing to the right of the title block, above
the title block, or above and to the right of the title block. If you place the title block
at the center of any of the edges of the drawing, you can only specify one position for
the drawing.
Reset — Resets the title block in its default position at the bottom left corner of the
page, with the drawing area above the title block.
Size — Allows you to specify the area of the drawing sheet that the title block can
occupy by setting its maximum size.
Units — Select the units to specify for the title block height or width: inches,
millimeters, or twips.
Maximum size — Type a value for the maximum height or width of the title block.
The dimension affected, height or width, depends on the alignment specified for the
title block.
Set size — Select this check box if you want to specify a maximum size for the title
block. Clear the check box to allow the title block to take up as much space as
needed on the title block. It is recommended that you select this check box if the title
block is very tall or very wide, to avoid overlap with other graphical elements on the
drawing sheet.
Working area margins — Displays the margins of the initial working area on the
drawing page. Drag the edges of the working area to set the margins to the position
you require. Note that when you set the working area margins, the defined area
includes the title block. The software generates the drawing starting from the top left
corner at the position relative to the title block that you specified on the Title Block
tab. If any drawing elements extend beyond the right and bottom limits of the
working area, the software displays those elements on a new sheet.
Units — Select the units to specify for the working area margins: inches,
millimeters, or twips.
Left — Specifies the width of the left margin of the working area in the specified
units.
Right — Specifies the width of the right margin of the working area in the specified
units.
Top — Specifies the width of the top margin of the working area in the specified
units.
Bottom — Specifies the width of the bottom margin of the working area in the
specified units.
Reset — Resets the working area margins with a default value of 20 twips for all
margins.
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.
Pagination options
Start from page number — Select the desired page number to appear on the first
drawing sheet.
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:
If you clear this check box, you can work with function blocks you create in
SmartPlant Instrumentation. The software hides function blocks belonging to
fieldbus devices you previously downloaded.
Relative tolerance — Type a value using a decimal point with `1' preceded by the
number of zeros representing the accuracy that you require, for example: 0.01,
0.0001.
Default folder for XML files — This option applies when you use the SmartPlant
Electrical, DeltaV, or Yokogawa interfaces. Click Browse to select a working folder
in which to keep the .xml files containing your published data.
Task execution — Use these option buttons to determine how the software executes
tasks in the To Do List when the user implements the Run command.
Enable claim and release of basic engineering data — Select this check box to
allow the software to generate tasks for claiming basic engineering data into a project
or releasing claimed basic engineering data back to As-Built.
Enable claim and release of wiring data — Select this check box to allow the
software to generate tasks for claiming wiring data into a project or releasing claimed
wiring data back to As-Built.
Delete failed tasks — Select this check box to allow the software to delete tasks for
which implementation failed.
Activate instrument type profile — When running a task that results in the
creation of a new instrument, if you select this check box, the software applies
instrument type profile options according to the settings specified under Preferences
> Instrument Index > Profile, provided the appropriate options are defined for the
specific instrument type. If you clear the check box, the software creates the
instrument type without applying the profile options.
Display tasks for all plant hierarchy items — Select this check box to display the
tasks for all plant groups in the current plant. Clear the check box to display tasks in
the current lowest plant hierarchy item only.
These preferences determine how the software claims, merges, or copies to the Claim
Buffer or Merge Buffer the sub-items and parent items associated with the items you
select for claiming or merging from the explorer windows. Documentation dealing
with claiming and merging data appears in the Administration module Help. For
common tasks associated with claiming data, see Scoping Data for Projects Common
Tasks in the Administration User's Guide. For common tasks associated with
merging data, see Merging Project and As-Built Data Common Tasks in the
Administration User's Guide.
The following table shows the related data or items that the software can include in
the Claim Buffer or Merge Buffer when you select a main item belonging to a
specific item type.
Notes
• 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 in the
Administration User's Guide. For more information about the Merge
Buffer, see the Administration module Help, Merge Buffer 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.
Include when claiming or merging items
No sub-items — Affects only items you selected in an explorer window. The
associated sub-items are claimed, or copied to the buffer as dummy items. In the
project, dummy items appear as view-only and are marked by a specific color defined
in the Administration module. In the Domain Explorer, dummy items appear with
the indicator . The associated wiring sub-items that do not have a signal (for
example, disconnected terminals or spare wires) are not processed at all. When
merging items, the software ignores dummy items.
Sub items — Allows you to claim, merge, or copy to the buffer the associated sub-
items. After you select this option, you can select any combination of the check
boxes if you want the software to include wiring data when you perform a desired
claim or merge operation using shortcut menu commands of an explorer window.
For example, if you do not select any check box, and then, in the Domain Explorer,
select a loop or a tag, the software includes all the engineering data but does not
include any wiring items that have a signal propagated to the loop or tag. The
engineering data that the software includes consists of process data, calculation,
calibration, dimensional data for piping, and specification sheets, and hook-up
associations. To include these wiring items, you must select the Wiring data of tags
and loops check box.
Note
• When you select a tag for claiming or merging, the basic engineering
data is selected automatically. You cannot claim or merge a specific
instrument, process data sheet, and so forth.
Wiring data of tags and loops — Allows you to claim, merge, or copy to the buffer
all the wiring items that have a signal propagated to the tags and loops you select for
claiming.
Tags and loops with lowest level sub-items only — Only available after you select
Wiring data of tags and loops. Allows you to claim, merge, or copy to the buffer
only the terminals and wires that have a signal propagated to the tags and loops you
select for claiming. The intermediate sub-items are processed as dummy.
Wiring equipment sub-items — Only available after you select Wiring data of
tags and loops. Allows you to claim, merge, or copy to the buffer all the wiring
items that are associated with wiring equipment. For example, if you claim a tag
associated with an apparatus, the software also claims all of the sub-items associated
with the apparatus.
Non-connected terminals and spare wires — Only available after you select
Wiring data of tags and loops. Allows you to claim, merge, or copy to the buffer
the non-connected terminals and spare wires together with the other associated wiring
items that have a signal.
Wires connected to terminals — Allows you to claim, merge, or copy to the buffer
all the wires that are connected to terminals associated with the parent items. For
example, if you claim a panel, the software also claims the panel strips, the terminals,
and the wires that are connected to the terminals.
Note
• If you selected a loop or tag, and also selected the Wiring data of tags
and loops check box, the Wires connected to terminals check box
does not apply to the wiring items associated with the loop or tag. In
this case, the software always claims, merges, or copies to the buffer
all the wires that have signal propagated to the tag.
Fully-functional items — Allows you to claim or copy to the Claim Buffer parent
items as fully-functional items. For example, if you claim an instrument, the source
loop number appears in the project as a fully-functional item.
Note
• When you claim instruments directly from the Instruments folder of
the Domain Explorer, the source loop is always claimed as a dummy
item. In this case, this preference does not apply.
When merging items
Convert parent items to dummy items — Allows you to copy items to the Merge
Buffer and display their parent items in the Merge Buffer as dummy items. When
your Project Administrator merges the items that you copied, the software converts
those parent items that remain in the projects to dummy items. For example, when
merging a strip, the strip is removed from the project and the parent panel remains in
the project as a dummy panel. The software automatically removes the dummy
parent item from the project if this item does not have any other sub-items.
Leave parent items a fully-functional items — Allows you to copy items to the
Merge Buffer and display their parent items in the Merge Buffer as fully-functional
items. When your Project Administrator merges the items that you copied, the
software leaves those parent items that remain in the project as fully-functional items.
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.
Report generator program path — Type the full path and filename or click
Browse to navigate to the InfoMaker executable file.
Enhanced report format — Enables you to specify the file type when generating
enhanced reports using IDEAL. Available options are:
The Domain Administrator can restrict the ability of other users to set their
preferences. Therefore, you can find that certain options are disabled. If you want to
enable these options, contact your Domain Administrator, who can manage
preferences from the Administration module.
• Drag an icon from the Available icons pane and drop it in the
Selected icons pane.
• Drag an icon from the Selected icons pane and drop it in the
Available icons pane.
• Double-click an icon or its name in the Selected icons pane.
• Select an icon and click Remove.
You can look for your tag and loop numbers in the SmartPlant Instrumentation
Explorer or you can use the search facilities provided in the pertinent modules. For
more information, see Search for Items in SmartPlant Instrumentation Explorer, page
233.
While working in a module, you can search for tag or loop numbers in different ways.
You can enter search parameters and find tag or loop numbers that match the search
parameters that you specified. If you do not specify any search parameters, the
software finds all the existing tag or loop numbers in the current <unit>. In the
Process Data and Calibrations modules, you can search for tag numbers either in the
current <unit>, or in all the <units> of the current <plant>. You can also look for
typical tags created in the current domain.
You search for tag numbers in the Find Tag dialog box. There are many cases where
the software opens the Find Tag dialog box. You can look for tag numbers after
clicking Find in dialog boxes that prompt you to enter a tag number. Also, you can
look for tag numbers when opening a process data sheet, when editing, duplicating, or
deleting a tag number, or when calculating or calibrating tag numbers, and so forth.
You search for loop numbers in the Find Loop dialog box. The software opens the
Find Loop dialog box whenever you need to search for a loop number. There are
many cases where the Find Loop dialog box opens: clicking Find in a dialog box
that prompts you to enter a loop number opens the Find Loop dialog box. For
example, you can click Find when you want to edit or duplicate one or more loop
numbers in the Instrument Index module.
Related Topics
• Search for Items in SmartPlant Instrumentation Explorer, page 233
• Searching for Tag and Loop Numbers Common Tasks, page 130
Entering search parameters in the Find Tag dialog box enables you to narrow down
your search. You can narrow your search to the maximum by entering all the search
parameters. It is up to you what search parameters to specify. You can use wildcards
in the fields where you type values.
Leaving some of the Search parameter fields empty widens the search. If you do
not specify any search parameters, the software finds all the existing tag numbers.
After the search is complete, the software displays the tag numbers that match your
search parameters in the Search results data window.
For more information, see Use Search Parameters to Find Tag Numbers, page 132.
Entering search parameters in the Find Loop dialog box enables you to narrow down
your search. You can narrow your search to the maximum by entering all the search
parameters. Leaving some of the Search parameter fields empty widens the search.
It is up to you which search parameters to specify. If you do not specify any search
parameters, the software finds all the existing tag numbers in the current <unit>.
Note that you can use wildcards in the fields where you type values.
After the search is complete, the loop numbers that match your search parameters are
displayed in the Results data window.
For more information, see Use Search Parameters to Find Loop Numbers, page 135.
Related Topics
• Searching for Tag and Loop Numbers: An Overview, page 129
Related Topics
• Searching for Tag and Loop Numbers Common Tasks, page 130
• Searching for Tag and Loop Numbers: An Overview, page 129
3. To broaden the search to include all of the <units> in a given <plant>, select
Look in the entire <plant>.
Tip
• This field is available in the Calibration module, and in the course of
various procedures in the Process Data and Specifications modules.
4. Click Find.
Tip
• Select the Show more search results check box to hide the search
parameter fields and enlarge the Search results data window to
display more tag rows. Clear this check box to return to normal view.
5. In the Search results data window, do one of the following:
• Select the desired tag number.
Related Topics
• Searching for Tag and Loop Numbers Common Tasks, page 130
• Searching for Tag and Loop Numbers: An Overview, page 129
Related Topics
• Searching for Tag and Loop Numbers Common Tasks, page 130
• Searching for Tag and Loop Numbers: An Overview, page 129
3. Select the required loop numbers in the Search results data window and click
OK.
Related Topics
• Searching for Tag and Loop Numbers Common Tasks, page 130
• Searching for Tag and Loop Numbers: An Overview, page
129
Manual (a loop
drawing generated
by using the manual
method
2. If required, select the Fieldbus check box to narrow your search to the loop
numbers that contain tags with a fieldbus I/O type.
3. Click Find.
4. Select one or more loop numbers in the Search results data window.
Tips
• The Select all option is not available when duplicating an existing
loop number.
• Select the Show more search results check box to hide the search
parameter fields and enlarge the Search results data window to
display more loop rows. Clear this check box to return to normal
view.
5. Click OK.
Related Topics
• Searching for Tag and Loop Numbers Common Tasks, page 130
• Searching for Tag and Loop Numbers: An Overview, page 129
To access a supporting table, click next to the list arrow in the relevant dialog box,
or when in the Wiring Module or Instrument Index Module window, click Tables
and then the relevant menu command.
Note that in a multi-user installation, SmartPlant Instrumentation allows only one user
at a time to edit a given supporting table record.
For a detailed list and description of all the supporting tables in the SmartPlant
Instrumentation, see Supporting Tables in SmartPlant Instrumentation, page 139.
Related Topics
• Supporting Tables Common Tasks, page 139
Related Topics
• Supporting Tables in SmartPlant Instrumentation, page 139
• Supporting Tables: An Overview, page 138
Notes
• For the various actions that you can perform with supporting tables,
see Supporting Tables Common Tasks, page 139.
• For the supporting tables used in Telecom, see Supporting Tables for
Telecom, page 147.
Related Topics
• Supporting Tables: An Overview, page 138
Supporting Description
Table
Telecom Allows you to create and manage telecom device types. You define
Device Types the required telecom device type profile for your telecom tag numbers
so that new tags that you create can acquire the necessary properties.
SmartPlant Instrumentation provides a number of predefined telecom
device types, such as AL (alarm), CAM (camera), and so forth. You
can add new telecom device types and modify the shipped ones as
desired. You can also delete a telecom device type that is not in use,
but the software does not let you delete a telecom device type that you
already used to create a tag number.
Telecom Line Allows you to maintain the contents of the Telecom line list when
Numbers creating a telecom field device in the Plug-and-Socket Box wizard
and the Line number list on the Tag Number Properties dialog box.
Telecom Field Allows you to maintain the contents of the Field equipment select list
Equipment on the Tag Number Properties dialog box.
Telecom Allows you to maintain the contents of the Signal level select list on
Signal Levels the Tag Number Properties dialog box.
Panel Sub- Allows you to maintain the contents of the Sub-system select list on
Systems the Equipment Panel Properties dialog box.
Telephone Allows you to define new telephone numbers that you can associate
Numbers with existing switch channels in PABX cabinets.
Telephone Allows you to manage the contents of the Telephone number status
Number select list on the Telephone Number Properties dialog box.
Statuses
Telephone Allows you to manage the contents of the Telephone number usages
Number select list on the Telephone Number Properties dialog box.
Usages
Intercom Allows you to define new intercom numbers that you can later
Numbers associate with amplifiers.
PA Zones Allows you to manage the PA zone definitions which are available for
selection on the Category Properties tab of the Wiring Equipment
Properties (Amplifier) dialog box.
Supporting Description
Table
Alarm Zones Allows you to manage the alarm zone definitions which are available
for selection on the Category Properties tab of the Wiring
Equipment Properties (Amplifier) dialog box.
PABX Allows you to manage the contents of the PABX categories select list
Categories on the PABX Cabinet Properties dialog box.
Note
• For the various actions that you can perform with supporting tables,
see Supporting Tables Common Tasks, page 139.
Related Topics
• Supporting Tables: An Overview, page 138
Related Topics
• Supporting Tables Common Tasks, page 139
Related Topics
• Supporting Tables Common Tasks, page 139
• English (default)
• French (partial translation)
• German (only some terms are translated)
• Custom (for languages other than English, French, or German)
After adding the desired interface language, you can do the following:
Related Topics
• Interface Languages Common Tasks, page 152
Related Topics
• SmartPlant Instrumentation Interface Languages: An Overview, page
150
Related Topics
• Interface Languages Common Tasks, page 152
• SmartPlant Instrumentation Interface Languages: An Overview, page
150
5. Click OK to close the dialog box and change the interface language.
Related Topics
• Interface Languages Common Tasks, page 152
• SmartPlant Instrumentation Interface Languages: An
Overview, page 150
interface language, for example: ~, &. For details, see Prefixes and
Suffixes in the Interface Text, page 157.
Related Topics
• Interface Languages Common Tasks, page 152
• SmartPlant Instrumentation Interface Languages: An Overview, page
150
The software allows you to add a revision to a specific report, drawing, or item , for
example, to a specific I/O card in the Wiring module. You add revisions to reports in
the report print preview and to items in the dialog boxes where you can edit the item
properties. Also, you can create global revisions.
In the Administration module, in the Report Management dialog box, the Domain
Administrator has rights to define revision management settings individually for each
report that you can generate in SmartPlant Instrumentation.
In the database, each report is assigned to the report type, which can be a list or a non-
list type report. The report type determines how you 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 SmartPlant Instrumentation users to manage
revisions either per document or per item .
In accordance with the revision management setting, you 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).
Regardless of the revision management setting, any document numbers and revisions
that you create in the software are shared with the document numbers and revisions
created for the same items in the Enhanced Report Utility. For example, a drawing
created in the Enhanced Report Utility automatically inherits the same document
number and revision that you assigned to an Enhanced SmartLoop report generated in
SmartPlant Instrumentation.
To place issue data on title blocks for enhanced reports, use the Place Drawing
Property Label command in the Enhanced Report Utility. For more information, see
Place Property Labels on a Drawing Sheet in the Enhanced Report Utility User's
Guide, under Working with Templates and Title Blocks.
At the first stage of applying global revisions, you select a revision activity, and
define the default revision settings, such as revision values, numbering method, and
revision details. At the second stage, you select the required items in a specific
module, and apply the defined revision settings.
• Add revision - select the required numbering method and add a new
revision.
• Update revision - change the existing revision value without changing
the numbering method. For example, you can update a revision from
A1 to A2.
• Upgrade revision - involves changing the revision numbering method.
For example, you can upgrade a revision from P0 to A.
• Delete revisions - delete all revisions for the selected items.
• Delete last revision - delete only the last revision.
You can add global revisions to non-list-type reports for which the Domain
Administrator selected the Per Document revision management setting in the Report
Management dialog box.
An exception is Enhanced Report Utility reports, which are always assigned to the
Per Item revision management setting. The document number and global revision
that you create in SmartPlant Instrumentation are shared with the document number
and revision created in the Enhanced Report Utility.
Note
• Items that have archive options defined as Save to database, any
revisions are only saved to the archive after closing the Global
Revisions dialog box. Adding a revision and then deleting the
revision, before closing the dialog box, results in the revision not being
archived.
Related Topics
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158
Related Topics
• Global Revisions: An Overview, page 159
• Revision Management: An Overview, page 158
Related Topics
• Global Revisions: An Overview, page 159
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158
• In the Revised by field, enter the initials of the person performing the
revision. The default is the current user's initials, if previously defined
by the System Administrator.
• In the Date field, enter the date of revision, if required.
• Fill out the other fields as needed.
6. Click the appropriate module tab to apply the defined settings. For details, see
Upgrade Revisions Globally, page 166.
Tips
• If you accessed the Global Revisions dialog box from the main
SmartPlant Instrumentation window, tabs for multiple modules are
available; if you accessed the dialog box from a particular module,
then only the Settings tab and the tab for that module are available.
• If you are working in an integrated environment, then regardless of
where you access this dialog box from, the following tabs are disabled:
Specifications, Process Data, Loops, and Dimensional Data.
Related Topics
• Global Revisions: An Overview, page 159
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158
• Revision Upgrade Example, page 167
Tips
• If you accessed the Global Revisions dialog box from the main
SmartPlant Instrumentation window, tabs for multiple modules are
available; if you accessed the dialog box from a particular module,
then only the Settings tab and the tab for that module are available.
• If you are working in an integrated environment, then regardless of
where you access this dialog box from, the following tabs are disabled:
Specifications, Process Data, Loops, and Dimensional Data.
6. In the data window, filter the items as needed. For details, see Filter Items for
Global Revisions, page 162.
7. In the data window, do one of the following to select the items whose revisions
you want to update:
• Select the desired tag numbers (hold down Ctrl or Shift to make
multiple selections).
• Select the Select all check box to select all the tag numbers in the data
window.
8. Click Apply to apply the new revision value to all the selected items in batch
mode.
9. If you want to update revisions for other modules, repeat the appropriate steps for
each module.
Related Topics
• Global Revisions: An Overview, page 159
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158
• Select the desired tag numbers (hold down Ctrl or Shift to make
multiple selections).
• Select the Select all check box to select all the tag numbers in the data
window.
5. Click Apply to apply the new revision value to all the selected items in batch
mode.
6. If you want to upgrade revisions for other modules, repeat the appropriate steps
for each module.
Previous 1 2 2 Comments
None P0 A B First revision uses initial numbering method (P0); subsequent
revisions use switch to numbering method (A, B, and so
forth.)
P2 A B C First and subsequent revisions use switch to numbering
method (A, B, and so forth.)
A B C D Incremented by one step each time from the previous revision
B C D E Incremented by one step each time from the previous revision
1 2 3 4 Incremented by one step each time from the previous revision
2 3 4 5 Incremented by one step each time from the previous revision
Related Topics
• Global Revisions: An Overview, page 159
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158
• Upgrade Revisions Globally, page 166
2. On the Settings tab of the Global Revisions dialog box, from the Activity list,
select one of the following:
• Delete revisions — select to delete all revisions for the selected
items.
• Delete last revision— select to delete the last saved revision for each
selected item .
3. Click one of the following tabs: Specifications, Process Data, Calculations,
Loops, Hook-Ups, Wiring, or Dimensional Data.
Tips
• If you accessed the Global Revisions dialog box from the main
SmartPlant Instrumentation window, tabs for multiple modules are
available; if you accessed the dialog box from a particular module,
then only the Settings tab and the tab for that module are available.
• If you are working in an integrated environment, then regardless of
where you access this dialog box from, the following tabs are disabled:
Specifications, Process Data, Loops, and Dimensional Data.
4. In the data window, filter the items as needed. For details, see Filter Items for
Global Revisions, page 162.
5. In the data window, do one of the following to select the required items:
• Select the desired tag numbers (hold down Ctrl or Shift to make
multiple selections).
• Select the Select all check box to select all the tag numbers in the data
window.
6. Click Apply to delete the revisions for the selected items.
7. If you want to delete revisions for other modules, repeat the appropriate steps for
each module.
Related Topics
• Global Revisions: An Overview, page 159
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158
Tip
• If you select a revision numbering method other than preliminary
revisions (P0, P1, P2...), you will not be able to return to the
preliminary revision method and this option will be disabled.
2. If needed, in the Drawing number field, type the number of the document
associated with the item for which you create the revision. In drawings and
reports, this number appears in the title block.
3. Click New to add a new revision.
Tips
• If you are working in an integrated environment in a module that
supports publishing and retrieving of documents, clicking New opens
the Revise dialog box for the integrated environment instead of the
SmartPlant Instrumentation Revisions dialog box.
•The software automatically increments the revision number according
to the selected revision method. You can overwrite SmartPlant
Instrumentation revisions if desired.
4. Add or edit the revision data as needed.
Note
• If the document for which you are making a revision contains a
custom-title block, the User-defined fields data window becomes
available for you. In this data window, you can view the user-defined
fields that you added to the custom title block that you created.
Related Topics
• Global Revisions: An Overview, page 159
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158
• View an Archived Revision, page 171
Related Topics
• Global Revisions: An Overview, page 159
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158
Related Topics
• Revision Management Common Tasks, page 160
• Revision Management: An Overview, page 158
When comparing reports, you can generate a comparison report to view the report
fields in which the values are different.
Notes
• Report comparison is only available if the System Administrator has
selected Audit trail options in the Domain Definition window for the
current domain, and if the Domain Administrator has selected one of
the options for saving revisions of the specified report in the Report
Management dialog box in the Administration module.
• For enhanced reports, you must perform revisions from the Enhanced
Report Utility if you want them to be archived for performing report
comparison.
• You cannot perform report comparison for Powersoft browsers.
Using report comparison, you can do the following:
Related Topics
• Report Comparison: An Overview, page 172
Related Topics
• Report Comparison: An Overview, page 172
The software does not display data changes in the following cases:
• If you add a new item such as a panel or gland in list reports, because
the software cannot determine whether the item is part of the
document.
• If you remove or assign tags or items in the Hook-ups module.
• For the Instrument Index Drawing Summary Browser. Changes that
you make in the Instrument Index Standard Browser are included in
the Browse - Instrument Index Report item, and not in the
Instrument Index under the list of browser
Workflow
The Workflow option enables instrument engineers to control the data entry process
for instrument tags by specifying if and when process data should be entered for a
particular tag. Workflow defines an additional level of access rights for individual
instrument tags, determined by the Workflow status of the tags. In this way, an
instrument engineer, while working on instrument data for a particular tag, can lock
out process engineers from making changes to process data until all the instrument
data has been entered.
Example Scenario
The following stages describe a typical Workflow scenario:
1. An instrument engineer creates a new instrument tag and determines whether or
not the tag requires process data. In the event that the instrument tag does require
process data, the process data fields of the tag become available to the process
engineers for editing.
2. The process engineer, after first accessing the instrument tag for editing of
process data, can lock the process data fields against any changes wherever the
instrument engineers have access rights.
3. On being released by the process engineer, the instrument engineer can now enter
instrument data as required. The instrument engineer can lock the tag against any
changes wherever the process engineers have access rights.
Related Topics
• Create a Workflow Browser, page 180
• Implementing Workflow, page 181
• Process Data Statuses, page 183
• Workflow Prerequisites, page 179
Workflow Prerequisites
Before you can implement Workflow in a given <unit>, the System Administrator and
Domain Administrator need to perform the following tasks:
Related Topics
• Implementing Workflow, page 181
• Process Data Statuses, page 183
• Workflow Prerequisites, page 179
• Workflow, page 178
Implementing Workflow
Workflow implementation begins when the instrument engineer who is going to work
on particular instrument tags determines whether those tags require process data.
Next, those tags that do require process data are assigned to a process engineer for
process data input. On completion of the data input, the tags are reassigned to the
instrument engineer for instrument data input.
Related Topics
• Create a Workflow Browser, page 180
• Implementing Workflow, page 181
• Workflow, page 178
Related Topics
• Editing Document Headers, page 191
• Modifying Printer Settings, page 189
• Previewing Documents, page 185
• Printing Documents, page 187
• Saving Documents, page 190
Previewing Documents
The option to preview a document is available whenever you select a report, a point-
to point wiring diagram for printing, or if you select the Print Preview option from a
browser view.
Note
• The Print Preview dialog box appears only after you select Always or
Ask user in the General tab of the Preferences dialog box.
The Print Preview dialog box appears only after you select Always or Ask user in
the General tab of the Preferences dialog box.
Preview a Document
1. Select the report you want to display and when prompted to preview the report,
click Yes.
2. Click to adjust the currently displayed report's magnification level.
3. In the Zoom dialog box, do one of the following:
• In the Magnification section, select a predefined magnification level:
200%, 100% (the default level), 65%, or 30%.
• Type the required magnification level in the field next to the Custom
option button.
4. Click OK to return to the Print Preview window at the selected magnification.
Related Topics
• Modifying Printer Settings, page 189
• Printing Documents, page 187
• Saving Documents, page 190
Printing Documents
Depending on the options you selected, printing is available directly when you select
a document for printing, or you can print a document from a print preview. This
procedure refers to general printing. For details of batch printing to .pdf files, see
Previewing Documents, page 185.
Note
• If your default printer is Acrobat PDFWriter, you must perform the
following operation in the Registry Editor: in the registry path
HKEY_CURRENT_USER\Software\Adobe\Acrobat PDFWriter, set
the SZ Busy key value to NULL.
Print Documents
1. Select the desired items from which you can print reports, and on the appropriate
main menu or, if available, on a shortcut menu, click the report that you want to
print.
2. If a print preview prompt appears, do one of the following:
• Click Yes to display a print preview of one or more reports.
• Click No to print the reports directly to a printer or a file.
3. To print a report from a print preview to a printer or a file, do one of the
following:
• Enhanced reports.
• Specification sheets.
• Binder packages from the Document Binder module. For details, see
Printing from a Binder Package to a PDF File, page ???.
Related Topics
• Modifying Printer Settings, page 189
• Previewing Documents, page 185
• Printing Documents, page 187
• Saving Documents, page 190
Notes
• All your page settings apply to all reports and documents that you print
and they are true for all plant hierarchy levels (domain, <plant>,
<area>, and <unit>).
• All your page settings apply to your local machine only and do not
affect other users of SmartPlant Instrumentation.
• If you want to change the page setup for the current print session only,
do not click Default, just make your changes and click OK.
When saving your settings as default, the software stores the values in the Intools.ini
file under the [PRINTER] section. If you want the software to calculate the required
paper size from the Windows printer driver settings, open the Intools.ini file and
under the [PRINTER] section, remove the semi-colon before the following
parameters:
• LEFTMARGIN
• RIGHTMARGIN
• TOPMARGIN
• WIDTH
• HEIGHT
• ORIENTATION
• HRES
• VRES
Add a semi-colon before the PAPERSIZE parameter.
For additional information about this option, click Help in the Page Setup dialog
box.
Related Topics
• Previewing Documents, page 185
Saving Documents
When you display a document, you can choose to save it as a file. This section
describes the various methods available for saving documents.
Related Topics
• Editing Document Headers, page 191
If a report has several pages, the software creates several .dxf files. A .dxf file can
only contain a single page of a report.
Important
• When saving a multi-page specification in .dxf format, the software
only saves the active page of the spec print preview. To save all pages
of a spec in .dxf format, you must display a print preview of each page
and save the pages one by one.
• It is not possible to save the multi-tag (SEE LIST) page of a multi-tag
spec in .dxf format.
Claiming items is the final stage of defining the project scope. Before claiming items,
you can copy them to the Claim Buffer, which is only available in the
Administration module. Then, your Project Administrator can log on to the
Administration module and claim the copied items for the project in batch mode.
Alternatively any user with full Project Definition access rights can claim the copied
items using command line parameters.
Any SmartPlant Instrumentation user can copy any number of items to the Claim
Buffer, however, only users with full Claim Items for Project access rights can
claim As-Built items directly from the project opened in SmartPlant Instrumentation,
without copying them to the Claim Buffer first, provided that the Claim Buffer is
empty. Performing a batch claim of As-Built items directly from the project is not
possible. You can only claim a specific item that you select, with or without its child
items, according to the preferences.
When the As-Built item used as a source for claiming has child items, you can set
preferences to include or exclude the child items when claiming the parent item. For
example, you can claim a cable with or without its associated cable sets or wires. It is
also possible to reclaim the same item to update the item properties with the As-Built
item properties. For details about the preferences for claiming see Claim and Merge
Options (Preferences), page 123.
In a project, claiming options are available in the Instrument Index module, Browser
module, and the Domain Explorer:
• In the Instrument Index module, you can select instruments and claim
them with the engineering data defined in other modules, for example,
with the associated hook-ups.
• In the Browser module, you can select instruments, lines, loop
numbers, or equipment data for claiming.
• In the Domain Explorer, you can select any item and copy it to the
Claim Buffer for further processing by your Project Administrator, or
claim the items according to the preferences set on the Claim and
Merge Options page of the Preferences dialog box. Note, however,
that if you want to claim fieldbus tags, you only need to claim the
associated fieldbus segments with their sub-items and the fieldbus tags
are claimed automatically.
Related Topics
• Claiming and Merging Items Common Tasks, page 198
• Display As-Built and Project Data, page 199
• Working with SmartPlant Instrumentation: An Overview, page 45
• Working with the Domain Explorer: An Overview, page 207
Before you copy items to the Merge Buffer, you can set preferences to include or
exclude the child items when copying the parent item. For example, you can copy a
cable with or without its associated cable sets or wires. For details about the
preferences for copying items to the Merge Buffer, see Claim and Merge Options
(Preferences), page 123.
When copying items to the Merge Buffer, you select a merge action for all or
selected items. At this stage, the software applies the merge action to the items and
also applies the preferences options that you have set. The following actions are
available per item:
Merge now — Overwrites the data in As-Built with the modified data in the current
project. The results depend on the change made in the project:
• The Release Claim action does not apply to new items that you create
in the project.
• The Release Claim action does not apply to new sub-items you
associated with a claimed item.
• If a claimed item does not have new sub-items you created in the
project, the software removes the claimed item from the project even if
you changed its name and description in the project.
• If a claimed item has new sub-items you created in the project, the
software always leaves this claimed item as a dummy item in the
project.
• If a claimed item has both claimed sub-items and new sub-items you
created in the project, the software only removes the claimed sub-
items from the project. The parent item appears in the project as a
dummy item.
Notes
• Your Project Administrator can merge items using one of the two
modes set by System Administrator for the current domain: with
deletion from the project or without deletion from the project.
Depending on the merge mode, on merging data, the software either
deletes the merged items from the project or leaves view-only copies
of the merged items 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.
• If you want to merge fieldbus tags, you only need to copy to the
Merge Buffer the associated fieldbus segments with their sub-items.
It is not possible to merge fieldbus tags manually.
Related Topics
• Claiming and Merging Items Common Tasks, page 198
• Display As-Built and Project Data, page 199
• Working with SmartPlant Instrumentation: An Overview, page 45
• Working with the Domain Explorer: An Overview, page 207
Related Topics
• Claiming As-Built Items for a Project: An Overview, page 194
• Preparing Project Items for Merging with As-Built: An Overview, page
196
2. Double-click the appropriate project icon to select the project you want to
work with (As-Built or a project).
• To view As-Built data only, select As-Built from the list.
• To view project data, select any project from the list (you can choose
afterwards whether to display As-Built data with the project data –
see steps 4 and 5 for details).
3. Select the <unit> in which you want to work and click OK. By default,
SmartPlant Instrumentation opens with data visible only from the project you
selected.
4. To display As-Built and project data together, do one of the following:
• Click .
• Click File > As-Built Data.
5. To return to the display of project data only, do one of the following:
• Click .
• 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.
Related Topics
• Claiming and Merging Items Common Tasks, page 198
• Claiming As-Built Items for a Project: An Overview, page 194
Related Topics
• Claiming and Merging Items Common Tasks, page 198
• Claiming As-Built Items for a Project: An Overview, page 194
Tips
o If the items that you select already appear in the Merge Buffer, when
copying the items, the software also changes the merge action to
Merge Now for those items.
o When you copy items to the Merge Buffer, in addition to the main
items you select, the software can select the associated sub-items
automatically, or you have the option to include the sub-items
manually with the main item by setting preferences accordingly. For
details, see Claim and Merge Options (Preferences), page 123.
o If you copied to the Merge Buffer a loop or instrument together with
the wiring items, the software only copies those wring items that have
a signal propagated to the loop or instrument. If you placed a device
panel inside a cabinet or junction box, when merging the loop, this
device panel is not copied together with the cabinet or junction box
because this device panel does not have a signal propagated to the
loop. You must select and copy such a device panel manually.
Related Topics
• Claiming and Merging Items Common Tasks, page 198
• Claiming As-Built Items for a Project: An Overview, page 194
• Preparing Project Items for Merging with As-Built: An Overview, page 196
o When you copy items to the Merge Buffer, in addition to the main
items you select, the software can select the associated sub-items
automatically, or you have the option to include the sub-items
manually with the main item by setting preferences accordingly. For
details, see Claim and Merge Options (Preferences), page 123.
• If you copied to the Merge Buffer a loop or instrument together with the
wiring items, the software only copies those wring items that have a signal
propagated to the loop or instrument. If you placed a device panel inside a
cabinet or junction box, when merging the loop, this device panel is not
copied together with the cabinet or junction box because this device panel
does not have a signal propagated to the loop. You must select and copy such
a device panel manually.
Related Topics
• Claiming and Merging Items Common Tasks, page 198
• Claiming As-Built Items for a Project: An Overview, page 194
• Preparing Project Items for Merging with As-Built: An Overview, page 196
Note
• When you create an item in the domain explorer, make sure you set the
naming convention for it in the Administration module. For details see
Naming Conventions: An Overview in the Administration User's
Guide, under Domain and Project Administration.
The Domain Explorer enables you to perform almost all the actions that are possible
in the SmartPlant Instrumentation modules. For example, you can create new tag
numbers, edit their properties, create and edit wiring items, open the Connection
window to make wiring connections, generate various data sheets, reports, and so
forth. You can drag items from the Reference Explorer to the Domain Explorer
and in this way create numerous items based on reference configurations on the fly.
Also, you can drag items from the Domain Explorer to the Reference Explorer to
create reference items based on existing configurations.
Working with the Domain Explorer is another mode of working with SmartPlant
Instrumentation, just like working with SmartPlant Instrumentation modules.
You can open the Domain Explorer from anywhere in SmartPlant Instrumentation.
Press F7 or on the Tools menu, click Domain Explorer.
Tips
• Depending on the access rights that have been granted to you, the
Domain Explorer allows you to perform actions with SmartPlant
Instrumentation items that belong to all the existing <plants> in your
domain and not just with the items in the plant that you have currently
logged in.
• You can expand the hierarchy of any <unit> and view the item
structure. However, specification, process data, or calculation sheets
are only accessible from the <unit> you have logged on to. Process
data, specification, and calculation sheets of items belonging to
<units> that you are not logged to are not accessible even for viewing.
The tree view pane of the Domain Explorer shows instrumentation items organized
by folders. SmartPlant Instrumentation defines standard folders in the database. You
cannot move or delete these folders, nor can you add new folders. Each folder
contains a particular item type, and the options available on the menus depend on the
currently selected item type.
For a detailed explanation of all the folders and their organization in the Domain
Explorer, see The Organization of Items in the Domain Explorer Tree View, page
212.
Item status indicators — the software uses various icons beside a folder or item to
indicate the status of a folder or an item , for example access denied, view only, an
item that belongs to As-Built, and so forth. For the full list of the item indicators,
see Item Status Indicators in the Domain Explorer, page 229.
Notes
• You can open several instances of the Domain Explorer by pressing
F7.
• After exiting SmartPlant Instrumentation, and starting a new session,
the software retains the size and position of all the windows that were
open in the previous session.
• Some SmartPlant Instrumentation modules have their own Explorers.
These are just limited views of the Domain Explorer and they contain
items specific to their modules. For details, see SmartPlant
Instrumentation Explorer: An Overview, page 206.
Related Topics
• Association Rules in the Domain Explorer, page 225
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206
Duplicate an Item
You use this action to create a duplicate item within the same parent hierarchy. That
is, the software creates another copy of the selected item under the immediate parent
item. For example, if you need to insert an apparatus within an existing apparatus
group, expand an apparatus group and duplicate an apparatus. You can then change
the sequence numbers of the apparatuses to re-arrange them on the strip the way you
require. Furthermore, if you are duplicating a panel or another item that contains
child items, the software duplicates this item in its entirety. That is, SmartPlant
Instrumentation creates the new item with exactly the same child items as the original
panel. Note that in this case, the software also retains all the existing internal
connections if you selected Copy internal connections in the wiring preferences.
For more information, see Duplicate an Item, page 230.
Note that the same rules apply when you want to move an item in the Reference
Explorer. If you drag an item from the Reference Explorer to the Domain
Explorer or vice versa, SmartPlant Instrumentation creates a copy of that item and
retains the selected one in its original place. If you open another instance of the
Domain Explorer and drag an item from one Domain Explorer window to another,
the same rules apply as when you drag an item within the same Domain Explorer
window.
For more information, see Move an Item in the Domain Explorer, page 231.
Delete Items
This procedure shows how to delete the items that you select in the Domain
Explorer. For more information, see Delete Items, page 231.
For more information, see Find an Item in the Tree View of an Explorer Window,
page 234.
Also, you can filter the items so that the software displays only those items that
belong to the current lowest plant group and only those items that were created by the
current user of SmartPlant Instrumentation. You can use these two filtering options
on their own or in concurrence with another filter definition.
Filter settings take effect only for the user who defined the filter and only for the
current custom view of the active Explorer window.
Note that item type filters override your item name filters.
For more information, see Filter the Display of Items According to a Specific Item
Type, page 236.
Also, you can filter the items so that the software displays only those items that
belong to the current lowest plant group and only those items that were created by the
current user of SmartPlant Instrumentation. You can use these two filtering options
on their own or in concurrence with another filter definition.
You can define an item name filter only if you do one of the following:
For the rules that govern the dragging of items in the Domain Explorer, see
Association Rules in the Domain Explorer, page 225.
Loops
Loops are arranged at the lowest level of the plant hierarchy. You can navigate to a
loop by expanding the plant hierarchy. Continue expanding your plant hierarchy to
display the Loops folder that contains all the existing loops in the current <unit>.
Loops, in turn, can contain loop blocks used in CAD loop drawing generation,
instruments and control system tags. Instruments can contain instrument blocks used
in CAD loop drawing generation. For more information, see Items in the Loops
Folder, page 222.
Instruments
Instrument tags are arranged at the lowest level of the plant hierarchy in the
Instruments folder. You can navigate to a tag number by expanding the plant
hierarchy. Continue expanding your plant hierarchy to display the Instruments
folder that contains all the existing tag numbers in the current <unit>. Instrument
tags can be parent items of CS tags, maintenance event record, specifications, process
data sheets, and any other documents that are associated with a selected instrument
tag.
Electrical Tags
This folder holds all the tag numbers that have either been published to SmartPlant
Instrumentation from SmartPlant Electrical or that you have created for the purpose
of representing electrical signals. You can associate these tags with items under the
Electrical Equipment folder and publish the items with these associations back to
SmartPlant Electrical.
Panels by Location
Panels are arranged according to their location and category. In this folder, panels are
arranged according to their location. You can perform the following actions:
Panels by Category
In this folder, panels are arranged according to their category. Panels, in turn, contain
their child items, for example terminal strips, racks, wiring equipment, and so forth.
There is a lot of flexibility in creating a panel hierarchy. There is no rigid structure
like "panel – strip – terminal" that limits your wiring design. You can create
various wiring structures, as you require. See Panels by Category Hierarchy
Examples, page 215 to examine a few possible structures.
Cables
This folder holds all the existing cables. You can create various child items under
cables. For an example, see Cable Hierarchy Example, page 218.
Cross Cables
This folder holds all the cross wiring cables and wires. You can create new cross
cables and cross wires as you require.
Lines, hook-ups, process equipment, P&IDs, and so forth are organized in separate
folders at the top hierarchy level of the tree view.:
Telecom Equipment
This folder holds all the available telecom equipment cabinets classified by their
categories: PA Cabinets, PABX Cabinets, Miscellaneous, Hubs, Amplifiers, and
Intercoms. Each folder displays the existing equipment cabinets belonging to that
category. You cannot create new cabinets in the Telecom Equipment folder. To
create a new equipment cabinet, expand the following hierarchy: Panels by Category
> Telecom Panels > Equipment Cabinets. Then, right-click the Equipment
Cabinets folder, point to New and click the command that you require.
Process Equipment
This folder displays all the existing equipment that your instruments are installed on.
Equipment is also categorized according to different types, such as compressors,
burners, pumps, and so on. You can right-click this folder and create new process
equipment. Then, you can create an instrument by right-clicking an equipment item.
Lines
This folder holds all the existing lines in your <plant>. After right-clicking a line,
you can add a new instrument.
Fieldbus Segments
This folder contains all the segments, their associated tag numbers and virtual tags
that exist in your fieldbus system. All fieldbus items are arranged in a tree-like
hierarchy that can be expanded and collapsed. For details, see Fieldbus Segments in
the Domain Explorer, page 218.
Hook-Ups
This folder holds all the existing hook-up types, hook-ups, and their child items. For
details, see Items in the Hook-Ups Folder, page 220.
P&IDs
This folder displays all the existing P&ID document references. You can right-click a
P&ID document reference and create a new instrument, loop, and line.
Controllers
This folder displays all the existing controllers and their child items. You cannot
create new controllers in this folder, but you can select a slot and add a terminal strip,
an I/O card, or any other wiring equipment item.
Electrical Equipment
This folder holds all the items of electrical equipment that have been retrieved from
SmartPlant Electrical. In this folder, you can view the items and associate them with
electrical signals. For details, see Items in the Electrical Equipment Folder, page
220.
Test Equipment
This folder displays all the items of test equipment that have been created in
SmartPlant Instrumentation.
Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206
Example 1:
Example 2:
Example 3:
Example 4:
Example 5:
Related Topics
• Domain Explorer Common Tasks, page 209
Related Topics
• Domain Explorer Common Tasks, page 209
All fieldbus items are arranged in a tree-like hierarchy that can be expanded and
collapsed:
Icon Explanation
Foundation Fieldbus segment that contains all the associated instruments and
virtual tags
Profibus DP segment that contains all the associated instruments and virtual tags
Profibus PA segment that contains all the associated instruments and virtual tags
Fieldbus instrument associated with a segment
Function block associated with a fieldbus instrument
Virtual tag associated with a fieldbus instrument
Related Topics
• Domain Explorer Common Tasks, page 209
You can expand or collapse the levels to view the existing items. To perform an
action, right-click the Drawing Block Types folder, a specific block type or a block,
and then click a command. The software uses various icons beside a folder or item to
indicate the status of a folder or an item , for example a view-only item, a claimed
item , an item that belongs to As-Built, and so forth. For the full list of the item
indicators, see Item Status Indicators in the Domain Explorer, page 229. For a
detailed explanation of the tree view and Items panes, see Working with the Domain
Explorer: An Overview, page 207.
In the Drawing Block Types folder, the items appear in two levels, based on the
relationship among them.
Level 1
Drawing Block Types
This is the highest level in the Drawing Block Types folder hierarchy. At this level,
the software displays all the drawing block types that exist in the current domain and
allows you to add general and instrument block types and manage block type
properties.
Level 2
Drawing Blocks
CAD blocks appear under block types. Blocks do not contain child items. You can
add new blocks or delete blocks that are not in use.
There are several sub-folders available for the following categories of electrical
equipment:
Related Topics
o Domain Explorer Common Tasks, page 209
o SmartPlant Instrumentation Explorer: An Overview,
page 206
The software arranges the items based on the relationship among them. The display
rules follow a rigid structure of the following four levels.
Level 1
Hook-Up Types and Hook-Ups
This is the highest level in the Hook-Ups folder hierarchy. At this level, the software
displays both all the hook-ups types and hook-ups that exist in the current domain.
Hook-up types are shown as and hook-ups as .
Hook-up types contain hook-ups for instruments sharing similar features, for
example, Control, Measure, Flow, and so forth. For each hook-up type, on the
shortcut menu, you can click New to add hook-ups. At this level, you can only create
one hook-up at a time. Also, you can move hook-ups from one hook-up type to
another, assign instrument tags and hook-up items. To assign tag numbers, on the
shortcut menu, click Actions > Associate Tag Numbers with Hook-Ups. To assign
hook-up items, on the shortcut menu, click Actions > Associate Items with Hook-
Ups. Also, at this level, you can generate various hook-up reports, a Bill of Material,
and hook-up drawings.
Level 2
Hook-Ups
Hook-ups (shown as ) appear under hook-up types. At this level, you can create
hook-ups in batch mode by duplicating existing hook-ups you select in the Items
pane. You can move hook-ups from one hook-up type to another, assign instrument
tags and hook-up items. To assign tag numbers, on the shortcut menu, click Actions
> Associate Tag Numbers with Hook-Ups. To assign hook-up items, on the
shortcut menu, click Actions > Associate Items with Hook-Ups. Also, at this level,
you can generate various hook-up reports, a Bill of Material, and hook-up drawings.
Level 3
Hook-Up Items
Hook-up items (shown as ) appear under hook-ups. Hook-up items do not contain
child items. To assign hook-up items to hook-ups, use a shortcut menu command
available at the level of hook-ups or hook-up types. You cannot create or delete
hook-up items in the Domain Explorer. Hook-up item management options are only
available in the Hook-Up Item Libraries folder of the Reference Explorer.
Instruments
Instruments (shown as ) appear under hook-ups. Instruments can contain
document assigned to instrument specs, process data, or calculation sheets. Also,
instruments can contain control system tags. You create documents and control
system tags in the appropriate modules of SmartPlant Instrumentation. To assign
instrument tag numbers to hook-ups, use the shortcut menu command available at the
first or second level of the folder hierarchy.
Level 4
Control System Tag
Control system tags (shown as ) appear under instruments at the lowest level of the
Hook-Ups folder hierarchy. It is possible to assign control system tags to instruments
when performing I/O assignment.
Documents
Documents (shown as ) appear under instruments at the lowest level of the folder
hierarchy. You define documents when creating specs, process data sheets, or
calculation sheets. You can modify or delete document data in the module pertaining
to the document displayed. For example, if you delete an instrument specification
from the Specifications module, the software automatically removes the document
from the Hook-Ups folder. Use the shortcut menu command to open documents.
The software opens the document in the module in which the document was created.
Instrument Blocks
Instrument blocks are represented by icons and . In the Hook-Ups folder,
instrument block options are not in use because they are only used in a CAD loop
drawing generation. You manage instrument blocks in the Loops folder.
Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206
To perform an action, right-click the Loops folder or an item and then click a
command. Note that the software uses various icons beside a folder or item to
indicate the status of a folder or an item , for example a view-only item , a claimed
item , an item that belongs to As-Built, and so forth. For the full list of the item
indicators, see Item Status Indicators in the Domain Explorer, page 229. For a
detailed explanation of the tree view and Items panes, see Working with the Domain
Explorer: An Overview, page 207.
The software arranges the items in three levels based on the relationship among them.
Level 1
Loops
This is the highest level in the Loops folder. This hierarchy level contains all the
loop numbers existing at the current highest plant hierarchy level. Loops are
indicated with the icon.
Loops contain tag numbers, which in turn contain blocks. For each loop, on the
shortcut menu, you can click New to add instruments. Also, you can assign
documents to loops. These documents are associated with drawings that you generate
for the loop. Loops can display annotations which refer to the generation method you
assigned for that loop, for example, C indicates a CAD method, M indicates a manual
method (intended for generation without using SmartPlant Instrumentation options).
Level 2
Instruments
The second hierarchy level contains all the instrument tag numbers that are associated
with the existing loops. Instruments are shown as .
If you use a CAD application to generate loop drawings, under instrument tags, you
can add instrument blocks using the following block assignment methods:
Loop Blocks
If you use a CAD application to generate loop drawings, at the second level of the
Loops folder hierarchy, you can assign CAD drawing blocks to the loop. Loop
blocks are indicated with the icon.
In the Domain Explorer, you create and manage loop blocks in the Drawing Block
Types > Loop Block folder.
Documents
The second hierarchy level contains all the documents that are associated with the
loop drawings you generated. Documents are indicated with the icon.
The software assigns a document number to a loop on loop creation. However, in the
Loops folder, the software only displays a document number after generating a
drawing for a loop. You can view and modify document numbers using options of
the Loop Drawing List dialog box, which you can open using a shortcut menu
command.
Level 3
Instrument Blocks
Instrument blocks, which are used in a CAD loop drawing generation, are the lowest
level in the Loops folder hierarchy. The displayed blocks are those blocks that you
associated with the instrument tag numbers according to the method of association.
The block icons that the software displays depend on the block assignment method:
Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206
Notes
1. I/O cards cannot be moved if they function as primary or secondary I/O cards.
2. Wiring equipment connectors cannot be moved to cables.
3. Cable connectors can only be moved to other cables. This is possible only if none
of the connector pins are associated with wires.
4. Terminal strips cannot be moved if:
• They are used in instrument type profile definition.
• They are associated with Auto-Wiring tasks.
• They are associated with CS tags.
• They are associated with general or local signals.
Special Conditions
• The software does not allow you to drag items to incompatible
hierarchies. For example, you cannot drag a rack to device
panel or a plug-and-socket junction box.
• The software does not allow you to move an item that contains
a child item that cannot be moved. For example, you cannot
move a rack if it contains an I/O card that functions as a
primary or secondary I/O card for an I/O termination.
• In an owner operator domain, you cannot move items that have
not been claimed for the current project.
Related Topics
• Domain Explorer Common Tasks, page 209
Icon Description
An item that belongs to the current project.
An item that belongs to As-Built. When working in a project with As-Built
items displayed, As-Built items are view-only. In the Domain Explorer, you
can select an As-Built item and display its properties.
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 a example, a hook-up type.
An item that cannot be deleted, duplicated, and under which no child items can
be created. However, you can edit the item properties and move the item to
another hierarchy level.
Access denied.
View-only. The item is marked as view-only if it has not been created using the
Domain Explorer. You cannot delete such an item or manage the item
properties using the Domain Explorer options. For example, a document, such
as a specification is always marked as view-only. However, you can open the
spec print preview and make changes as you require.
An item that cannot be deleted, duplicated, moved to another hierarchy level,
and under which no child items can be created. However, you can edit the item
properties.
An As-Built item that has been claimed for a project.
Indicates that a folder or parent hierarchy item has been filtered according to an
item type.
Indicates that a folder or parent hierarchy item has been filtered according to an
item type name.
Notes
• An item without any indicator denotes an item that is not
supported by the Domain Explorer. The software allows you
to perform actions with such items only from the pertinent
SmartPlant Instrumentation modules.
• The software does not use item indicators in the Reference
Explorer.
Duplicate an Item
1. Do one of the following
• Press F7 to open the Domain Explorer.
• Press F8 to open the Reference Explorer.
2. In the tree view pane, expand the plant hierarchy.
3. Do one of the following:
• In the tree view pane, select an item.
• In the Items pane, select one or more items.
4. Right-click the selected items and then on the shortcut menu, click Duplicate.
5. Modify the properties as you require. For help with individual properties, click
the Help button on the dialog box.
Note
• When you duplicate an item in the domain explorer, the duplicate item
inherits the naming conventions from the original item. Make sure you set
the naming convention for an item you wish to duplicate. For details see
Naming Conventions: An Overview in the Administration User's Guide,
under Domain Administration.
Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206
Related Topics
• Domain Explorer Common Tasks, page 209
• Reference Explorer Common Tasks, page 245
• SmartPlant Instrumentation Explorer: An Overview, page 206
Delete Items
1. Press F7 to open the Domain Explorer or F8 to open the Reference Explorer.
2. In the tree view pane, expand the plant hierarchy.
3. Do one of the following:
• In the tree view pane, select an item .
• In the Items pane, select one or more items.
4. Right-click the selected items and then on the shortcut menu, click Delete.
Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206
Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206
Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206
Related Topics
• Reference Explorer Common Tasks, page 245
• SmartPlant Instrumentation Explorer: An Overview, page 206
6. In the Item properties data window, if needed, specify item properties so that the
software looks for items with those properties only. Click Add to append a new
row if you want to specify more than one property.
• Property— select an existing property from the list.
• Operator — select an operator from the list to determine how
the selected property will relate to the expression you type in
the Value field.
• Value— type an appropriate value to determine how the
selected property will be specified.
• Logic— select a logic operator (AND or OR) to determine
how the next expression will relate to the current one. Leave
this field empty if this is the last expression you are defining.
7. Click Search Now.
8. In the Results data window, select the items that you want to work with and click
Add to My List.
Notes
• After the software finds the items that you were looking for and
lists them in the Results data window, you can search for more
items without losing your current results. Select another item type
and click Search Now. The software adds the newly found items
to the previously found results.
• To start a new search and clear the Search results data window.
Related Topics
• Domain Explorer Common Tasks, page 209
• Reference Explorer Common Tasks, page 245
• SmartPlant Instrumentation Explorer: An Overview, page 206
5. Select Find whole name only if you want the software to search for occurrences
that are whole names and not part of a larger item name.
6. Do one of the following:
• Under Item , type a name and click Find.
• Select As typed and then under Item type a name. The software
looks for the item as you type. You can set the search delay to
determine how long the software will wait after the last time you
press a key on your keyboard.
7. Click Close.
Related Topics
• Domain Explorer Common Tasks, page 209
• Search for Items in SmartPlant Instrumentation Explorer, page 233
• SmartPlant Instrumentation Explorer: An Overview, page 206
• Filter settings take effect only for the user who defined the filter
and only for the current custom view of the active Explorer
window.
• Item type filters override your item name filters.
Related Topics
Define a Filter for Pre-Assigned Device Cables, page 239
Domain Explorer Common Tasks, page 209
Filter Loops in an Explorer Window, page 240
Filter the Display of Items According to a Specific Item Name, page 235
Filter the Display of Items According to a Specific Item Type, page 236
SmartPlant Instrumentation Explorer: An Overview, page 206
Related Topics
Domain Explorer Common Tasks, page 209
Filter Cables in an Explorer Window, page 238
Filter the Display of Items According to a Specific Item Name, page 235
Filter the Display of Items According to a Specific Item Type, page 236
SmartPlant Instrumentation Explorer: An Overview, page 206
Related Topics
Domain Explorer Common Tasks, page 209
Filter Cables in an Explorer Window, page 238
Filter the Display of Items According to a Specific Item Name, page
235
Filter the Display of Items According to a Specific Item Type, page
236
SmartPlant Instrumentation Explorer: An Overview, page 206
You can use predefined configurations as reference items and copy them to the
Domain Explorer. For more information about using reference wiring items, see
Copy a Reference Item to the Domain Explorer, page 233.
The tree view pane of the Reference Explorer shows reference items organized by
folders. SmartPlant Instrumentation defines standard folders in the database. You
cannot move or delete these folders, nor can you add new folders. Each folder
contains a particular item type, and the options available on the shortcut menus
depend on the currently selected item type.
Item status indicators — the software uses various icons beside a folder or item to
indicate the status of a folder or an item, for example access denied, view only, an
item that belongs to As-Built, and so forth. For the full list of the item indicators,
see Item Status Indicators in the Domain Explorer, page 229.
Notes
You can create several instances of the Reference Explorer by pressing
F8.
After exiting SmartPlant Instrumentation, and starting a new session, the
software retains the size and position of all the windows that were open in
the previous session.
Related Topics
Copy a Reference Item to the Domain Explorer, page 233
Domain Explorer Common Tasks, page 209
SmartPlant Instrumentation Explorer: An Overview, page 206
For more information, see Copy a Reference Item to the Domain Explorer, page 233.
Duplicate an Item
You use this action to create a duplicate item within the same parent hierarchy. That
is, the software creates another copy of the selected item under the immediate parent
item. For example, if you need to insert an apparatus within an existing apparatus
group, expand an apparatus group and duplicate an apparatus. You can then change
the sequence numbers of the apparatuses to re-arrange them on the strip the way you
require. Furthermore, if you are duplicating a panel or another item that contains
child items, the software duplicates this item in its entirety. That is, SmartPlant
Instrumentation creates the new item with exactly the same child items as the original
panel. Note that in this case, the software also retains all the existing internal
connections if you selected Copy internal connections in the wiring preferences.
For more information, see Duplicate an Item, page 230.
Delete Items
This procedure shows how to delete the items that you select in the Reference
Explorer. For more information, see Delete Items, page 231.
For more information, see Find an Item in the Tree View of an Explorer Window,
page 234.
Also, you can filter the items so that the software displays only those items that
belong to the current lowest plant group and only those items that were created by the
current user of SmartPlant Instrumentation. You can use these two filtering options
on their own or in concurrence with another filter definition.
Filter settings take effect only for the user who defined the filter and only for the
current custom view of the active Explorer window.
Note that item type filters override your item name filters.
For more information, see Filter the Display of Items According to a Specific Item
Type, page 236.
Also, you can filter the items so that the software displays only those items that
belong to the current lowest plant group and only those items that were created by the
current user of SmartPlant Instrumentation. You can use these two filtering options
on their own or in concurrence with another filter definition.
You can define an item name filter only if you do one of the following:
Panels
In this folder, reference panels are arranged according to their category. Panels, in
turn, contain their child items, for example terminal strips, racks, wiring equipment,
and so forth. There is a lot of flexibility in creating a panel hierarchy. There is no
rigid structure like "panel – strip – terminal" that limits your wiring design. You
can create various wiring structures, as you require. For details, see Panels by
Category Hierarchy Examples, page 215 to examine a few possible structures.
Cables
This folder holds all the existing reference cables. You can create various child items
under cables. For an example, see Cable Hierarchy Example, page 218.
Wiring Equipment
This folder holds all the available reference wiring equipment. The items are
organized in sub-folders according to the wiring equipment category such as barriers,
amplifiers, hubs, I/O cards, and so forth.
Related Topics
• Domain Explorer Common Tasks, page 209
• SmartPlant Instrumentation Explorer: An Overview, page 206
In the Hook-Up Item Libraries folder, the software arranges the items in three
levels, based on the relationship among them.
Level 1
Hook-Up Item Libraries
This is the highest level in the Hook-Up Item Libraries folder hierarchy. At this
level, the software displays all the hook-up libraries that exist in the current domain.
Hook-up libraries are indicated with the icon.
A hook-up library always contains one default sub-library and can also contain any
number of user-defined sub-libraries. For each hook-up library, on the shortcut
menu, you can click New to add user-defined sub-libraries, or click Properties to
update properties of an existing sub-library. You must set a specific library as the
active item library, which is indicated with the icon. To do so, on the shortcut
menu, click Actions > Set as Active Item Library. You cannot delete the default
sub-library.
Level 2
Hook-Up Item Sub-Libraries
Hook-up sub-libraries (indicated with the icon) appear under hook-up libraries.
At this level, you can click New to add items to sub-libraries, or click Properties to
update properties of an existing sub-library. You cannot delete the default sub-
library.
Level 3
Hook-Up Items
Hook-up items (indicated with the icon) appear under hook-up item sub-libraries.
Hook-up items do not contain child items. The actions that you can perform at this
level depend on the sub-library to which the items belong.
• Add new hook-up items one by one or in batch mode. To add a single
item, right-click the default sub-library and on the shortcut menu, click
New. To add items in batch mode, on the shortcut menu, click
Actions > Batch Item Creation.
• Update properties of an existing item. If this item exists in the user-
defined sub-libraries, the software automatically updates the item
properties in the user-defined sub-libraries.
• Permanently delete a hook-up item. When deleting an item from the
default sub-library, the software also deletes this item from all of the
sub-libraries that exist in the entire item library.
• Manually associate an item with a user-defined sub-library by
dragging the item from the default sub-library to a user-defined sub-
library.
In a user-defined sub-library, you can perform the following actions:
• Add new hook-up items. When you create a new item in a user-
defined sub-library, the software automatically creates this item in the
default sub-library too.
3. Right-click the I/O Cards folder and then on the shortcut menu, click New >
Wiring Equipment.
4. In the New Wiring Equipment dialog box, under Name, type the name of the
new I/O card and click OK.
Tip
• As a rule, I/O cards reside in rack slots. However, reference I/O cards
do not have parent hierarchy items. As a result, the software does not
check the name uniqueness of new reference I/O cards. Therefore,
make sure that you name your new reference I/O cards appropriately.
5. On the Wiring Equipment Properties - I/O Card dialog box, on the General
tab, do one of the following to define the name of the new card:
• Select the Apply naming convention check box selected if you want
the software to name the new card automatically according to the
naming conventions that are set for this type of equipment in the
Administration module. For more information, see SmartPlant
Instrumentation Administration Help, Domain Administration >
Naming Conventions.
• Clear the Apply naming convention check box and under Name, type
the name of the new card. Note that if you do not clear the Apply
naming convention check box, the software will ignore the name that
you type under Name.
6. Select the Double width check box if the card occupies a double width slot.
7. In the Details group box do the following as you require:
a. Type a description.
b. Select an I/O card type, model, and manufacturer. If the required value is not
available on the list, click to define a new one.
c. Enter a sequence if you need to define the sequence of the new card in its
parent item. This sequence also determines the order in which wiring items
appear under their parent item in the Domain Explorer tree view.
8. Click the Control System tab.
9. In the Control system details group box, under I/O type, select a I/O type to
determine the actual function of the new I/O card. For example, AI, AO, DI, DP,
Fieldbus, Profibus, and so forth. You can add more values to this list in the I/O
Type supporting table in the Instrument Index module. (See the important notes
at the end of this procedure.)
10. Under Module, type the software address that this card is assigned to.
Tip
• Module, Controller/Processor, Rack, and Slot are field headers
specific to panel manufacturers. Selecting a different manufacturer
when editing the panel displays the headings used by that panel
manufacturer. For details, see Customize the Controller/Processor
List Header in I/O Card Properties, page ???.
11. From the Controller/Processor list, select an I/O card controller. If the required
controller is not available on the list, click to define a new one.
12. To view the list of all I/O terminations associated with the current I/O card, click
the I/O Terminations button.
13. Click the Category Properties tab.
14. Revise and modify category property values as you require. Click the value for
each property and modify it as needed.
Tip
• I/O card is a wiring equipment category that is shipped with
SmartPlant Instrumentation. You cannot delete or rename any of the
wiring equipment categories that have been shipped with the software.
Nor can you delete or rename the properties of the shipped categories.
However, when editing I/O card properties, you can add user-defined
properties which you can rename or delete as you wish. For details,
see Customize and Use Wiring Equipment Categories, page ???.
15. Click the Associate Symbols tab to associate a symbol with the current I/O cards.
The software will use this symbol when generating a report in the Enhanced
Report Utility. For details, see Associate a Symbol with an Item, page ???.
16. Click OK to accept your settings and close the dialog box.
Important
• In a redundant system configuration, an I/O card can function as a
primary or secondary I/O card and can be associated with several I/O
terminations. Therefore, an I/O termination can serve multi-paired
redundant I/O cards. However, in these redundant I/O card
configurations, the I/O termination can be associated only with one
pair of primary and secondary I/O cards. Also, an I/O card cannot
function as both a primary and secondary I/O card for the same I/O
termination.
• If an I/O card functions as a primary I/O card, the Control System tab
of the Wiring Equipment Properties - I/O Card dialog box displays
the secondary I/O card data and the primary I/O card data properties
remain blank. If an I/O card functions as a secondary I/O card, the
Control System tab displays the primary I/O card data and the
secondary I/O card data properties remain blank.
Tip
• Wiring equipment categories that are shipped with SmartPlant
Instrumentation have predefined properties. You cannot delete or
rename any of these categories or their properties. You can only edit
their values. However, you can add user-defined properties to any
category which you can rename or delete as you wish. For details, see
Customize and Use Wiring Equipment Categories, page ???.
10. Click the Associate Symbols tab to associate a symbol with the current item .
The software will use this symbol when generating a report in the Enhanced
Report Utility. For details, see Associate a Symbol with an Item, page ???.
11. Click OK to accept your settings and close the dialog box.
Related Topics
• Reference Explorer Common Tasks, page 245
7. Select the Double width check box if the card occupies a double width slot.
8. In the Details group box do the following as you require:
a. Type a description.
b. Select an I/O termination type, model, and manufacturer. If the required value
is not available on the list, click to define a new one.
c. Enter a sequence if you need to define the sequence of the new I/O
termination in its parent item . This sequence also determines the order in
which wiring items appear under their parent item in the Domain Explorer
tree view.
9. Click the Control System tab.
10. From the I/O type list, select a I/O type to determine the actual function of the
new I/O termination. For example, AI, AO, DI, DP, Fieldbus, Profibus, and so
forth. You can add more values to this list in the I/O Type supporting table in the
Instrument Index module.
11. To set the new I/O termination in a distant cabinet or to associate the I/O
termination with an I/O card that resides in another panel, do the following:
a. select the Set within a distant cabinet check box.
b. Select a cabinet in the Primary I/O card group box.
12. To associate the current I/O termination with an I/O card that does not have a
built-in termination block, select the required options in the Primary I/O card
group box.
Tip
• The I/O card list contains only those I/O cards that have been created
under a rack and a slot. Fore more information, see Associate an I/O
card with an I/O Termination, page ???.
13. To define the current I/O termination as an I/O termination that serves two
redundant I/O cards, do the following:
a. Select the Define a redundant I/O card check box.
b. Select the required options in the Secondary I/O card group box.
14. Click the Category Properties tab.
15. Revise and modify category property values as you require. Click the value for
each property and modify it as needed.
Tip
• I/O termination is a wiring equipment category that is shipped with
SmartPlant Instrumentation. You cannot delete or rename any of the
wiring equipment categories that have been shipped with the software.
Nor can you delete or rename the properties of the shipped categories.
However, when editing I/O termination properties, you can add user-
defined properties which you can rename or delete as you wish. For
details, see Customize and Use Wiring Equipment Categories, page
???.
16. Click the Associate Symbols tab to associate a symbol with the current I/O
termination. The software will use this symbol when generating a report in the
Enhanced Report Utility. For details, see Associate a Symbol with an Item, page
???.
17. Click OK to accept your settings and close the dialog box.
Related Topics
• Reference Explorer Common Tasks, page 245
The module offers tools for adding, editing, duplicating, and deleting loop and
instrument tag numbers. Instrument types and their profiles are organized in a
comprehensive fashion providing easy data entry. Other data, such as model and
manufacturer, P&ID drawing numbers, lines, locations, I/O types, equipment names
are organized in supporting tables.
The Instrument Index module also provides other functions that include item-oriented
(tag, loop, and so forth), filtered, sorted and customizable database viewing options.
You can generate reports in several formats, attaching remarks to items, creating
specific summaries, and viewing and managing history.
Before working with the Instrument Index module make sure the Domain
Administrator has defined the Loop and Tag naming conventions in the
Administration Module. For more information, see Naming Conventions: An
Overview in the Administration User's Guide, under Domain and Project
Administration, Naming Conventions, Naming Conventions: An Overview.
Related Topics
• Associating Instrument Tags with Loop Numbers: An Overview, page 310
• Editing Data in a Browser View: An Overview, page 332
• Generating Documents: An Overview, page 346
• Managing Instrument Tags: An Overview, page 284
• Managing Lines: An Overview, page 326
• Managing Loop Numbers: An Overview, page 259
• Working with External Documents: An Overview, page 352
• Working with Instrument Types: An Overview, page 276
Related Topics
• Managing Loop Numbers Common Tasks, page 260
Note that if you are deleting a loop number associated with wiring, SmartPlant
Instrumentation automatically disconnects all the required instruments. For more
information, see Delete Loop Numbers, page 272.
Note that you can define multiple functional requirements for a specific loop number.
Also, you can generate a specification for a loop that has a functional requirement.
For more information, see Define a Functional Requirement for a Loop.
Related Topics
• Managing Loop Numbers: An Overview, page 259
• You can define a functional requirement while creating a new loop. For
details see Define a Functional Requirement for a Loop, page 275.
Related Topics
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259
Segment Description
100 – prefix derived from the loop naming convention defined by
the Domain Administrator
F – measured variable
IC – loop function
2225 – loop number
E – suffix
Related Topics
• Create a Loop Number When Editing a Tag, page 270
• Create a New Individual Loop Number, page 262
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259
Tip
• The data field on the Duplicate Loop Number dialog box displays the
loop name template based on the loop naming convention defined by
the Domain Administrator. In the alphanumeric and the numeric parts
of the name, you can type any character (letters, digits, spaces, and so
forth).
5. If required, do the following to create the duplicated loop number in a different
<unit> in the current domain:
a. On the Duplicated Loop Number dialog box, check the Create in another
unit check box.
b. On the Select Target Unit dialog box, select the target unit.
c. Click OK to return to the Duplicated Loop Number dialog box.
6. Click OK in the Duplicated Loop Number dialog box.
7. Do the following to create new tag numbers that will be associated with the new
loop number:
a. On the Create Loop Tags dialog box, select the appropriate check boxes
beside the tag numbers that you want to create. The software duplicates the
tags associated with the source loop and associates the new tags with the new
loop number. Note if you have more than one type of tag associated with the
loop, for example; Conventional tags and Functional requirement tags, then a
Create Loop Tags dialog box will open for each tag type, one after the other.
b. Modify the names of the new tag numbers as needed. Note that you cannot
change the prefix and the separator.
c. Select Copy the instrument type from the source tag numbers to keep the
instrument type of the source tags.
d. Click Next, to move to the next tag type Create Loop Tags dialog box. Note
if you click Next after editing all the loop tag types a prompt will appear, click
Yes to return to the first Create Loop Tags dialog box, or No to close the
prompt.
e. Click OK.
f. When prompted, click Yes to edit the tag properties you have duplicated, or
No to duplicate the tag numbers with their existing parameter values.
g. On the Loop Number Properties dialog box, define the properties you want
to associate with the loop number. For details of the options available click the
Help button in the Loop Number Properties dialog box.
h. Define a functional requirement if required. For details see Define a
Functional Requirement for a Loop, page 275.
i. Click OK .
Notes
• You can change the measured variable of the new loop number or keep
it the same as the source one. New tag numbers associated with the
new loop number will be affected accordingly, that is, the measured
variable of the new tag numbers will change if the measured variable
of the new duplicated loop is changed. For example, if you are
duplicating Loop 101-F-102 and you change the measured variable of
the new loop to T, the new tag numbers associated with the new loop
number will change their instrument type in accordance with the new
measured variable: source Tag Number 101-FE-102 will change to
101-TE-102.
• You can also duplicate a loop number from the Instrument Index
module. In the Instrument Index Module window, click on the
toolbar or on the menu bar, click Edit > Loop Numbers > Duplicate
Loop Number.
Related Topics
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259
• Click .
• Click Modules > Instrument Index.
2. On the Instrument Index menu bar click Edit > Loop Numbers > Move
Number.
3. On the Enter Loop Number dialog box, do one of the following:
• To move one loop number, type the required loop number.
• To move a group of loop numbers, click Find.
• In the Find Loop dialog box click Find again.
• In the Search results data window, hold down Ctrl and highlight the
required loop numbers, or select the Select all check box to move all
the displayed loop numbers.
4. Click OK.
5. On the Select Target <Unit> dialog box, select the <unit> to which you what to
move the selected loop numbers.
6. Click OK.
Related Topics
• Managing Loop Numbers Common Tasks, page 260
Tips
• If you clear the Apply P&ID drawing to tags check box, you will still
be able to define a P&ID drawing reference for subsequently
associated new tag numbers by selecting a required drawing number
from the P&ID list in the Tag Number Properties dialog box.
• If the loop you are editing already contains associated equipment,
selecting this option replaces the existing equipment values with the
new equipment that you type in the Loop equipment field.
8. Select the Update document number check box to update the document number
of the associated loop drawing.
Tip
• A document number naming convention can contain segments that
represent loop number properties. Therefore, if you select this check
box, changing a loop number property that is used in the document
number segment also changes the document numbers in accordance
with this change. After you select this check box, the software updates
numbers of all documents containing the current loop number. For the
current loop number, the software overrides the default or user-defined
numbers of all the documents that appear in the Loop Drawing List
dialog box of the Loop Drawings module. For details on document
number naming conventions, see the Administration module Help,
Document Number Naming Convention Examples.
9. Click OK.
10. At the prompt, do one of the following:
• Click Yes to edit the tag numbers associated with the current loop.
• Click No to close the Loop Number Properties dialog box and save
new loop number values without editing the associated tag numbers.
Related Topics
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259
• Click .
• Click Modules > Instrument Index.
2. In the Instrument Index Module window, do one of the following:
• Click .
• Click Edit > Loop Numbers > Loop Number Properties.
8. Select the Update document number check box to update the document number
of the associated loop drawing.
Tip
• A document number naming convention can contain segments that
represent loop number properties. Therefore, if you select this check
box, changing a loop number property that is used in the document
number segment also changes the document numbers in accordance
with this change. After you select this check box, the software updates
numbers of all documents containing the current loop number. For the
current loop number, the software overrides the default or user-defined
numbers of all the documents that appear in the Loop Drawing List
dialog box of the Loop Drawings module. For details on document
number naming conventions, see the Administration module Help,
Document Number Naming Convention Examples.
9. Click OK.
10. At the prompt, do one of the following:
• Click Yes to edit the tag numbers associated with the current loop.
• Click No to close the Loop Number Properties dialog box and save
new loop number values without editing the associated tag numbers.
Related Topics
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259
• Click .
• Click Modules > Instrument Index.
2. In the Instrument Index Module window, do one of the following:
• Click .
• Click Edit > Loop Numbers > Loop Number Properties.
3. On the Enter Loop Number dialog box, click Find without typing any loop
number.
4. On the Find Loop dialog box, click Find.
5. On the Search results data window, select the loop numbers you require. You
can hold down the Ctrl key and select a group of loop numbers or check the
Select all check box.
6. Click OK.
7. On the Loop Number Properties dialog box, edit the loop properties by entering
values or selecting values from the lists.
Tip
• If needed, click the button beside an appropriate list arrow to open
the supporting table where you can rename a loop number, add, edit,
or delete an item on the list.
8. Select Apply service to tags to apply the loop service of the current loop number
to the associated tag numbers.
9. Select Apply P&ID to tags to propagate the P&ID drawing number data to all the
tag numbers associated with the current loop number.
10. Select Apply equipment to tags to propagate the equipment data to all the tag
numbers associated with the current loop number.
11. Click Next to edit the properties of another loop.
Tip
• When you save the new loop number values, the software does not
update the properties of the tags associated with the loop numbers you
are editing. When editing multiple loop numbers, the software does not
prompt you to edit the associated tag numbers. For more details on
editing tags see Edit Instrument Tags from the Instrument Index, page
291.
12. Click OK to close the Loop Number dialog box and save new loop number
values.
Related Topics
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259
Related Topics
• Managing Loop Numbers Common Tasks, page 260
• No default – The data field in the New Loop Number dialog box does
not display any default loop, letting you enter the number you need.
• Same as the last created loop – The data field in the New Loop
Number dialog box displays the last created loop. You can accept the
displayed number, modify it, or type the number you need.
• Same as the last created loop + 1 – The data field in the New Loop
Number dialog box displays the last created loop number incremented by
one. You can accept the displayed number, modify it, or type the number
you need.
• The last existing loop in the unit + 1 – The data field in the New Loop
Number dialog box displays the last existing loop number in the current
unit incremented by one. You can accept the displayed number, modify it,
or type the number you need.
• The last existing loop in the domain + 1 – The data field in the New
Loop Number dialog box displays the last existing loop number in the
current domain incremented by one. You can accept the displayed number,
modify it, or type the number you need.
• Apply loop service to drawing description
Specifies that in the Loop Drawings module, a loop service which you define for a
loop appears in the Loop Drawing List dialog box under the Description column. If
you clear the check box, the Description column remains empty.
Note
• The last three options in the Define new loop name template are
available for numeric loop names only. If your loop names are not
numeric, the data field in the New Loop Number dialog box will display
the last created loop.
Related Topics
• Create a New Individual Loop Number, page 262
• Loop Number Naming Convention, page 263
• Managing Loop Numbers Common Tasks, page 260
• Click
• Click Modules > Instrument Index.
2. On the Instrument Index Module, do one of the following:
• Click
• Click Edit > Loop Numbers > Loop Number Properties.
3. On the Enter Loop Number dialog box type the name of the loop that you want
to rename and click OK or do the following:
• On the Enter Loop Number dialog box, click Find without typing
any loop number.
• On the Find Loop dialog box click Find.
• Select the loop number from the Search results dialog box and click
OK.
4. On the Loop Number Properties dialog box, click next to the Loop number
field.
5. On the Rename Loop Number dialog box, type the new loop number name.
6. Click OK.
7. On the Loop Number Properties dialog box click OK.
Tips
• If you set the preferences to open the Rename Loop Drawing File
dialog box after renaming a loop number, do the following to rename
the file name of the associated CAD drawing. In the Rename Loop
Drawing File dialog box, select a check box beside a desired file
name. Type a new name over the name displayed in the New
Drawing File column.
• If more than one file appears in the data window, the drawing type is
multi-drawing.
Notes
• You can rename the drawing file name if the loop number that you are
renaming is associated with a CAD loop drawing. To do this, set a
preference on the Rename page of the Preferences Dialog box before
performing this procedure. For more details see Set Preference for
Renaming A CAD File from A Loop Number, page 274.
• Make sure that your new loop number name complies with the naming
conventions for the current <unit>.
• All loop numbers must have unique names in the current <unit>.
Related Topics
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259
Related Topics
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259
• Rename A Single Loop Number, page 273
• Click .
• Click Modules > Instrument Index.
2. On the Instrument Index Module, do one of the following:
• Click .
• Click Edit > Loop Numbers >Rename Multiple Loop Numbers.
3. On the Enter Loop Number dialog box, click Find.
4. On the Find Loop dialog box, click Find again.
5. On the Search results data window, select the loop numbers you require. You
can hold down the Ctrl key and select a group of loop numbers or check the
Select all check box.
6. Click OK.
7. On the Rename Multiple Loop Numbers dialog box, do the following:
a. Select the Select check box next to each loop number that you want to
rename, or select the Select all check box to rename all the loops in the
Rename Multiple Loop Numbers dialog box.
b. On the New Loop Number field, type the new loop number name.
c. Click the Loop Service field and modify the value if needed.
d. Select the Edit tag numbers check box to edit the properties of the tag
numbers associated with the selected loop numbers after you rename these
loop numbers
e. Click Rename.
8. On the Tag Number Properties dialog box, edit the properties of the tag
numbers you have chosen.
9. Click OK.
10. The Rename Multiple Loop Numbers dialog box reopens.
Tip
• If after clicking Rename some of the selected loop numbers have not
been renamed, the Result field of the Rename Multiple Loop
Numbers dialog box displays the reason why you could not rename
these loop numbers.
11. Click Close.
Note
• Make sure that your new loop number names comply with the naming
conventions of the current <unit>. All loop numbers must have unique
names in the current <unit>.
Related Topics
• Managing Loop Numbers Common Tasks, page 260
• Managing Loop Numbers: An Overview, page 259
Related Topics
• Create a New Individual Loop Number, page 262
• Duplicate a Loop Number, page 263
• Edit Loop Number Properties from the Domain Explorer, page 266
For each instrument type that you define, you also set a profile definition that allows
you to automate the creation of tag numbers with a number of predefined properties.
When defining an instrument type, you also define its profile. Instrument type profile
allows you to automate the creation of tag numbers with a number of predefined
properties. When you create a tag number whose instrument type includes a profile,
the software automatically creates and associates a number of items that you chose in
the instrument type profile that serves as a basis for the new tag number.
Related Topics
• Instrument Types Common Tasks, page 277
Related Topics
• Working with Instrument Types: An Overview, page 276
Tip
• If you have duplicate instrument type acronyms, when creating new
tags based on such an instrument type, SmartPlant Instrumentation
opens the Select Instrument Type dialog box and lets you select the
exact instrument type that you require for the new instrument.
5. Under Description, type a brief description as desired.
6. Under CS Tag Instrument Type Alias, type an alias for a control system tag
instrument type. Do this only if you want to create control system tags that will
have an alias instrument type associated with the current instrument type. Leave
this field blank if you are not going to create CS tags based on the current
instrument type or if you want the CS tags to have the same instrument type as the
tag number.
7. If you selected the General process function, under General Process Function
Sub-Category, select a value that you predefined in the General Process
Function Sub-Category supporting table. For details, see Define a General
Process Function, page 279.
Related Topics
• Apply all Existing Profiles, page ???
• Define an Instrument Type Profile, page 279
• Generate a Process Data Sheet for an Instrument, page 349
• Instrument Types Common Tasks, page 277
• Set an Alias Control System Tag, page 282
• Working with Instrument Types: An Overview, page 276
Related Topics
• Define an Instrument Type, page 278
• Instrument Types Common Tasks, page 277
• Working with Instrument Types: An Overview, page 276
3. In the data window, select the instrument type for which you want to define
profile options.
4. Click Profile.
5. Make your definitions as you require.
Important
• Make sure that your preferences on the Instrument Index > Profile page
of the Preferences dialog box are set to activate the options that you
require. These preferences only apply when you create new instruments.
For example, if you clear the Specifications check box, when creating a
tag number, the software ignores specification creation options defined on
the General tab of the Instrument Type Profile dialog box and creates
the tag without any specification. If you then manually generate a
specification for the created tag, the software applies the existing
instrument type profile options.
• Preferences on the Instrument Index > Profile page of the Preferences
dialog box do not apply to the settings on the Calibration tab of the
Instrument Type Profile dialog box.
Related Topics
• Instrument Types Common Tasks, page 277
• Working with Instrument Types: An Overview, page 276
9. From the Reference device panel list, select an appropriate reference panel for
this instrument type. These are device panels that were created in Reference
Explorer.
10. If your reference device panel settings enable the Conventional connections
group box, do one of the following for each connection that you need for the
current instrument type:
• Click New, to add a connection.
• Click Properties, to edit the properties of an existing convention, and
on the Conventional Connection Properties dialog box, define the
settings that you require, and click OK.
11. If your reference device panel settings enable the Plug-and-socket connections
group box, do one of the following for each connection that you need for the
current instrument type:
• Click New, to add a connection.
• Click Properties, to edit the properties of an existing convention, and
on the Plug-and-Socket Connection Properties dialog box, define
the settings that you require, and click OK.
Notes
• SmartPlant Instrumentation creates the wiring items according to an
instrument type profile, it always connects the created cable to the right
side of the panel that it creates. Therefore, you are not allowed to select a
left-oriented terminal from the Starting terminal list on the
Conventional Connection Properties dialog box. You can check the
configuration of a terminal by right-clicking it in the Domain Explorer
and selecting Properties on the shortcut menu.
• SmartPlant Instrumentation does not allow you to define a wiring
instrument type profile that enables connections on the left side of a device
panel.
Related Topics
• Define an Instrument Type, page 278
• Instrument Types Common Tasks, page 277
• Working with Instrument Types: An Overview, page 276
5. From the Process function list, select the required process function.
6. In the data window, select the instrument type whose profile data you want to
copy.
7. Click OK to reopen the Instrument Type Profile dialog box, where you can
view the new profile properties.
8. Define the instrument type profile as you require.
Tips
• If you want to copy the specification profile properties, note that both
the source and the target instrument type must belong to the same
process function. When the source and the target instrument type
belong to different process functions, the system copies the data
without the specification profile properties.
• When copying instrument type profile settings, the software ignores
the definitions on the Calibration profile tab.
Related Topics
• Instrument Types Common Tasks, page 277
• Working with Instrument Types: An Overview, page 276
Related Topics
• Working with Tag Numbers Common Tasks, page 285
Segment Description
100 Prefix derived from the tag naming convention defined by the Domain
Administrator
FE Measured variable
2225 Loop number that the tag is associated with
E Suffix
Note
• Though the naming conventions do not apply to tags classed as electrical,
you can not create an electrical tag until the naming convention for
conventional instruments has been defined.
Related Topics
• Create an Instrument in the Domain Explorer, page 287
• Create an Instrument Tag in the Instrument Index Module, page 289
• Instrument Tag Renaming Options, page 301
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285
Related Topics
• Managing Instrument Tags: An Overview, page 284
a. From the Tag class list, select the desired tag class according to whether you
want to create a conventional, Foundation Fieldbus, HART instrument, soft
tags, Telecom tag, and so forth.
b. Type the name of the new tag. For details on instrument tag naming
conventions see Instrument Tag Naming Convention, page 284.
5. Click OK.
6. If the Select Instrument Type dialog box opens (because there is more than one
record for a given instrument type acronym), select the required instrument type
and click OK.
Tips
• If the tag name does not correspond to an existing loop name, you are
prompted to enter a loop name based on the tag you have entered. If
the loop identifier already matches an existing loop, then the new tag
name will automatically be associated with the loop.
• If the loop convention includes the loop function parameter, the
prompt will always appear. In this case, you have to complete the loop
name. If a profile exists for the selected instrument type, any new tags
for that instrument type will be created with the selected default
settings.
7. On the Loop Name dialog box, do one of the following:
• Type the loop number that the new tag is to be associated with.
• Accept the displayed loop number.
• Click Cancel to create the tag number without a loop association.
8. Click OK.
9. On the Loop Number Properties dialog box, accept the loop number properties
or modify them as required and then click OK.
Tip
• The Loop Number Properties dialog box only opens if the tag
number is associated with a loop number.
10. On the Tag Properties dialog box enter the properties as required, and click OK.
For details on entering power supply data (not available if the selected Tag Class
is electrical), see Enter Power Supply Data for Panels and Instrument Tags, page
293
Notes
• You can also create a new instrument tag in the Instrument Index module.
For more details, see Create an Instrument Tag in the Instrument Index
Module, page 289.
• When creating a new tag, you can determine whether or not process data is
required for it, and if so, at what stage the information should be entered
by a process engineer. For more details of workflow implementation, see
Workflow, page ???.
Related Topics
• Create an Instrument Tag in the Instrument Index Module, page 289
• Flow of Activities for Managing Soft Tags, page 308
• Managing Instrument Tags: An Overview, page 284
• Click .
• Click Modules > Instrument Index.
2. Do one of the following:
• Click Edit > Tag Numbers > New Tag Number.
• Click
3. On the New Tag Number dialog box, do the following:
a. From the Tag class list, select the desired tag class according to whether you
want to create, a conventional, Foundation Fieldbus, HART instrument, soft
tags, Telecom tag, and so forth.
b. Type the name of the new instrument tag. For details on instrument tag
naming conventions, see Instrument Tag Naming Convention, page 284.
4. Click OK.
5. If the Select Instrument Type dialog box opens (because there is more than one
record for a given instrument type acronym), select the required instrument type
and click OK.
Tips
• If the instrument tag name does not correspond to an existing loop
name, you are prompted to enter a loop name based on the instrument
tag name you have entered. If the loop identifier already matches an
existing loop, then the new tag name will automatically be associated
with the loop.
• If the loop convention includes the loop function parameter, the
prompt will always appear. In this case, you have to complete the loop
number. If a profile exists for the selected instrument type, any new
tags for that instrument type will be created with the selected default
settings.
• The data that appears in the Prefix, Number, and Suffix fields is derived
from the tag number itself.
• You can also edit the properties of an instrument tag from the Instrument
Index module. For more details see, Edit Instrument Tags from the
Instrument Index, page 291
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285
• Click .
• Click Modules > Instrument Index.
2. Do one of the following:
• Click .
• Click Edit > Tag Numbers > Tag Number Properties.
3. On the Enter Tag Number dialog box, do one of the following:
• To edit a single tag , type the tag number in the box.
• To edit multiple tags, click Find to open the Find Tag dialog box.
Click and select the tags to be edited.
4. Click OK.
5. On the Tag Properties dialog box enter the properties as required. For details on
entering power supply data (not available if the selected Tag Class is electrical),
see Enter Power Supply Data for Panels and Instrument Tags, page 293.
6. After modifying the data, do one of the following:
• For multiple tags, click Apply > Next to continue editing. Click OK
when you have finished editing.
• For a single tag click OK.
Notes
• Editing the properties of an existing instrument tag does not affect its
existing association with a loop. For more details, see Change a Tag Loop
Association, page ???
• The data that appears in the Prefix, Number, and Suffix fields is derived
from the instrument tag itself.
Related Topics
• Managing Instrument Tags: An Overview, page 284
Define new tag name template – These options determine how SmartPlant
Instrumentation displays new tag number names in the New Tag Number dialog box
in relation to the previously created tag number. The options are:
• No default – The data field in the New Tag Number dialog box will not
display any default tag, letting you enter the number you need.
• Same as the last created tag – The data field in the New Tag Number
dialog box displays the last created tag. You can accept the displayed
number, modify it, or enter the number you need.
• Same as the last created tag + 1 – The data field in the New Tag
Number dialog box displays the last created tag plus 1 (one). You can
accept the displayed number, modify it, or enter the number you need.
This option is available for numeric tag names only. If your tag number
names are not numeric, the data field in the New Tag Number dialog box
will display the last created tag.
Ignore loop creation when creating new virtual tag – Allows you to create a
virtual tag without being prompted to create a loop associated with the new virtual
tag.
Use loop suffix in tag number name – Allows you to include the loop suffix in the
name of a newly-created tag number.
Related Topics
• Instrument Tag Naming Convention, page 284
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285
Note
• The fields under Power distribution board data group box display data
that is determined within SmartPlant Electrical. On the Power Supply
tab, click Help for more information.
Related Topics
• Create an Instrument in the Domain Explorer, page 287
• Create an Instrument Tag in the Instrument Index Module, page 289
• Duplicate an Instrument Tag in the Domain Explorer, page 295
• Duplicate an Instrument Tag in the Instrument Index, page 296
• Edit an Instrument Tag from the Domain Explorer, page 290
Note
• If necessary, define a custom browser view that you want to use for
displaying the remarks. For details, see Define a Standard Browser View
for the Instrument Index, page 336
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285
Tips
• You can also duplicate an instrument tag from the Instrument Index
module. For more details, see Duplicate an Instrument Tag in the
Instrument Index, page 296.
• The software does not duplicate existing calibration settings of the
source tag. If you want to define calibration settings for the duplicated
tag, the calibration profile definitions apply. These definitions exist at
the level of the instrument type.
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285
• Click .
• Click Edit > Tag Numbers > Duplicate Tag Number.
2. On the Enter Tag Number dialog box, type the instrument tag number you want
to duplicate, and then click OK.
3. To find a tag that you want to duplicate do the following:
a. On the Enter Tag Number dialog box, click Find.
b. On the Find Tag dialog box, click Find.
c. Select the instrument tag you want to duplicate, and then click OK.
4. Type the new instrument tag on the Duplicated Tag Number dialog box, and
then click OK.
5. If you want to duplicate the instrument tag in another <unit> of the same domain,
do the following:
a. Select the Create in another unit check box.
b. Click OK.
c. On the Select Target <Unit> dialog box, select the target <unit> for the new
tag and then click OK.
6. On the Select Instrument Type dialog box, select the instrument type you want
to associate with the current tag number, and then, click OK.
7. On the Loop Name dialog box, and do one of the following:
• Type the loop number that you want to associate the new instrument
tag with, and click OK.
• On the Loop Properties dialog box, type the desired data and click
OK.
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285
4. Click OK.
5. When prompted, click Yes to confirm deletion.
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285
Note
• If you move an instrument tag to a target <unit> whose tag naming
conventions are different from the naming conventions of the <unit>
where the source tag is, the software applies the target <unit> naming
conventions to the duplicated tag number.
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285
• Before clicking OK, note that all the wiring items that were associated
with the old CS tag will be renamed according to the new control system
tag name, and the associated specification will be deleted. Verify whether
the appropriate loop blocks and hook-ups are associated with the new tag
number.
• Make sure that the new name complies with the naming conventions for
the current <unit>. Naming conventions do not apply to tags classed as
electrical. For more details, see Instrument Tag Naming Convention, page
284.
• For more information about instrument tag renaming options, see
Instrument Tag Renaming Options, page 301.
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285
• The Process Function has not changed— for example: renaming 108-
PT-2212 to 108-PI-2212. Renaming a tag number this way does not
change the process which the tag describes. Therefore, all the process data
information that has been associated with the old tag will be automatically
associated with the new tag. You can also delete the old process data if
required.
• The Process Function has changed— for example: renaming 108-PT-
2212 to 108-FT-2212. If you rename a tag number this way, only general
process data properties, such as pressure, temperature, and density will be
propagated from the old tag number to the new one. Process data
properties specifically associated with the tag's process function, for
example, range, alarm trip settings, upper level, and so forth, will either
not be propagated to the renamed tag or only be propagated partially. In
this case, the old tag's additional properties and calculation results will not
propagate to the new tag either.
Related Topics
• Customize Tag Name, page 292
• Instrument Tag Naming Convention, page 284
• Managing Instrument Tags: An Overview, page 284
• Rename an Instrument Tag, page 299
• Working with Tag Numbers Common Tasks, page 285
Notes
• If you have connected several CS tags to the current tag number, the
system automatically assigns the same new name to all the CS tags. You
must rename the new CS tags manually to make the names unique.
• Before clicking OK, note that all the wiring items that were associated
with the old CS tag will be renamed according to the new control system
tag name, and the associated specification will be deleted. Verify whether
the appropriate loop blocks and hook-ups are associated with the new tag
number.
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285
5. Select the Quality System (ISO) check box to associate the currently selected tag
with an ISO quality system.
Related Topics
• Managing Instrument Tags: An Overview, page 284
• Working with Tag Numbers Common Tasks, page 285
To generate an Enhanced Report Utility drawing that includes a soft tag you need to
create a symbol representing the tag using the Symbol Editor. Then you associate the
symbol with the tag in SmartPlant instrumentation, associate the tag with a loop and
generate the appropriate drawing.
Related Topics
• Create an Instrument in the Domain Explorer, page 287
• Create an Instrument Tag in the Instrument Index Module, page 289
Related Topics
• Associating Instrument Tags with Loop Numbers Common Tasks, page
311
Related Topics
• Associating Instrument Tags with Loop Numbers Common Tasks, page
311
Related Topics
• Associating Instrument Tags with Loop Numbers Common Tasks, page
311
• Duplicate an Instrument Tag in the Domain Explorer, page 295
• Duplicate an Instrument Tag in the Instrument Index, page 296
• Edit an Instrument Tag from the Domain Explorer, page 290
• Click .
• Click Modules > Instrument Index.
2. Do one of the following:
• Click .
• Click Edit > Tag Numbers > Tag Number Properties.
3. On the Enter Tag Number dialog box, do one of the following:
• To choose a single tag, type the tag number in the box.
• To choose multiple tags, click Find to open the Find Tag dialog box,
and then click and select the desired tags.
4. Click OK, to open the Tag Number Properties box.
5. Click Associate.
6. On the Find Loop dialog box, type the desired search parameters as needed and
click Find.
7. Select the loop you require in the Search results data window and click OK.
8. If you chose one instrument tag, on the Tag Number Properties dialog box, click
OK.
9. If you chose more than one instrument tag, on the Tag Number Properties
dialog box:
a. Click Apply to save the changes.
b. Click Next to find the next tag.
c. Click Associate to associate a tag with a loop.
d. Click OK to finish.
Related Topics
• Associating Instrument Tags with Loop Numbers Common Tasks, page
311
• Duplicate an Instrument Tag in the Domain Explorer, page 295
• Duplicate an Instrument Tag in the Instrument Index, page 296
• Edit an Instrument Tag from the Domain Explorer, page 290
Related Topics
• Associating Instrument Tags with Loop Numbers Common Tasks, page
311
Related Topics
• Associating Instrument Tags with Loop Numbers Common Tasks, page
311
A typical tag is a virtual tag that is used for the creation of instrument tag numbers in
your plant. Each typical tag must be associated with a specific instrument type and
description. Furthermore, you can set instrument tag number properties for a virtual
tag. For example, you can define service, location, I/O type, and so forth. You must
define at least one typical tag for each typical loop you create.
You can create as many typical loops as required and use them to create loops in
batch mode. Typical loops with associated typical tags can be very useful when you
need to create numerous loops based on the same loop template.
You can view all the typical loops you have created in the current domain. The list of
typical loops is automatically updated after you create a new typical loop, or if you
edit or duplicate existing loops.
Related Topics
• Typical Loops and Tags Common Tasks, page 316
Creating a new typical loop is the first stage in batch loop creation procedure. This is
when you make all the required typical loop definitions including the typical loop
name, measured variable, and so forth. At this stage, you also select the appropriate
instrument types for the typical tags you associate with this typical loop.
Duplicating a typical loop involves defining a new typical loop name and new typical
tag names to ensure name uniqueness.
For more information, see Batch Loop Creation from Typical Loops, page 321.
When creating numerous loops and tag numbers from typical loops in batch mode,
some data problems might cut short the creation process. If, during batch loop
creation, SmartPlant Instrumentation encounters a data problem with one loop, the
creation process cannot proceed with the rest of the typical loops. To avoid this
problem, SmartPlant Instrumentation helps you verify that you selected and entered
data that will not stop the creation process.
For more information, see Verify New Loop Numbers, page 322.
For more information, see Edit a Typical Tag in a Browser View, page 324.
5. In the Loop name field, type a unique name for the new typical loop.
6. In the Loop service field, enter an appropriate loop service if required.
7. In the Loop suffix field, type a suffix if required.
Tip
• Use a suffix if you want to have numerous typical loops with the same
names. This is useful when you have numerous typical loops that
perform the same or similar function.
8. From the Measured variable list, select the required measured variable for the
new typical loop. If the required value is not available, click next to the list
arrow to open the Loop Measured Variables dialog box where you can add a
new loop process variable identifier or edit an existing one.
9. From the Loop type list, select the required loop type for the new typical loop. If
the required value is not available, click next to the list arrow to open the Loop
Types dialog box where you can add a new loop type or edit an existing one.
10. From the Loop function list, select the required loop function for the new typical
loop. If the required value is not available, click next to the list arrow to open
the Loop Functions dialog box where you can add a new loop function identifier
or edit an existing one.
11. In the Note field, type a short note if needed.
12. Select the Apply service to tags check box, to propagate the loop service you
entered for this typical loop to all typical tags that are associated with it.
13. Click Add, to append a new typical tag row in the Associated typical tags data
window.
14. On the data window, do the following:
a. From the Instrument Type list, select the instrument type that you require.
SmartPlant instrumentation retrieves profile data associated with this
instrument type and applies this data to new tag numbers only when
performing batch loop creation. For more details, see Batch Loop Creation
from Typical Loops, page 321.
b. On the Number field, type the required typical tag number.
c. On the Suffix field, enter the required typical tag suffix to ensure tag name
uniqueness.
15. Click Add, to add as many typical tags as required, and then click OK, to create
the typical loop with the associated tags.
Tip
• On clicking OK, you are prompted to edit the newly-created typical
tag.
Notes
• Ensure that the typical tag naming conventions comply with the required
naming convention rules. For more details, see Typical Tag Naming
Conventions, page 325.
• The New Tag Name field automatically displays the name of the new
typical tag after defining the typical tag instrument type, number, and
suffix.
Related Topics
• Typical Loops and Tags Common Tasks, page 316
Tip
• You should verify the correctness of the data if you are creating a large
number of loops. The creation process may stop if SmartPlant
Instrumentation encounters a problem with one of the loops. To avoid
this situation, click Verify to correct some possible data problems
before you proceed with loop creation. For more details, see Verify
New Loop Numbers, page 322.
7. Click Create to start the loop creation.
Tip
• If for some reason the loop creation process fails, the software displays
an appropriate message informing you that a particular set in a
specified row has not been created. Moreover, the Done check box for
that row remains cleared.
8. Click Close.
Note
• To avoid duplicate loop numbers in your <plant>, check which tag
number numeric segments are available before starting batch loop
creation. For more details, see Create a List of Available Tags, page 350.
Related Topics
• Duplicate a Typical Loop, page 319
• Typical Loops and Tags Common Tasks, page 316
Related Topics
• Typical Loops and Tags Common Tasks, page 316
Important
• The Loop name and the Measured variable fields are required fields.
4. On the Associated typical tags data window, select an existing typical tag that
has been already associated with the current loop and do one of the following:
• Click Properties to open the Typical Tag Number Properties dialog
box to edit the typical tag properties. For more details, see Edit a
Typical Tag, page 324.
• Click Delete to delete the selected tag.
5. Click Add to append a typical tag row in the Associated typical tags data
window.
6. On the data window, do the following:
a. In the Instrument Type column, select the required instrument type from the
list. The selected instrument type serves as a typical tag associated with the
current typical loop.
b. In the Number field, type the required typical tag number.
c. In the Suffix field, type the required typical tag suffix to ensure tag name
uniqueness.
7. Add as many typical tags as required and click OK to associate the newly added
typical tags with the current loop.
Notes
• Ensure that the typical tag naming conventions comply with the required
naming convention rules. For more details, see Typical Tag Naming
Conventions, page 325.
• The New Tag Name field automatically displays the name of the new
typical tag after defining the typical tag instrument type, number, and
suffix.
Related Topics
• Typical Loops and Tags Common Tasks, page 316
Related Topics
• Typical Loops and Tags Common Tasks, page 316
Related Topics
• Working with Lines Common Tasks, page 327
Delete a Line
This option shows you how to delete a line that is no longer in use. Note that you
cannot delete a line that is associated with a tag number. For more information, see
Delete a Line, page 330.
Related Topics
• Managing Lines: An Overview, page 326
Related Topics
• Managing Lines: An Overview, page 326
• Working with Lines Common Tasks, page 327
Related Topics
• Managing Lines: An Overview, page 326
• Working with Lines Common Tasks, page 327
Delete a Line
1. Start the Instrument Index module.
2. To open the Lines dialog box, do one of the following:
• On the Tables menu, click Lines.
• Open the Tag Number Properties dialog box, click next to the
Line list arrow.
3. From the Line type list, select the required line type or select the Show all line
types check box.
4. Highlight the required line in the data window.
5. Click Delete.
Related Topics
• Managing Lines: An Overview, page 326
• Working with Lines Common Tasks, page 327
You can view, organize, and edit your instrument index data by opening an
Instrument Index Standard Browser view in the Browser module. You can also add a
PowerSoft browser that supports the display of tag data and define a view for it to use
with the Instrument Index module.
In the selected browser view, you can access numerous commands to manage your
instrument index data. You can edit the tag number properties in the multi-edit or
single-edit mode, create new loop and tag numbers, associate an instrument with a tag
category, associate and open external documents, generate process data sheets and
specifications for tags, and so forth.
Related Topics
• Edit and View Data Common Tasks, page 333
• Find a record by entering the whole value, for example, 101-FV 100 (the
full tag number name) or CONTROL VALVE (the full instrument type
value).
• Set a shade of gray to emphasize the changed data in printed reports and
their previews.
• Set bold and italic font style for emphasis on the screen and in print.
History indication is available only if the System Administrator has activated the
audit trail functionality. When the audit trail functionality is activated, each time that
you save data after making changes, the data is recorded in the audit trial repository.
For more information, see View Data History in a Browser View, page 341.
Related Topics
• Editing Data in a Browser View: An Overview, page 332
Related Topics
• Edit and View Data Common Tasks, page 333
• Editing Data in a Browser View: An Overview, page 332
3. Click a specific supporting table cell in the highlighted row and do one of the
following:
• Click Actions > Open Supporting Table.
• Click .
4. In the supporting table dialog box that opens, type the item you are looking for in
the Find box.
Tips
• Clicking OK closes the supporting table and displays the selected item
in the list
• If the item you are looking for does not exist in the supporting table,
click New and add an item. Clicking OK after adding the new item
automatically selects this item in the active select list in the browser
view.
Related Topics
• Edit and View Data Common Tasks, page 333
• Editing Data in a Browser View: An Overview, page 332
Related Topics
• Edit and View Data Common Tasks, page 333
• Editing Data in a Browser View: An Overview, page 332
4. In the Tag Number Properties dialog box, edit the data for each tag as you
require. You can also do the following:
• Click New Loop to create a new loop number and then associate it
with the current tag number.
• Click New to create a new tag number.
5. When you have edited data for a particular tag number, click Apply.
6. Click Next or Previous to move from one tag number to another.
Related Topics
• Edit and View Data Common Tasks, page 333
• Editing Data in a Browser View: An Overview, page 332
Related Topics
• Edit and View Data Common Tasks, page 333
• Editing Data in a Browser View: An Overview, page 332
Related Topics
• Edit and View Data Common Tasks, page 333
• Editing Data in a Browser View: An Overview, page 332
Related Topics
• Edit and View Data Common Tasks, page 333
• Editing Data in a Browser View: An Overview, page 332
Related Topics
• Edit and View Data Common Tasks, page 333
• Editing Data in a Browser View: An Overview, page 332
Related Topics
• Edit and View Data Common Tasks, page 333
• Editing Data in a Browser View: An Overview, page 332
• Select the Delete process data option to delete all the process data
associated with the tag numbers.
6. Select Change all so that SmartPlant Instrumentation does not prompt you to
change the process function and the instrument type for each tag number.
Tip
• Before clicking OK, note that all the wiring items that were associated
with the old CS tag will be renamed according to the new control
system tag name, and all the specifications associated with the tags
will be deleted. Verify that the appropriate loop blocks and hook-ups
are associated with the new tag number.
7. Click OK when done.
Notes
• If among the tags whose process function and instrument type you are
changing there are control system tags, SmartPlant Instrumentation
reopens the Tag Number Renaming Options dialog box, so that you can
rename the CS tags if you want to.
• To find and select the instrument type that you require quickly, start
typing in the Find instrument type field, and the software highlights the
record in the data window as you type. If the instrument type is not
available, you can create a new one. For more details, see Working with
Instrument Types: An Overview, page 276.
Related Topics
• Edit and View Data Common Tasks, page 333
• Editing Data in a Browser View: An Overview, page 332
• Specification sheets
• Process Data sheets
• Drawing and Revision reports
• Available tag lists
• Loop Summary
• Generating Documents Common Tasks, page 347
• Specification
• Process data sheet
• Calculation sheet
• Loop drawing
• Hook-up drawing
• P&ID drawing
You can also display revision data for all of the above drawings, except P&ID
drawings. For more information, see Generate a Drawing and Revision Report, page
349.
Related Topics
• Generating Documents: An Overview, page 346
• Select the required tag numbers in the browser view and click .
• Select the required tag numbers in the browser view, click Actions >
Documents.
Related Topics
• Generating Documents Common Tasks, page 347
• Select the required tag numbers in the browser view and click .
• Select the required tag numbers in the browser view, click Actions >
Documents.
Related Topics
• Generating Documents Common Tasks, page 347
• Generating Documents: An Overview, page 346
Related Topics
• Batch Loop Creation from Typical Loops, page 321
• Generating Documents Common Tasks, page 347
• Generating Documents: An Overview, page 346
• Select All loops to generate the Summary of All Loop Numbers report.
• Select Loops with no associated tags to generate Summary of Loop
Numbers with no Associated Tags report.
5. Click OK.
6. When prompted select Yes to preview the report before printing, select No to
print the report without previewing first.
Related Topics
• Generating Documents Common Tasks, page 347
• Generating Documents: An Overview, page 346
Related Topics
• Managing External Documents Common Tasks, page 353
Related Topics
• Managing External Documents Common Tasks, page 353
• Working with External Documents: An Overview, page 352
Batch creation of process data sheets can be done by adapting existing instruments
and lines using an interface that allows process characteristics to be simultaneously
assigned to several instrument groups, thus ensuring system-wide integrity.
The Process Data module shares data with loop components that are associated with a
given process. Data is also shared with the Specifications, Calculations, and
Instrument Index modules, allowing all the data from these modules to be
incorporated into generated reports.
To view process data for instruments, enter the tag number directly when prompted,
or use the search parameters. To view line process data, select a line on the Select
Line dialog box.
If instruments or lines have none or partial process data attached, you can do either
enter new data or modify existing data, including automatic conversion of units as
desired.
Notes
• When the Workflow option is activated, only instrument tags with status
Process Data Required are visible in process data sheets. For details
regarding workflow implementation, see Workflow, page ???.
• Saving process data modifications makes them accessible to other
modules. When you generate a report that includes process data, you can
set SmartPlant Instrumentation to prompt you that the relevant process
data has been changed.
• You cannot generate process data sheets for virtual tags.
Related Topics
• Adding a New Line, page 375
• Modifying Line Properties, page 376
• Click OK.
Related Topics
• API 2540 Standard for Liquid Density Calculation, page 401
• Fluid Definition, page 420
• Modifying Instrument Base Conditions, page 362
• Multiple Process Data Cases, page 385
Related Topics
• Performing Calculations, page 422
Related Topics
• Copying Line Data from One Line to Another, page 382
Notes
• The current procedures propagate line process data to a single tag. For
details of how to propagate line data to more than one tag, see Batch
Propagation of Line Data to Instrument Tags, page 366.Preventive
Maintenance technician options include filling out test results.<Unit>
• Use the current procedures to propagate multi-case process data from a
line to a tag, since the batch procedure propagates process data from the
governing case only.
Note
• This procedure propagates the governing case only. For details of how to
propagate all cases from a given line to a given tag, see Propagating Line
Process Data to an Instrument Tag, page 365.
Related Topics
• Propagating Line Process Data to an Instrument Tag, page 365
• Setting the Line-to-Tag Filter, page 367
Related Topics
• Batch Propagation of Line Data to Instrument Tags, page 366
• Propagating Line Process Data to an Instrument Tag, page 365
Important
• The deletion process is irreversible. Once you have deleted the process
data, you cannot restore it!
Note
• This option is not available for materials where the state is solid/powder,
nor for 2-phase flow.
Related Topics
• Changing the Line Type, page 373
• Deleting a Line Type, page 374
• Editing a Line Type, page 372
Related Topics
• Adding a New Line Type, page 371
• Changing the Line Type, page 373
• Deleting a Line Type, page 374
Related Topics
• Adding a New Line Type, page 371
• Deleting a Line Type, page 374
• Editing a Line Type, page 372
Related Topics
• Managing Line Component Tables, page 393
Duplicate a Line
1. On the Domain Explorer, expand your current <plant> hierarchy to display the
Lines folder.
2. Double-click the Lines folder to display the existing lines.
3. Right-click the loop you want to duplicate, and on the shortcut menu, click
Duplicate.
4. On the Line Properties dialog box, type the new line number.
Tip
• The data field on the Line Properties dialog box displays the line
name template which is based on the line naming convention defined
by the Domain Administrator. In the alphanumeric and the numeric
parts of the name, you can type any character (letters, digits, spaces,
and so forth).
5. If required, do the following to create the duplicated line in a different <unit> in
the current domain:
Related Topics
• Managing Line Component Tables, page 393
• Viewing Line Process Data, page 379
Related Topics
• Editing Line Process Data - Fluid, page 381
• Editing Line Process Data - Selecting Pipe Standards, page 380
• For all pipe standard options — ANSI, DIN, and Other— you edit the
following parameters directly: pipe material, pipe spec, and wall thickness.
• If your current selection from the Pipe Standard list is Other, you can
also edit Line size and its unit of measure, and Line Int. diameter
• If your current selection from the Pipe standard list is ANSI or DIN,
SmartPlant Instrumentation allows you to set additional fields from the
Line Properties dialog box that opens. If you closed this dialog box and
want to reopen it, on the Options menu, click Pipe Data.
• The method and effects of changing the pipe standard, and the impact of
these changes on the current parameters, are summarized in the table
below:
Change Action Result
ANSI DIN: ANSI / Select ANSI or DIN See the first and fourth notes. See
DIN to Other: Other to Select Other Select the second and third notes. See
ANSI / DIN: ANSI or DIN the first and third notes.
Notes
• The Pipe Data dialog box opens for new parameter selections.
• If you change your Pipe standard selection from ANSI or DIN to Other,
the parameter fields become editable.
• If you change from ANSI or DIN to Other, SmartPlant Instrumentation
hides the Line schedule field. If you change from Other to ANSI or
DIN, this field appears.
• If you change from ANSI to DIN or from DIN to ANSI, your selection in
the Pipe Data dialog box changes all parameters except for pipe material
and pipe spec.
• Fluid state: Indicates whether the fluid is a generic liquid, water, a generic
gas, steam, or solid/powder. Selecting the fluid opens the properties
section with the appropriate parameters for selection.
• Fluid name: When the User-defined option is selected from the list, you
can type the name of the fluid in the text box.
• Fluid phase: The phase indicates whether the fluid is single or 2-phase.
This selection is for information only.
Related Topics
• Copying Instrument Process Data from Another Instrument, page 364
Important
• Before deleting process data, note that deleted process data cannot be
restored.
If you enter fluid flow as mass or volumetric flow at standard / normal / base
conditions, SmartPlant Instrumentation will calculate volumetric flow at flow
conditions first (using density values) and then the line fluid velocity.
Note
• For flowmeters, fluid velocity at operating conditions is calculated
automatically according to fluid flow and line internal diameter. If the
mass flow value has been entered, density is required for fluid velocity
calculation.
Note
• Each case has a separate drawing with its own revisions. Each drawing
includes the case name as part of the drawing name.
In the Process Data or Calculation modules, use the following procedures to
implement multiple process data cases:
• Enable cases for a tag or a line by assigning a case name to the current
process data
• Add additional cases to the tag or the line, thus creating multiple cases
Note
• Case names that you assign to a given line or tag can be duplicates of
names that you assign to cases in other lines and tags.
For either of these procedures, do one of the following:
• Open the process data sheet for an instrument tag from the Process Data
module or the Calculation module.
• Open a process data sheet for a line.
Note
• The Design Temperature and Design Pressure fields in the Additional
Properties section of a process data sheet, are common to all cases
associated with the data sheet. Any action (data entry, editing, or deletion
of data) in these fields is reflected in all the cases, irrespective of which
case the action was carried out on.
Related Topics
• Deleting a Process Data Case, page 390
• Managing the Cases Supporting Table, page 389
• Multiple Process Data Cases, page 385
• Setting a Governing Case, page 388
Note
• Once you have enabled cases for line or a tag, if there is only one case,
SmartPlant Instrumentation automatically defines it as the governing case.
If you subsequently enable additional cases, the first case still remains the
governing case until you set a new governing case.
Note
• Case names that you assign to a set of process data for a given line or tag
can be duplicates of names that you assign to cases in other lines and tags.
Important
• Deletion of a case is irreversible.
Related Topics
• Creating Process Data Cases, page 386
• Managing the Cases Supporting Table, page 389
• Multiple Process Data Cases, page 385
• Setting a Governing Case, page 388
Process Analyzers
Process analyzers measure physical or chemical properties of a process flow.
SmartPlant Instrumentation supports two types of process analyzers — simple and
complex.
Simple Analyzers
A simple analyzer measures one physical or chemical property of a process fluid at
the point of measurement or fluid sampling.
Important
• Simple analyzers belong to the Conventional Tag Class.
Complex Analyzers
A complex analyzer also measures physical and chemical properties of a process flow
at the point of measurement or fluid sampling. However, you have the following
elements of flexibility in a complex analyzer:
Although the application determines whether you define some analyzers as simple or
complex, gas chromatographs are by their nature complex. Even if you consider one
stream only, in general you will want to utilize the ability of a gas chromatograph to
analyze various components/properties in the stream.
For procedures related to complex analyzers, see Flow of Activities for Complex
Analyzers, page 392.
Related Topics
• Flow of Activities for Complex Analyzers, page 392
The Line Components table that you create individually for each line is based on a
Fluid Components supporting table — which you also manage — that is available
for all lines.
For both procedures, open a process data sheet for the line for which you want to
create a Line Components table.
Related Topics
• Defining a Complex Analyzer, page 394
• Flow of Activities for Complex Analyzers, page 392
• Linking Analyzer Stream Components with Line Components, page 395
• Process Analyzers, page 391
Related Topics
• Flow of Activities for Complex Analyzers, page 392
• Linking Analyzer Stream Components with Line Components, page 395
• Managing Line Component Tables, page 393
• Process Analyzers, page 391
Related Topics
• Defining a Complex Analyzer, page 394
• Flow of Activities for Complex Analyzers, page 392
• Managing Line Component Tables, page 393
• Process Analyzers, page 391
Use this procedure to define a pipe spec to the Pipe Specs supporting table from the
Process Data module, or to modify properties of an existing pipe spec.
Note
• You cannot delete a pipe spec that is currently assigned to lines. First edit
the lines to which the pipes spec that you want to delete is assigned.
Related Topics
• Defining or Modifying Pipe Specs, page 398
Related Topics
• Converting Engineering Units of Measure Automatically, page 402
• Copying Default Units of Measure from Another <Unit>, page 403
Note
• When converting from one engineering unit to another, the data value
changes in accordance with the new engineering unit.
Related Topics
• Setting the Default Units of Measure, page 400
Related Topics
• Setting the Default Units of Measure, page 400
Note
• Use this procedure to import back into SmartPlant Instrumentation process
data for a tag that already exists in your SmartPlant Instrumentation
database.
5. In the dialog box that opens, navigate to the folder from which you want to import
the file.
6. Select the desired file and click Open.
Tip
• The software only accepts .ipd files that contain line data.
7. Under Search results, select the Select check box beside the lines that you want
to import.
Tip
• The software only displays lines that already exist in your SmartPlant
Instrumentation database.
8. Click Apply or OK.
Related Topics
• Exporting Process Data Files, page 406
8. In the dialog box that opens, navigate to the folder to which you want to export,
type a filename, and click OK.
Related Topics
• Importing Process Data Files, page 404
Related Topics
• Generating a Process Data Report for One Instrument or Line, page 409
• Generating Instrument Reports, page 411
• Generating Line Reports, page 410
Note
• If you are generating a report for a multi-case instrument tag, this option
prints the current case.
Related Topics
• Generating a Process Data Report for One Instrument or Line, page 409
Related Topics
• Generating a Process Data Report for One Instrument or Line, page 409
• Generating Line Reports, page 410
Note
• If the process data workflow control has been enabled, only users with
access rights are able to edit the Process Data Revisions. For more details,
see Workflow, page ???.
• Click .
• On the Actions menu, click External Revisions.
2. In the Revisions dialog box, select one of the revision numbering methods (use
P0, P1, P2... for preliminary revisions or 0, 1, 2 /A, B, C, and so forth for normal
serial revisions).
Tip
• When you first select a revision numbering method, several options
are available to you, including preliminary revisions (designated by
P0, P1, P2…). Once you select one of the other revision methods, you
will not be able to return to the preliminary revision method and this
option will be disabled.
3. Click New to add a new revision or click in a data field to update existing revision
data in that field.
4. Add or edit the revision data in the appropriate data fields.
Tip
• The By data field contains the current user's initials by default, if
previously defined by the SmartPlant Instrumentation System
Administrator. You can also edit this field if desired.
5. To delete revisions, do the following:
a. Select the revision you want to delete.
b. Click Delete.
Tip
• As a time saver and a forget-me-not precaution, take advantage of
using a default Revision method. The software automatically adds a
new line with the next logical character and date each time you click
New after you select the initial method.
6. When done, click OK.
Note
• If the process data workflow control has been enabled, only users with
access rights are able to edit the Process Data Revisions. For more details,
see Workflow, page ???.
Related Topics
• Viewing and Editing Process Data Revisions, page 412
The Calculation module employs the major international standards (ISA, ANSI, API,
ISO, and IEC 60534-2-1 (1998)), to perform complex control valve, flow element,
relief valve, and thermowell calculations quickly and effortlessly.
Calculation data originates mainly from the Process Data module, but also from the
Instrument Index module. You then open the relevant dialog box for the specified
instrument type, (control valve, flowmeter, relief valve, or thermowell), enter all the
parameters required for calculation, and initiate the calculation. After performing the
calculation, the relevant data may then be incorporated into generated reports and
specifications.
Notes
• The software does not support calculations for materials for which the
state is solid/powder, nor for 2-phase flow.
• If you need to add or modify process data, you can do this in the
Calculation module (for details, see Editing Instrument Process Data,
page 361).
Related Topics
• Multiple Process Data Cases, page 385
Note
• Before starting this module, check with the Domain Administrator to
ensure that you have been granted appropriate access rights for the tasks
you will carry out.
Note
• You can also select a batch of instruments of a given process function for
calculation (for details, see Multiple Process Data Cases, page 385).
Related Topics
• Multiple Process Data Cases, page 385
• Performing Calculations, page 422
Fluid Definition
When opening a tag in a process data sheet, you are required to define the fluid for
which a calculation will be carried out. You define the fluid by selecting the fluid
state, entering the fluid name or selecting it from one of the two property databases,
and setting the fluid phase.
Notes
• If this is a new tag that you just created in the Calculation module, the
PROPERTIES section of the window will be blank until you select the
required Fluid State.
• The software does not support calculations for materials for which the
state is solid/powder, nor for 2-phase flow.
Related Topics
• Multiple Process Data Cases, page 385
Performing Calculations
The calculation dialog boxes comprise the essence of the Calculation module. The
values that you enter in these dialog boxes together with the data in the process data
sheets serve as the basis of the calculations displayed on the screen. Calculation item
reports provide information that is more comprehensive.
Tip
• When you open a Calculation Item window and some of the process data
values are not filled in, you can click Highlight Process Data on the
Options menu to highlight all the fields that you must fill in to carry out
the calculation.
Related Topics
• Calculating a Control Valve, page 433
• Calculating a Relief Valve, page 430
• Calculating a Thermowell, page 436
• Preparing for Flowmeter Calculation, page 423
Notes
• By default, SmartPlant Instrumentation updates tag values from the
current unit of measure to their value in a new unit of measure that you
set. If on the Options menu you clear Automatic Unit Conversion, the
software changes the unit of measure without recalculating the values.
Therefore, to protect the integrity of your values, on the Options menu,
click Automatic Unit Conversion.
• To highlight the fields that are required for a calculation, on the Options
menu, click Highlight Process Data.
Related Topics
• Editing Instrument Process Data, page 361
• Multiple Process Data Cases, page 385
• Orifice Flowmeter Calculation, page 424
• Restriction Device Calculation, page 428
Tips
• The Orifice material list contains standard options provided with
SmartPlant Instrumentation. If the required orifice material is not in
the list, select from the list the MATERIAL NOT LISTED option
and in the Linear expansion coefficient field type the required linear
expansion coefficient.
• If you select a standard option from the Orifice material list, you
cannot change the linear expansion coefficient value for the displayed
orifice material because this is the standard value taken from
SmartPlant Instrumentation database.
7. In the Diameter of bleed/vent hole field, type the required diameter of the
bleed/vent hole or accept the given value.
Tips
• When calculating the orifice flowmeter parameters for the Steam fluid
state, in the Water in steam, %wt field, type the percentage of water
in steam.
• If the value in the Full scale flow field has been changed, you can
click to get the values from the Process Data module.
8. Under Select calculate field, select one of the following options to calculate the
orifice flowmeter parameters:
• Orifice diameter
• Full scale flow
• Differential range
9. Click Calculate.
10. Examine the calculation results and possible calibration error messages.
Tips
• The units of pressure loss derive from the default units for Differential
Range (Flow) set in the Units of Measure and Accuracy dialog box.
• When sizing flowmeters for Liquids and Water, SmartPlant
Instrumentation checks whether Downstream pressure is greater than
Vapor pressure. If it is, the program continues sizing. If it is not,
critical flow takes place, and the program advises you to check the
input data.
11. To recalculate the orifice flowmeter parameters, enter the new data and click the
Calculate command button.
12. Click Close to return to the calculation data sheet.
Related Topics
• Preparing for Flowmeter Calculation, page 423
• When calculating the tube flowmeter parameters for the steam fluid
state, in the Water in steam, %wt field, type the percentage of water
in steam.
• If the value in the Full scale flow field has been changed, you can
click to retrieve the values from the Process Data module.
7. Under Select calculate field, select one of the following options to calculate the
tube flowmeter parameters:
• Throat diameter
• Full scale flow
• Differential range
8. Click OK to carry out and display the calculation results.
9. Examine the calculation results and possible calibration error messages.
Tips
• The values of pressure loss in the results comes from the default values
for differential range flow set in the Units of Measure and Accuracy
dialog box.
• When sizing flowmeters for Liquids and Water, the software checks
whether Downstream pressure is greater than Vapor pressure. If it
is, the program continues sizing. If it is not, critical flow takes place,
and the program advises you to check the input data.
10. To recalculate the tube flowmeter parameters, enter the new data and then click
Calculate.
11. Click Close to return to the calculation data sheet, where you can click to
generate a report for the current calculation result. Error messages also appear in
a calculation report.
Related Topics
• Preparing for Flowmeter Calculation, page 423
7. In the Diameter of the bleed/vent hole field, accept the displayed value, or type
the diameter of the bleed/vent hole.
8. If needed, clear the Calculate discharge coefficient check box to enable you to
type the discharge coefficient.
Tips
• If you leave the Calculate discharge coefficient check box selected,
the software automatically calculates the discharge coefficient
according to the preset values.
• When calculating the restriction device parameters for the Steam fluid
state, in the Water in steam, %wt field, type the percentage of water
in steam.
• If the value in the Full scale flow field has been changed, you can
click to get the values from the Process Data module.
9. Under Select calculate field, select one of the following options to calculate the
restriction device parameters:
• Orifice diameter
• Full scale flow
• Pressure loss
Caution
• Do not type any values in the field next to the selected calculation
option.
10. Click OK to carry out and display the calculation results.
11. Examine the calculation results and possible calibration error messages.
Tips
• The values of pressure loss in the results comes from the default values
for differential range flow set in the Units of Measure and Accuracy
dialog box.
• When sizing flowmeters for Liquids and Water, SmartPlant
Instrumentation checks whether Downstream pressure is greater than
Vapor pressure. If it is, the program continues sizing. If it is not,
critical flow takes place, and the program advises you to check the
input data.
12. To recalculate the restriction device parameters, enter the new data and then click
Calculate.
13. Click Close to return to the calculation data sheet, where you can click to
generate a report for the current calculation result. Error messages also appear in
a calculation report.
Notes
• By default, SmartPlant Instrumentation updates tag values from the
current unit of measure to their value in a new unit of measure that you
set. If on the Options menu you clear Automatic Unit Conversion, the
software changes the unit of measure without recalculating the values!
Therefore, to protect the integrity of your values, on the Options menu,
click Automatic Unit Conversion.
• To highlight the fields that are required for a calculation, on the Options
menu, click Highlight Process Data.
Related Topics
• Calculating a Relief Valve in Case of Fire, page 432
• Entering Built-Up Back Pressure - Relief Valve, page 447
• Multiple Process Data Cases, page 385
Notes
• By default, SmartPlant Instrumentation updates tag values from the
current unit of measure to their value in a new unit of measure that you
set. If on the Options menu you clear Automatic Unit Conversion, the
software changes the unit of measure without recalculating the values.
Therefore, to protect the integrity of your values, on the Options menu,
click Automatic Unit Conversion.
• To highlight the fields that are required for a calculation, on the Options
menu, click Highlight Process Data.
Notes
• By default, SmartPlant Instrumentation updates tag values from the
current unit of measure to their value in a new unit of measure that you
set. If on the Options menu you clear Automatic Unit Conversion, the
software changes the unit of measure without recalculating the values.
Therefore, to protect the integrity of your values, on the Options menu,
click Automatic Unit Conversion.
• To highlight the fields that are required for a calculation, on the Options
menu, click Highlight Process Data.
8. Based on the value that you selected from the Fluid state list on the process data
sheet, do one of the following:
• If you set Liquid or Water, select Masoneilan or IEC from the Noise
calculation method list.
• If you set Gas/Vapor or Steam, select ISA or IEC from the Noise
calculation method list.
9. Enter hydrodynamic noise data as necessary.
Tip
• This option is available only If under State you selected Liquid or
Water, and under Noise Calculation Method you selected IEC.
10. From the Body type list, select the required body type.
11. Enter the required critical flow factor values (Fl, Cf) at minimum, normal, and
maximum control valve coefficients.
12. To define the required pressure drop ratio factor values (Xt) at minimum, normal,
and maximum control valve coefficients, do one of the following:
• To calculate the values automatically, as a function of critical flow,
select Calculate pressure drop ratio factor.
• Type the required values in the @Minimum, @Normal, and
@Maximum fields.
13. Type the Valve style modifier (Fd) value.
14. To set the Relative capacity value, do one of the following:
• Accept the value that SmartPlant Instrumentation calculates based on
the calculation method and on the standard that you selected from the
Flow coefficient list.
• Type the value that you require.
15. Type the required Number of flow passages.
16. Enter the appropriate Valve size and select its unit of measure.
17. To set the outlet pipe diameter, do one of the following:
• Under Outlet pipe diameter, type the value required.
• Click Default to apply the inlet pipe diameter.
18. Click Calculate to carry out and display the calculation results.
19. Examine the figures for results that may have to be re-calculated.
20. To recalculate the orifice flowmeter parameters, enter the new data and click the
Calculate command button.
21. Click Close to return to the calculation data sheet.
Tip
• You can calculate a control valve and the relevant parameters even if
the pipe wall thickness is not defined. In this case, Noise is not
calculated and a line of text in Notes section of the calculation sheet
informs you that Noise will not be calculated because Pipe wall
thickness is not defined.
Related Topics
• Multiple Process Data Cases, page 385
• Recommended Control Valve Characteristic, page 446
Calculating a Thermowell
A thermowell, inserted into a pipe, enables you to calculate tag temperature. This
procedure shows you how SmartPlant Instrumentation calculates the maximum
permissible length of a thermowell. The calculation is based on the maximum
frequency that the thermowell can withstand. The calculation complies with ASME
PTC 19.3 Standard.
Notes
• By default, SmartPlant Instrumentation updates tag values from the
current unit of measure to their value in a new unit of measure that you
set. If on the Options menu you clear Automatic Unit Conversion, the
software changes the unit of measure without recalculating the values.
Therefore, to protect the integrity of your values, on the Options menu,
click Automatic Unit Conversion.
• To highlight the fields that are required for a calculation, on the Options
menu, click Highlight Process Data.
Related Topics
• Multiple Process Data Cases, page 385
Notes
• You must define process data before calculation.
• After calculating tags, you can change parameters and then use this
procedure to recalculate.
9. To display process data for a given tag, in the Batch Calculation window, select
a tag, and on the Reports menu, click Process Data Report.
Related Topics
• Generating Calculation Item Reports, page 442
• Performing Calculations, page 422
Related Topics
• Creating a Hybrid Case, page 440
• Multiple Process Data Cases, page 385
Caution
• When generating a report, only those items that include the saved
calculation results appear on the list in the Find Tag dialog box.
Related Topics
• Calculation Revisions, page 443
• Performing Calculations, page 422
Calculation Revisions
The revision feature is used to keep track of the changes made to SmartPlant
Instrumentation reports and items, including calculations. It is important and useful
to have a chronological description of the changes, dates of change, and a list of
persons who approved them. Use this procedure to add, edit, and delete revisions.
Note
• You can also maintain revisions in batch mode using global revisions (for
more information, see Global Revisions: An Overview, page ???.
Related Topics
• Generating Calculation Item Reports, page 442
Note
• Make sure that you enter the required pressure drop, pump drop, and
system loss values in the process data sheet before performing this
procedure.
Specifications: An Overview
The Specifications module provides the means to efficiently generate detailed
specification documents (often referred to as specs). This is helpful for engineering
and ordering procedures and provides a useful permanent record for checking
installed instruments. The Specifications module also incorporates data from the
Instrument Index, Process Data, and Calculation modules into generated documents.
You can generate any type of specification (that is, single-tag instrument spec,
composite spec, multi-tag spec, and so forth) in the Specifications module. Also, it is
possible to generate single-tag instrument specs in the Domain Explorer. Note,
however, that if you want to generate a spec in the Domain Explorer, you must first
assign a specific spec form to the instrument type profile. A generated specification
automatically appears in the Domain Explorer, under the items for which you
generated the specification. You can open an existing spec either from the Domain
Explorer, Specifications module, or Instrument Index Standard Browser view.
When printing a specification, we recommend that the print sheet size be either A4 or
Letter. Note, however, that if the title block assignment method in the current domain
is defined as Standard (used in all modules), you need to adjust your title block
before printing specs using the Letter size. For details, see Spec Title Blocks: An
Overview, page 547.
Related Topics
• Composite Specifications: An Overview, page 539
• Copying Specification Data Common Tasks, page 555
• Managing Spec Pages Common Tasks, page 459
• Multi-Tag Specs Common Tasks, page 518
• Non-Instrument Specs Common Tasks, page 536
• Principles of Generating Specifications, page 449
• Printing Specifications and Reports Common Tasks, page 597
• Save, Export, and Import Options Common Tasks, page 569
• Single-Tag Specs Common Tasks, page 508
• Spec Forms Common Tasks, page 492
• Spec Title Block Common Tasks, page 549
• Specification General Operations Common Tasks, page 451
When you first create a specification for an item, you have to specify the form
number to create the item-form association. On subsequent occasions, you only need
to specify the item number to display the specification. It is only possible to generate
a spec in the Specifications module. On generating a spec, the software automatically
creates a unique document number for the spec.
Each specification is made up of data portions. For example: general data, process
data, construction data, purchase data, a note field, and a specification header, which
is the title block. The General Data portion of the spec includes details that were
entered in the Instrument Index module. The Process Conditions portion values are
derived from the Process Data module (if available) along with calculation results
from the Calculation module (if available). If you defined multiple cases for a given
tag, the specification displays the process data from the governing case.
Notes
• If you want to generate a non-instrument spec, for example, a panel spec, a
hook-up item spec, and so forth, you must first restore the appropriate
library forms.
• You cannot generate specifications for virtual tags.
• It is only possible to generate one spec at a time.
Related Topics
• Composite Specifications: An Overview, page 539
• Multi-Tag Specs: An Overview, page 517
• Non-Instrument Specs: An Overview, page 535
• Process Data Case Specs: An Overview, page 513
• Single-Tag Specs: An Overview, page 507
• Specifications: An Overview, page 448
Related Topics
• Principles of Generating Specifications, page 449
• Specifications: An Overview, page 448
• If you do not select any format, the software creates the spec as a
single-tag spec even if the source form is defined as a multi-tag form.
Afterwards, you can move this spec it to a new multi-tag spec or an
existing one.
5. If you defined a form data template for the selected spec form in the
Specifications module, from the Copy data from template list, select a template
from which you want to copy the default data to a generated spec.
6. On the Instrument Type Profile dialog box, click OK.
7. On the Instrument Types dialog box, click OK.
8. On the menu bar, click File > Preferences.
9. On the Preferences dialog box, click Instrument Index > Profile page, do one
of the following:
• Select Specifications and maintenance events if you want to use the
defined profile options automatically when creating tag numbers.
• Clear Specifications and maintenance events if you want to create
tag numbers without any specifications. If you then manually generate
a specification for the created tag, the software applies the existing
instrument type profile options.
Related Topics
• Specification General Operations Common Tasks, page 451
Tip
• The software does not open the generated specs automatically because
you cannot open several specs at a time. If you want to open a spec,
select a specific instrument and then, on the shortcut menu, click
Reports > Specification.
Related Topics
• Principles of Generating Specifications, page 449
• Specification General Operations Common Tasks, page 451
Related Topics
• Specification General Operations Common Tasks, page 451
• Specifications: An Overview, page 448
c. Click Find to display a list of items according to the search parameters that
you have selected.
d. Select the required item from the retrieved list.
e. Click OK to accept your choice and return to the Open Specification dialog
box.
6. With the mouse pointer in the Form number box, do the following:
a. Click Find to open the Select Specification Form dialog box.
b. Select the required form and click OK.
7. On the Open Specification dialog box, click OK to open the spec associated with
the item that you selected.
Related Topics
• Open a Spec from the Instrument Index Standard Browser View, page 454
• Specification General Operations Common Tasks, page 451
• Specifications: An Overview, page 448
SmartPlant Instrumentation provides a default library of spec pages you can use in
spec forms. A spec is always associated with a specific process function. If needed,
you can select a different process function for a page, provided that this page is not in
use in specs. A spec page contains a number of data fields, which correspond to table
columns in the database, and also contains field headers, which correspond to column
headers in the database. You can customize the data fields and fields headers to fit
specific requirements. You cannot, however, create new pages in SmartPlant
Instrumentation.
All spec pages are based on the A4 print sheet size. It is also possible to use the
Letter print sheet size when printing specs. Note, however, that if the title block
assignment method in the current domain is defined as Standard (used in all
modules), you need to adjust your title block before printing specs using the Letter
size. For details, see Spec Title Blocks: An Overview, page 547.
You open and manage spec pages in the Page Editor of the Specifications module.
Then you can use the Edit Fields and Headers floating toolbar options to modify the
spec page field layout without having to use a third-party interface, such as
InfoMaker. Note, however, that if you want to assign new select lists or drop-down
data window to spec page fields, you must use InfoMaker.
Related Topics
• Add a Select List in a PSR File, page 625
• Add a Unit of Measure Drop-Down Data Window in a PSR File, page 624
• Composite Specifications: An Overview, page 539
• Customizing Pages in the Page Editor Common Tasks, page 481
• Maintenance Event Records: An Overview, page 720
• Managing Spec Pages Common Tasks, page 459
Open a Page
Use this procedure to open a spec page in the Page Editor. You can open one page at
a time. For more information, see Open a Page, page 461.
Delete a Page
Use this procedure to delete a specific spec page that are not associated with forms,
that is, a page you opened from a file, or a new page that you created on the basis of
an existing page. Also, you can delete a page that was previously associated with a
library form but you decided to retain this page after deleting the form. After deleting
such a page, you can restore is automatically when restoring the library form that is
based on this page. If you want delete a page you saved to the database from an
external file, we recommend that you first save this page as a file. After deleting such
a page, you can restore it by opening it from the external file. For more information,
see Delete a Page, page 465.
In a print preview for a specification that contains a large note, the software displays a
large note on a separate page in which you can scroll up and down to view the note
text. When printing a specification with a large note page, the software automatically
counts the total number of sheets and divides the large note page into separate sheets,
depending on the note text length. For more information, see Create a Large Note
Page, page 466.
Related Topics
• Open a Form Page in InfoMaker, page 623
• Specification Page Customization: An Overview, page 480
• Specification Pages: An Overview, page 458
Open a Page
1. In the Specifications Module window, do one of the following to open the Page
Editor:
Related Topics
• Managing Spec Pages Common Tasks, page 459
Related Topics
• Managing Spec Pages Common Tasks, page 459
Related Topics
• Managing Spec Pages Common Tasks, page 459
4. Under Show Columns, click Show for each required table or view.
5. Under Select columns, do one of the following:
• Select the Select all check box to select all the columns in the table.
• Hold down the Ctrl key and select or clear specific columns as
desired.
6. Click OK.
Related Topics
• Managing Spec Pages Common Tasks, page 459
• Regenerate Pages in Batch Mode, page 464
Related Topics
• Managing Spec Pages Common Tasks, page 459
• Regenerate a Specification Page, page 463
2. To save the page to the database under a new name, or to save a page opened
from an external file, click Actions > Save as Page.
3. On the Save as Page dialog box, click New.
4. On a dialog box that opens, type a unique name and an optional description, and
then click OK.
Tips
• Clicking Actions > Save also saves the page to the database (under the
same name as the currently open page). You cannot use the Actions >
Save option to save a page opened from an external file.
• After you save a library page whose data fields you modified, it is
considered a custom page.
Related Topics
• Managing Spec Pages Common Tasks, page 459
Related Topics
• Managing Spec Pages Common Tasks, page 459
Delete a Page
1. On the Page Editor menu bar, click Actions > Delete Page.
2. On the Select Specification Page dialog box, select the page you want to delete
and click OK.
Tips
• In the Page Editor, you can only delete a specific page, provided that
it is not in use in a spec form. If you want to delete all pages included
in a particular form, you need to delete the entire form. If this form is
a library form, you can restore the deleted pages automatically when
restoring this form. Note, however, that when restoring the form, the
software only restores the library pages, not pages you opened from an
external file and then included in this form.
Related Topics
• Delete a Form, page 498
• Managing Spec Pages Common Tasks, page 459
• Restore Library Forms, page 498
Related Topics
• Managing Spec Pages Common Tasks, page 459
Tips
• Assigning a zero (0) to a field means that this field becomes non-
editable in a generated spec. Some fields are read-only by default and
not available for editing even if you assign a tab sequence to them.
• The zero number applies to all fields you added in the page using
InfoMaker. Therefore, in a spec page containing fields added in
InfoMaker, after defining the tab order, you must switch to the default
tab order. For details, see Switch to the Default Tab Order, page 469.
4. When done, click Actions > Tab Order once again, to clear the tab number
display.
Related Topics
• Managing Spec Pages Common Tasks, page 459
Caution
• This action overwrites the tab order in the currently open page with the
default tab order. After performing this procedure and saving the page, it
is not possible to revert to the original tab order.
1. With the specification page open for editing, click Actions > Tab Order to
display the tab numbers on the page according to the current tab order.
2. Click Actions > Default Tab Order.
3. Click Actions > Tab Order to clear the tab number display.
4. Save the spec page.
Related Topics
• Managing Spec Pages Common Tasks, page 459
3. Under Target folder, accept the displayed folder path, or click Browse do specify
a target folder for saving the selected custom pages as .psr files.
Tip
• The path displayed in the Target folder box is the path set for the
PSR working folder option on the Specifications > General page of
the Preferences dialog box.
4. Click OK.
Related Topics
• Customizing Form Pages in InfoMaker Common Tasks, page 621
• Managing Spec Pages Common Tasks, page 459
Related Topics
• Specification Page Customization: An Overview, page 480
• Specification Pages: An Overview, page 458
Related Topics
• Working with Page Graphics Common Tasks, page 472
Related Topics
• Change Line Properties, page 475
• Modify Line Position and Length Using Arrow Keys, page 474
• Modify Line Position and Length Using the Mouse, page 475
• Working with Page Graphics Common Tasks, page 472
Tip
• You need to define the line ID if you intend to save the current page in
.psr format and then customize it in InfoMaker. The line ID must be
unique.
7. Under Line color, select the color that you need.
8. Under Line style, select the option that you need.
9. Under Line thickness, type the new value or use the spinners to set a value using
PowerBuilder units from one to five.
10. Click OK to update the line properties on the page.
Related Topics
• Set Precise Position and Length of a Line, page 474
• Working with Page Graphics Common Tasks, page 472
Related Topics
• Working with Page Graphics Common Tasks, page 472
Related Topics
• Modify Position and Size of Page Objects Using Arrow Keys, page 479
• Modify Position and Size of Page Objects Using the Mouse, page 478
• Working with Page Graphics Common Tasks, page 472
Note
• You must use InfoMaker if you want to assign new select lists or drop-
down data window to spec page fields or if you need to customize
calibration form pages. For details, see Customizing Form Pages in
InfoMaker Common Tasks.
Related Topics
• Add a Select List in a PSR File, page 625
• Add a Unit of Measure Drop-Down Data Window in a PSR File, page 624
• Customizing Pages in the Page Editor Common Tasks, page 481
• Managing Spec Pages Common Tasks, page 459
Related Topics
• Guidelines for Customizing Pages for Save as Excel, page 578
• Specification Page Customization: An Overview, page 480
• Specification Pages: An Overview, page 458
Tip
• If you want to display an ampersand character & in the field header
text, in the Name box, enter &&. For example, to display the P&ID
header on the spec page, in the Name box, type P&&ID.
5. Click OK.
Related Topics
• Customizing Pages in the Page Editor Common Tasks, page 481
• On the Edit Fields and Headers toolbar, click and then click a
field in the Page Editor.
• In the Page Editor, select and double-click a field to open the
Computed Field dialog box showing the current computed value of
that field.
4. In the Name box, do one of the following:
• Type a new name to add a field with this name to the current page
• Type a field name which already exists in the current page or leave the
current value if you selected this field in the current page.
5. In the Expression box, type a value, function, or any other appropriate
expression.
6. Click Verify to verify that the expression you entered is a valid InfoMaker
expression.
7. Click OK.
Notes
• If you make changes to a field in the currently opened page, the software
displays the computed results automatically, using the settings you entered
on the Computed Field.
• See your InfoMaker User Guide for additional information about the data
types you can use as valid expressions for this procedure.
Related Topics
• Customizing Pages in the Page Editor Common Tasks, page 481
Tip
• For example, to show changes for the maximum pressure, the
expression is written as follows:
f_changevalue(cmpnt_id,rev_id,dwg_id,"pd_press_max")
6. Click Verify to verify that the expression you entered is a valid InfoMaker
expression.
7. Click OK.
8. To show the change in the specification, do the following:
a. Modify an existing value of a property for which you added a computed field
to display changes for the last revision.
b. Close the specification sheet and re-open it the following day.
c. Add a revision to the specification sheet and refresh the display.
Tips
• The indication appears only after the day advances on your computer's
clock.
• The indication appears only for existing values that were changed at
the last revision. If you enter a new value for a property that
previously did not have a value, no change is indicated.
Related Topics
• Customizing Pages in the Page Editor Common Tasks, page 481
9. Click OK.
Related Topics
• Customizing Pages in the Page Editor Common Tasks, page 481
Related Topics
• Customizing Pages in the Page Editor Common Tasks, page 481
Related Topics
• Customizing Pages in the Page Editor Common Tasks, page 481
4. Regenerate the page, and from the APPARATUS table, add the appropriate
APPAR_UDF columns as data fields in the page.
5. In the page, name the column headers to match the headers that you defined for
wiring equipment properties in the Wiring module.
Tips
• To display a list of headers, you need to open an external .psr file
WIRING_EQUIPMENT_UDF.PSR, which is located in the path
<SmartPlant Instrumentation home folder> \PSR. You can open the
file WIRING_EQUIPMENT_UDF.PSR using InfoMaker, or from the
Browser module.
• After adding custom fields in a spec page, you have to change the
column headers in the page so that they match the user-defined
property names in the Wiring Equipment Category Properties
dialog box, which you access for the Wiring module (with the Wiring
module main window open, click Tables > Wiring Equipment >
Categories).
Related Topics
• Customizing Pages in the Page Editor Common Tasks, page 481
• Regenerate a Specification Page, page 463
• Restore Library Forms, page 498
Related Topics
• Customizing Pages in the Page Editor Common Tasks, page 481
You can manage spec forms in the Specifications module, using the Form Editor
options. You can you change form properties, such as name, description, and
number, save a form either as a new form or as a spec page to fit your own
conventions.
After defining the form pages, you can create specs on the basis of this form. If you
want to generate a multi-tag spec containing a page where you can display values of
individual instruments, you must first create a multi-tag spec format on the basis on a
particular form. You can create other types of specs by assigning a SmartPlant
Instrumentation item directly to the number of the appropriate spec form. When you
assign a form to an item and generate a spec, the software creates the spec pages
according to the pages that the source form contains. You cannot modify the data
fields in the form itself, only in the form pages, which you can open in the Page
Editor.
It is possible to create multiple templates for a specific form and then, when
generating a spec, assign the item to the form data template rather than to the form.
You can then copy data from any other template based on the same form to the
current spec, and even copy data from the spec to any of these templates.
Related Topics
• Form Data Template Common Tasks, page 504
• Maintenance Event Records: An Overview, page 720
• Spec Forms Common Tasks, page 492
• Specification Page Customization: An Overview, page 480
• Specification Pages: An Overview, page 458
Create a Form
Use this procedure to create a form comprising one spec page. You can only create
and manage spec forms in the Specifications module. For more information, see
Create a Form, page 494.
Delete a Form
This procedure enables you to delete a form that is not in use in any spec. You can
either delete the form together with all of the pages included in the form, or just the
form itself, and then delete the pages manually, from the Page Editor. If the form
that you are about to delete is a library form, you can restore this form at any stage,
together with the library pages. However, you cannot restore custom pages included
in the form. For more information, see Delete a Form, page 498.
Related Topics
• Spec Forms: An Overview, page 491
Create a Form
1. In the Specifications Module window, do one of the following:
• Click Edit > Form Editor.
• On the toolbar, click .
2. In the Form Editor, click .
3. Select a page for the new form.
Tip
• A form must contain at least one page. You can add other pages in the
form after creating the form.
4. On the toolbar, click to save the form to the database.
Related Topics
• Spec Forms Common Tasks, page 492
• Spec Forms: An Overview, page 491
• Specification Page Customization: An Overview, page 480
• Specification Pages: An Overview, page 458
Related Topics
• Spec Forms Common Tasks, page 492
Related Topics
• Spec Forms Common Tasks, page 492
• Spec Forms: An Overview, page 491
• Specification Page Customization: An Overview, page 480
• Specification Pages: An Overview, page 458
Delete a Form
1. On the Form Editor menu bar, click Actions > Delete Form.
Tips
• You can only delete a form that is not in use in any specs.
• You can delete one form at a time.
• If the form has pages, and it is not in use in any spec, you are
prompted to delete all of the form pages as well. If the form that you
are about to delete is a library form, you can restore this form at any
stage, together with the library pages. However, you cannot restore
custom pages included in the form. Therefore, before deleting the
form, we recommend that you save the appropriate pages as external
files. You can save pages as files in the Page Editor.
2. On the Select Specification Form dialog box, select the form you want to delete
and click OK.
Related Topics
• Delete a Page, page 465
• Spec Forms Common Tasks, page 492
Related Topics
• Restore Library Forms, page 498
• Spec Forms Common Tasks, page 492
• Specification Page Customization: An Overview, page 480
• Specification Pages: An Overview, page 458
Related Topics
• Spec Forms Common Tasks, page 492
Related Topics
• Define a Multi-Form Browser, page 501
• Spec Forms Common Tasks, page 492
Cautions
• If you need to redefine fields for an existing multi-form browser that
already has browser created views created in the Browser module, note
that on recreating the browser, the software automatically deletes all the
existing views.
• On a multi-user database platform, before recreating a multi-form
browser, you must first make sure that other users have no views open for
this browser. Recreation of an existing browser when its view is open on
another machine results in unstable software behavior and the software
might close unexpectedly on the machine where the browser view is open.
1. In the Specifications Module window menu bar, click Define Multi-Form
Browser to open the Define Multi-Form Browser Wizard.
2. On the Welcome page, click Next.
3. On the Browser Name Definition and Selection page, do the following:
a. Beside browser, click the ellipsis button .
b. On the Multi-Form Browsers dialog box, click New and then type a unique
browser name and an optional description.
c. Click OK to close the Multi-Form Browsers dialog box and return to the
Browser Name Definition and Selection page.
d. Make sure the browser name appears in the Browser box and then click Next.
4. On the Item Type Selection page, select the specification form item type and
then click Next.
Tip
• At this stage, the software assigns the browser name to the form item
type.
5. On the Specification Form Selection page, select check boxes for those spec
forms whose fields want to include in the current browser.
6. Click Next.
7. On the Field Header Selection page, do the following:
a. If needed, click Filter and then specify the filter for displaying the field
headers that you require.
b. Under Field headers, select the field headers you want to display in the
browser view as column names.
c. Click Next.
8. On the Multi-Form Browser Creation page, click Finish.
9. Test the multi-form browser in the Browser module. For details, see Test a Multi-
Form Browser, page ???.
You base form data templates on a specific spec form. You can create multiple
templates for each form. The form data template name does not have to be unique
and can contain up to 50 alpha-numeric characters. After generating a spec based on
the form for which you defined data templates, you can select a template and copy its
data to the spec. Also, you can copy data to a form data template from a spec based
on the same form.
Related Topics
• Copy Data to a Form Data Template from a Spec, page 556
• Copy Data to a Spec from a Form Data Template, page 557
• Form Data Template Common Tasks, page 504
• Spec Forms: An Overview, page 491
Related Topics
• Copy Data to a Form Data Template from a Spec, page 556
• Copy Data to a Spec from a Form Data Template, page 557
• Form Data Templates: An Overview, page 503
Tip
• If the form data template has fields that are not accessible, these fields
are protected in the Spec Data Dictionary. You cannot enter values
in protected fields. When copying data, the software ignores protected
fields. For details, see Protect Fields from Overwriting When Copying
Data, page 555.
6. On the toolbar, click to save the changes.
7. If needed, on the toolbar, click to define and open another form data template
in the Form Data Template Editor.
Tips
• If you opened several templates in the Form Data Template Editor,
you can display the template that you require by selecting it on the
Window menu.
• We recommend that you define unique and meaningful names for your
form data templates. The software does not check whether the
template names are unique.
Related Topics
• Form Data Template Common Tasks, page 504
• Spec Forms: An Overview, page 491
Tips
• Deleting a form a data template does not affect the source spec form or
specs to which you copied data from the template.
• Deletion of a form data template is irreversible.*
Related Topics
• Form Data Template Common Tasks, page 504
• Spec Forms: An Overview, page 491
In the specification, you can edit some of the fields by clicking inside the field and
typing the required data. Other fields, such as Tag Number or Process Conditions
receive their data from the Instrument Index, Process Data or Calculation modules
and thus do not allow a direct editing. However, you can edit the process data and
calculation fields if you have been granted the appropriate access rights to do so. The
unit of measure fields allow you to select values from a predefined list of units. All
tag number property changes that are made not in the spec itself automatically take
effect in the spec generated for this tag.
It is possible to export single-tag specs to External Editor, where other users can edit
the appropriate data settings, and then import the edited data back to SmartPlant
Instrumentation.
Note
• If a single-tag spec has fieldbus columns, you can set preferences to allow
you to edit the fieldbus column values in the spec. However, you can only
make the fieldbus columns editable if the instrument type of the spec tag
number is Fieldbus.
Related Topics
• Single-Tag Specs Common Tasks, page 508
Related Topics
• Single-Tag Specs: An Overview, page 507
Related Topics
• Generate Instrument Specs in Batch Mode, page 453
• Principles of Generating Specifications, page 449
• Single-Tag Specs Common Tasks, page 508
• Single-Tag Specs: An Overview, page 507
Units of Measure
The Units of Measure (UOM) fields allow you to select a unit from a predefined list
of units. After selecting a pressure unit, you are prompted to choose the pressure
reading method. When you select volumetric flow units, you are prompted to select
the measurement conditions (at flow or at base).
Related Topics
• Single-Tag Specs Common Tasks, page 508
• Single-Tag Specs: An Overview, page 507
Related Topics
• Single-Tag Specs Common Tasks, page 508
• Single-Tag Specs: An Overview, page 507
Related Topics
• Generate a Single-Tag Spec, page 508
• Generate a Spec for an Analyzer Stream, page 526
You create process data case specifications in the same way that you create
specifications for other items. Since all process data case specifications share the
same tag number, creation of a process data case specification involves an additional
step, that is selecting the desired tag case. After you specify a tag number for creating
a new spec, the software automatically detects whether this tag number has multiple
cases and prompts you to select one of those cases.
Since all process data case specifications for a given instrument share the same spec
form, after creating the first specification for a particular case, you need to use the
same spec form for all subsequent process data case specifications that you create for
the instrument.
Note
• It is possible to generate a composite (multi-section) specification that
displays more than one process data case of an instrument. For details, see
Composite Spec for Instrument with Cases: Generation Workflow, page
542.
Related Topics
• Process Data Case Specifications Common Tasks, page 514
Related Topics
• Process Data Case Specs: An Overview, page 513
Related Topics
• Process Data Case Specifications Common Tasks, page 514
Tip
• The library form #76 is the library form supplied with SmartPlant
Instrumentation. This form contains columns that display minimum,
normal, and maximum flow coefficient values (Cv/Kv) you calculated
for the various cases in the Calculation module. If this form is not
displayed in the Select Specification Form dialog box, restore the
supplied library forms.
6. On the Open Specification dialog box, click OK to open the New Specification
dialog box, and then proceed with spec creation.
Related Topics
• Process Data Case Specifications Common Tasks, page 514
• Restore Library Forms, page 498
Instrument tags in a multi-tag spec must have identical process functions except for
the following case: if the spec form process function is General but the form pages do
not include any data fields from the PD_NOT_ASSIGN or PD_GENERAL tables,
such a spec can contain instruments whose process functions are not identical, for
example, such a spec can contain both Flow and Temperature instruments.
A multi-tag specification always contains one Notes page, one Multi-Tag List page,
and one or more common pages with fields that are identical for all of the tags. The
Tag Number field, and other specification fields that appear on the Multi-Tag List
page, show the words SEE LIST instead of data. The SEE LIST label indicates that
the values in the fields appear on the Multi-Tag List tab of the spec. The Multi-Tag
List page contains fields whose values can differ from tag to tag. You can change the
SEE LIST label to any other text using the appropriate option on the Multi-Tag
Specifications page of the Preferences dialog box.
It is possible to export multi-tag specs to External Editor, where other users can edit
the appropriate data settings, and then import the edited data back to SmartPlant
Instrumentation. Also, you can move tags to another multi-tag spec (to another see
list), or, on removing a tag, automatically generate a single-tag spec for this tag. You
cannot remove the master tag.
Notes
• You can include fieldbus instruments in a multi-tag spec. However, the
software does not support editing of fieldbus data fields in a multi-tag
spec.
• You cannot include composite pages in a multi-tag spec. For details of
composite specs, see Composite Specifications: An Overview, page 539.
Related Topics
• Formats Common Tasks, page 529
• Multi-Tag Specs Common Tasks, page 518
• Title Block in a Multi-Tag Spec, page 548
• You generate a multi-tag specification, with the stream tag as the more
master tag.
• You then add the instrument tags associated with this stream to the multi-
tag specification.
• Fields that relate to the stream are displayed on the common page or pages
(not in the see list).
• The fields that vary — the tag names and tag-specific values — are
displayed in the in the see list on the Multi-Tag List tab.
For more information, see Generate a Spec for an Analyzer Stream, page 526.
Related Topics
• Formats Common Tasks, page 529
• Multi-Tag Specs: An Overview, page 517
• Principles of Generating Specifications, page 449
Tip
• After generating the multi-tag spec, you can add other instrument tags
to the spec directly from the spec see list, without having to perform
the current procedure again.
Related Topics
• Generate Instrument Specs in Batch Mode, page 453
• Multi-Tag Spec Formats: An Overview, page 528
• Multi-Tag Specs Common Tasks, page 518
• Principles of Generating Specifications, page 449
Related Topics
• Multi-Tag Spec Formats: An Overview, page 528
• Multi-Tag Specs Common Tasks, page 518
Related Topics
• Multi-Tag Spec Formats: An Overview, page 528
• Multi-Tag Specs Common Tasks, page 518
2. Based on such a format, generate a multi-tag spec for the stream tag that you want
to set as the master tag.
3. In the Multi-Tag List of the generated spec, add other tags belonging to the
current analyzer stream.
4. Click Actions > Save.
Related Topics
• Add Instrument Tags to a Multi-Tag Spec in Batch Mode, page 522
• Create a Format, page 530
• Generate a Spec for a Complex Analyzer, page 512
• Multi-Tag Specs Common Tasks, page 518
• Restore Library Forms, page 498
Related Topics
• Formats Common Tasks, page 529
• Multi-Tag Specs Common Tasks, page 518
Create a Format
Use this procedure to create a formats for multi-tag specs. You create a format based
on a spec form, which in turn is based on a spec page. You can build an unlimited
number of formats based on a given form. When creating a format, you can edit the
headers of the columns that appear in the spec see list, and also fine-tune the order
and width of columns. For more information, see Create a Format, page 530.
Modify a Format
You can modify an existing format so that it fits the needs of your multi-tag specs.
The modification process is similar to creating a new format. Changes that you make
to a specification format affect multi-tag specs that are already associated with that
format. You modify formats in the Format Editor, in the Specifications module.
For more information, see Modify a Format, page 531.
Delete a Format
This procedure enables you to select a specific form, display its format, and then
delete a format that is not in use in multi-tag specs. For more information, see Delete
a Format, page 532.
Regenerate Formats
Use this procedure if you encounter problems with opening or printing a multi-tag
spec after upgrading your SmartPlant Instrumentation version. These problems occur
because certain format properties are not applied to a form. Format regeneration can
fix these problems. For more information, see Regenerate Formats, page 533.
Related Topics
• Multi-Tag Spec Formats: An Overview, page 528
• Multi-Tag Specs Common Tasks, page 518
Create a Format
1. On the Specifications Window module menu bar, click Edit > Format Editor.
2. On the Format Editor menu bar, click Actions > Open Format.
3. On the Select Specification Form dialog box, select a form and click OK.
4. On the Select Format dialog box, under Format, type the name of the new
format and click OK.
Tip
• If the form that you selected on the Select Specification Form dialog
box has existing formats, click New before typing the new format
name.
5. Do the following for each field that you want to appear on the spec see list:
a. In the field selection area of the form (usually on the right), double-click the
field.
b. To display the original form header in the active row of the Edit Headers
pop-up window, click the form header after the cursor changes its shape to
.
c. In the Edit Headers pop-up window, edit the header as necessary.
Tips
• The background color of the active field changes to magenta.
• Fields already added to the Edit Headers pop-up window are
highlighted in cyan.
• The icon in the left column of the Edit Headers pop-up window
points to the header input box for the active field. If you are working
from a library form, the form header was automatically copied to this
field.
6. On the Format Editor toolbar, click to generate the format.
7. To change the see list column position of a header and its field, do the following
in the Edit Headers pop-up window:
a. Select the header for which you want to change the column position.
b. Click Move Up or Move Down as necessary.
Tip
• The order of the headers in the Edit Headers pop-up window
determines the left-to-right column order on the Multi-Tag List tab
the spec.
8. To change the width of columns as they appear in the spec see list, do the
following on the Format dialog box:
a. Select portrait or landscape print preview.
b. Set the cursor on the border between two headers.
c. Drag the border to the left or to the right as necessary.
9. Click to save the new format.
Related Topics
• Formats Common Tasks, page 529
• Multi-Tag Spec Formats: An Overview, page 528
Modify a Format
1. On the Specifications Window module menu bar, click Edit > Format Editor.
2. On the Format Editor module menu bar, click Actions > Open Format.
3. On the Select Specification Form dialog box, select a form and click OK.
4. Select a format that you want to modify, and click OK.
5. To edit headers that currently appear in the Edit Headers pop-up window, do the
following:
a. In the field selection area of the form (usually on the right), double-click the
field for which you want to edit the header.
b. In the Edit Headers pop-up window, edit the header as necessary.
Tips
• When you double click the field, the background color of the field
changes to magenta.
• The icon in the left column of the Edit Headers pop-up window
points to the Header input box for the active field.
• To copy the original form header into the active Header input box,
click the form header after the cursor changes its shape to .
6. To remove a field and its header from the multi-tag list, do the following:
a. In the field selection area of the form, double-click the field that you want to
delete.
Related Topics
• Formats Common Tasks, page 529
• Multi-Tag Spec Formats: An Overview, page 528
Delete a Format
1. With the Specifications module window open, do one of the following:
• On the toolbar, click .
• On the Edit menu, click Format Editor.
2. Click Actions > Delete Formats.
3. On the Select Specification Form dialog box, select a form whose format you
want to delete, and then click OK.
4. On the Select Format dialog box, select the required format from the list.
Tips
• You can only select and delete one format at a time.
Related Topics
• Formats Common Tasks, page 529
• Multi-Tag Spec Formats: An Overview, page 528
Regenerate Formats
1. In the Specifications Module window, click Actions > Regenerate Formats.
2. On the Regenerate Formats dialog box, click Run.
3. On completion of the process, click Close.
Related Topics
• Formats Common Tasks, page 529
• Multi-Tag Spec Formats: An Overview, page 528
Related Topics
• Formats Common Tasks, page 529
• Multi-Tag Spec Formats: An Overview, page 528
5. On the form that opens, add field headers to the Edit Headers dialog box. For
details, see Create a Format, page 530.
Related Topics
• Non-Instrument Specs Common Tasks, page 536
Related Topics
• Non-Instrument Specs: An Overview, page 535
Related Topics
• Generate a Non-Instrument Spec, page 537
• Non-Instrument Specs Common Tasks, page 536
• Non-Instrument Specs: An Overview, page 535
In the Domain Explorer, document numbers of loop composite specs appear under
loop numbers and document numbers of instrument composite specs appear under
each instrument included in the spec. When duplicating an instrument tag associated
with a composite spec, the software never duplicates the composite spec. When
duplicating a loop, the software always duplicates the loop composite spec.
When printing a composite specification, we recommend that the print sheet size be
either A4 or Letter. Note, however, that if the title block assignment method in the
current domain is defined as Standard (used in all modules), you need to adjust
your title block before printing specs using the Letter size. For details, see Spec Title
Blocks: An Overview, page 547.
You manage spec sections in the Sections Editor. Spec section editing options are
the same as for spec pages, which you manage in the Page Editor. Therefore, before
modifying data fields in a spec section, it is recommended that you familiarize
yourself with spec page management options. For details, see Specification Pages:
An Overview, page 458 and the related topics. The Section Editor has a limited
number of editing options. It is possible, however, to export spec sections to
InfoMaker, edit them as you require, and then import them back to SmartPlant
Instrumentation.
9. In the Page Editor working area, position the sections one under the other, within
the page borders.
10. Save the page with the name CV/I/P Transducer Test.
11. Open the Form Editor and click Actions > New Form, select the Control
Valve/I/P Transducer page for the form, and then name the new form as CV/I/P
Transducer Test and specify a form number.
12. On the Specifications Module window menu bar, click Actions > Open
Specification and do the following:
a. From the Item type list, select Instrument.
b. In the Item number box, enter the tag number of the control valve you
created.
c. In the Form number box, enter the number of the CV/I/P Transducer Test
form and click OK.
d. On the New Composite Specification dialog box, beside I/P Transducer
Style1, click Assign and assign your I/P transducer to the I/P Transducer
Style1 section.
e. Click OK to generate and open an instrument composite specification.
Related Topics
• Composite Specifications: An Overview, page 539
• Principles of Generating Specifications, page 449
5. On the Specifications Module window menu bar, click Edit > Section Editor
and modify the fields of the following sections as you require:
• Flow Orifice Header (header section)
• Flow Orifice Data (data section)
6. On the Specifications Module window menu bar, click Edit > Page Editor.
7. On the Page Editor menu bar, click Actions > New Composite Page.
8. On the New Composite Page dialog box, select Header section and data
section.
9. On the Select Sections for Composite Page dialog box, select the following
sections:
• Flow Orifice Header
• Flow Orifice Data
10. In the Page Editor working area, position the sections one under the other.
11. Save the page with the name Orifice Plate Composite Test.
12. Open the Form Editor and click Actions > New Form, select the Orifice Plate
Composite page for the form, and then name the new form as Orifice Plate
Composite Test and specify a form number.
13. On the Specifications Module window menu bar, click Actions > Open
Specification and do the following:
a. From the Item type list, select Instrument.
b. In the Item number box, enter the tag number of the flow instrument that has
cases.
c. In the Form number box, enter the number of the Orifice Plate Composite
Test form and click OK.
d. Select a case to assign it to the instrument composite spec you are creating and
click OK.
e. On the New Composite Specification dialog box, beside Flow Orifice Data,
click Assign and assign the two remaining cases to the Flow Orifice Data
section.
f. Click OK to generate and open an instrument composite specification.
Tip
• In the composite spec, the sections that show case data appear from
left to right. The sections are sorted in ascending order according to
case sequence defined in the Process Data module (governing case is
always the left-most section).
Related Topics
• Composite Specifications: An Overview, page 539
• Principles of Generating Specifications, page 449
Tip
• When you select a section multiplying option, you determine how the
software multiplies sections in a generated composite spec. In a
generated spec, if you assigned more than one instrument to a section,
the software multiplies this section on the spec as many times as the
number of assigned instruments. You set a section multiplying option
only once and cannot change it after you open and save the current
spec page in the Page Editor. This setting applies to all instrument
sections you add in the current spec page.
9. In the Page Editor working area, position the sections one under the other, with
the loop section placed at the top.
10. Save the page with the name Flow Loop Test.
11. Open the Form Editor and click Actions > New Form, select the Flow Loop
Test page for the form, and then name the new form as Flow Loop Test and
specify a form number.
12. On the Specifications Module window menu bar, click Actions > Open
Specification and do the following:
a. From the Item type list, select Loop.
b. In the Item number box, enter the number of the loop you created.
c. In the Form number box, enter the number of the Flow Loop Test form and
click OK.
d. On the New Composite Specification dialog box, beside Control Valve
Style1, click Assign and assign the current loop control valve to the Control
Valve Style1 section.
e. Beside I/P Transducer Style1, click Assign and assign the current loop I/P
transducer to the I/P Transducer Style1 section.
f. Click OK to generate and open a loop composite specification.
Related Topics
• Composite Specifications: An Overview, page 539
• Principles of Generating Specifications, page 449
Tips
• When removing tags from a loop composite spec, you can remove all
the instruments.
• When removing tags from an instrument composite spec, you cannot
remove the last remaining tag because such a spec must include at
least one instrument tag.
• After removing instruments, the sections remain displayed in the spec.
If you want to remove these sections from the spec, you must remove
them in the Page Editor. For details, see Remove a Section from a
Composite Page, page 546.
4. On the toolbar, click to save the changes.
Related Topics
• Composite Specifications: An Overview, page 539
This method allows you to associate one default title block with all the specs you
generate. When using this method, the software hides all the title block assignment
options that are available in the Specifications module. In this case, you need to
associate your title block with SmartPlant Instrumentation on the Title Blocks dialog
box, page ???. The Domain Administrator, when managing reports, can then define
your title block as the default title block that appears automatically in all
specifications that you generate.
Notes
• If you print specs using the A4 sheet size, we recommend that you use the
Specs Default TB with PB Units.psr title block with specs, which is fully
compatible with all the library forms and does not require any manual
adjustments. This is a template title block that is shipped with SmartPlant
Instrumentation. This title block is created using PowerBuilder units.
• If you print specs using the Letter sheet size, you must first customize the
Specs Default TB with PB Units.psr title block in InfoMaker by
reducing the title block height. Removing two revision rows from the title
block is enough to make it appear correctly in a printout of any spec based
on a library form.
• If you want to use a custom title block, you need to place the title block
correctly in a spec page layout. To do so, on the Preferences dialog box,
Specifications > Custom page, under Parameter, enter
TitleFooterHeight, and under Value, enter 798, which is the optimal
value for specifications created using SmartPlant Instrumentation options.
For a spec page created in InfoMaker, you may need to enter a different
value, depending on the page layout settings.
This method allows you to assign various title blocks to spec forms. If this method is
defined in the current domain, the Domain Administrator does not assign any default
title block to your specs, so you need to make title block assignments by yourself,
using the Specifications module options. You can create multiple custom title blocks
and associate then with SmartPlant Instrumentation using the Title Block Styles dialog
box, page ???. Depending on your database platform, you must only use one of the
following title blocks as a source for creating custom title blocks: tb_mss.psr (when
using SQL Server), tb_ora.psr (when using Oracle, or Tbsample.psr (when using
Sybase Adaptive Server Anywhere).
Note
• When working with composite specs, you cannot use the title block
assignment options that are available in the Specifications module.
Therefore, if the selected block assignment method is Special, the
software automatically assigns the default title block to a composite spec
even though the module-specific option are available in the Specifications
module. This title block is supplied with SmartPlant Instrumentation and
is associated by default with all SmartPlant Instrumentation reports.
Related Topics
• Customize a Title Block in InfoMaker, page 550
• Spec Title Block Common Tasks, page 549
• Title Block in a Multi-Tag Spec, page 548
Related Topics
• Multi-Tag Specs: An Overview, page 517
• Spec Title Block Common Tasks, page 549
Related Topics
• Spec Title Blocks: An Overview, page 547
• If you move any report layout items while working on the report
layout, make sure you reposition those items exactly in their original
locations.
Tips
• You cannot insert a new field in the report layout. You can only
modify existing fields.
• If you want to use the Specs Default TB with PB Units.psr in your
specs and print specs using the Letter size, we recommend that you
remove two revision rows from this title block in InfoMaker to adjust
the title block height for the Letter size.
• The width of the title block should not be greater than 7.5" in portrait
layout or 9.8" in landscape layout.
4. Save the report layout under a different name and close InfoMaker.
Related Topics
• Spec Title Block Common Tasks, page 549
• Spec Title Blocks: An Overview, page 547
a. On the Specifications Module window menu bar, click Actions > Associate
Title Block.
b. On the Select Specification Form dialog box, select a form, and click OK.
c. On the Associate Title Block dialog box, under Style Name, select the title
block that you imported.
d. Under Choose location, select Detail.
e. Drag the title block to the required location in the specification page and when
done, click OK.
Related Topics
• Spec Title Block Common Tasks, page 549
Related Topics
• Spec Title Block Common Tasks, page 549
• Form data template— You can copy data to any spec whose form is the
same as the template form.
• Specification — You can copy data either to another spec or to a form
data template, provided that the source and target form is the same. When
you copy data to a form data template, the software does not affect data of
existing specs that are based on this template.
Data copying options are only available in the Specifications module. You cannot
copy specification data in batch mode.
You can protect all or certain fields from being overwritten when you copy
specification data. You can protect the appropriate fields in the Spec Data
Dictionary. Also, you can set preferences for copying specification data. The
following options are available on the Preferences dialog box (File > Preferences >
Specifications > General):
Related Topics
• Copying Specification Data: An Overview, page 554
Related Topics
• Copying Specification Data Common Tasks, page 555
• Copying Specification Data: An Overview, page 554
• Create and Modify a Form Data Template, page 504
Tip
• If the form data template has fields that are not accessible, these fields
are protected in the Spec Data Dictionary. When copying data, the
software ignores protected fields. For details, see Protect Fields from
Overwriting When Copying Data, page 555.
7. On the menu bar, click Actions > Copy From.
8. On the Find Item dialog box, under Form number, select the form of the spec
you want to use for copying data, and click Find.
9. Under Search results, select the item whose spec you want to use as a source for
copying data.
10. Click OK to copy the spec data.
11. On the toolbar, click to save the changes.
Related Topics
• Copying Specification Data Common Tasks, page 555
• Copying Specification Data: An Overview, page 554
• Create and Modify a Form Data Template, page 504
5. On the Select Form Data Template dialog box, select a form data template from
the list.
6. Click OK to copy the data from the selected form data template to the
specification.
7. Save the specification.
Related Topics
• Copying Specification Data Common Tasks, page 555
• Copying Specification Data: An Overview, page 554
• Create and Modify a Form Data Template, page 504
Tip
• When you copy data to a spec, be careful when overwriting existing
data. In the Spec Data Dictionary, you can define fields that you do
not want to overwrite. For more details, see Protect Fields from
Overwriting When Copying Data, page 555.
7. Click OK to copy the data.
8. Save the specification.
Related Topics
• Copying Specification Data Common Tasks, page 555
• Copying Specification Data: An Overview, page 554
Related Topics
• Revision and Data Comparison Common Tasks, page 560
Related Topics
• Spec Revisions: An Overview, page 560
Tip
• The By box contains the current user's initials by default, if previously
defined by the System Administrator in the Administration module.
You can also edit this setting if required.
6. To delete revisions locally you no longer require, select the revisions and click
Delete.
Related Topics
• Revision and Data Comparison Common Tasks, page 560
Related Topics
• Revision and Data Comparison Common Tasks, page 560
• Select ZIP file to save all the selected revisions as a single external
.zip file in the location specified in the Administration module. This
option is only available after the Domain Administrator, in the Report
Management dialog box, specifies the folder for saving spec revisions
as .psr or .zip files.
• Select Database to save the revision to the SmartPlant Instrumentation
database. For this option, the data is automatically compressed to save
disk space.
5. Click Change method.
Related Topics
• Revision and Data Comparison Common Tasks, page 560
• Spec Revisions: An Overview, page 560
Related Topics
• Save, Export, and Import Options: An Overview, page 568
Related Topics
• Save, Export, and Import Options Common Tasks, page 569
• Save, Export, and Import Options: An Overview, page 568
Note
• SmartPlant Instrumentation does not support saving non-instrument
specifications in .isf format.
Related Topics
• Save, Export, and Import Options Common Tasks, page 569
• Save, Export, and Import Options: An Overview, page 568
2. In the Select Specification Form dialog box, select the form for which you want
to set field protection, and click OK.
3. On the Spec Data Dictionary toolbar, click to open the Field Properties tab.
4. Do one of the following:
• To protect individual fields, on the Column Headers tab, under
Editable in IEE, clear the check boxes for the fields you want to
protect.
•To protect all of the fields belonging to a given database table, click
the Tables tab, and then, under Editable in IEE, click No.
5. On the toolbar, click to save the changes.
Note
• You perform this procedure at the form level. This means that the fields
that the field protection applies to any instrument specification based on
this form. Field protection does not apply to existing specs saved as .isf
files.
Related Topics
• Save, Export, and Import Options Common Tasks, page 569
• Save, Export, and Import Options: An Overview, page 568
Related Topics
• Save, Export, and Import Options Common Tasks, page 569
• Save, Export, and Import Options: An Overview, page 568
The Excel workbook opens displaying the specification with the lowest tag number.
If the file that you opened contains multi-page specs, each page is displayed on a
separate Excel worksheet. If you exported multi-tag specifications, the multi-tag list
is displayed on the Excel See List worksheet. The notes are displayed on the Excel
Notes worksheet.
Note
• In Excel XP, you need to set macro security to Medium.
Supported Spec Types
You can only use Save as Excel options with specs whose item type is Instrument
(single-tag or multi-tag specs). SmartPlant Instrumentation does not support Save as
Excel options for specs whose item type is other than instrument, or whose form
contains page sections.
Note
• If you previously saved multi-tag specifications in Excel format and then
made changes to the format upon which these specifications are based,
you should rename the previous result files or move them from the target
folder before exporting further specifications based on that format.
Font Style
Regardless of the font of the original specification, the text font style in the target
Excel file is Arial.
Related Topics
• Batch Save of Instrument Specs in Excel Format, page 572
• Customizing Specs for Save as Excel Common Tasks, page 576
Related Topics
• Save as Excel Troubleshooting, page 585
• Save as Excel: An Overview, page 575
• When one line ends by running into another, make sure that they share an
X value or a Y value. This prevents overshooting and undershooting.
• Create as much of the grid as possible before creating text and value
objects.
• Although there is no requirement for every line to run the entire length or
width of the page, imagine an Excel grid underlying your InfoMaker page.
For example, if you inserted a vertical line near the top of the page at X =
500 PBU, if your mouse placement of a vertical line near the bottom of the
page ended up at X = 505, make the X values consistent for both lines.
• Similarly, if you inserted a horizontal line towards the left of the page at Y
= 700 PBU, if your mouse placement of a horizontal line towards the right
of the page ended up at Y = 705, make the Y values consistent for both
lines.
Left-Aligning Fields to Lines
After you set the major lines of the page grid, you can insert data fields and field
headers, computed fields, fields displayed as select lists, check boxes, or option
buttons. During the process of export from SmartPlant Instrumentation to Excel, the
software associates each field with a vertical line to the left of the field. To ensure
accurate display, the X1 value of a field should equal the X values of the line to its
left. The following lines are acceptable:
Related Topics
• Customizing Specs for Save as Excel Common Tasks, page 576
• Open a Page from an External File, page 462
• Save a Page as an External File, page 465
7. Regenerate the spec page and specification, and save the specification again in
Excel format.
Related Topics
• Customizing Specs for Save as Excel Common Tasks, page 576
• Open a Page from an External File, page 462
• Save a Page as an External File, page 465
Related Topics
• Customizing Specs for Save as Excel Common Tasks, page 576
• Open a Page from an External File, page 462
• Save a Page as an External File, page 465
Related Topics
• Customizing Specs for Save as Excel Common Tasks, page 576
• Open a Page from an External File, page 462
• Save a Page as an External File, page 465
Related Topics
• Customizing Specs for Save as Excel Common Tasks, page 576
• Open a Page from an External File, page 462
• Save a Page as an External File, page 465
• If the text string in a cell is longer than the width of the cell, and the cell to
the right is empty, the text extends into the adjacent cell.
• If the text string in a cell is longer than the width of the cell, and the cell to
the right is not empty, the overlapping text is cut off.
• If the cell is very narrow, no data appears in the cell. By inserting the
mouse pointer in the cell, you can view the cell contents in the formula
bar.
For more information, see Fix Text Display in Excel Cells, page 592.
Related Topics
• Specification Page Customization: An Overview, page 480
• Specification Pages: An Overview, page 458
Related Topics
• Save as Excel Troubleshooting, page 585
Related Topics
• Save as Excel Troubleshooting, page 585
d. On the Position tab, under Y2, paste the Clipboard value, using a standard
Microsoft shortcut.
6. On the menu bar, click File > Save.
7. Import the page back into SmartPlant Instrumentation.
8. Regenerate the spec page and specification, and save the specification again in
Excel format.
Related Topics
• Open a Page from an External File, page 462
• Save a Page as an External File, page 465
• Save as Excel Troubleshooting, page 585
Related Topics
• Open a Page from an External File, page 462
• Save a Page as an External File, page 465
• Save as Excel Troubleshooting, page 585
b. On the Position tab, under Y, copy the value to the Clipboard, using a
standard shortcut (for example, Ctrl+C).
c. Right-click the displaced label, and on the shortcut menu, click Properties.
d. On the Position tab, under Y, paste the Clipboard value, using a standard
shortcut (for example, Ctrl+V).
Tip
• The value of the Height field on the Position tab can also influence
the appearance of the text in Excel. You must enter a height value that
is in proportion to the font size that you set in the Font tab folder.
4. On the File menu, click Save.
Tip
• You only need to perform the following steps if you want to fix
displaced labels by extending an existing horizontal line above or
below the displaced label. These steps deal with extending a line that
runs through the right-hand and the middle column into the left-hand
(categories) column. You can adapt this procedure for other
configurations as well.
5. To extend an existing horizontal line above or below the displaced label, do the
following:
a. Right-click the left-most line (vertical), and on the shortcut menu click
Properties.
b. On the Position tab, under X1, copy the value to the Clipboard, using a
standard shortcut (for example, Ctrl+C).
c. Right-click the horizontal line that you want to extend, and on the shortcut
menu, click Properties.
d. On the Position tab, under X1, paste the Clipboard value, using a standard
shortcut (for example, Ctrl+V).
e. Click in the main window to view your changes.
6. On the File menu, click Save.
7. Import the page back into SmartPlant Instrumentation.
8. Regenerate the spec page and specification, and save the specification again in
Excel format.
Related Topics
• Open a Page from an External File, page 462
• Save a Page as an External File, page 465
• Save as Excel Troubleshooting, page 585
Related Topics
• Save as Excel Troubleshooting, page 585
Tips
• If you resave the same specification in Excel format, to prevent the
software from overwriting your new function, you must rename the
corrected Excel file. You can then copy the formula to future Excel
versions of this specification.
• If the converted formula does not work, restore the original cell
contents from the temporary cell, and then contact Intergraph Support.
Related Topics
• Save as Excel Troubleshooting, page 585
Related Topics
• Printing Specifications and Reports Common Tasks, page 597
5. If prompted, click Yes to preview the report, or click No to print the report
without opening the print preview.
Tips
• By default, the software prompts you to open a print preview. You
can also change this setting on the Preferences dialog box, on the
General page.
• By default, the software prints specification notes on a separate sheet.
You can change this setting on the Preferences dialog box, on the
Specifications > General page.
Related Topics
• Printing Specifications and Reports Common Tasks, page 597
• Specification Report List, page 595
Related Topics
• Printing Specifications and Reports Common Tasks, page 597
• Specification Report List, page 595
Related Topics
• Printing Specifications and Reports Common Tasks, page 597
• Specification Report List, page 595
In a hook-up drawing, you can display all instrument you associate with a particular
pipe spec. You make pipe spec definitions using the Pipe Specs supporting table,
available either from the Instrument Index or Process Data module. After making
your pipe spec definitions, you can assign a pipe spec to one or more lines in the
Process Data or Instrument Index module. Also, you can assign a pipe spec to one or
more instruments in the Browser or Instrument Index module. You do not use the
Specifications module options to generate or manage pipe specs.
You then assign pipe specs to user-defined hook-up item sub-libraries and affect
instrument – hook-up assignment. After assigning a pipe spec to a user-defined sub-
library, when making instrument – hook-up associations, you can only use
instruments that have the source pipe spec data. You cannot use the default sub-sub-
library for pipe spec assignment.
Related Topics
• Pipe Specs Common Tasks, page 603
Related Topics
• Pipe Specs: An Overview, page 602
• After you assign tags to hook-ups in the Hook-Ups module, you can
open a view for the Hook-Up Tag List browser. This browser displays
only those tags that are associated with hook-ups. In this browser
view, you can also change the pipe spec associations as you require.
Related Topics
• Assign Pipe Specs to Lines, page 605
• Pipe Specs Common Tasks, page 603
• Pipe Specs: An Overview, page 602
• In the tree view pane, expand the hierarchy of an item library and
right-click a user-defined sub-library.
• In the tree view pane, select an item library and then, in the Items
pane, select one or more user-defined sub-libraries.
2. On the shortcut menu, click Actions > Associate Pipe Specs with Sub-
Libraries.
Tips
• On the dialog box that opens, the software displays all the pipe specs
defined in the Pipe Specs supporting table.
• In the dialog box panes, you can double-click the Pipe Specs column
header in the to sort the items in ascending order. Double-click the
header again to sort the items in descending order.
3. Under Available pipe specs, select one or more pipe specs and do one of the
following:
• Click Associate.
• Drag the selected items to the Associated pipe specs pane.
4. If you selected more than one user-defined sub-library in the Reference
Explorer, click Next to display another sub-library and associate pipe specs as
you require.
Tip
• You can associate the same pipe specs with more than one user-
defined sub-library.
Related Topics
• Pipe Specs Common Tasks, page 603
• Pipe Specs: An Overview, page 602
5. Click Pipe Specs to display pipe specs associated with the user-defined sub-
library that you selected.
Tips
• The Pipe Specs button is only available when the sub-library that you
selected is user-defined.
Related Topics
• Pipe Specs Common Tasks, page 603
• Pipe Specs: An Overview, page 602
Important
• You must have working knowledge of the SmartPlant Instrumentation
database table structure to be able to customize reports, specification or
calibration form pages. For further information, refer to the SmartPlant
Instrumentation Data Dictionary, which is available upon request.
• The latest InfoMaker Service Pack is available from the Sybase Web site
(accessible via the InfoMaker Help menu). To find out which version of
InfoMaker you require for the current version of SmartPlant
Instrumentation, refer to the Compatibility Matrix on the Intergraph PPM
Support Web site at http://crmweb.intergraph.com/ecustomer_enu.
Related Topics
• Customizing Form Pages in InfoMaker Common Tasks, page 621
• Enabling InfoMaker for SmartPlant Instrumentation Common Tasks, page
612
• Open a Form Page in InfoMaker, page 623
• SmartPlant Instrumentation Database Structure, page 610
• Working with Libraries and Reports Common Tasks, page 615
Two of the important features of the SmartPlant Instrumentation database are its
hierarchical and relational structure.
Within each domain, there are plant hierarchy levels. By default, each domain has
three default levels as follows: <plant>, <area>, and <unit>. The following table
shows most common types of data you can define at each level of the hierarchy:
There is a connection between the data settings at each level of the plant hierarchy,
for example, an instrument tag includes data from various tables at the following
levels:
Note
• The schema name always appears prefixed to the table name separated by
a period (.). For example, if your Domain schema logon name is DEMO,
and in InfoMaker you select CABLE as your table name, the table name in
InfoMaker appears are DEMO.CABLE. For details of database schemas
and their descriptions, see Internal Setup Utility Online Help, Database
Structure and Schemas.
Relational Structure of the Database
The relational structure of the database is concerned with the associations defined
between tables and columns. For example, if you want to create a customized cable
report that includes only the cable description, color, manufacturer, and model, you
need to know that these are columns that are associated with their respective tables.
The following is a summary for this example, taken from the SmartPlant
Instrumentation Data Dictionary.
Note
• The SmartPlant Instrumentation Data Dictionary, which is available upon
request, contains complete information about tables and columns.
Related Topics
• Drop-Down Data Windows that Retrieve Units of Measure, page 625
• Enabling InfoMaker for SmartPlant Instrumentation Common Tasks, page
612
• SmartPlant Instrumentation and InfoMaker, page 609
• Working with Libraries and Reports Common Tasks, page 615
Related Topics
• Working with Libraries and Reports Common Tasks, page 615
Related Topics
• Enabling InfoMaker for SmartPlant Instrumentation Common Tasks, page
612
• SmartPlant Instrumentation and InfoMaker, page 609
• SmartPlant Instrumentation Database Structure, page 610
Related Topics
• Enabling InfoMaker for SmartPlant Instrumentation Common Tasks, page
612
• SmartPlant Instrumentation and InfoMaker, page 609
Related Topics
• Enabling InfoMaker for SmartPlant Instrumentation Common Tasks, page
612
• SmartPlant Instrumentation and InfoMaker, page 609
• SmartPlant Instrumentation Database Structure, page 610
Build a Query
This procedure describes how to build a query, which is necessary for exporting
SmartPlant Instrumentation data to an external file that you can use to generate an
InfoMaker report. The customized report created in this procedure is limited to only
one data source and presentation style with no other adornments. This example uses
information from the Instrument Index module to generate a report for the description
of a set of instruments, including their service and function type. For details, see
Build a Query, page 617.
Related Topics
• Enabling InfoMaker for SmartPlant Instrumentation Common Tasks, page
612
Related Topics
• Working with Libraries and Reports Common Tasks, page 615
Tip
• To organize your display of .psr files in InfoMaker, create various
reports within various libraries.
5. In the Report window, click File > Open File.
6. On the Select a File Name dialog box, navigate to the .psr file that you want to
open, and click Open.
Related Topics
• Working with Libraries and Reports Common Tasks, page 615
Related Topics
• Working with Libraries and Reports Common Tasks, page 615
Build a Query
1. With the main InfoMaker window open, click .
2. On the New dialog box, click the Database tab.
9. Click the close box to close the Preview window and return to the Query
window.
10. If you want to select additional tables, click to reopen the Select Tables dialog
box.
11. Perform additional steps as needed. These can include the following:
• Using the Join function to rebuild links manually between table rows.
• Defining a sort sequence for the retrieved data.
• Using a Where condition to filter the retrieved data.
Note
• Full details of these procedures are beyond the scope of this topic. For
further information, see to the InfoMaker documentation.
12. To view details of your query, click the Syntax tab. The following screen shot
shows an example of a query.
13. When finished, save your query by doing one of the following:
• Click .
• Click File > Save Query.
14. On the Save Query dialog box, in the Queries box, type a name for your query.
Notes
• Your query name must not include any spaces.
• The software saves the query in the backup library that you defined. For
details, see Create an InfoMaker Library, page 615.
Related Topics
• Create an InfoMaker Library, page 615
• Working with Libraries and Reports Common Tasks, page 615
Note
• It is recommended that you back up the shipped files before customizing.
When customizing forms, you can do the following:
The standard calibration settings page includes columns from the COMPONENT and
CALIBRATION_SETTING tables. The standard calibration data entry page includes
columns from the COMPONENT, CALIBRATION_RESULT, and
CALIBRATION_RESULT_POINTS tables. It is not possible to add columns from
other tables in calibration pages.
Related Topics
• Calibration Forms: An Overview, page 657
• Customizing Form Pages in InfoMaker Common Tasks, page 621
• After you open a spec page .psr file in SmartPlant Instrumentation, save it
as a new page and associate it with a spec form, all specifications based on
this form are generated with the drop-down data window that you added.
• After you open a calibration page .psr file in SmartPlant Instrumentation,
save it as a new page and associate it with a Calibration Settings or
Calibration Data Entry form, the form that you open in the Calibration
module contains the drop-down data window that you added.
For details, see Add a Unit of Measure Drop-Down Data Window in a PSR File, page
624.
• After you open a spec page .psr file in SmartPlant Instrumentation, save it
as a new page and associate it with a spec form, all specifications based of
this form are generated with the select list that you added.
Related Topics
• Calibration Form Customization: An Overview, page 620
Related Topics
• Customizing Pages in the Page Editor Common Tasks, page 481
Related Topics
• Add a Select List in a PSR File, page 625
• Customizing Form Pages in InfoMaker Common Tasks, page 621
• Specification Page Customization: An Overview, page 480
• Specification Pages: An Overview, page 458
Related Topics
• Add a Unit of Measure Drop-Down Data Window in a PSR File, page 624
Related Topics
• Add a Unit of Measure Drop-Down Data Window in a PSR File, page 624
• Customizing Form Pages in InfoMaker Common Tasks, page 621
• Specification Page Customization: An Overview, page 480
• Specification Pages: An Overview, page 458
Related Topics
• Calibration Form Customization: An Overview, page 620
• Customizing Form Pages in InfoMaker Common Tasks, page 621
• Expression for Displaying Fractions of an Inch, page 636
Important
• Tab order value of 0 (zero) overrides field protection expression. Field tab
order is set in the Specifications module of SmartPlant Instrumentation. 0
(zero) tab order indicates that the field is non-editable. For details, see Set
the Tab Order of the Fields on a Page, page 468.
• The 0 (zero) tab order value is assigned automatically to every new table
column you add in the form page in InfoMaker. If you add new fields in
InfoMaker and include these fields in an expression for field protection,
after completing this procedure, and opening the form page in the
Specifications module, you must switch to the default tab order. For
details, see Switch to the Default Tab Order, page 469.
1. Open the target form page saved as a .psr file in InfoMaker. For details, see Open
a Form Page in InfoMaker, page 623.
2. In the Report window, right-click the target table column, and then, click
Properties.
3. In the Properties window, on the General tab, beside the Protect box, click .
4. On the Protect dialog box, do the following:
a. In the Functions pane, click the if(b, t, f) function, in which b stands for a
Boolean expression, t for true, and f for false.
b. Substitute the b argument with the name of the table columns that you want to
protect, operators, and values.
c. Substitute the t,f arguments with the protection values, with 0 indicating that
the field is editable and 1 that the field is protected.
5. Close the Protect dialog box.
Tip
• On the General tab, the Protect box now displays the expression and
the expression icon changes to green .
6. If needed, define the field background display conditions. For details, see Add an
Expression for Field Background Color, page ???.
7. Save the .psr file.
Related Topics
• Calibration Form Customization: An Overview, page 620
• Customizing Form Pages in InfoMaker Common Tasks, page 621
if( b, t, f )
in which b stands for a Boolean expression, t for true and f for false. You substitute
the t and f arguments with 0 and 1. When true, the value of 0 indicates that the field
is editable and 1 that the field is protected.
Example 1
Notes
• The cmpnt_id value determines whether the software opens the
Calibration Profile Settings window or the Tag Calibration Settings
window in the Calibration module. To open profile settings, the software
runs an SQL command which includes the following parameter:
cmpnt_id=0; whereas, to open calibration settings for an instrument, the
software runs an SQL command which includes the cmpnt_id value of that
instrument.
• For details of calibration type ID numbers, see Calibration Type ID
Numbers, page 630.
Example 2
Note
• The calib_hist_flg value determines whether the software opens the
Calibration Data Entry or Calibration History window. If the value is
'0' or NULL, the software opens the Calibration Data Entry window;
whereas, if the value is '1', the software opens the Calibration History
window. The calib_hist_flg value is character and not integer; therefore,
in the expression, you must enclose the calib_hist_flg value in single
quotes.
Related Topics
• Add an Expression for Field Protection, page 627
• Calibration Form Customization: An Overview, page 620
• Customizing Form Pages in InfoMaker Common Tasks, page 621
Related Topics
• Customizing Form Pages in InfoMaker Common Tasks, page 621
Prerequisite
• An expression for settings the appropriate background color always
depends on the field protection expression. Therefore, you must also
define an expression for field protection. For details, see Add an
Expression for Field Protection.
1. Open the target form page saved as a .psr file in InfoMaker. For details, see Open
a Form Page in InfoMaker, page 623.
2. In the Report window, right-click the target table column, and then, click
Properties.
3. In the Properties window, click the Fonts tab.
4. Beside the Background Color box, click .
5. On the background.color dialog box, do the following:
a. In the Functions pane, click the if(b, t, f) function, in which b stands for a
Boolean expression, t for true, and f for false.
b. Substitute the b argument with the same Boolean expression you defined in
the field protection expression on the General tab.
c. Substitute the t,f arguments with the background color parameters as you
require.
6. Close the background.color dialog box.
Tip
• On the Font tab, the icon beside the Background Color box changes
to green . You can ignore the color setting displayed in the box
because an expression overrides the specific property value defined in
the Properties window.
7. Save the .psr file.
Related Topics
• Calibration Form Customization: An Overview, page 620
• Customizing Form Pages in InfoMaker Common Tasks, page 621
In this example, the expression sets the Windows Background color for the measuring
point field if it is editable and Button Face color if the measuring point field is
protected. This expression is used together with the field protection expression. The
expression does not apply to the Function Check or Switch Set Point calibration
types.
if(calib_set_no_pnt=1 and cmpnt_id<>0 and calib_type_id<>2 and
calib_type_id<>3,1073741824,67108864)
Example 2
In this example, the expression sets the red background for the As Found tolerance
field if the field value exceeds the tolerance value.
If(as_found > tolerance, rgb(255,0,0),1073741824)
The following table describes the background color use in the IF expression.
Related Topics
• Add an Expression for Background Color of Result Field, page 633
• Calibration Form Customization: An Overview, page 620
• Calibration Type ID Numbers, page 630
• Customizing Form Pages in InfoMaker Common Tasks, page 621
Related Topics
• Calibration Form Customization: An Overview, page 620
• Customizing Form Pages in InfoMaker Common Tasks, page 621
Related Topics
• Calibration Form Customization: An Overview, page 620
• Customizing Form Pages in InfoMaker Common Tasks, page 621
if( b, t, f )
in which b stands for a Boolean expression, t for true and f for false. You substitute
the t and f arguments with 1 and 0. When true, the value of 1 indicates that the field
is visible and 0 that the field is invisible.
Example
In this example, the expression sets the expected output field in the Calibration Data
Entry and Calibration History windows as visible if the As Found result point value
is equal to or greater than 1; otherwise, the field is invisible.
if(calib_no_pnt >= 1,1,0)
Related Topics
• Add an Expression for Field Visibility, page 634
• Calibration Form Customization: An Overview, page 620
• Customizing Form Pages in InfoMaker Common Tasks, page 621
Important
• The feet-inch-sixteenths format is not supported outside the Calibration
module, that is, in browser views or when accessing the field from
database tools.
• It is only possible to display sixteenths of an inch in a calibration form
field.
Prerequisite
• Make sure that the unit of measure for target field is defined as ft.
1. Open the target form page saved as a .psr file in InfoMaker. For details, see Open
a Form Page in InfoMaker, page 623.
2. In the Report window, right-click the target numeric table column, and then,
click Properties.
3. In the Properties window, on the Edit tab, under Style Type, select EditMask.
4. In the Mask box, type the following mask: ##-##-##/16
Tip
• In this mask, the pound # symbol stands for a digit. The left segment
is used for a feet value, the middle for an inch value, and the right for a
fraction of an inch.
Related Topics
• Add a Multi-Use Column in a Calibration Form Page, page 627
• Calibration Form Customization: An Overview, page 620
• Customizing Form Pages in InfoMaker Common Tasks, page 621
The [0] value indicates that this is the first calibration result in the number or runs.
The PowerBuilder data window used in the calibration form page contains an array
that allows you to enter several result points in the same table column. In the data
window, the first occurrence of the column in the array is indicated with the [0] value,
the second with [1], and so forth. Therefore, in a compute expression, all the fields
should be specified the appropriate result point number in the array. Since the
expression includes actual table columns, you do not need to specify any suffixes of
multi-use columns. In the form page, each occurrence of a multi-use column is
indicated with a unique numeric suffix. For example, when inserting the
as_left_value column into the form page three times, you must specify specify the _1
suffix for the first occurrence of the as_left_value column, _2 for the second
occurrence, and _3 for the third occurrence. In the data window, the first occurrence
of the column in the array is indicated with the [0] value, the second run with [1], and
so forth.
Notes
• Although the compute expression seems complex, when defining another
expression, you can copy the current expression to the target computed
field, and then, you only need modify the result point occurrence in the
array and the field names.
• getdecimalfeetlength and getmaskedfeetvalue are SmartPlant
Instrumentation internal functions (not available in InfoMaker).
• The feet-inch-sixteenths format is not supported outside the Calibration
module, that is, in browser views or when accessing the field from
database tools.
• It is only possible to display sixteenths of an inch in a calibration form
field.
Related Topics
• Customizing Form Pages in InfoMaker Common Tasks, page 621
• Define a Computed Field for Calibration, page 638
• Enable the Use of Fractions of an Inch, page 635
a. enter the appropriate compute expression, whose segments may include any of
the following data types:
Data Type Example Note
Number 2210
String of 'AA' or "AA"
characters
Table column cmpnt_name You can only add names of
name columns that appear in the
Columns pane of the Modify
Expression dialog box.
Function upper(cmpnt_name) In addition to the InfoMaker
functions that appear in the
Functions pane, you can also add
PowerBuilder functions, which are
part of the SmartPlant
Instrumentation code. For
example, when defining an
expression for displaying a
fraction of an inch, you must use
two PowerBuilder functions. For
details, see Expression for
Displaying Fractions of an Inch,
page 636.
Conditional if(as_left_value[0]<>0,round(as_f
IF expression ound_value[0]/as_left_value[0],3,
0)
b. Click Verify to verify that the expression you entered is a valid InfoMaker
expression.
c. Click OK.
5. If you want the computed value to be saved to the database, in the Detail section
of the form page, click the field and add a c_ prefix to the field name.
Related Topics
• Customizing Form Pages in InfoMaker Common Tasks, page 621
• Customizing Pages in the Page Editor Common Tasks, page 481
The .psr format allows you to save a multi-page report and nested reports (reports
which contain sub-reports or embedded objects). The .psr file format also enables
you to design your own reports in InfoMaker and use names of columns from your
database. You can then view the reports with the actual data in PBL Viewer.
Related Topics
• PSR File Viewer Common Tasks, page 641
Related Topics
• Enabling InfoMaker for SmartPlant Instrumentation Common Tasks, page
612
• PSR File Viewer: An Overview, page 640
Related Topics
• PSR File Viewer Common Tasks, page 641
• PSR File Viewer: An Overview, page 640
Related Topics
• PSR File Viewer Common Tasks, page 641
• PSR File Viewer: An Overview, page 640
Caution
• Make sure you select an appropriate .pbl file, as the .pbl format is also
used for purposes other than storing reports.
3. In the DataWindow List pop-up window, scroll to the required data window and
select it.
4. Click to retrieve the appropriate column data from the database and display it
in the PSR File Viewer window.
Related Topics
• PSR File Viewer Common Tasks, page 641
• PSR File Viewer: An Overview, page 640
Caution
• If you click Path and choose a new folder location for the .psr files,
the original paths that were displayed for the files will be overwritten.
You should therefore only use this option where you are certain that all
the files in the list are located in the same folder.
4. On completion of the required action, click Save.
Related Topics
• PSR File Viewer Common Tasks, page 641
• PSR File Viewer: An Overview, page 640
For example:
ProfileString("C:\Program Files\SmartPlant\Instrumentation\intools.ini",
"External Report","udf_C01","Not found")
Tip
• The 's_udf_value' parameter is used to specify a default string to
display where no value exists for the specified customd field.
d. At the right of the report, using the Position, Font, and Format tabs, make
the desired definitions for the custom field, for example, alignment, color,
style, and so forth.
4. If you intend to display more than one .psr file in the SmartPlant Instrumentation
PSR List window, display the SQL data source, and under the where section, type
the following expression:
psr_storage.psr_stor_desc='<PSR description>'
Important
• Without adding this expression to InfoMaker, SmartPlant
Instrumentation always retrieves from the database the first row of
custom fields in the PSR List window, regardless of the report you
select. Make sure that the '< PSR description>' has the same value as
the value in the Description column of the PSR List window.
5. Save the current report as a .psr file.
6. Open SmartPlant Instrumentation.
7. With any main module window open, click File > Import PSR.
8. In the PSR File Viewer window, click to open the PSR List window.
9. Scroll to the right side of the window to view the custom field columns and in the
columns Udf C01 to Udf C10, type the desired values.
Related Topics
• PSR File Viewer Common Tasks, page 641
• Retrieve Custom Field Values from PSR Files, page 645
You first create a title block or duplicate it from an existing one using InfoMaker and
save it as a .psr file. You then open the .psr file in SmartPlant Instrumentation and
add it to the title block inventory. After that, you need to associate the title block
with the required reports and finally, generate a report through the relevant module
using the created title block.
Note
• It is usually more convenient to edit an existing title block and save it
under a different name rather than to create a new one.
Related Topics
• Requirements for Customized Report Title Blocks, page 647
• Spec Title Blocks: An Overview, page 547
Report type — When creating a new report set the report type to be External
(mandatory).
Field prompt — When prompted to set the required fields for a title block, type any
text in the appropriate field. There is no significance to inserting any particular field
name as long as something is typed (mandatory).
Group — The title block customization has to be performed in the Detail group
(mandatory).
Layer — Make sure that you create the title block in the Band layer (the default -
mandatory).
Design — The frame of the title block consists of four lines. Make sure that each
line has its own unique name typed in small caps as follows:
Important
• When adding other design-related items, such as internal lines, text boxes,
and so forth, to the title block, make sure that the names of the new items
contain the tb segment. For example, if you want to add a new line, name
the line as <Line>_tb_<1>. This is required to distinguish between items
that belong to the title block and items that belong to the rest of the report
outside the title block.
Field type — select any field type other than Column (mandatory).
Revisions — Make sure that you have a number 1 revision field. For instance, a title
block with solely a revision no. 2, would not apply.
Report measurement units — The units of measure of the customized title block
must be compatible with the units of measure of the report it is associated with. All
the reports were created in inches except for the following, which use PowerBuilder
units:
Notes
• Macros retrieve the data and enter it to the fields. For these macros to
function properly, you must insert the macro name accurately according to
the macro tables below.
• You can implement custom title blocks that for macros custom_1 through
custom_5 display field values without labels, for example, 'DCS-1' instead
of 'Panel DCS-1'. To enable this option, make sure that the [Custom]
section of the intools.ini file includes the line
'RemoveFixedTextFromTB=1'.
Table includes Text type fields only:
Revision custom fields — You can define your own fields and related macros in
addition to those in the inventory of macros (designated for fields) that are supplies
with SmartPlant Instrumentation. You can add up to 20 revision custom fields per
title block. Inserting the right name in the field name box is necessary for the proper
function of the field in the title block. The naming convention for the revision custom
fields is as specified in the following table:
rev_udf_c01_t Header
rev_udf_c01_1 Data field
rev_udf_c01_2 Second data field under the same header
rev_udf_c02_t Header 2 (another UDF)
rev_udf_c02_1 The data in the field (2)
Document custom fields — Using these fields you can have a record of the
documents that were related to a certain report. These are fields that you define under
the following limitation: each custom field must have only two fields, one for the
header and one for the data. This is the naming convention for these fields:
dwg_udf_c01_t Header
dwg_udf_c01 Data field
dwg_udf_c02_t Header 2 (another custom field)
dwg_udf_c02 Data field (2)
Related Topics
• Customizing Title Blocks for Reports: An Overview, page 646
• Spec Title Blocks: An Overview, page 547
You can specify a large variety of calibration parameters such as calibration ranges,
trip point values, and alarms. The calibration user interface allows you to easily
compare current measured values with the appropriate specifications.
Important
• If you upgraded the software from a version prior to 2007.5, you must
restore the standard forms and regenerate the form pages to be able to use
existing calibration settings and data. If you intend to use customized
calibration forms only, you may skip this upgrade step. For details, see
Upgrading the Standard Calibration Forms, page 658.
• The Calibration module is available only if it is included in the software
license that you purchased from Intergraph.
Related Topics
• Flow of Activities for Defining Tag Calibration Settings, page 668
• Flow of Activities for Entering Tag Calibration Data, page 673
Leaving some of the search parameter fields empty widens the search. If you do not
specify any search parameters, the software finds all the existing tag numbers.
After the search is complete, the software displays the tag numbers that match your
search parameters in the Search results data window of the Find Tag dialog box.
Note
• The following procedure describes how to find tags using search
parameters. If needed, you can also find tag numbers without defining any
search parameters.
• When searching for tag numbers by tag category, you can narrow
down your search by typing a specific tag category or loop name, or by
selecting the required instrument type and process function. Note that
you cannot use certain search parameters together with the tag
category parameter. These fields become view-only.
4. Define you search criteria using the required combination of the following search
parameters:
Search Explanation Example
Parameter
Tag number Type the whole tag number you are looking 101-FT – 2225/1 or
for. Include any prefix, suffix, and separator use a wildcard: 101-
characters. You can use wildcards if needed. FT%
Process Select a process function to narrow your Flow Pressure
function search to tags belonging to this process
function.
Instrument Select an instrument type to narrow your D/P Type Flow
type search to tags belonging to this instrument Element (FE), Mass
type. Flow Transmitter
(FT)
Status Select a tag status to narrow your search to An existing device, a
tags associated with this status. new instrument, a
relocated device
Location Select a tag location, for example: Field, to Equipment room,
narrow your search to tags for which you have junction box
defined this location.
I/O Type Select an I/O type to narrow your search to AO (analog output)
tags for which you have defined this I/O type. DI (Digital input)
Prefix Type the tag number prefix to find all the tag 101
numbers that contain this prefix in their names.
Do not include the separator characters. The
unit number segment in the tag number name
is usually the tag number prefix. You can also
use wildcards if needed.
Number Type the numeric segment of a tag number to 2315
find all the tag numbers that contain this
numeric segment. You can also use wildcards
if needed.
Suffix Type the suffix segment of the tag number to 1 ( the number
find all the tags that contain this suffix. Do not following the slash
type the slash character before the suffix. You (/) in tag number
can also use wildcards if needed. 101-FT – 2225/1)
5. If desired, select Look in all units to look for the defined search criteria in all the
units of the current plant.
6. Click Find to display the tag numbers in the Search results data window.
Tip
• Select the Show more search results check box to hide the search
criteria fields and enlarge the Search results data window to display
more tag rows. Clearing this check box returns to normal view.
7. Select the required tag numbers in the Search results data window.
Tip
• You can also select the Select all check box to select all the displayed
tag numbers.
8. Click OK to open the appropriate window (Tag Calibration Settings,
Calibration Data Entry, or Calibration History) and proceed with the
calibration activities.
SmartPlant Instrumentation comes shipped with two forms so that existing users can
continue to work with legacy data and still see a calibration form layout similar to
what existed previously. The names of these forms are Standard Settings and
Standard Data Entry. In addition, there are various shipped .psr files, which you
can customize as needed.
You use the Specifications module options to create and manage calibration forms
because the form creation mechanism is the same as for specification forms. You can
create as many calibration forms as you require; and the forms can differ in type of
data, layout and calibration requirements. In the Specifications module, there are two
page item types designated for calibration forms: Calibration Settings and
Calibration Data Entry. You must assign one settings form and one data entry form
to each calibration profile that you define. There is no specific form for calibration
history because calibration history is always based on the data entry form. When
opening any window in the Calibration module, you actually open a calibration form
assigned to a calibration profile.
Notes
• Any calibration form, whether shipped or user-defined, can only comprise
a single data page.
• A calibration form page may include a title block in the body of the page,
as one the page portions. However, in calibration form pages, you do not
create revisions or revision data.
• If you upgraded the software from a version prior to 2007.5, you must
restore the standard forms and regenerate the form pages to be able to use
existing calibration settings and data. If you intend to use customized
calibration forms only, you may skip this upgrade step. For details, see
Upgrading the Standard Calibration Forms, page 658.
Related Topics
• Calibration Form Customization: An Overview, page 620
• Customizing Form Pages in InfoMaker Common Tasks, page 621
• Flow of Preliminary Activities for Calibration, page 662
• Restore Library Forms, page 498
Notes
• To ensure continued support for existing tag settings, the program creates
a standard (shipped) profile with two associated forms: Standard Settings
and Standard Data Entry.
• The standard profile is associated with each existing instrument type.
• Each existing tag setting is associated with the Standard Settings form.
Related Topics
• Calibration Forms: An Overview, page 657
• Customizing Form Pages in InfoMaker Common Tasks, page 621
• Flow of Preliminary Activities for Calibration, page 662
9. If you have existing calibration records that you want to save as history events in
the current version, do the following:
a. From the SmartPlant Instrumentation program folder, double-click the
CalibrationResultsUpgrade.exe utility.
b. Select a domain.
c. If you have updated your calibration forms, you can recreate previously saved
history events for the updated forms. When doing this, select Overwrite
existing results.
d. Click OK
Tip
• If you have previous calibration results that originated from a Fluke
Calibrator, and you want to save history events for these results using
the Fluke forms, first save the Fluke pages as standard calibration
pages before running the CalibrationResultsUpgrade.exe utility. This
results in the software saving all of your existing calibration data as
history events using the Fluke forms. For details of how to use the
Fluke forms, see Set up a Profile for the Fluke Calibrator, page 691.
Important
• If you upgraded the software from a version prior to 2007.5, you must
restore the standard forms and regenerate the form pages to be able to use
existing calibration settings and data. If you intend to use customized
calibration forms only, you may skip this upgrade step. For details, see
Upgrading the Standard Calibration Forms, page 658.
1. Customize calibration form pages in InfoMaker
SmartPlant Instrumentation comes shipped with a number of .psr files that you can
customize according to your needs using InfoMaker. For details, see Customizing
Form Pages in InfoMaker Common Tasks, page 621.
Related Topics
• Flow of Activities for Defining Tag Calibration Settings, page 668
• Flow of Activities for Entering Tag Calibration Data, page 673
• Performing Calibrations: An Overview, page 652
Related Topics
• Associate Calibration Profiles with Instrument Types, page 665
• Calibration Forms: An Overview, page 657
Related Topics
• Create a Calibration Profile, page 664
• Define Tag Calibration Settings, page 669
Related Topics
• Dissociate Profiles from Instrument Types, page 666
Related Topics
• Associate Calibration Profiles with Instrument Types, page 665
Note
• There are three predefined result codes: Passed, Failed, and None that
you cannot edit or delete from the database. These values do not appear in
the Result Codes dialog box. An additional value, Bad Result, is also
available when editing history results.
1. In the Calibration Data Entry window, on the Tables menu, click the desired
code table.
2. On the dialog box that opens, do one of the following:
Related Topics
• Enter Calibration Data, page 674
• Flow of Preliminary Activities for Calibration, page 662
Important
• If you upgraded the software from a version prior to 2007.5, you must
restore the standard forms and regenerate the form pages to be able to use
existing calibration settings and data. If you intend to use customized
calibration forms only, you may skip this upgrade step. For details, see
Upgrading the Standard Calibration Forms, page 658.
• In order to perform calibrations, a calibration infrastructure must exist.
This infrastructure includes definitions of profiles, settings and data entry
forms, and, if required, the creation of customized calibration forms. For
details, see Flow of Preliminary Activities for Calibration, page 662.
1. Create a tag number and define the tag calibration settings
When you create a tag number for an instrument or test equipment, the instrument
type of that tag number must be associated with one or more calibration profiles
suitable for the type of calibration to be performed. When opening the tag calibration
settings in the Calibration module, you must select the desired calibration profile.
The software loads the values from that profile into the tag calibration settings, which
you can then view and edit in the Tag Calibration Settings window. If you select a
different calibration profile, the software loads settings values from that profile to the
tag calibration settings and overwrites any existing values. The tag calibration
settings determine what kind of input data you require for your calibration, such as
ranges, input and output units of measure, and tolerances. These settings serve as a
reference for any calibrations you perform on the tag provided you do not modify
them or select a different profile when performing data entry. For details, see Define
Tag Calibration Settings, page 669.
Related Topics
• Performing Calibrations: An Overview, page 652
Related Topics
• Define Calibration Profile Settings, page 664
• Enter Calibration Data, page 674
Related Topics
• Define Alarm / Trip Settings, page 671
• Define Tag Calibration Settings, page 669
Related Topics
• Copy Existing Process Data, page 670
• Define Tag Calibration Settings, page 669
Related Topics
• Define the Set Point, page 672
Related Topics
• Copy Existing Process Data, page 670
• Define Tag Calibration Settings, page 669
1. Select a profile
Profiles provide a means of allowing you to perform different types of calibration for
the same tag. When you select a profile in Data Entry mode, the software loads the
profile values into the Calibration Data Entry form. For details, see Select a
Calibration Profile, page 674.
Note
• If desired, you can by-pass profile selection by choosing the existing tag
settings.
2. Enter calibration data
After selecting a profile or the existing settings for your tag, you enter the calibration
data. The software uses any formulas you have defined on the Data Entry form to
calculate calibration results. While entering data, the calibration result is accepted as
long as the input values do not exceed the specified tolerances which are set by the
expressions on the form. On saving a calibration record, the software generates a
history event. For details, see Enter Calibration Data, page 674.
Related Topics
• Flow of Activities for Defining Tag Calibration Settings, page 668
• Flow of Preliminary Activities for Calibration, page 662
• Performing Calibrations: An Overview, page 652
3. Click the Data Entry tab and enter values in each section by typing or selecting
from the lists.
4. Do the following for each of the points that you defined for the current tag in the
Tag Calibration Settings window:
a. In the Calibration Data Entry window, in the Alarms / Trips section, click
First Point, Second Point, Third Point, Fourth Point, Fifth Point, or Sixth
Point.
b. Under As Found, type the value before calibration.
c. Under As left, type the value after calibration.
d. In the Codes section, enter general calibration information as you require.
e. From the Result Code list, select the desired predefined result code, or
custom result code predefined in the Result Code dialog box.
f. If from the Result code list you selected Failed or any other option that
indicates a calibration result failure, from the Diagnostic code list, select a
calibration diagnostic code for this kind of failure.
g. If from the Result code list you selected Failed or any other option that
indicates a calibration result failure, from the Action code list, select an action
code associated with a solution description for this kind of failure.
h. If from the Result code list you selected Failed or any other option that
indicates a calibration result failure, from the Damage code list, select a
damage code associated with a solution description for this kind of failure.
Tip
•If a desired Result, Diagnostic, Damage, or Action code is not
available from the list, you can define additional codes by selecting
the appropriate item on the Options menu.
i. Enter additional values, and a short note if needed.
5. Type the pre-calibration values in the As Found column.
Tip
• On the standard calibration data entry page, error values that exceed
the maximum permissible error are highlighted in red, while values
that exceed the intermediate error tolerances but do not exceed the
permissible error are highlighted in light blue.
6. After calibration of the instrument, type the values in the As Left column.
Tips
• Any error values still highlighted in red show that this instrument's
calibration failed. When you save the updated data, the software
prompts you to create a Work Request. For details, see Performing
Breakdown Maintenance, page 713.
Note
• The fields Compnt_Mfr_ID and Compnt_Mod_ID display the current
manufacturer and model name associated with the tag. The fields
Compnt_Mfr_Name and Compnt_Mod_Name display the history of
changes made to the manufacturer and model name when saving the
Calibration Data Entry sheet.
Related Topics
• Enter Calibration Data, page 674
• Flow of Activities for Entering Tag Calibration Data, page 673
.
Component Error For one or more selected instruments, displays the error
variation over the specified date range at the specified
calculated point. This report is useful \ for checking the
zero drift of an instrument over time.
.
Alarm / Trip Points Generates a summary of the trip and alarm point data of all
Summary selected tags.
Calibration Certificate Generates a summary of the selected tag's calibration
(available from main results.
Calibration module
window only)
Calibration Results Generates a summary of the selected tag's calibration
Report results, calibration settings, a graphic representation of the
error percentage, and test equipment used for calibrating
this tag.
Related Topics
• Generate Calibration Reports, page 678
Note
• If you are using the Fluke Documenting Process Calibrator models 743B
or 744, there is a separate interface and special forms that you use for
exchanging and displaying the calibration data. For details, see Working
with the Fluke Interface, page 690.
To create a Test Equipment tag, first a free segment text name must be created in the
Administration module. For easy identification of a specific item of test equipment,
when creating a naming convention for test equipment it is advisable to include the
serial number of the equipment as part of the tag. For more details, see Define
Naming Conventions in the Administration User's Guide, under Domain and Project
Administration > Naming Conventions.
After defining the naming conventions for your test equipment, you then define the
Instrument Type Profile for the specific test equipment. When creating the
Instrument Type Profile you must select General as the process function and Test
Equipment in the General Process Function Sub-Category column of the data
window, then in the Instrument Type Profile dialog box you can associate a
Specification Form with the profile. For more details, see Define an Instrument
Type Profile., page ???
Next you create the Test Equipment tag. For more details, see Create a Test
Equipment Tag, page 682.
Finally, on the calibration sheet, enter calibration data and choose the desired test
equipment. For more details on calibration, see Performing Calibrations: An
Overview, page 652.
• I/O types
• P&IDs
• Process equipment
• Process lines
• Process data
• Electrical power requirements (SmartPlant Electrical integration)
• Associated symbols for the Enhanced Report Utility
• Calculation module data
• Wiring data
• Loop data or association
Related Topics
• Selecting Test Equipment, page 682
On the Data Entry sheet for a particular instrument tag, you may specify up to four
fields for selecting test equipment items. If desired, you can select the same test
equipment item more than once (you may need to do so when using the same
equipment for different calibration purposes). Then, in the Calibration History
window, you can view detailed test equipment information for each calibration entry.
Detailed test equipment information also appears in the Instrument Calibration
Results report.
Related Topics
• Test Equipment: Overview, page 680
Related Topics
• Selecting Test Equipment, page 682
• Test Equipment: Overview, page 680
The error is measured at several points that you predefine in the Tag Calibration
Settings window. The error is calculated at the default point that you define in the
Preferences dialog box. The loop error is measured relative to the largest tolerance
value of all the calibration data for the tags that are included in the loop error
calculation.
Related Topics
• Calculating Loop Error, page 688
• Define Tag Calibration Settings, page 669
• Loop Error Calculation Common Tasks, page 684
• Setting Tags for Loop Error Calculation, page 686
Caution
• To make a valid loop error calculation, make sure that your calibration and
calculation have been time stamped on the same day.
• Set the value of the loop error calculation method and the loop calculation
point on the Preferences dialog box. For details, see Calibration and
Maintenance > General (Preferences), page ???.
• Define the calibration settings for the selected tags. Tags have their
predefined settings which you enter in the Tag Calibration Settings
window. When you calculate the loop error of a specific loop you should
use the settings to include at least one tag that belongs to the designated
loop. For details, see Setting Tags for Loop Error Calculation, page 686.
• Enter calibration data for the selected tags in the loop. For details, see
Enter Calibration Data, page 674.
• Select the desired calculation method and perform the actual calculation.
For details, see Calculating Loop Error, page 688.
• Generate a loop error report. For details, see Generate Calibration
Reports, page 678.
Related Topics
• Loop Error Calculation: An Overview, page 683
Example:
out.signalmin = 4 mA
out.signalmax = 20 mA
Note
• Errors are calculated to four decimal places. Any error smaller than
0.0001 will be displayed as zero (0) and stored in the database as zero.
Important
• You must calibrate the tags before you perform the actual loop error
calculation.
• You can also set the tags for inclusion from a view that you create in the
Browser module. For details of how to create a view, see Add a New
View, page ???. If you use a browser view to set the tags, make sure that
you include the Tag Number, Loop Number, and Calibration Required
columns.
6. In the Tag Calibration Settings window, in the Errors / Points section, from the
Include in loop error list, select Yes.
7. Define all the remaining settings as needed.
8. Click Save to save the settings.
Tip
• You can now start entering calibration data by selecting Yes when
prompted after saving the data. Click No when prompted to start the
data entry to continue to define calibration settings for another tag
number.
Related Topics
• Loop Error Calculation Common Tasks, page 684
• Loop Error Calculation: An Overview, page 683
Tip
• You have to enter the calibration data for all the tags that you want to
include in a loop error calculation on the same day that you intend to
perform the calculation. If you enter tag calibration data more than
once on a calculation day, the calculation is performed using the
results that deviated the most from the predefined tolerance.
7. Click Options > Loop Error.
8. If a message appears with a list of tag numbers that are not yet calibrated, do the
following:
a. In the Calibration Data Entry window, enter the calibration data for the
desired tag numbers.
b. Click Options > Loop Error.
9. On the Loop Error Calculation Method message box, select the desired
calculation method.
Caution
• The calculation method that you set here cannot be changed later.
Make sure that you set the optimal calculation method for the selected
loop.
10. Click OK.
11. On the Loop Error Result dialog box, after you view the results, click Close.
Related Topics
• Loop Error Calculation Common Tasks, page 684
• Setting Tags for Loop Error Calculation, page 686
Notes
• If you upgraded the software from a version prior to 2007.5, you must
restore the standard forms and regenerate the form pages to be able to use
existing calibration settings and data. For details, see Upgrading the
Standard Calibration Forms, page 658.
• When performing calibrations using the Fluke interface, there are two
special forms that come shipped with SmartPlant Instrumentation:
d_ff_default_fluke_result.psr and d_ff_default_fluke_settings.psr. These
forms can be found on the hard drive where you installed the application
under the 'Program Files\SmartPlant\Instrumentation\PSR' folder. For
more information about using and assigning forms, see Managing Spec
Pages Common Tasks, page 459, Spec Forms Common Tasks, page 492,
and PSR File Customization Using Infomaker in the Online Help.
• If you are working on a Citrix console to which a Fluke Calibrator is
connected, to enable the software to detect the calibrator on the serial port
located on the client machine, you must first map the serial port to the
client machine as follows:
1. Within the Citrix console, at the server location, click Start > Run.
2. On the Run dialog box, in the Open box, type: cmd
3. At the command prompt, type: net use
A summary of the mapping between local and remote ports similar to the
following should appear:
4. If the desired port, for example COM 1, does not appear in the summary, then
type: net use COM1: \\Client\COM1:
5. At the command prompt, type net use again and check that the desired serial
port is now included in the mapping.
Note
• These forms are similar to the standard calibration forms, but with the
following additional properties:
• CALIB_RES_UDF_C01…C20— Fields for user-defined results
(data entry) values.
• CALIB_SET_UDF_C01…C15— Fields for user-defined settings
values.
• Loop Power — None, Enabled 24V, Enabled 28V.
• Temperature Element Type— All T/C and RTD supported
types.
• TC Source Mode— Applicable for T/C element types only.
• Source Mode — Corresponds to the sUEV Fluke property for
source user-entered values. The value can be Auto or Manual
Entry.
• Measure Mode — Corresponds to the mUEV Fluke property for
measure user-entered values. The value can be Auto or Manual
Entry.
4. Define a new profile for Fluke and assign the Fluke forms that you created. For
details, see Create a Calibration Profile, page 664.
Notes
• The following pressure units of measure are supported by SmartPlant
Instrumentation when working with the Fluke 743B or 744 Calibrators:
• Psi
• Bar
• InHg
• mBar
• inH2O
• mH2O
• ftH2O
• Pa
• kPa
• gf/cm² (Fluke: g/cm²)
• Any other pressure unit of measure not supported by the Fluke Calibrator
(as `base' units) will default to `psi' when downloaded to the calibrator.
• Other units of measure that are not supported by the the Fluke Calibrator
will appear as voltage units.
Breakdown Maintenance
Breakdown maintenance features deal with the malfunction of equipment. You can
deal with problems on two levels:
• Work Requests
A work request can be initiated by most of the technical staff. A work request
describes a possible malfunction or repair that may be required in the future.
The work requests are then examined by the maintenance supervisor or
foreman who can approve them and then create an actual work order (repair).
• Repair Forms
A repair form is the actual repair or work that has been approved by the
maintenance supervisor or foreman. It indicates the repair date and describes
the nature of the problem as well as the work group that is assigned to carry
out the job. The repair form also includes, in a different section, the
information that is filled in by the person who performed the work,
malfunction cause and action taken, as well as the down and repair time.
Preventive Maintenance
Preventive maintenance features enable you to maintain and schedule periodic
maintenance activities that contain tasks and procedures.
Notes
• The Maintenance module is available only if it is included in the software
license that you purchased from Intergraph.
• You can issue new work requests, repairs, or preventive maintenance work
orders only from the Instrument Index module. Once you have added
maintenance records, you need to access the Maintenance Activities
Summary window for further handling of these activities.
Related Topics
• Maintenance Event Records: An Overview, page 720
• Performing Breakdown Maintenance, page 713
• Performing Preventive Maintenance, page 702
• Preventive maintenance
• Repair forms
• Work requests
Scheduling new preventive maintenance work orders is done only from the
Instrument Index module (unless you are extending an already assigned PM job).
Once a PM work order has been scheduled, you open the Maintenance Activities
Summary window for further handling of these activities where you fill in the
maintenance details or reports.
To define the raw PM activities, tasks and attachments, you need to access the
Maintenance module and start to define the tasks from the lowest level – the
`attachment'. An `attachment' describes a set of instructions to the technical staff. An
attachment can be associated with any external document (a `Word' file, a scanned
image, or manufacturer maintenance document). Typical attachments define safety
precaution instructions, technical instructions for bypassing a process, the actual set
of instructions required to carry out the activity itself, restoring the process back to its
operational status, and so forth.
Once you define the attachments and tasks, you can introduce a new PM activity.
Each PM activity can hold several tasks in the sequence they were added. At this
stage, it is also advisable to associate a PM code with a particular typical instrument
(for example, transmitter, transducer, control valve, switch, and so forth.) This is very
useful for report generation and other statistics. Moreover, a PM activity contains
additional default information, such as the required calibration values, the
down/repair time that an average maintenance job will take, the interval and
frequency for each PM job.
Once all the required attachments, tasks, and activities have been defined, the
preventive maintenance supervisor can schedule these activities to the selected tags
from an Instrument Index Standard Browser view. At this stage, the PM activities are
ready to be further processed and be filled in by the maintenance crew in due time.
4. If the instrument requires calibration, enter the appropriate calibration settings for
the selected tags.
Caution
• Failure to define the calibration settings prior to starting the
Maintenance module result in the inability to enter the calibration
values when entering preventive maintenance details. The
Calibration As Found/As Left dialog box will not be accessible.
Therefore, it is essential that you enter the calibration settings for the
selected tags before you schedule a PM job from the browser view.
5. Go back to the Instrument Index Standard Browser view and right-click the
selected tags.
6. Associate the tag category and criticality as needed. For details, see Associate
Tag Category and Criticality, page ???.
7. On the shortcut menu, click Maintenance > Schedule Preventive Maintenance
Activities.
8. Create the new schedule for the PM activity.
9. Start the Maintenance module and fill out the PM activity details as desired.
10. At this stage, you can also issue work requests and open repair forms for the
required instrument if needed.
Tip
• When saving PM activity details, SmartPlant Instrumentation prompts
you to create a work request if the result of the PM activity is Failed.
Clicking Yes creates the Preventive Maintenance record and opens the
Work Request dialog box where you can create a repair form.
Related Topics
• Defining Preventive Maintenance Activities, page 706
• Defining Preventive Maintenance Attachments, page 704
• Defining Preventive Maintenance Tasks, page 705
• Entering Preventive Maintenance Details, page 711
• Extending Existing Scheduling, page 710
• Preventive Maintenance Preliminary Activities, page 701
• Scheduling Maintenance, page 708
Here you define the preventive maintenance attachments, enter their descriptions and
associate them with an external file (a .doc file, a drawing, and so forth) that then
serves as a reference for the field maintenance personnel.
Related Topics
• Defining Preventive Maintenance Activities, page 706
• Defining Preventive Maintenance Tasks, page 705
• Performing Preventive Maintenance, page 702
Related Topics
• Defining Preventive Maintenance Activities, page 706
• Defining Preventive Maintenance Attachments, page 704
• Performing Preventive Maintenance, page 702
10. Enter the default scheduling data as needed by selecting the appropriate
scheduling settings from the Default scheduling and Estimated maintenance
time sections.
Tip
• Selecting the Calibration Required check box enables you to enter
calibration values when filling out the Preventive Maintenance details.
This option becomes available in the Preventive Maintenance
Activity Details dialog box if you have defined the required
calibration settings for the current tag before you started the
Maintenance module.
11. Click Save and then Close to return to the Maintenance Activities Summary
window.
Related Topics
• Defining Preventive Maintenance Attachments, page 704
• Defining Preventive Maintenance Tasks, page 705
• Performing Preventive Maintenance, page 702
Scheduling Maintenance
Now that you have defined all your required maintenance attachments, tasks, and
activities, you can select a tag or a number of tags and schedule them for
maintenance. As the Maintenance module is closely connected with the Instrument
Index module, you schedule tag maintenance activities from an Instrument Index
Standard Browser view and then return to the Maintenance Activities Summary
window to continue your maintenance operations.
Schedule Maintenance
1. With the Maintenance Activities Summary window open, click on the Main
toolbar to start the Instrument Index module.
2. On the Actions menu, click Browse Index or click on the Instrument Index
module toolbar.
3. In the Instrument Index Standard Browser view, select the instrument for
which you want to schedule maintenance. You can select multiple tag numbers if
needed.
4. Right-click the selected tags to open a shortcut menu, point to Maintenance and
select Schedule Preventive Maintenance Activities.
5. From the PM code list, select the appropriate preventive maintenance code to
associate the selected instruments with the required PM code, or click .
6. From the Assigned workgroup list, select the work group to which the
preventive maintenance activity will be assigned. If the required work group is
not available in the list, click .
7. From the Priority list, select the required job priority.
8. Set the starting date, frequency, and the PM interval. By default, these values are
taken from PM definition.
9. In the Limit by section, select either the Date or the Number of PM Activities
option button to choose whether you want to set the number of times this PM
activity to be carried out or be limited by a time period.
10. In the Scheduling Options section, select how you want to fine-tune the
scheduling:
• No changes — the scheduling will remain as you defined it in the
Start date, Frequency, Interval, and Limit by options.
• Schedule jobs for— fine-tune the scheduling by selecting a specific
day of the week, for example every Tuesday of the month.
• Schedule jobs for each— fine-tune the scheduling by selecting a
specific day of the month, for example every 15th of the month.
11. Click Preview to display the scheduling in the Preview data window.
Tip
• You can also fine-tune the scheduling by editing the PM dates in the
Preview data window. Click the required PM date and modify the
date as needed. All the changes will be implemented after you click
Generate.
12. Click Generate and then click Close.
13. Go back to the Maintenance Activities Summary window by selecting it from
the Window menu.
14. In the Maintenance Activities Summary window, click to display the new
PM records that you have just scheduled for selected instruments.
Related Topics
• Entering Preventive Maintenance Details, page 711
• Extending Existing Scheduling, page 710
• Performing Preventive Maintenance, page 702
Related Topics
• Entering Preventive Maintenance Details, page 711
• Performing Preventive Maintenance, page 702
• Scheduling Maintenance, page 708
9. From the Maintenance staff (actual) list, select the repair technician.
10. Select the required PM result from the Results list.
11. If the maintenance result is Failed, select the failure reason and repair action.
Tip
• The Failure reason and Repair action lists are available only if the
maintenance result is Failed.
12. Type any additional notes you might require in the Note data window.
13. Select the Calibration Required check box and click to open the Calibration
Data Entry window where you enter the required calibration values. Note that
the Calibration Data Entry window is accessible only if you have entered
appropriate calibration settings for the selected instrument before entering PM
activity details.
14. To change the work status, select the required option from the Work status list.
15. Click and create a work request if needed.
16. Click Yes when prompted for SmartPlant Instrumentation to create a work request
automatically.
Tip
• SmartPlant Instrumentation prompts you to create a work request
when a maintenance activity fails. This happens when you select
Failed from the Results list in the Work Activity Details window.
17. Click Close in the Work Activity Details window to return to the Maintenance
Activities Summary window.
Related Topics
• Extending Existing Scheduling, page 710
• Performing Preventive Maintenance, page 702
• Scheduling Maintenance, page 708
After the maintenance work is carried out, the technician responsible for it can fill in
the rest of the repair information, and change its status to Done or close it. You can
customize additional statuses such as Hold, Turnaround, and so forth to cope with
situations and that comply with the conventions at your plant.
Note
• It is recommended to set the required quality system and criticality prior to
starting the Maintenance module.
The following is the recommended flow of activities for breakdown maintenance:
1. Start the Instrument Index module and open an Instrument Index Standard
Browser view.
2. Select the desired instruments (tag numbers) for which you want to enter work
requests and start the Calibration module.
3. If the instruments require calibration, enter the required calibration settings for the
selected tag numbers. For details, see Define Tag Calibration Settings, page 669.
Caution
• Failure to define the calibration settings prior to starting the
Maintenance module results in the inability to enter the calibration
values when completing a Repair Form. (The Calibration As
Found/As Left dialog box will not be accessible.) Therefore, it is
essential that you enter the calibration settings for the selected tags
before you open Work Requests from the Instrument Index Standard
Browser view.
4. Go back to the Instrument Index Standard Browser view and right-click the
selected tags.
5. Associate the tag category and criticality as needed. For details, see Associate
Tag Category and Criticality, page ???.
6. In the browser view, right-click the selected tags and on the Maintenance menu,
click the Repair Form or the Work Request Form option.
7. Enter the desired repair or work request values.
8. Start the Maintenance module to complete the entry of the required repair or work
request values.
Related Topics
• Creating Repair Forms, page 718
• Filling Out Repair Forms, page 719
• Opening a Work Request, page 716
If you have been granted full access rights and you are the maintenance supervisor,
you can first issue a new work request in the Instrument Index Standard Browser
view and then open it in the Maintenance Activities Summary window. This
enables you to create a repair form. Repair form creation is not available when
issuing a new work request, which is only possible from the Maintenance Activities
Summary window. It is not possible to create a repair form from the work request
because all work requests have to be reviewed by the supervisor.
2. In the Work requests pane, select the required records and click .
Tip
• All work requests have the WR notation preceding the work request
number.
3. In the Work Request window, modify the work request number and title if
needed these are filled in automatically by SmartPlant Instrumentation. If you
leave the Word request title field blank, the software fills it after you select a
typical instrument and a work request reason.
4. Modify or select the typical instrument and the work request reason from the lists.
If the required option is not on the list, on the Tables menu, click Typical
Instruments or Work Request Reasons as needed.
5. Type the appropriate problem description if needed.
6. To generate a repair form, on the Actions menu, click Repair Form.
Tips
• This option is not available if you opened the Work Request dialog
box from an Instrument Index Standard Browser view.
Tip
• This option is accessible only if you have been granted the appropriate
access rights (for details, see Access Rights in the Maintenance
Module, page 697).
7. Click Save and then Close to return to the Maintenance Activities Summary
window.
Related Topics
• Creating Repair Forms, page 718
• Filling Out Repair Forms, page 719
• Issuing a New Work Request, page 715
• Performing Breakdown Maintenance, page 713
Also, it is possible to create a new repair form from the Work Request window when
opening a work request from the Maintenance Activities Summary window. You
can then open the newly created repair form from the Maintenance Activities
Summary window.
Note
• A repair form that you create from a work request retains WR
identification number.
Note
• To add entries to supporting tables that you need below, on the Tables
menu, click the relevant menu command.
Related Topics
• Creating Repair Forms, page 718
• Issuing a New Work Request, page 715
• Opening a Work Request, page 716
When creating a record, the software specifies a name for the record automatically,
according to the preferences that you set on the Preferences dialog box. For details
of the preferences options, see Calibration and Maintenance > General
(Preferences), page ???. The maximum length of the record name can be sixty
characters. Before a record is complete, a user with full Calib. & Maint. Events
access rights can update the record name by changing the event date.
When creating a maintenance event record, you must select a maintenance even form
whose process function is the same as the process function of the source instrument.
If you assign a maintenance event form to an instrument type profile in the Instrument
Index module, this form is selected automatically when you open the Maintenance
Event Properties dialog box to create a new record. You need to familiarize
yourself with various options of the Specifications module to be able to define and
manage forms compatible with maintenance event records. For more details about
forms, see Spec Forms: An Overview, page 491. There is one shipped form designed
for displaying maintenance event records for level instruments: Displacer Level
Switch (form number 93). You need to restore this form first. This form page
contains non-editable fields from the COMPONENT table. When regenerating a
page for such a form, you can add editable fields from the WORK_ACTIVITY table,
and also add non-editable fields from the CALIBRATION_SETTING,
COMPONENT, PD_GENERAL, and SPEC_SHEET_DATA tables. If you want to
create maintenance event records for instruments whose process function is other than
Level, you need to use the Change Process Function options of the Page Editor.
For details, see Select a Different Process Function for a Page, page 467.
A page on which you base maintenance event records does not have a title block and,
therefore, does not contain any revision data or document number. You cannot use
comparison options with maintenance event records. You can create, open and
complete one record at a time. It is possible to open and print out several completed
records at a time.
Related Topics
• Flow of Activities for Defining and Managing Maintenance Event
Records, page 722
• Maintenance Module: An Overview, page 696
• Restore Library Forms, page 498
• Specification Page Customization: An Overview, page 480
• Specification Pages: An Overview, page 458
Related Topics
• Maintenance Event Records: An Overview, page 720
Tips
• SmartPlant Instrumentation only support date formats that are listed in
this table.
• You can use one of the following characters as separators: dash (-),
slash (/), space, comma, semicolon, colon, or dot.
Related Topics
• Flow of Activities for Defining and Managing Maintenance Event
Records, page 722
• Maintenance Event Records: An Overview, page 720
Tip
• When you define the date, the software automatically displays the
record name in the Record name box, according to the preferences
you set. For details, see Calibration and Maintenance > General
(Preferences), page ???.
5. In the Maintenance event description box, type and optional description.
Tip
• The description does not appear automatically on the record sheet. To
display the description on the record sheet, you need to regenerate the
form page on which the record is based and add the wa_prob_desc
field in the page.
6. Under Form number, select a form whose process function is the same as the
process function of the source instrument.
7. Click OK to create the record and display it in the Maintenance Events folder
with the icon .
Related Topics
• Flow of Activities for Defining and Managing Maintenance Event
Records, page 722
• Maintenance Event Records: An Overview, page 720
Related Topics
• Conventional and Fieldbus Multi-Input Devices: An Overview, page 1014
• Conventional Panels: An Overview, page 754
• Creating and Managing Cables: An Overview, page 736
• Foundation Fieldbus Design: An Overview, page 941
• I/O Assignment: An Overview, page 844
• Principles of Wiring Operations in SmartPlant Instrumentation, page 727
• Profibus Design: An Overview, page 1001
• Splitting the Wiring Design Among Several Teams, page 728
• Wiring Equipment: An Overview, page 786
The wires and the items to which they are connected are arranged hierarchically as
they appear in the Domain Explorer. These terms are described in detail in the
relevant help topics.
You can make connections between or within any of the <unit> in a <plant>.
Reference cables and panels are, however, available for all the <plants> in the
domain.
A good example of such a project is when the main contractor designs the field
instrumentation wiring up to the marshaling racks while the DCS vendor is
responsible for the DCS design and also for the design of the wiring from the
marshaling panels to the terminals of the I/O cards that they supply, as shown below:
At the end of the project, or at any intermediate stage, there is a need to integrate both
designs into one database to complete the wiring from the field to the DCS and then
generate the complete loop diagrams and the wiring reports.
At this time, the boundary or the scope of the design that each party is responsible for
can vary from project to project. Usually, the intersection point would be somewhere
around a marshaling panel, either at the field side of a terminal strip and the control
system terminal strip side. This issue is usually discussed between the parties and
they agree where to draw this line.
• Provides the ability to see the current As-Built data while connecting to
the data (and not the other way around).
• Enables good control of new tag numbers and subcomponents.
For more information, see Owner Operator Domain (As-Built and Projects): An
Overview in the Administration User's Guide, under Domain and Project
Administration, Owner Operator: General Activities.
• reference cables
• reference device panels with terminal strips
• connection types
These reference items suffice for the most common connections to device panels. For
more sophisticated combinations, you should create your own reference items.
For example, for a 2-wire device you need to create in the Reference Explorer:
When you start a new wiring scheme, the folders in the Domain Explorer are empty.
You can right-click one of the panel folders in the Domain Explorer and on the
shortcut menu, click New and then click the required option. The Reference
Explorer contains several reference panels and cables that are provided as shipped
data that you can copy to the Domain Explorer.
Note that you must have appropriate access rights to alter the reference items.
Item Sequence
If SmartPlant Instrumentation detects that the sequence of a wiring item is not unique,
the software displays an appropriate message and does not create the item until you
enter a unique sequence.
If SmartPlant Instrumentation detects that an item does not have a unique name, the
software displays a warning message, after which you proceed depending on the
setting you made on the General page of the wiring preferences. You can set the
software to proceed without changing the item name if you do not select the Enforce
name uniqueness wiring preference option on the General page. If you select the
Enforce name uniqueness check box, you must rename the item in order to proceed
with your work.
• For all the other wiring items, SmartPlant Instrumentation checks for
name uniqueness at the level of the immediate parent item under which the
item exists.
• If you try to create a wiring item that has no name, the software prompts
you to enter a name. If you select the Enforce name uniqueness wiring
preference option, the software treats items without names according to
the validation rules stated above. If you do not select this wiring
preference option, the software allows you to create wiring items without
names.
• When moving an item to another parent item , the software validates the
name uniqueness at the target level. If you did not select the Enforce
name uniqueness wiring preference option, the software moves the item
and retains its name. If you selected the Enforce name uniqueness
wiring preference option, the software does not allow you to move the
item if the item name violates the validation rules.
For more information, see Naming Conventions: An Overview in the Administration
User's Guide, under Domain and Project Administration, Naming Conventions: An
Overview.
After applying the naming conventions, the software renames the selected items
according to the existing conventions. You can apply naming conventions to a single
item or multiple items. If you need to that for a single wiring item, you can do it in
the Properties dialog box of that item by selecting the Apply naming convention
check box.
For more information, see Apply Naming Conventions to Wiring Items, page 733.
As a time saver, it is recommended that you create reference items for the cable, cable
set, and wire arrangements you intend to use frequently. You create these reference
cables in the Reference Explorer. You can then drag them to the Domain Explorer
and this way create numerous cables on the fly.
Related Topics
• Creating and Managing Cables Common Tasks, page 737
Create a Cable
This procedure explains how to create cables. You can create new cables either in the
Domain Explorer or the Reference Explorer. If you are creating a cable that is
going to have a frequently used configuration, we recommend that you create it in the
Reference Explorer. Reference cables facilitate fast creation of plant cables by
copying an existing cable configuration from the Reference Explorer to the Domain
Explorer. However, if you want to create a cable that does not have a configuration
that you intend to use frequently, we recommend that you create this cable in the
Domain Explorer and in the <unit> where it is to be physically located. This is
helpful when filtering the cables in the current <unit>.
Create a Connector
Connectors are needed for fieldbus home-run cables, telecom cables, and other cables
that require connectors. SmartPlant Instrumentation allows you to build your wiring
system with any of the following connector implementations:
Create a Connector
Connectors are needed for fieldbus home-run cables, telecom cables, and other cables
that require connectors. SmartPlant Instrumentation allows you to build your wiring
system with any of the following connector implementations:
After you drag a terminal or a pin to a wiring equipment channel, the software retains
it in its original place from which you dragged it. However, after expanding the
destination hierarchy, the software also shows the terminal or pin that you dragged.
This means that the terminal or pin is physically located in its original place but it is
associated with the item to which it was dragged.
For more information, see Associate a Pin or a Terminal with a Channel, page 989.
Delete a Connector
This topic shows how to delete a connector. For more information, see Delete a
Connector, page 990.
Related Topics
• Create a Plug-and-Socket Device Panel, page 970
• Device Panels: An Overview, page 770
Tip
• The selected cable type determines whether cables based on this
configuration have multiple wires, pairs, triads, and so forth.
6. Click OK to return to the Cable Configuration dialog box.
7. In the Cable Configuration dialog box, type the name of the new configuration
in the Cable Configuration data field.
8. In the Cable default name field, type a name of the cables that will be based on
the current configuration.
Tip
• This means that every time you create a new cable based on this new
configuration, SmartPlant Instrumentation uses this default setting to
name the new cable. You can then modify this name as needed when
you define the cable in the Cable Properties dialog box.
9. In the Description text field, type a brief description of the new configuration.
10. Click in the Cable Set text field and type the name of each cable set that is
defined in this configuration. You can rename the individual cable sets later if
needed when editing the cable set in the Cable Set Properties dialog box.
11. For each cable set, in the Cable Set Type field, accept the displayed value (the
cable set type you selected in the New Cable Configuration dialog box) or select
another one if needed.
12. For each first cable set of a given cable set type, do the following under Cable set
details:
a. Click in the Wire Tag text field and type the names of the individual wires
within the cable sets. You can accept the displayed value if needed.
b. From the Wire Color list, select a color for each wire. If the required value is
not available, you can add it in the Wire Color dialog box that you access
from the Tables menu in the Wiring Module window.
c. From the Wire Type list, select a type for each wire. If the required value is
not available, you can add it in the Wire Type dialog box that you access
from the Tables menu in the Wiring Module window.
d. From the Polarity list, select the appropriate polarity or shield for each wire.
13. For additional cable sets based on a cable set type for which you already entered
settings under Cable set details, do one of the following:
• To copy the values from a selected cable set to all sets based on the
current cable set type, click Apply. You can select the Exclude wire
tags check box before you click Apply if you do not wish to copy the
wire tags while copying wire color, wire type, and polarity details.
• Enter the settings individually for each cable set.
14. Click Save.
a. Click in the Wire Tag text field and type the names of the individual wires
within the cable sets. You can accept the displayed value if needed.
b. From the Wire Color list, select a color for each wire. If the required value is
not available, you can add it in the Wire Color dialog box that you access
from the Tables menu in the Wiring Module window.
c. From the Wire Type list, select a type for each wire. If the required value is
not available, you can add it in the Wire Type dialog box that you access
from the Tables menu in the Wiring Module window.
d. From the Polarity list, select the appropriate polarity or shield for each wire.
14. For additional cable sets based on a cable set type for which you already entered
settings under Cable set details, do one of the following:
• To copy the values from a selected cable set to all sets based on the
current cable set type, click Apply. You can select the Exclude wire
tags check box before you click Apply if you do not wish to copy the
wire tags while copying wire color, wire type, and polarity details.
• Enter the settings individually for each cable set.
15. Click Save.
Related Topics
• Creating and Managing Cables Common Tasks, page 737
• Creating and Managing Cables: An Overview, page 736
Related Topics
• Creating and Managing Cables Common Tasks, page 737
• Creating and Managing Cables: An Overview, page 736
Create a Cable
1. Do one of the following:
• Press F7 to open the Domain Explorer.
Related Topics
• Creating and Managing Cables Common Tasks, page 737
• Creating and Managing Cables: An Overview, page 736
Create a Connector
1. In the Domain Explorer or Reference Explorer, do one of the following:
• To create a new cable, right-click the Cables folder and on the
shortcut menu click New > Cable.
•Right-click an existing cable, and on the shortcut menu click
Properties.
2. Modify cable properties as needed. For details, see Create a Cable, page 743.
3. Click Connectors.
4. In the Connector Assignments dialog box, do one of the following:
• To manage connector-wire associations for end 1 of the cable, click
the End 1 tab.
• To manage connector-wire associations for end 2 of the cable, click
the End 2 tab.
5. In the Connector Assignments dialog box, click New.
6. In the Connector Properties dialog box that opens, under Connector, type the
name of the new connector.
• From the list, select a connector type as configured.
• To modify or create a connector type, click . For details, see Define
or Edit a Connector Type, page 986.
7. Under Male/female select Male or Female as needed.
8. Click OK to return to the Connector Assignments dialog box.
Related Topics
• Creating and Managing Cables Common Tasks, page 737
• Flow of Activities for Foundation Fieldbus Design, page 942
Related Topics
• Creating and Managing Cables Common Tasks, page 737
• Creating and Managing Cables: An Overview, page 736
Related Topics
• Creating and Managing Cables Common Tasks, page 737
8. From the Color list, select the required wire color. If the required color is not on
this list, click next to the list arrow to open a dialog box where you can add,
modify, or delete items from the Wire color list.
9. In the Note text field, type a brief note if needed.
10. To name the wire ends according to a naming convention, select the appropriate
naming convention from the Wire end naming convention list. Note that this
check box is available only if the Domain Administrator has enabled it in the
Wire End Naming Conventions dialog box.
11. Do the following to name the wire ends not according to a naming convention:
a. Select Override naming convention.
b. Under Wire end 1, type the first wire end name.
c. Under Wire end 2, type the second wire end name.
12. Click Revisions to manage revisions for the current wire.
13. Click OK in the Wire Properties dialog box.
Related Topics
• Creating and Managing Cables Common Tasks, page 737
• Creating and Managing Cables: An Overview, page 736
Tip
• Since cables without cable sets and wires are useful during the early
stages of plant design and when creating cable block diagrams, the
only cable property that you need to enter is the cable name. You can
populate the other properties when you apply a reference cable to this
cable.
7. Click OK.
Related Topics
• Creating and Managing Cables Common Tasks, page 737
• Creating and Managing Cables: An Overview, page 736
Related Topics
• Creating and Managing Cables Common Tasks, page 737
• Creating and Managing Cables: An Overview, page 736
5. Click OK.
Related Topics
• Creating and Managing Cables Common Tasks, page 737
• Creating and Managing Cables: An Overview, page 736
Tip
• When you create a cable for the first time, or when you copy from
reference cables, check for the existence of shield indication wherever
needed. Shield indication is important when SmartPlant
Instrumentation propagates signals through wires. In this case, the
software does not overwrite the wire tag with the tag signal. You can
also define a wire as an overall shield if required.
8. From the Type list, select the required wire type. If the required type is not on
this list, click next to the list arrow to open a dialog box where you can add,
modify, or delete items from the Wire type list.
9. From the Color list, select the required wire color. If the required color is not on
this list, click next to the list arrow to open a dialog box where you can add,
modify, or delete items from the Wire color list.
10. In the Note text field, type a brief note if needed.
11. To name the wire ends according to a naming convention, select the appropriate
naming convention from the Wire end naming convention list. Note that this
check box is available only if the Domain Administrator has enabled it in the
Wire End Naming Conventions dialog box.
12. Do the following to name the wire ends not according to a naming convention:
a. Select Override naming convention.
b. Under Wire end 1, type the first wire end name.
c. Under Wire end 2, type the second wire end name.
13. Click Revisions to manage revisions for the current wire.
14. Click OK in the Wire Properties dialog box.
Related Topics
• Creating and Managing Cables Common Tasks, page 737
• Creating and Managing Cables: An Overview, page 736
Note that when duplicating a panel that has another panel as its child item (usually a
device panel), the software duplicates the parent item without the child panel.
• Junction boxes
• Marshaling racks
• Cabinets (multi-purpose panels)
• Device panels
• Distributed Control System (DCS) panels
• Programmable Logic Controller (PLC) panels
Related Topics
• Fieldbus Plug-and-Socket Boxes: An Overview, page 969
• Managing Conventional Panels Common Tasks, page 755
You can create new panels either in the Domain Explorer or the Reference
Explorer. If you are creating a panel that is going to have a frequently used
configuration, we recommend that you create it in the Reference Explorer.
Reference panels facilitate fast creation of plant panels by copying an existing panel
configuration from the Reference Explorer to the Domain Explorer. However, if
you want to create a panel that does not have a configuration that you intend to use
frequently, we recommend that you create this panel in the Domain Explorer and in
the <unit> where it is to be physically located. This is helpful when filtering the
panels in the current <unit>.
Create a Cabinet
This procedure explains how to create a cabinet. For more information, see Create a
Cabinet, page 759.
Create a Rack
This procedure deals with the creation of racks. Since racks are panel child items,
you can add a new rack under any panel except for a device panel. For more
information, see Create a Rack, page 767.
Related Topics
• Conventional Panels: An Overview, page 754
Note
• To create a junction box panel that contains both terminals and plug-and-
socket connections, see Create a Panel with Terminals and Connectors,
page 765.
Related Topics
• Conventional Panels: An Overview, page 754
• Create a Panel with Terminals and Connectors, page 765
• Create a Plug-and-Socket Junction Box, page 971
• Managing Conventional Panels Common Tasks, page 755
6. Under Dimensions, type a value for the marshaling rack dimensions if needed.
7. Under Maximum number of racks, type a value to set the maximum number of
racks that can be created in this panel.
Tip
• Setting this value to zero means that the current panel can have an
unlimited number of racks.
8. Under Mounting, type a value if needed.
9. Under Backplane, type a value if needed.
10. Select the Set as intrinsically safe check box if this marshaling rack has intrinsic
safety certification.
11. If you need to enter power supply properties, select the Requires power supply
check box and then click the Power Supply tab. For details, see Enter Power
Supply Data for Panels and Instrument Tags, page 766.
12. Click the Associate Symbols tab to associate a symbol with the current panel.
The software will use this symbol when generating a report in the Enhanced
Report Utility. For details, see Associate a Symbol with an Item, page 734.
13. Click Revisions to manage the revisions of the new panel if needed.
14. Click OK to accept your definitions for the new marshaling rack and close this
dialog box.
Note
• To create a marshaling rack that contains both terminals and plug-and-
socket connections, see Create a Panel with Terminals and Connectors,
page 765.
Related Topics
• Conventional Panels: An Overview, page 754
• Create a Panel with Terminals and Connectors, page 765
• Managing Conventional Panels Common Tasks, page 755
Create a Cabinet
1. Do one of the following:
• Press F7 to open the Domain Explorer.
• Press F8 to open the Reference Explorer and expand the Panels
folder. For more information, see Create a Reference Item, page ??? .
2. In the Domain Explorer, do one of the following:
• Expand the Panels by Category folder to display all the panel
category folders.
Note
• To create a cabinet that contains both terminals and plug-and-socket
connections, see Create a Panel with Terminals and Connectors, page
765.
Related Topics
• Conventional Panels: An Overview, page 754
• Create a Panel with Terminals and Connectors, page 765
• Managing Conventional Panels Common Tasks, page 755
6. Select the required values from the Type, Manufacturer, Model, Dimensions,
Area classification, and Location lists. If the required value is not available,
click next to the relevant list arrow to open the appropriate supporting table.
(For details, see Add a New Value to a Drop-Down List, page ???.)
7. Under Dimensions, type a value for the marshaling rack dimensions if needed.
8. Under Mounting, type a value if needed.
9. Select the Set as intrinsically safe check box if this marshaling rack has intrinsic
safety certification.
10. Click the Associate Symbols tab to associate a symbol with the current panel.
The software will use this symbol when generating a report in the Enhanced
Report Utility. For details, see Associate a Symbol with an Item, page 734.
11. Click Revisions to manage the revisions of the new panel if needed.
12. Click OK to accept your definitions for the new device panel and close this dialog
box.
Note
• To create a device panel that contains both terminals and plug-and-socket
connections, see Create a Panel with Terminals and Connectors, page
765.
Related Topics
• Conventional Panels: An Overview, page 754
• Create a Panel with Terminals and Connectors, page 765
• Device Panels: An Overview, page 770
• Managing Conventional Panels Common Tasks, page 755
• Managing Device Panels Common Tasks, page 772
Note
• To create a DCS panel that contains both terminals and plug-and-socket
connections, see Create a Panel with Terminals and Connectors, page
765.
Related Topics
• Conventional Panels: An Overview, page 754
• Managing Conventional Panels Common Tasks, page 755
6. Under Maximum number of racks, type a value to set the maximum number of
racks that can be created in this panel.
Tip
• Setting this value to zero means that the current panel can have an
unlimited number of racks.
7. To create a PLC panel compatible with a Profibus DP segment, do the following:
a. Select the Enable DP Profibus check box.
b. Under DP Profibus node, type a node for the new panel.
8. If you need to enter power supply properties, select the Requires power supply
check box and then click the Power Supply tab. For details, see Enter Power
Supply Data for Panels and Instrument Tags, page 766.
9. Click the Associate Symbols tab to associate a symbol with the current panel.
The software will use this symbol when generating a report in the Enhanced
Report Utility. For details, see Associate a Symbol with an Item, page 734.
10. Click Revisions to manage the revisions of the new panel if needed.
11. Click OK to accept your definitions for the new PLC panel and close this dialog
box.
Note
• To create a PLC panel that contains both terminals and plug-and-socket
connections, see Create a Panel with Terminals and Connectors, page
765.
Related Topics
• Conventional Panels: An Overview, page 754
• Managing Conventional Panels Common Tasks, page 755
Related Topics
• Conventional Panels: An Overview, page 754
• Making Connections and Associations for Fieldbus Common Tasks, page
985
• Managing Conventional Panels Common Tasks, page 755
Create a Rack
1. Do one of the following:
• Press F7 to open the Domain Explorer.
• Press F8 to open the Reference Explorer and expand the Panels
folder. Then, select a desired reference panel. For more information,
see Create a Reference Item, page ??? .
2. In the Domain Explorer, do one of the following:
• Expand the Panels by Category folder to display all the panel
category folders.
• Expand the Panels by Location hierarchy to display the available
locations and their panels. Then, select a desired panel.
3. In the Domain Explorer or in the Reference Explorer, right-click the selected
panel and then click New >Rack.
4. In the Rack Properties dialog box, on the General tab, do one of the following
to define the name of the new panel:
• Clear the Apply naming convention check box and under Rack, type
the name of the new rack. Note that if you do not clear the Apply
naming convention check box, the software will ignore the name that
you type under Rack.
• Keep the Apply naming convention check box selected if you want
the software to name the new panel automatically according to the
naming conventions that are set for racks in the Administration
module. For more information, see SmartPlant Instrumentation
Administration Help, Domain Administration > Naming Conventions.
5. In the Details group box, type a description and sequence as you require.
6. Click Slots to add some slots for the current rack.
7. In the Batch Slot Creation dialog box, type the number of new slots that you
want to add in the new rack.
8. Do the following to define the slot numbering:
a. Type a prefix for the slot name.
b. Enter a value in the Start from number and Increment by fields.
9. Click OK and to add the new slots return to the Rack Properties dialog box.
Tip
• In the Rack Properties dialog box, the software now displays the
number of slots that you added.
10. Click the Associate Symbols tab to associate a symbol with the current rack. The
software will use this symbol when generating a report in the Enhanced Report
Utility. For details, see Associate a Symbol with an Item, page 734.
Note
• When duplicating a rack that contains child items, the software duplicates
the rack together with its child items.
Related Topics
• Conventional Panels: An Overview, page 754
• Managing Conventional Panels Common Tasks, page 755
Create a Slot
1. Do one of the following:
• Press F7 to open the Domain Explorer.
• Press F8 to open the Reference Explorer and expand the Panels
folder. Then, select a desired reference panel. For more information,
see Create a Reference Item, page ??? .
2. In the Domain Explorer, do one of the following:
• Expand the Panels by Category folder to display all the panel
category folders.
• Expand the Panels by Location hierarchy to display the available
locations and their panels. Then, select a desired panel.
Related Topics
• Conventional Panels: An Overview, page 754
• Managing Conventional Panels Common Tasks, page 755
Wiring information consists of a signal (a wire group), signal level, and signal
sequence. An instrument generates a signal which is carried through a group of
wires. These wires are connected to a device panel associated with that instrument.
The software propagates the signal through the wires on different levels. Signal
levels can be, for example, plus, minus, and shield. A signal sequence is a method
used by SmartPlant Instrumentation to assign numbers, in ascending or descending
increments, to connection points along the signal propagation path at the same signal
level.
The following diagram indicates how a device panel is associated with an instrument.
You may then continue the wiring routing as required.
Each signal level defines a signal routing associated with a particular loop. It is
possible to have up to 99 levels within one signal.
Note that SmartPlant Instrumentation automatically tracks signals and assigns the
signal, signal level, and signal sequence values when you create a device panel.
Also, if a device panel is a child item of another panel, the software does not
duplicate the child device panel when duplicating the parent panel.
Related Topics
• Managing Device Panels Common Tasks, page 772
• Principles of Creating Device Panels, page 771
Before creating a device panel with wiring information you need to define a number
of reference items. These reference items are the panel, cable, and connection type.
You can also define appropriate instrument type profiles that include wiring
definitions. When creating an instrument based on a defined instrument type profile,
the software automatically checks if the instrument that is being added needs to have
a device panel. Based on the given default settings, the software will create the panel,
the cable, and the connections between them. Also, SmartPlant Instrumentation
automatically propagates the signals and names the device panels and cables
according to the appropriate naming conventions defined in the Administration
module. If no naming convention for device cables has been defined, the software
names the cable after the instrument, when the name is prefixed with "C-".
Related Topics
• Device Panels: An Overview, page 770
• Fieldbus Plug-and-Socket Boxes: An Overview, page 969
• Managing Device Panels Common Tasks, page 772
You can create new panels either in the Domain Explorer or the Reference
Explorer. If you are creating a panel that is going to have a frequently used
configuration, we recommend that you create it in the Reference Explorer.
Reference panels facilitate fast creation of plant panels by copying an existing panel
configuration from the Reference Explorer to the Domain Explorer. However, if
you want to create a panel that does not have a configuration that you intend to use
frequently, we recommend that you create this panel in the Domain Explorer and in
the <unit> where it is to be physically located. This is helpful when filtering the
panels in the current <unit>.
For more information, see Create an Instrument Without a Device Panel, page 779.
For more information, see Associate Instruments with Device Panels, page 782.
SmartPlant Instrumentation renames the cable to draw your attention to the fact that
the cable is not connected to any device. In addition, the software renames the wires
to SPARE throughout the signal run. For more information, see Dissociate Device
Panels from Instruments, page 783.
Related Topics
• Device Panels: An Overview, page 770
• Principles of Creating Device Panels, page 771
• Click .
• On the menu bar click Actions > Device Panels.
3. In the Device Panels window, clear the Manual configuration check box.
4. Do one of the following:
• Click .
• On the menu bar click Actions > New Tag.
5. In the New Tag Number dialog box, do the following:
a. From the Tag class list, select the desired tag class according to whether you
want to create a conventional instrument, Foundation Fieldbus instrument,
HART instrument, Telecom instrument, and so forth.
b. Type the name of the new instrument. If needed, it is possible for instruments
and device panels to have the same names. Make sure that you follow the
naming conventions for new tag numbers. For details, see Instrument Tag
Naming Convention, page ???.
c. Click OK to create the instrument.
6. If more than one function identifier exists for the current instrument type
acronym, on the Select Instrument Type dialog box, select the appropriate
instrument type, and then, click OK.
Tips
• If the instrument name does not correspond to an existing loop name,
SmartPlant Instrumentation prompts you to enter a loop name based on
the tag number you have entered. The software automatically
associates the new instrument with the loop if the loop identifier
already matches an existing loop.
• If the loop convention includes the loop function parameter, the
prompt always appears. In this case, you have to complete the loop
number. If a profile exists for the selected instrument type, the
software creates the new instruments for that instrument type
according to the selected reference items. For details, see Define an
Instrument Type Profile, page ???.
7. In the Loop Name dialog box, do one of the following:
• Type the loop number name that the new instrument will be associated
with.
• Accept the displayed value to create a new loop with this name.
8. In the Loop Name dialog box, do one of the following:
• Click OK to create the new loop number.
• Click Cancel to create the new instrument without a loop association.
9. On the Tag Number Properties dialog box, edit the instrument properties as you
require and click OK.
Note
• The software adds the new instrument to the list of instruments in the
Device Panels window. Also, you can see the new instrument in the
Instruments folder of the Domain Explorer.
Related Topics
• Device Panels: An Overview, page 770
• Managing Device Panels Common Tasks, page 772
• Principles of Creating Device Panels, page 771
c. Click Profile.
d. Under Activate instrument type profile options, select the Wiring check
box.
e. Click OK
2. In the Wiring Module window, do one of the following:
• Click .
• On the menu bar click Actions > Device Panels.
3. In the Device Panels window, select the Manual configuration check box.
4. Do one of the following:
• Click .
• On the menu bar click Actions > New Tag.
5. On the New Tag Number dialog box, do the following:
a. From the Tag class list, select the desired tag class according to whether you
want to create a conventional instrument, Foundation Fieldbus instrument,
HART instrument, Telecom instrument, and so forth.
b. Type the name of the new instrument. If needed, it is possible for instruments
and device panels to have the same names. Make sure that you follow the
naming conventions for new tag numbers. For details, see Instrument Tag
Naming Convention, page ???.
c. Click OK to create the instrument.
6. If more than one function identifier exists for the current instrument type
acronym, on the Select Instrument Type dialog box, select the appropriate
instrument type, and then, click OK.
Tips
• If the instrument name does not correspond to an existing loop name,
SmartPlant Instrumentation prompts you to enter a loop name based on
the tag number you have entered. The software automatically
associates the new instrument with the loop if the loop identifier
already matches an existing loop.
• If the loop convention includes the loop function parameter, the
prompt always appears. In this case, you have to complete the loop
number. If a profile exists for the selected instrument type, the
software creates the new instruments for that instrument type
according to the selected reference items For details, see Define an
Instrument Type Profile, page ???.
7. In the Loop Name dialog box, do one of the following:
• Type the loop number name that the new instrument will be associated
with.
• Accept the displayed value to create a new loop with this name.
8. In the Loop Name dialog box, do one of the following:
• Click OK to create the new loop number.
• Click Cancel to create the new instrument without a loop association.
9. On the Create Device Panel and Cable dialog box, under Device panel, accept
or the displayed name of the device panel that will be created with the current
instrument.
Tip
• The Create Device Panel and Cable dialog box opens only if the
instrument that you are creating is based on an instrument type profile
that has at least partial wiring definitions.
10. From the Reference device panel list, select a reference device panel that you
want to use as a basis for the new device panel.
Tips
• The displayed reference panel is the one that you defined in the
Instrument Index module, in the Instrument Type Profile dialog box,
under Wiring and I/O Profile.
• The properties of the reference panel that you select determine whether
one or both of the Conventional connections and Plug-and-socket
connections group boxes are enabled, and the values that are initially
displayed.
11. In the active group boxes, to define the device cables, do the following as
necessary:
• To modify the properties of a selected device cable connection, click
Properties, and in the dialog box that opens, change the values as
necessary.
• To add an additional device cable connection, click New, and in the
dialog box that opens, enter the appropriate values.
• To delete selected cable connections, click Delete.
12. Click OK to complete the process.
13. On the Tag Number Properties dialog box, edit the instrument properties as you
require and click OK.
Note
• The new device panel appears next to the selected instrument in the
Device Panels window. SmartPlant Instrumentation displays a cable icon
next to the new device cable indicating that a device cable is
connected to it.
• Click .
• On the menu bar click Actions > Device Panels.
3. In the Device Panels window, do one of the following:
• Click .
• On the menu bar click Actions > New Tag.
4. In the New Tag Number dialog box, do the following:
a. From the Tag class list, select the desired tag class according to whether you
want to create a conventional instrument, Foundation Fieldbus instrument,
HART instrument, Telecom instrument, and so forth.
b. Type the name of the new instrument. If needed, it is possible for instruments
and device panels to have the same names. make sure that you follow the
naming conventions for new tag numbers. For details, see Instrument Tag
Naming Convention, page ???.
c. Click OK to create the instrument.
5. If more than one function identifier exists for the current instrument type
acronym, on the Select Instrument Type dialog box, select the appropriate
instrument type, and then, click OK.
Tips
• If the instrument name does not correspond to an existing loop name,
SmartPlant Instrumentation prompts you to enter a loop name based on
the tag number you have entered. The software automatically
associates the new instrument with the loop if the loop identifier
already matches an existing loop
Note
• To make this feature work, you must select the Create wiring check box
and choose a reference device panel on the Wiring and Control System
tab in the instrument type profile of the selected tag number before you
attempt to create a new device panel. You can also select a reference
device cable if you want SmartPlant Instrumentation to create device
cables with the device panels. For more details, see Define an Instrument
Type, page ???.
Related Topics
• Device Panels: An Overview, page 770
• Managing Device Panels Common Tasks, page 772
• Principles of Creating Device Panels, page 771
• Click .
• On the menu bar click Actions > Device Panels.
2. In the Device Panels window, do one of the following:
• Select the Manual configuration check box to define the device panel
and cable manually.
• Clear the Manual configuration check box to define the device panel
and cable automatically.
3. On the menu bar, click Actions > New Tag or click on the toolbar.
4. Select the instruments for which you want to create device panels and cables.
You can use the Ctrl and Shift keys to select multiple instruments.
5. On the menu bar click Actions > Create.
Tips
• If you cleared the Manual configuration check box, SmartPlant
Instrumentation creates and configures the device panel automatically.
The creation process ends at this point and the new device panels
appear next to the selected instruments in the Device Panels window.
The software displays a cable icon next to the new device panel
indicating that a device cable is connected to it.
• If you selected the Manual configuration check box, the creation
process continues.
6. On the Create Device Panel and Cable dialog box, under Device panel, accept
or the displayed name of the device panel that will be created with the current
instrument.
Tip
• The Create Device Panel and Cable dialog box opens only if the
instrument that you are creating is based on an instrument type profile
that has at least partial wiring definitions.
7. From the Reference device panel list, select a reference device panel that you
want to use as a basis for the new device panel.
Tips
• The displayed reference panel is the one that you defined in the
Instrument Index module, in the Instrument Type Profile dialog box,
under Wiring and I/O Profile.
• The properties of the reference panel that you select determine whether
one or both of the Conventional connections and Plug-and-socket
connections group boxes are enabled, and the values that are initially
displayed.
8. In the active group boxes, to define the device cables, do the following as
necessary:
• To modify the properties of a selected device cable connection, click
Properties, and in the dialog box that opens, change the values as
necessary.
• To add an additional device cable connection, click New, and in the
dialog box that opens, enter the appropriate values.
• To delete selected cable connections, click Delete.
9. To apply the values that you set to the selected instruments with incomplete
wiring profiles, select Apply to all selected instruments with incomplete
profile.
Note
• You can also create device panels and cables for selected instruments in
the Instrument Index Standard Browser view. For details, see Create
Device Panels and Cables in the Instrument Index Standard Browser
View, page 780.
Related Topics
• Device Panels: An Overview, page 770
• Managing Device Panels Common Tasks, page 772
• Principles of Creating Device Panels, page 771
• Click .
• Click .
• On the menu bar, click Actions > Associate.
4. On the Select Device Panels dialog box, select the appropriate device panels.
5. Click OK.
Note
• The new device panel appears next to the selected instrument in the
Device Panels window. You can now create a device cable for these
panels.
Related Topics
• Device Panels: An Overview, page 770
• Managing Device Panels Common Tasks, page 772
• Principles of Creating Device Panels, page 771
• Click .
• On the menu bar click Actions > Device Panels.
2. In the Device Panels window, select the instruments you require and then do one
of the following:
• Click .
• On the menu bar, click Actions > Dissociate.
Related Topics
• Device Panels: An Overview, page 770
• Managing Device Panels Common Tasks, page 772
• Principles of Creating Device Panels, page 771
• Click .
• On the menu bar click Actions > Device Panels.
2. In the Device Panels window, do one of the following:
• Select the Manual configuration check box to define the device panel
and cable manually.
• Clear the Manual configuration check box to define the device panel
and cable automatically.
3. Select the required device panel - instrument associations for which you want to
create device cables.
4. On the menu bar, click Actions > Create.
Tips
• If you cleared the Manual configuration check box, SmartPlant
Instrumentation creates and configures the device panel automatically.
The creation process ends at this point and the new device panels
appear next to the selected instruments in the Device Panels window.
The software displays a cable icon next to the new device panel
indicating that a device cable is connected to it.
• If you selected the Manual configuration check box, the creation
process continues.
5. On the Create Device Panel and Cable dialog box, in the active group box
(Conventional connections or Plug-and-socket connections) do the following
for each device panel — associated with an instrument.
a. Click New.
b. On the dialog box that opens, enter the appropriate values.
c. Click OK.
6. On the Create Device Panel and Cable dialog box, click OK.
Note
• The new device cable appears in the Device Panels window next to the
selected instrument.
Related Topics
• Device Panels: An Overview, page 770
• Managing Device Panels Common Tasks, page 772
• Principles of Creating Device Panels, page 771
4. On the Rename tab of the Rename Device Cables dialog box, select the check
boxes next to the cables that you want to rename or choose the Select All check
box to select all the cables displayed in the data window.
5. Click the Convention tab to define the cable name template, that is, the rules how
the cable names will change.
Tip
• If a name template has been defined, it is displayed in the Current
Convention field.
6. Insert and define as many conventions as required.
7. Select the Use as default check box to use the convention row definitions as your
default naming conventions.
8. Click Apply when done.
Note
• You can modify the device panel name according to your needs. Device
cable names are, however, not editable in this dialog box. You can
rename device cables in the Domain Explorer.
Related Topics
• Device Panels: An Overview, page 770
• Managing Device Panels Common Tasks, page 772
• Principles of Creating Device Panels, page 771
Prior to Version 7, SmartPlant Instrumentation provided for this type of objects only
by letting you create an apparatus. However, apparatus did not deal with certain
aspects of wiring equipment such as electric properties. Apparatus provided a "flat"
structure that could only group terminals on an apparatus strip under a position name.
Wiring equipment, however, introduces a structured object which you can remove,
add, and copy. You can accurately define wiring equipment properties such as
category, manufacturer, model, and so forth.
Wiring equipment is a much wider feature which allows you to create various types
of termination objects and define their electric properties. You can use wiring
equipment whenever you need to define any type of card, or piece of hardware that
you need to buy separately, count the number of units you need (BOM), install it
inside a panel, and make connections
SmartPlant Instrumentation enables you to create and manage wiring equipment items
that:
When designing a Foundation Fieldbus or Profibus system, you can create a wiring
equipment item belonging to the fieldbus brick category. Then, under a fieldbus
brick you can add a fieldbus apparatus. This compound object provides for the
creation and management of fieldbus termination objects required for your
Foundation Fieldbus or Profibus system. For details, see Fieldbus Bricks: An
Overview, page 979.
This procedure explains how to customize a wiring equipment category and add a
customized property to a category. Note that some of the shipped wiring equipment
categories have predefined properties. You can add your own customized properties
to the shipped categories as well as to the customized ones.
You can create new wiring equipment items either in the Domain Explorer or the
Reference Explorer. If you are creating a wiring equipment item that is going to
have a frequently used configuration, we recommend that you create it in the
Reference Explorer. Reference wiring equipment items facilitate fast creation of
plant items by copying an existing wiring equipment item from the Reference
Explorer to the Domain Explorer. However, if you want to create a wiring
equipment item that does not have a configuration that you intend to use frequently,
we recommend that you create it in the Domain Explorer and in the <unit> where it
is to be physically located. This is helpful when filtering the wiring equipment items
in the current <unit>.
For more information, see Create a Wiring Equipment Item, page 792 .
You can create new I/O cards either in the Domain Explorer or the Reference
Explorer. If you are creating an I/O card that is going to have a frequently used
configuration, we recommend that you create it in the Reference Explorer.
Reference I/O cards facilitate fast creation of plant I/O cards by copying an existing
item from the Reference Explorer to the Domain Explorer. However, if you want
to create an I/O card that does not have a configuration that you intend to use
frequently, we recommend that you create it in the Domain Explorer and in the
<unit> where it is to be physically located. This is helpful when filtering I/O cards in
the current <unit>.
Also, you can create an I/O termination when you need to define a distant I/O card
that resides in a different panel or rack. You need to create a terminal strip with
channels under an I/O termination to be able to effect I/O assignment and make
connections.
You can create new I/O termination cards either in the Domain Explorer or the
Reference Explorer. If you are creating an item that is going to have a frequently
used configuration, we recommend that you create it in the Reference Explorer.
Reference items facilitate fast creation of plant items by copying an existing item
from the Reference Explorer to the Domain Explorer. However, if you want to
create an I/O termination that does not have a configuration that you intend to use
frequently, we recommend that you create it in the Domain Explorer and in the
<unit> where it is to be physically located. This is helpful when filtering the wiring
equipment items in the current <unit>.
For more information, see Associate an I/O card with an I/O Termination, page 802.
Related Topics
• Wiring Equipment: An Overview, page 786
7. From the Type list, select the type of value for the new customized category
property. You will then be able to enter a value for this new property on the
Category Properties tab of the appropriate wiring equipment properties dialog
box. The values can be numeric, text, or date/time.
8. Do one of the following:
• Click Add to define another new property.
• Click OK to accept your definitions and close this dialog box.
9. Create a new wiring equipment item .
Tip
• In the Domain Explorer, right-click a panel or a panel child item, and
then on the shortcut menu, click New > Wiring Equipment.
10. In the New Wiring Equipment dialog box, from the Category list, select the
newly created category, type the wiring equipment item name, and click OK.
11. On the General tab of the Properties dialog box, define wring equipment
properties as you require and click the Category Properties tab.
12. On the Category Properties tab, enter the values for each property as you
require,
13. Continue defining the properties of the new wiring equipment item as you need.
Note
• The software does not allow you to delete or rename the shipped wiring
equipment categories. Nor can you delete or rename any of the predefined
properties belonging to the shipped wiring equipment categories.
Related Topics
• Wiring Equipment Common Tasks, page 788
• Wiring Equipment: An Overview, page 786
3. Right-click a wiring item under which you want to create new wiring equipment
and then on the shortcut menu, click New > Wiring Equipment.
4. In the New Wiring Equipment dialog box, from the Category list, select a
category to which the new item belongs.
Tip
• If you need to create an I/O card or an I/O termination, see Wiring
Equipment Common Tasks, page 788.
5. Under Name, type the name of the item and click OK.
6. In the Wiring Equipment Properties dialog box, on the General tab, do one of
the following to define the name of the new equipment:
• Select the Apply naming convention check box selected if you want
the software to name the new equipment automatically according to
the naming conventions that are set for this type of equipment in the
Administration module. For more information, see SmartPlant
Instrumentation Administration Help, Domain Administration >
Naming Conventions.
• Clear the Apply naming convention check box and under Name, type
the name of the new equipment. Note that if you do not clear the
Apply naming convention check box, the software will ignore the
name that you type under Name.
7. Select the Double width check box if the item occupies a double width slot.
8. In the Details group box do the following as you require:
a. Type a description.
b. Select an item type, model, and manufacturer. If the required value is not
available on the list, click to define a new one.
c. Enter a sequence if you need to define the sequence of the new item in its
parent item . This sequence also determines the order in which wiring items
appear under their parent item in the Domain Explorer tree view.
9. Click the Category Properties tab.
Tip
• If you are creating a miscellaneous wiring equipment item , the
Category Properties tab is not available.
10. Revise and modify category property values as you require. Click the value for
each property and modify it as needed.
Tip
• Wiring equipment categories that are shipped with SmartPlant
Instrumentation have predefined properties. You cannot delete or
rename any of these categories or their properties. You can only edit
their values. However, you can add user-defined properties to any
category which you can rename or delete as you wish. For details, see
Customize and Use Wiring Equipment Categories, page 790.
11. Click the Associate Symbols tab to associate a symbol with the current item .
The software will use this symbol when generating a report in the Enhanced
Report Utility. For details, see Associate a Symbol with an Item, page 734.
12. Click OK to accept your settings and close the dialog box.
Related Topics
• Wiring Equipment Common Tasks, page 788
• Wiring Equipment: An Overview, page 786
Example 1:
Example 2:
Example 3:
Example 4:
Example 5:
Example 6:
This example shows the wiring items that can exist in the Panels by Location folder.
Example 7:
This example shows the items that can exist in the Cables folder.
For a better understanding of the Domain Explorer, see Working with the Domain
Explorer: An Overview, page ???.
Related Topics
• Wiring Equipment Common Tasks, page 788
• Wiring Equipment: An Overview, page 786
• Select the Apply naming convention check box selected if you want
the software to name the new card automatically according to the
naming conventions that are set for this type of equipment in the
Administration module. For more information, see SmartPlant
Instrumentation Administration Help, Domain Administration >
Naming Conventions.
• Clear the Apply naming convention check box and under Name, type
the name of the new card. Note that if you do not clear the Apply
naming convention check box, the software will ignore the name that
you type under Name.
8. Select the Double width check box if the card occupies a double width slot.
9. In the Details group box do the following as you require:
a. Type a description.
b. Select an I/O card type, model, and manufacturer. If the required value is not
available on the list, click to define a new one.
c. Enter a sequence if you need to define the sequence of the new card in its
parent item . This sequence also determines the order in which wiring items
appear under their parent item in the Domain Explorer tree view.
10. Click the Control System tab.
11. In the Control system details group box, under I/O type, select a I/O type to
determine the actual function of the new I/O card. For example, AI, AO, DI, DP,
Fieldbus, Profibus, and so forth. You can add more values to this list in the I/O
Type supporting table in the Instrument Index module. (See the important notes
at the end of this procedure.)
12. Under Module, type the software address that this card is assigned to.
Tip
• Module, Controller/Processor, Rack, and Slot are field headers
specific to panel manufacturers. Selecting a different manufacturer
when editing the panel displays the headings used by that panel
manufacturer. For details, see Customize the Controller/Processor
List Header in I/O Card Properties, page 802.
13. From the Controller/Processor list, select an I/O card controller. If the required
controller is not available on the list, click to define a new one.
14. To view the list of all I/O terminations associated with the current I/O card, click
the I/O Terminations button.
15. Click the Category Properties tab.
16. Revise and modify category property values as you require. Click the value for
each property and modify it as needed.
Tip
• I/O card is a wiring equipment category that is shipped with
SmartPlant Instrumentation. You cannot delete or rename any of the
wiring equipment categories that have been shipped with the software.
Nor can you delete or rename the properties of the shipped categories.
However, when editing I/O card properties, you can add user-defined
properties which you can rename or delete as you wish. For details,
see Customize and Use Wiring Equipment Categories, page 790.
17. Click the Associate Symbols tab to associate a symbol with the current I/O cards.
The software will use this symbol when generating a report in the Enhanced
Report Utility. For details, see Associate a Symbol with an Item, page 734.
18. Click OK to accept your settings and close the dialog box.
Important
• In a redundant system configuration, an I/O card can function as a primary
or secondary I/O card and can be associated with several I/O terminations.
Therefore, an I/O termination can serve multi-paired redundant I/O cards.
However, in these redundant I/O card configurations, the I/O termination
can be associated only with one pair of primary and secondary I/O cards.
Also, an I/O card cannot function as both a primary and secondary I/O
card for the same I/O termination.
• If an I/O card functions as a primary I/O card, the Control System tab of
the Wiring Equipment Properties - I/O Card dialog box displays the
secondary I/O card data and the primary I/O card data properties remain
blank. If an I/O card functions as a secondary I/O card, the Control
System tab displays the primary I/O card data and the secondary I/O card
data properties remain blank.
Related Topics
• Wiring Equipment Common Tasks, page 788
• Wiring Equipment: An Overview, page 786
12. To set the new I/O termination in a distant cabinet or to associate the I/O
termination with an I/O card that resides in another panel, do the following:
a. select the Set within a distant cabinet check box.
b. Select a cabinet in the Primary I/O card group box.
13. To associate the current I/O termination with an I/O card that does not have a
built-in termination block, select the required options in the Primary I/O card
group box.
Tip
• The I/O card list contains only those I/O cards that have been created
under a rack and a slot. Fore more information, see Associate an I/O
card with an I/O Termination, page 802.
14. To define the current I/O termination as an I/O termination that serves two
redundant I/O cards, do the following:
a. Select the Define a redundant I/O card check box.
b. Select the required options in the Secondary I/O card group box.
15. Click the Category Properties tab.
16. Revise and modify category property values as you require. Click the value for
each property and modify it as needed.
Tip
• I/O termination is a wiring equipment category that is shipped with
SmartPlant Instrumentation. You cannot delete or rename any of the
wiring equipment categories that have been shipped with the software.
Nor can you delete or rename the properties of the shipped categories.
However, when editing I/O termination properties, you can add user-
defined properties which you can rename or delete as you wish. For
details, see Customize and Use Wiring Equipment Categories, page
790.
17. Click the Associate Symbols tab to associate a symbol with the current I/O
termination. The software will use this symbol when generating a report in the
Enhanced Report Utility. For details, see Associate a Symbol with an Item, page
734.
18. Click OK to accept your settings and close the dialog box.
Related Topics
• Wiring Equipment Common Tasks, page 788
• Wiring Equipment: An Overview, page 786
Related Topics
• Wiring Equipment Common Tasks, page 788
• Wiring Equipment: An Overview, page 786
Apparatus: An Overview
Apparatus is a wiring item that pertains to different types of multi-purpose I/O
devices. These devices accept wires and signals, for example, barriers, opto-couplers,
relays, repeaters, isolators, and so forth. You also use this feature to create a fieldbus
termination block whose configuration is different from an apparatus configuration.
Adding a new apparatus group to a panel or a wiring equipment item starts with
configuring the new apparatuses: setting the number of apparatuses on an apparatus
strip, defining the apparatus terminal numbering pattern, signal propagation, and the
color of the terminals. After defining an apparatus configuration, you can proceed
with the creation of an apparatus group. The software opens the Terminal Strip
Properties dialog box so that you can define an apparatus strip for the new apparatus
group. After defining the apparatus strip properties in the Terminal Strip Properties
dialog box, the software creates the apparatus strip and the apparatuses according the
selected configuration.
Once you have created a new apparatus group or a single apparatus, SmartPlant
Instrumentation displays it in the Domain Explorer showing the terminals belonging
to the apparatus.
Note that an apparatus is a wiring item . Therefore, you can define apparatus
properties, duplicate, or delete an apparatus, and assign it a special symbol. The
software uses this symbol in the Enhanced Report Utility.
Related Topics
• Apparatus Common Tasks, page 805
When defining an apparatus configuration, you define the apparatus profile (name,
description, manufacturer, and model), the number of apparatuses, the apparatus
terminal configuration, and the position numbering.
Related Topics
• Apparatus: An Overview, page 804
• Wiring Equipment: An Overview, page 786
18. Do the following to define the apparatus terminal name and color:
a. Click in the left and/or right terminal side text box and type the required
terminal name, for example 1A:
b. Select a color of the terminal side from the list, for example red:
19. Repeat steps 17 and 18 for the other terminal side if appropriate. Note that the
line between the two terminal list arrows represents the internal relation between
the input and output terminals.
20. Click Add Terminal to add another terminal to this apparatus configuration if
needed and then repeat steps 14 through 16.
21. Click Delete Terminal if you need to delete a selected terminal from the current
configuration.
22. Click Save and then Close. You can now add the required apparatus as needed.
Related Topics
• Apparatus Common Tasks, page 805
• Apparatus: An Overview, page 804
Tip
• If you do not have an appropriate configuration, create one. For
details, see Define an Apparatus Configuration, page 806.
6. Use the Number of apparatuses spinner or type the required number of
apparatuses to be added. This way you can have a block of more than one
apparatuses. This number will be displayed by default when adding a new
apparatus to an apparatus strip.
7. Click Create.
Tip
• SmartPlant Instrumentation automatically assigns sequential position
numbers to each apparatus. You can edit them later if required. For
details, see Edit Apparatus Terminal Properties, page 810.
8. In the Terminal Strip Properties dialog box, define the new apparatus strip as
required and click OK. For details, see Create a Terminal Strip, page 817.
9. Click Close in the Apparatus dialog box.
Tip
• The new apparatus appears in the Domain Explorer within the new
terminal strip.
10. Connect the apparatus to the appropriate cables. Select the apparatus group you
want to connect and click . The Connection window opens displaying the
apparatus terminals in yellow:
Related Topics
• Apparatus Common Tasks, page 805
• Apparatus: An Overview, page 804
Related Topics
• Apparatus Common Tasks, page 805
• Apparatus: An Overview, page 804
Related Topics
• Apparatus Common Tasks, page 805
• Apparatus: An Overview, page 804
You can create terminal strips either in the Domain Explorer or the Reference
Explorer. If you are creating a terminal strip that is going to have a frequently used
configuration, we recommend that you create it in the Reference Explorer.
Reference terminal strips facilitate fast creation of terminal strips in your plant by
copying a terminal strip from the Reference Explorer to the Domain Explorer.
However, if you want to create a terminal strip that does not have a configuration that
you intend to use frequently, we recommend that you create it in the Domain
Explorer and in the <unit> where it is to be physically located. This is helpful when
filtering the terminal strips in the current <unit>.
Related Topics
• Managing Terminal Strips Common Tasks, page 812
You can label the terminals on a terminal strip according to any numbering system
that you require (up to ten characters in length). To facilitate logical terminal
numbering, SmartPlant Instrumentation requires you to configure the basic repeating
numbering pattern (configuration) for the terminals in the new terminal strip before
defining that terminal strip.
When creating a strip in an I/O card or I/O termination, you use configurations that
include channels. If you want to create a terminal strip without channels in one of
these panels, set the number of terminals per channel to zero.
For more information, see Define a Terminal Strip Configuration, page 813.
For more information, see Modify a Terminal Strip Configuration, page 815.
Move a Terminal
This option enables you to move a terminal from one position to another on a
terminal strip/channel, or from one terminal strip/channel to another terminal
strip/channel. It is possible to move a terminal under the following circumstances:
Related Topics
• Terminal Strips: An Overview, page 811
Tip
• This number determines the number of rows (terminals) that will
constitute the basic repeating numbering (naming) pattern.
• This numbering pattern is shown in the Terminal Numbering
Pattern data grid on the Terminal Strip Configuration dialog box.
5. Under Configuration name, type the name of the new configuration.
6. Under Configuration description, type an optional description of the new
configuration.
7. Type or select the total number of terminals required in the terminal strip.
8. Select the starting number for the first terminal in the terminal strip.
9. Select the required number of terminals per channel or segment.
10. Select the first channel.
Tip
• If the new configuration is to be used to create I/O cards, the value in
the Number of terminals per channel and First channel fields must
be larger than zero. Otherwise, the terminals on the terminal strip are
created without channels and you will not be able to create an I/O card.
11. In the Terminal Numbering Pattern data grid, click and type in the Prefix field,
click and type a value if you want to prefix the names of the terminals.
12. Select the Incremented check box if you want the terminal number to be
incremented within the pattern.
13. Select the Numbered check box if you want the number of the terminal to appear
between the prefix and the suffix.
14. In the Suffix field, click and type a value if you want a suffix for the names of the
terminals.
15. From the Orientation list, select the connection orientation to the terminal:
• Regular— a conventional terminal that functions as a single unit.
• Left— a terminal that has wires on the left side only.
• Right— a terminal that has wires on the right side only.
• Left / Right— a terminal that has wires on the left side only.
16. Click Save.
Notes
• If the required number of terminals is not exactly divisible by the number
of terminals in a pattern, the remaining terminals are labeled SPARE.
• For examples of possible terminal strip configurations, see Terminal Strip
Configuration Examples, page 816.
Notes
• If the required number of terminals is not exactly divisible by the number
of terminals in a pattern, the remaining terminals are labeled SPARE.
• For examples of possible terminal strip configurations, see Terminal Strip
Configuration Examples, page 816.
Related Topics
• Managing Terminal Strips Common Tasks, page 812
• Terminal Strips: An Overview, page 811
No numbering
Related Topics
• Managing Terminal Strips Common Tasks, page 812
• Terminal Strips: An Overview, page 811
6. From the Type, Model, and Manufacturer lists, select appropriate values to
define the new terminal strip as you require. If any of the lists do not contain the
value that you need, click to open the relevant supporting table where you can
manage the contents of the select lists.
7. Type a value for mounting, dimensions, and rail if needed.
8. Under Sequence, enter a number to define the sequence of the current terminal
strip in its parent item (a panel, rack, slot, or wiring equipment).
9. To manage the revisions of the terminal strip, click Revisions.
10. Click the Associate Symbols tab to associate a symbol with the current terminal
strip. The software will use this symbol when generating a report in the Enhanced
Report Utility. For details, see Associate a Symbol with an Item, page 734.
11. Click OK to create the new terminal strip.
Related Topics
• Managing Terminal Strips Common Tasks, page 812
• Terminal Strips: An Overview, page 811
Note
• This dialog box does not allow you to save the changes you make to an
existing terminal strip configuration. The software applies the changes
only to the group of terminals you are currently adding.
Related Topics
• Managing Terminal Strips Common Tasks, page 812
• Terminal Strips: An Overview, page 811
10. In the Note text box, type, if required, type a brief note or a remark about this
terminal.
11. Click the Associate Symbols tab to associate a symbol with the current terminal.
The software will use this symbol when generating a report in the Enhanced
Report Utility. For details, see Associate a Symbol with an Item, page 734.
12. Click OK to create the new terminal.
Related Topics
• Managing Terminal Strips Common Tasks, page 812
• Terminal Strips: An Overview, page 811
Move a Terminal
1. In the Domain Explorer or Reference Explorer, select a terminal that you want
to move.
2. Expand the hierarchy of the target terminal strip.
Tip
You can open another instance of the Domain Explorer or Reference Explorer
and place it beside the one that is already open to make the drag-and-drop
operation easier.
3. Drag the selected terminal to the desired terminal strip.
Important
It is possible to move a terminal under the following circumstances.
2. On the Terminal Types dialog box. select a terminal type or create a new one.
3. Click in G1 box to select a graphic that will represent a terminal connection with
a single wire or without any wire.
4. Click in G2 box to select a graphic that will represent a terminal connection with
a multiple wires.
Notes
• The selected graphic appears in the G1, G2, or both boxes. The size of the
G1 and G2 boxes represents the actual size of the icons that appear in the
Connection window.
• If you do not select anything in the G1 or G2 box, SmartPlant
Instrumentation displays the default gray screw head for terminal
connections with or without single wires and the turquoise screw head
for terminal connections with multiple wires.
Related Topics
• Managing Terminal Strips Common Tasks, page 812
• Terminal Strips: An Overview, page 811
The software enables you to make connections by using the drag-and-drop operation
in the Connection window.
• Connect cables and cable sets to terminals in single mode — this option
allows you to connect cables one by one to the appropriate terminals.
• Connect cables and cable sets to terminals in batch mode — this option
allows you to simultaneously connect cables to the appropriate terminals
and define their connections.
Notes
• You can keep more than one Connection window open at the same time.
This can be useful when viewing the wiring routing.
• Dragging a cable, cable set, or wire to a terminal not currently visible in
the Connection window makes the screen scroll up or down until the
required terminal is displayed.
• If the width of your computer monitor allows it, you can follow the course
of a cable from one terminal strip to the other (provided that the cable is
connected between two terminal strips). You can view the cable
continuation between two terminal strips by resizing the Connection
window and clicking (or clicking Actions > Adjacent on the
Connection window menu bar) to simultaneously display both terminal
strips.
• When connecting the right side of a DCS or PLC panel, the software
increases the signal level by one.
Related Topics
• Making Connections Common Tasks, page 825
Related Topics
• Making Connections in SmartPlant Instrumentation: An Overview, page
824
Tip
• The Wire field displays a specific wire in the cable set. The displayed
W00x values represent the wire names and are used to illustrate the
current connection type configuration. This field is not editable.
9. To configure a jumper connection, do the following in the Jumpers group box:
a. From the Type list, select a jumper type from this list. The values in this list
are determined in the Wire Type supporting table.
b. From the Color list, select the required jumper color.
c. Click in the End 1 and End 2 fields to connect to a jumper. A screw head
shows up indicating that a connection has been configured.
d. Click in the Skip text field and type the number of terminals to skip for the
jumper in the cable set for landing. You can accept the displayed value if
appropriate. Repeat the same procedure for the other end.
e. In the Side fields, click the A – Active or O – Opposite option button to
select the terminal side where the jumper will be connected. The side that is
currently active depends on which side you start to connect.
Tips
• The options in the Jumpers group box become available only if you
have selected jumpers to be configured on the New Connection Type
dialog box.
• The terminals to which the ends of a jumper are connected must reside
on the same strip. Both ends of a jumper must be connected for it to
appear in the display region. For an illustration, see Connection Type
Examples, page 828.
10. Click Save.
Related Topics
• Making Connections Common Tasks, page 825
• Making Connections in SmartPlant Instrumentation: An Overview, page
824
The following connection type example illustrates how the connections are made for
a 2-wire cable set when the skip between cable sets is 6:
The position of the + wire in each cable set to be connected has been assigned a skip
of 0. The – wire of Set 1 has been assigned a skip of 1. The – wires of Sets 2 and 3
have each been assigned a skip of 6.
The following example illustrates how you can connect a single pair to a strip and
create a jumper on the opposite side between the first and third terminals. The next
pair will be connected to the third terminal, if the skip between sets parameter was set
to 2.
The outcome of this operation, when terminating multiple pairs, will be pairs
connected sequentially where every first wire in a set is connected by a jumper to the
one that follows, as illustrated below:
Related Topics
• Define a Connection Type, page 827
• Making Connections Common Tasks, page 825
c. In the Cable set connection details data window, select the cable sets that
you want to connect, or choose Select all cable sets.
d. From the Connection Type list, select the connection type for each cable set
that you are going to connect.
e. Select L (left) or R (right) for the physical side of the terminal where the cable
set enters. Note that screw head indicates that the cable set is already
connected on the selected cable end.
f. Click Connect to connect the selected cable sets and return to the Connection
window.
Notes
• SmartPlant Instrumentation connects the individual wires automatically in
accordance with the selected connection type.
• You can double-click a cable, cable set, wire, terminal, or terminal strip
header in the Connection window to edit it.
Related Topics
• Creating and Managing Cables Common Tasks, page 737
• Creating and Managing Cables: An Overview, page 736
• Making Connections Common Tasks, page 825
• Making Connections in SmartPlant Instrumentation: An Overview, page
824
12. To connect the devices cables to the terminal strip according to your settings, do
one of the following:
• Click Actions > Connect.
• On the lower toolbar, click .
Related Topics
• Creating and Managing Cables Common Tasks, page 737
• Creating and Managing Cables: An Overview, page 736
• Making Connections Common Tasks, page 825
• Making Connections in SmartPlant Instrumentation: An Overview, page
824
Notes
• If a terminal strip or terminal is connected to more than one cable, only
wires which are unique to a terminal or which belong to a cable at the top
level layer (at the front) will be disconnected by SmartPlant
Instrumentation.
• SmartPlant Instrumentation uses to represent terminals on which
multiple wires are connected.
• To ensure disconnection of the correct cables or cable sets, first move the
cable you want to disconnect to front by selecting it from the Cable name
list.
Related Topics
• Creating and Managing Cables Common Tasks, page 737
• Making Connections Common Tasks, page 825
• Making Connections in SmartPlant Instrumentation: An Overview, page
824
c. If you need to define a constant gap between the jumpered terminals, enter a
value in the Interval between jumpers box.
d. From the Last terminal list, select the last terminal in the pattern that you
want to jumper.
e. Select the Jumper the last terminal check box if you want to jumper the last
remaining terminal in the terminal pattern.
f. Select a jumper color.
g. In the Jumper name box, type the name of the new jumper, or accept the
default setting. By default, SmartPlant Instrumentation suggests a name for a
new jumper of the format J<first terminal name>/<second terminal name>.
You can change the preferences so as not to display a suggested jumper name.
For details, see Set Preferences for Automatic Naming of Jumpers, page 836.
7. Click OK.
Note
• Your new jumpers appears in the Connection window.
Related Topics
• Making Connections Common Tasks, page 825
• Making Connections in SmartPlant Instrumentation: An Overview, page
824
• Signal Propagation: An Overview, page 887
Related Topics
• Add Jumpers to the Existing Wiring, page 835
• Making Connections Common Tasks, page 825
• Making Connections in SmartPlant Instrumentation: An Overview, page
824
When you click Wire Group, Group Level, or Wire Sequence data, you can reassign
the wire designation by selecting the required value from the appropriate lists.
You can assign a new signal name to more than one terminal without having to
browse through the Wire Group list for each terminal. You use this feature only
with terminals whose Wire Group is currently undefined (that is, the Wire Group
data field displays asterisks).
First, you need to assign a new signal name to a terminal whose Wire Group is
currently undefined. After assigning the new signal to the current terminal, select
another terminal (click the up or down arrow or select a terminal in the Terminal
name list). If you now click in the Wire Group data field, the list opens with the
new signal name selected by default. Clicking the terminal name enables you to
navigate quickly.
Note
• If you want to reassign wire designations on the Terminal Connection
dialog box, it is advisable to plan your changes in advance on paper, to
avoid conflicting Wire Group, Group Level, and Group Sequence data.
• Creating and Managing Cables Common Tasks, page 737
• Making Connections Common Tasks, page 825
• Making Connections in SmartPlant Instrumentation: An Overview, page
824
The Connection window is automatically refreshed only when you open it.
However, SmartPlant Instrumentation does not refresh the data in the Connection
window, if you have several instances of the Connection window open and you
switch from one Connection window to another.
Related Topics
• Making Connections Common Tasks, page 825
• Making Connections in SmartPlant Instrumentation: An Overview, page
824
Example 1:
In this example, you selected the left side connections of JB-2. Therefore, SmartPlant
Instrumentation will display the connection of the device panel.
Example 2:
In this example, you selected the right side connections of JB-2. Therefore, the
software will display the connection of the DCS or the I/O card.
Related Topics
• Creating and Managing Cables Common Tasks, page 737
• Making Connections Common Tasks, page 825
• Making Connections in SmartPlant Instrumentation: An Overview, page
824
Related Topics
• Making Connections Common Tasks, page 825
• Making Connections in SmartPlant Instrumentation: An Overview, page
824
Related Topics
• Generating Wiring Reports Common Tasks, page 927
• List of Wiring Reports, page 928
• Making Connections Common Tasks, page 825
• Making Connections in SmartPlant Instrumentation: An Overview, page
824
Note that after you effect an I/O assignment and your preference was set to the Same
I/O type for tag and I/O card, you can still change the I/O type of the I/O card if
you need to do so. The software does not verify the compatibility of a changed I/O
type with instrument tags already associated with I/O cards.
For more information, see Set I/O Assignment Instrument Tag Preferences, page 847.
• Select an instrument tag coupled with a control system tag and assign both
of them to a free channel.
• Couple an instrument tag with an existing control system tag and then
assign them to a free channel.
• Assign an uncoupled control system tag to a free channel.
• Assign an uncoupled instrument tag to a free channel. You will have to
create a new control system tag in the process and the coupling will be
done automatically.
• Assign an uncoupled instrument tag to a channel to which a control system
tag has already been assigned.
For more information, see Assign an Instrument to a Channel, page 850.
Create a Channel
This option allows you to create additional channels to the ones that the software
created in a particular I/O card or terminal strip. For more information, see Create a
Channel, page 852.
Related Topics
• I/O Assignment: An Overview, page 844
• All I/O types — allows the selection of all instrument tag I/O types
in the I/O Assignment window and upon connection.
4. Click OK.
Related Topics
• Effecting I/O Assignment Common Tasks, page 845
• I/O Assignment: An Overview, page 844
• Click to open the Find Channel dialog box, where you find and
select channels to display in the I/O Assignment window.
• In the I/O card details pane, click beside the I/O termination list to
open the Domain Explorer where you select the required I/O cards,
then click OK to add them to the I/O card list.
6. From the I/O termination list, select an item for which you want to effect I/O
assignment.
Tip
• The I/O type of the selected I/O card or I/O termination determines the
I/O type of the initial instrument tag displayed in the I/O type list.
You can select a different I/O type from this list if required. The list of
instruments displayed in the Tag list data grid depends on the I/O type
that you select from the I/O type list. If the I/O type selection is
MIXED, instruments of all I/O types are shown. If any another I/O
type is selected, only the instruments of the selected I/O type are
shown.
7. If required, select a different I/O type, which enables you to use an instrument tag
for the I/O assignment whose I/O type is different from the I/O card I/O type. To
do this, do one of the following:
• If the I/O type selection is MIXED, select the required I/O type from
the I/O type list.
• If the I/O type selection is not MIXED, change the definitions to
make the I/O type list available at all times by selecting the All I/O
types preference on the Preferences (Wiring - I/O Assignment)
dialog box. For details, see Set I/O Assignment Instrument Tag
Preferences, page 847.
8. Drag an instrument or a control system tag to a free channel in the Channel
assignment pane to effect I/O assignment.
Note
• Several assignment options are possible. For details, see the Assign an
Instrument to a Channel section in Effecting I/O Assignment Common
Tasks, page 845.
Related Topics
• Effecting I/O Assignment Common Tasks, page 845
• I/O Assignment: An Overview, page 844
Tips
• You can also open the Segment I/O Assignment window from the
Connection window. On the Connection menu, click I/O
Assignment.
4. On the I/O Assignment Type dialog box, select I/O Assignment.
Tip
• For fieldbus I/O assignment, select Segment I/O assignment. For
details, see Configure a Fieldbus Apparatus, page 982.
5. If the I/O Assignment Type dialog box opens, select Segment I/O Assignment
I/O assignment.
6. From the I/O termination list, select an item for which you want to effect I/O
assignment.
7. From the Segment coupling list, select a required segment type. This selection
determines which items are displayed under Segments.
8. Drag a segment to a free channel in the Channel assignment pane to effect I/O
assignment.
Note
• Several assignment options are possible. For details, see the Assign an
Instrument to a Channel section in Effecting I/O Assignment Common
Tasks, page 845.
Related Topics
• Effecting I/O Assignment Common Tasks, page 845
• I/O Assignment: An Overview, page 844
Note
• You can shift the assignment of an instrument to another unassigned
channel by simply pressing and holding the Ctrl key while dragging the
instrument to another unassigned channel. You cannot change the
assignment this way if the target channel has already been assigned to
another instrument. Note that when changing the assignment, the software
retains the existing control system data.
Related Topics
• Fieldbus Bricks: An Overview, page 979
• Managing Fieldbus Brick Assemblies and Apparatuses Common Tasks,
page 980
• Profibus Design Common Tasks, page 1004
Create a Channel
1. In the Domain Explorer, select an I/O card, I/O termination, or a terminal strip
with channels.
2. Right-click the item to which you want to add a channel and then on the shortcut
menu, click New > Channel.
3. On the Channel Properties dialog box, on the General tab, type a channel name,
description and sequence as you require.
4. If you are adding a channel on a terminal strip under an I/O card or I/O
termination, click the I/O Properties tab.
5. On the I/O Properties tab, select the channel type, I/O type, and signal type.
6. Type a value in the Address field as you require.
7. Type a minimum and maximum range and select a unit of measure for the range
values.
8. Select the Enable for use with external DCS interfaces (DeltaV) check box to
make these channel property values available for use with a DCS interface such as
DeltaV.
9. Click the Associate Symbols tab to associate a symbol (.sym) file with the new
channel. For details, see Associate a Symbol with an Item, page 734.
10. Click OK.
Related Topics
• Effecting I/O Assignment Common Tasks, page 845
• I/O Assignment: An Overview, page 844
Related Topics
• Effecting I/O Assignment Common Tasks, page 845
• I/O Assignment: An Overview, page 844
Related Topics
• Effecting I/O Assignment Common Tasks, page 845
• I/O Assignment: An Overview, page 844
• Click .
• Click Actions > Delete Control System Tag.
3. Click Yes to confirm the deletion.
Related Topics
• Effecting I/O Assignment Common Tasks, page 845
• I/O Assignment: An Overview, page 844
• Click .
• Click Actions > Filter.
Related Topics
• Effecting I/O Assignment Common Tasks, page 845
• I/O Assignment: An Overview, page 844
• Click .
• Click .
• Click Reports > Tag assignment Report.
4. Click Yes to open the print preview of the report or click No to send the report to
your default printer.
Related Topics
• Effecting I/O Assignment Common Tasks, page 845
• Generating Wiring Reports Common Tasks, page 927
• I/O Assignment: An Overview, page 844
• List of Wiring Reports, page 928
Diagram key:
B — Field device and Control System channel assigned without cables connected to
the Control System channel.
C — Field device and Control System channel assigned with cables. Wiring routing
is not completed.
Notes
• If you open the I/O Assignment window without selecting anything in the
Domain Explorer, the I/O Data dialog box shows the control system tags
of the DCS/PLC cabinet you selected the last time you opened the I/O
Assignment window.
Related Topics
• Effecting I/O Assignment Common Tasks, page 845
• I/O Assignment: An Overview, page 844
Tip
• If you select a channel rather than an I/O card, SmartPlant
Instrumentation displays the card to which the channel belongs in the
I/O Assignment window.
7. In the I/O Assignment window, under I/O card name, select the required card.
the software displays its channels in the Assignment details data window.
Related Topics
• Effecting I/O Assignment Common Tasks, page 845
• I/O Assignment: An Overview, page 844
• Manual Cross Wiring– This is the default cross wiring mode, where you
select the terminals on the strips to be cross-wired.
• Semiautomatic Cross Wiring– SmartPlant Instrumentation
automatically finds potential targets for the signal that it will propagate.
You can accept the suggested terminals and carry out the cross wiring or
select different terminals to be cross-wired.
• Automatic Cross Wiring– SmartPlant Instrumentation automatically
finds matching signals and performs the cross wiring for you.
Related Topics
• Cross Wiring Connections Common Tasks, page 863
• The signals are between two terminal strips belonging to the same panel.
• Both signals are on the same signal level.
• The first signal comes to the first terminal from a device panel (the signal
sequence is less than 50) and the second signal comes from a control
system (the signal sequence is greater than 50.)
You can set the default definitions for matching signals by using the Preferences
dialog box.
For more information, see Perform Automatic Cross Wiring, page 868.
Related Topics
• Cross Wiring: An Overview, page 862
Tip
• This option is not available if the current secondary terminal strip is a
terminal strip with channels (belonging to a DCS or PLC panel). In
this case, you can connect the left side only.
7. From the Cross-wiring cable list, select one of the following to define a cross-
wiring cable:
• Select CROSS WIRE to cross wire the terminals with wires that the
software creates during the cross-wiring process.
• Select the required cross-wiring cable. If the cross wiring cable that
you need is not on this list, click beside the list arrow to open the
Wiring Explorer. Select a cable and click OK to add it to the list.
Note that you can also create a new cross wiring cable if the one you
need does not exist in the Domain Explorer.
8. Select the Prompt for cross operation message check box to be prompted by
SmartPlant Instrumentation to confirm the cross wiring. If you do not select this
check box, cross wiring of the selected terminals proceeds without messages and
SmartPlant Instrumentation propagates all the existing signals.
9. In the Primary Terminal Strip pane, click the required terminal to be cross-
wired.
10. In the Secondary Terminal Strip pane, click the required terminal to be cross-
wired.
11. If you selected the Prompt for cross operation message check box, click Yes to
confirm the cross wiring.
Notes
• For an example and information about the conventions used to represent
various items and connections in the Cross Wiring window, click the
Help icon on the main toolbar and then click the required link at the
bottom of the help page.
• In the Primary Terminal Strip pane, select the required cross-wired
terminal, and then click to open the Point-to-Point Wiring Diagram.
• Click to open the Terminal Connection window. You can also
double click to get the same result.
• Click to remove the cross wiring between two terminals after selecting
the cross-wired terminals (shown connected by a solid black line).
• Click to generate a report that shows all the wiring connections of the
primary strip on both sides.
Related Topics
• Cross Wiring Connections Common Tasks, page 863
• Cross Wiring: An Overview, page 862
7. Select the Prompt for cross operation message check box to be prompted by
SmartPlant Instrumentation to confirm the cross wiring. If you do not select this
check box, cross wiring of the selected terminals proceeds without messages and
SmartPlant Instrumentation propagates all the existing signals.
8. In the Primary Terminal Strip pane, click the required terminal to be cross-
wired.
9. Do one of the following to find a matching target signal for potential cross wiring:
• Click View > Target Signal.
• Click .
SmartPlant Instrumentation searches for a matching signal in the
current <plant> and adds the terminals that it finds in the Secondary
Terminal Strip pane. SmartPlant Instrumentation indicates each of
the potential terminals by placing an arrow beside it in the
Secondary Terminal Strip pane.
10. Select the required terminal in the Secondary Terminal Strip pane to cross wire
with the selected terminal in the primary terminal strip.
Notes
• For an example and information about the conventions used to represent
various items and connections in the Cross Wiring window, click the
Help icon on the main toolbar and then click the required link at the
bottom of the help page.
• In the Primary Terminal Strip pane, select the required cross-wired
terminal, and then click to open the Point-to-Point Wiring Diagram.
• Click to open the Terminal Connection window. You can also
double click to get the same result.
• Click to remove the cross wiring between two terminals after selecting
the cross-wired terminals (shown connected by a solid black line).
• Click to generate a report that shows all the wiring connections of the
primary strip on both sides.
Related Topics
• Cross Wiring Connections Common Tasks, page 863
• Cross Wiring: An Overview, page 862
Related Topics
• Cross Wiring Connections Common Tasks, page 863
• Cross Wiring: An Overview, page 862
Tip
• To add terminal strips that do not appear on the list, click beside the
Primary terminal strip list arrow, select the required terminal strips
in the Domain Explorer, then click OK to add them to the Primary
terminal strip list.
4. Under Primary auto cross-wiring side, click Left or Right to select the
appropriate side of the primary terminal strip that you want to connect.
5. From the Secondary terminal strip list, select the required terminal strip that you
want to cross wire.
Tip
• To cross wire two terminal strips belonging to different panels where
you did not select one of the panels in Domain Explorer, click
beside the Secondary terminal strip list arrow, select the required
terminal strip in the Domain Explorer and click OK to add it to the
Secondary terminal strip list. Then, select that terminal strip from
the Secondary terminal strip list for cross wiring.
6. Under Secondary connection side, click Left or Right to select the appropriate
side of the secondary terminal strip that you want to connect.
Tip
• This option is not available if the current secondary terminal strip is a
terminal strip with channels (belonging to a DCS or PLC panel). In
this case, you can connect the left side only.
7. From the Cross-wiring cable list, select one of the following to define a cross-
wiring cable:
• Select CROSS WIRE to cross wire the terminals with wires that the
software creates during the cross-wiring process.
• Select the required cross-wiring cable. If the cross wiring cable that
you need is not on this list, click beside the list arrow to open the
Domain Explorer. Select a cable and click OK to add it to the list.
Note that you can also create a new cross wiring cable if the one you
need does not exist in the Domain Explorer.
8. Select the Prompt for cross operation message check box to be prompted by
SmartPlant Instrumentation to confirm the cross wiring. If you do not select this
check box, cross wiring of the selected terminals proceeds without messages and
SmartPlant Instrumentation propagates all the existing signals.
9. Do one of the following to find matching signals:
• Click Actions > Auto
• Click .
SmartPlant Instrumentation finds and selects the matching signals and
the terminals that it can cross-wire automatically. The Secondary
Terminal Strip pane does not appear in the Cross Wiring window.
10. Do one of the following:
5. Select the new cable in the Cross-wiring cable list to be used in the cross wiring
operation.
Related Topics
• Cross Wiring Connections Common Tasks, page 863
• Cross Wiring: An Overview, page 862
Related Topics
• Cross Wiring Connections Common Tasks, page 863
• Cross Wiring: An Overview, page 862
• Generating Wiring Reports Common Tasks, page 927
• List of Wiring Reports, page 928
Auto-Wiring: An Overview
Auto-wiring allows you to make automatic batch connections between specified
terminal strips. This feature facilitates faster and more efficient wiring design
especially when working on a grass-root project where the required wiring items
already exist and you need to connect them. The essence of this feature is that you
create an auto-wiring routing task where you define a cable that will connect two
designated panels.
You can define an auto-wiring task for two different kinds of connection:
• The required instrument tags and their device panels already exist and they
are connected to their junction boxes.
• There are instrument tags with pre-assigned I/O points – essential for
cross-wiring tasks.
• There are defined reference wiring profiles for the required instrument
types.
Notes
• For details about various auto-wiring tasks, see Defining and Executing
Auto-Wiring Tasks: An Overview, page 873.
• You cannot create an auto-wiring task for panels that are defined as
Fieldbus or Telecom panels.
Related Topics
• Auto-Wiring Connections Common Tasks, page 876
• Defining and Executing Auto-Wiring Tasks: An Overview, page 873
Related Topics
• Auto-Wiring Connections Common Tasks, page 876
Related Topics
• Auto-Wiring Connections Common Tasks, page 876
• Auto-Wiring: An Overview, page 872
Related Topics
• Auto-Wiring: An Overview, page 872
• Flow of Activities for Auto-Wiring, page 875
4. On the Auto-Wiring Routing Task dialog box, define the End 1 connection as
follows:
a. Click next to the Panel field to select the required panel.
b. In the Domain Explorer, select a panel that contains at least one terminal
strip with unconnected terminals and then click OK.
c. Select a terminal strip from the Strip list.
d. Select a terminal that will serve as the first terminal.
e. Select a terminal side.
f. Select a connection type.
g. If required, select an appropriate overall shield terminal connection.
5. In the End 2 connection group box, do the following:
a. Click next to the Panel field to select the required panel.
b. In the Domain Explorer, select a panel that contains at least one terminal
strip with unconnected terminals and then click OK.
c. Select a terminal strip from the Strip list.
d. Select a terminal that will serve as the first terminal.
e. Select a terminal side.
f. Select a connection type.
g. If required, select an appropriate overall shield terminal connection.
6. Use the options in the Cable group box to define the cable that SmartPlant
Instrumentation will use to connect the two panels:
a. From the Reference cable list, select the appropriate reference cable that
SmartPlant Instrumentation will use as the source for the creation of a cable
that will connect the two panels. The software duplicates the new cable in the
Domain Explorer.
b. In the Cable name data field, accept or type the name of the cable that
SmartPlant Instrumentation will create to connect the two panels. The cable
names suggested by the software are composed of the End 1 and End 2 panel
names. Additional cables have their names incremented by one, for example
XYZ.1, XYZ.2, and so forth.
7. Click OK to complete the task definition and return to the Auto-Wiring Browser
View - New Auto-Wiring Routing Task window.
8. In the Browser View - New Auto-Wiring Routing Task window, click .
Notes
• After notifying you that the task has been executed successfully, the task
status changes to Done. For details, see Auto-Wiring Task Statuses, page
885.
• You can open the Connection window for the selected junction box to
display the adjacent connection to make sure that the auto-wiring task has
been executed correctly.
Related Topics
• Auto-Wiring Connections Common Tasks, page 876
• Auto-Wiring: An Overview, page 872
• Flow of Activities for Auto-Wiring, page 875
Tip
• Selecting the Control system check box disables all the options in the
End 2 connection group box (except for Connection type) so that
SmartPlant Instrumentation can search for an available DCS or PLC
panel with a matching signal.
6. From the Connection type list, select the required End 2 connection type.
7. In the Cross wiring group box, select an appropriate cross wiring option to
connect the control system to the junction box:
• Single cross wires– connects the control system using a single wire
created by SmartPlant Instrumentation automatically during the auto-
wiring process.
• Cables created from reference – connects the control system using
a cable that SmartPlant Instrumentation creates by duplicating the
reference cable that you select from the Reference cable list in the
Cable group box. The software checks whether such a cable exists in
the Domain Explorer and if so, whether this cable is connected to the
panel selected in the End 1 connection group box. If this cable has
unconnected cable sets, the software connects them and then creates
additional cables so that all the terminals are connected. Note that in
this case, the software connects all the cable sets whether they are
required or not. Therefore, for this option to work properly, you must
create appropriate reference cables and connection types before
starting auto-wiring.
• One cable per tag – connects the control system using a separate
cable for each tag number. The software creates each cable by
duplicating the reference cable that you select from the Reference
cable list in the Cable group box. SmartPlant Instrumentation creates
the required number of cables according to the number of tag signals it
detects. The software names each cable according to the signal name.
You can add a prefix and a suffix to the cable name by typing the
required string in the Cable name prefix and Cable name suffix
fields.
8. Use the options in the Cable group box to define the cable for connecting the pre-
assigned junction box to the control system (not available if you selected the
Single cross wires option):
a. From the Reference cable list, select an appropriate reference cable that
SmartPlant Instrumentation uses as a source for the creation of a cable that
will connect the two panels. The software duplicates the new cable in the
Domain Explorer.
b. In the Cable name data field, the software suggests a cable name composed
of the End 1 and End 2 panel names. Accept this name or type a name of your
choice for the cable that SmartPlant Instrumentation will create to connect the
two panels. Any additional cables that the software creates have identical
names with a numeric suffix that is incremented by one for each new cable;
for example XYZ.1, XYZ.2, and so forth.
9. Click OK to complete the task definition and return to the Browser View - New
Auto-Wiring Routing Task window.
10. Click .
Notes
• After notifying you that the task has been executed successfully, the task
status changes to Done. For details, see Auto-Wiring Task Statuses, page
885.
• You can open the Connection window for the selected junction box to
display the adjacent connection to make sure that the auto-wiring task has
been executed correctly.
Related Topics
• Auto-Wiring Connections Common Tasks, page 876
• Auto-Wiring: An Overview, page 872
• Flow of Activities for Auto-Wiring, page 875
• Click .
Tip
• The Auto-Wiring Routing Task dialog box opens where all the End
1 connection properties except for the Connection type and Overall
shield terminal connection have been defined. You can accept the
displayed values or modify them as needed.
4. On the Auto-Wiring Routing Task dialog box, complete the End 1 connection
definition as follows:
a. Select the required connection type from Connection type list.
b. If required, select the appropriate overall shield terminal connection.
5. In the End 2 connection group box, select the Control system check box.
Tip
• Selecting the Control system check box disables all the options in the
End 2 connection group box (except for Connection type) so that
SmartPlant Instrumentation can search for an available DCS or PLC
panel with a matching signal.
6. From the Connection type list, select the required End 2 connection type.
7. In the Cross wiring group box, select an appropriate cross wiring option to
connect the control system to the junction box:
• Single cross wires– connects the control system using a single wire
created by SmartPlant Instrumentation automatically during the auto-
wiring process.
• Cables created from reference – connects the control system using
a cable that SmartPlant Instrumentation creates by duplicating the
reference cable that you select from the Reference cable list in the
Cable group box. The software checks whether such a cable exists in
the Domain Explorer and if so, whether this cable is connected to the
panel selected in the End 1 connection group box. If this cable has
unconnected cable sets, the software connects them and then creates
additional cables so that all the terminals are connected. Note that in
this case, the software connects all the cable sets whether they are
required or not. Therefore, for this option to work properly, you must
create appropriate reference cables and connection types before
starting auto-wiring.
• One cable per tag – connects the control system using a separate
cable for each tag number. The software creates each cable by
duplicating the reference cable that you select from the Reference
cable list in the Cable group box. SmartPlant Instrumentation creates
the required number of cables according to the number of tag signals it
detects. The software names each cable according to the signal name.
You can add a prefix and a suffix to the cable name by typing the
required string in the Cable name prefix and Cable name suffix
fields.
8. Use the options in the Cable group box to define the cable for connecting the pre-
assigned junction box to the control system (not available if you selected the
Single cross wires option):
a. From the Reference cable list, select an appropriate reference cable that
SmartPlant Instrumentation uses as a source for the creation of a cable that
will connect the two panels. The software duplicates the new cable in the
Domain Explorer.
b. In the Cable name data field, the software suggests a cable name composed
of the End 1 and End 2 panel names. Accept this name or type a name of your
choice for the cable that SmartPlant Instrumentation will create to connect the
two panels. Any additional cables that the software creates have identical
names with a numeric suffix that is incremented by one for each new cable;
for example XYZ.1, XYZ.2, and so forth.
9. Click OK to complete the task definition and return to the Browser View - New
Auto-Wiring Routing Task window.
10. Click .
Notes
• After notifying you that the task has been executed successfully, the task
status changes to Done. For details, see Auto-Wiring Task Statuses, page
885.
• You can open the Connection window for the selected junction box to
display the adjacent connection to make sure that the auto-wiring task has
been executed correctly.
Related Topics
• Auto-Wiring Connections Common Tasks, page 876
• Auto-Wiring: An Overview, page 872
• Flow of Activities for Auto-Wiring, page 875
The following table defines the various task statuses and explains which statuses you
can change.
Related Topics
• Auto-Wiring Connections Common Tasks, page 876
• Auto-Wiring: An Overview, page 872
• Flow of Activities for Auto-Wiring, page 875
Related Topics
• Auto-Wiring Connections Common Tasks, page 876
• Auto-Wiring: An Overview, page 872
• Flow of Activities for Auto-Wiring, page 875
However, there may be situations in which tag signal propagation does not occur
automatically. In this case, SmartPlant Instrumentation offers you two options for
semiautomatic propagation of a selected tag signal. You can re-propagate a tag signal
or force tag signal propagation. For details, see Tag Signal Propagation Common
Tasks, page 890.
Also, you can effect signal propagation at terminal strip level by manually entering or
changing a signal or its level at any point along the wiring path.
Tips
• Unlike wires, jumpers do not propagate signals. You can assign a wire
group to a jumper manually on the Terminal Connection dialog box.
• Tag signal propagation for a shield takes place automatically without the
need to connect that shield to a device panel terminal.
• Tag signal propagation stops if it reaches a point where multiple optional
paths exist.
• You can re-propagate or force propagation of tag signals if this is required.
• You can intervene at any point of the wire path and change tag number
propagation manually.
You can generate a point-to-point wiring diagram and view the signal path after you
finish assigning an instrument tag to a channel in an I/O card. For information about
point-to-point diagrams, see Trace a Signal in a Point-to-Point Wiring Diagram, page
841.
Related Topics
• Possible Cases of Signal Propagation, page 888
• Tag Signal Propagation Common Tasks, page 890
• Trace a Signal in a Point-to-Point Wiring Diagram, page 841
Case 1
In this example, the signal sequence is from the device panel up to the PLC cabinet
with all the wiring:
Case 2
In this case the connection sequence starts from the device panel and continues to the
PLC cabinet, however, there is a discontinuity between Strip 1 and Strip 2 of the
marshaling rack:
Note that the wiring sequence can be different depending on the completeness of the
connection:
• From 1 to 8 (as in the first case) — connected from the device panel to
the PLC.
• From 1 to 4 and from 99 to 100 (as in the second case) — there is a break
in the middle of the connection.
Case 3
The signal sequence is from the device panel to the PLC cabinet however, there is a
discontinuity between the marshaling rack and the PLC cabinet.
Case 4
The connection sequence starts from the PLC cabinet and continues to the junction
box. The device panel is absent.
Related Topics
• Signal Propagation: An Overview, page 887
• Tag Signal Propagation Common Tasks, page 890
• You can create a local tag signal by assigning a local signal to a wiring tag
that does not yet have a signal of its own.
• You can create a general signal and link it to the signals that are wired
into the terminal strip.
For more information, see Create a Local Tag Signal, page 894.
• Combine signals into a wire group for transmitting multiple signals that
are multiplexed or de-multiplexed through it.
• Represent the common connection for single or multiple loop power
supply.
For more information, see Create a General Signal, page 896.
Related Topics
• Possible Cases of Signal Propagation, page 888
• Signal Propagation: An Overview, page 887
Related Topics
• Possible Cases of Signal Propagation, page 888
• Signal Propagation: An Overview, page 887
• Tag Signal Propagation Common Tasks, page 890
6. To save the filter condition settings so that the next time you open the Signal
dialog box SmartPlant Instrumentation filters the data accordingly, select Save
filter.
Tip
• Click Restore to revert to the filter condition that you saved the last
time.
7. Click Verify to check the correctness of your filter.
8. Click OK.
Related Topics
• Possible Cases of Signal Propagation, page 888
• Signal Propagation: An Overview, page 887
• Tag Signal Propagation Common Tasks, page 890
7. Do the following for each terminal in the wire group that you are associating with
the general signal:
a. Under Signal, select the general signal that you want to propagate.
b. Select a sequence and a signal level.
8. To navigate to other terminals for which you need to change propagation settings,
do one of the following:
• Click Next or Previous.
• Under Terminal number, select the terminal that you want to edit.
9. Click Save.
Related Topics
• Possible Cases of Signal Propagation, page 888
• Signal Propagation: An Overview, page 887
• Tag Signal Propagation Common Tasks, page 890
• Resistance
• Capacitance
• Inductance
The calculations are made at the domain level. For more information, see Calculate
Intrinsic Safety, page 901.
10. Under Hazardous area loop components, enter the relevant data for the
hazardous devices, such as transmitters, I/P converters, and so forth. You must
define the R2, C2, and L2 values.
11. On the Intrinsically Safe Data Input dialog box, under Non-hazardous area
loop components, enter the relevant data for the non-hazardous devices, such as
barrier, isolator, and so forth. You must define the
12. Click OK to close the Intrinsically Safe Data Input dialog box.
13. Click OK to finish.
Tip
• The Intrinsically Safe Calculation Results dialog box opens where
you can view the calculation results, change the units of measure, and
save the results with the different units.
• The maximum permissible length must be less than the actual length
of the cable used (Cable “A” - connecting the hazardous and non-
hazardous areas).
9. Click OK to return to the Intrinsically Safe Data Input dialog box.
10. If needed, you can do any of the following:
• View and enter revisions.
• Enter intrinsic safety notes.
• Click Print to generate and print a report that shows all the data that
you entered and the calculation results.
Related Topics
• Intrinsic Safety Calculations Common Tasks, page 899
Related Topics
• Intrinsic Safety Calculations Common Tasks, page 899
Related Topics
• Intrinsic Safety Calculations Common Tasks, page 899
Tips
• In the data window, if you select a tag for which you did not define an
intrinsically safe circuit type, nothing is displayed in the lower group
box.
• If you select a tag number for which you defined an intrinsically safe
circuit type, SmartPlant Instrumentation displays non-hazardous area
and hazardous area loop components below the data window.
4. On the Intrinsically Safe Loop Data dialog box, click Calculate.
5. In the Intrinsically Safe Calculation Results dialog box, select each tag number
for which you want to display intrinsic safety data.
6. To preview reports for all of the tags in the current loop, click Print.
Related Topics
• Intrinsic Safety Calculations Common Tasks, page 899
Related Topics
• Cable Routing Common Tasks, page 907
• Cable Routing Flow of Activities, page 906
For more information, see Set Cable Routing Options, page 909.
That is, you define the number of cables for a standard position and only then the
position becomes available to include in a trunk. For more information, see Set the
Maximum Number of Cables for the Standard Positions, page 911.
• A source cable is a trunk cable for which you have already defined cable
routing options, created the routing sections, and associated cables with
these sections.
• A destination cable is a trunk cable to which you want to add the routing
data of the source cable.
For more information, see Append Routing Data to a Cable, page 915.
Related Topics
• Cable Routing Flow of Activities, page 906
• Cable Routing: An Overview, page 905
Related Topics
• Cable Routing Common Tasks, page 907
• Cable Routing Flow of Activities, page 906
• Cable Routing: An Overview, page 905
Related Topics
• Cable Routing Common Tasks, page 907
• Cable Routing Flow of Activities, page 906
• Cable Routing: An Overview, page 905
Related Topics
• Cable Routing Common Tasks, page 907
• Cable Routing Flow of Activities, page 906
• Cable Routing: An Overview, page 905
Related Topics
• Cable Routing Common Tasks, page 907
• Cable Routing Flow of Activities, page 906
• Cable Routing: An Overview, page 905
• For routing category Trunk, to select a width for each position from
the Position and widths grid (unless the cable assigned to this section
is on a locked drum).
5. Click OK to save your changes and close the Routing Section Properties dialog
box.
Related Topics
• Cable Routing Common Tasks, page 907
• Cable Routing Flow of Activities, page 906
• Cable Routing: An Overview, page 905
• Click
• Drag the sections to the Assigned sections pane.
4. From the Routing Position list of the required section, select the position that will
hold the cable.
Tip
• Change the order of the assigned sections by highlighting an assigned
section and clicking Move Up or Move Down.
5. Type the panel-routing distance, or accept the default.
6. Repeat steps 2 through 5 for each cable in the Cable list.
Related Topics
• Cable Routing Common Tasks, page 907
• Cable Routing Flow of Activities, page 906
• Cable Routing: An Overview, page 905
• Click
• Drag the sections to the Assigned sections pane.
4. To remove sections from the selected cable, under Assigned sections, highlight
the sections that you want to remove, and do one of the following:
• Click
• Drag the sections from the Assigned sections pane to the Assigned
sections pane.
5. Change the position of a section, as necessary, from the Routing Position list.
6. Change the order of assigned sections, as necessary, by highlighting a section and
clicking Move Up or Move Down.
7. Edit the panel-routing distance, as necessary, by changing the value in the Panel-
routing distance box.
8. Repeating steps 3 through 7 for each cable in the Cable Name list.
Related Topics
• Cable Routing Common Tasks, page 907
• Cable Routing Flow of Activities, page 906
• Cable Routing: An Overview, page 905
Tip
• A source cable is a trunk cable for which you have already defined
cable routing options, created the routing sections, and associated
cables with these sections. SmartPlant Instrumentation displays the
routing data for the source cable you select in the Source routing data
grid.
4. In Domain Explorer, highlight target cables, and drag them to the Destination
cables group box.
5. Select the cables to which you want to copy the routing data of the source cable in
one of the following ways:
• Select the check box to the left of each cable.
• Choose Select all cables without routing. Use this option to avoid
overwriting existing routing data.
• Choose Select all to enable overwriting of existing routing data on the
destination cables.
6. Click Copy.
Note
• To copy routing data to additional cables, repeat steps 3 through 6.
Related Topics
• Cable Routing Common Tasks, page 907
• Cable Routing Flow of Activities, page 906
• Cable Routing: An Overview, page 905
5. Select the cables to which you want to append the routing data of the source cable
in one of the following ways:
• Select the check box to the left of each cable.
• Choose Select all cables without routing. Use this option to avoid
overwriting existing routing data.
• Choose Select all to enable overwriting of existing routing data on the
destination cables.
6. Click Append.
Notes
• To append routing data to additional cables, repeat steps 3 through 6.
• SmartPlant Instrumentation appends the new sections after the original
sections of the destination cable, if there were any. You can change the
order of these sections by opening the destination cable in the Cable
Routing dialog box. For details, see Edit a Cable Routing, page 913.
Related Topics
• Cable Routing Common Tasks, page 907
• Cable Routing Flow of Activities, page 906
• Cable Routing: An Overview, page 905
The pulling area that you define here does not have the same functionality as the
<area> in SmartPlant Instrumentation plant hierarchy. The pulling area is
designated for cables and cable drums only.
The steps required to set up a fully functional cable drum assignment are as follows:
1. Define the pulling areas where the cable drums are placed.
2. Associate cables with the predefined pulling areas.
3. Define drum attributes for cable types.
4. Create the cable drums that will eventually be assigned to your cables. This
includes both adding the cable drums that already exist in your <plant> and
adding the cable drums that you need to purchase to complete your required cable
drum inventory. You can also perform this automatically in a cable drum
assignment.
5. Select the cables that you want to assign to the cable drums that you have created
(even if the drums have not been purchased yet).
6. The last stage is to assign cables to cable drums. At this stage the cable drum
feature automatically adds new cable drums as required.
Related Topics
• Cable Drums Common Tasks, page 918
• Design— Cable drums that you intend to purchase in the future and you
want to design to fit your cables.
• Purchased— Existing cable drums that you want to include in a cable-
drum optimization.
• Locked— Existing cable drums that you do not want to include in a
cable-drum optimization.
For more information, see Manage Cable Drums Manually, page 920.
• The highest priority is to utilize cable drums that are purchased but not yet
locked. Optimization may assign new cables to these drums.
• The second priority is to optimize the drum cable length for drums whose
status is design. The guiding parameters are minimum drum length and
maximum. drum length.
• The third priority is to create new cable drums of a given cable type.
For more information, see Assign Cables to Drums Automatically (with
Optimization), page 922.
• A cable type.
• At least one pulling area.
• A cable drum associated with the cable type and with the pulling area.
The manual cable drum assignment is performed without optimization, which means
that the designated cable drum is not necessarily the optimum for the selected cable.
For more information, see Assign Cables to Drums Manually (Without Optimization),
page 922.
Related Topics
• Cable Drums: An Overview, page 917
Related Topics
• Cable Drums Common Tasks, page 918
• Cable Drums: An Overview, page 917
Related Topics
• Cable Drums Common Tasks, page 918
• Cable Drums: An Overview, page 917
2. On the Cable Drums dialog box, select a cable type to filter the data window.
3. Do one of the following:
• Click New to add a new cable drum.
• Select a cable drum row and click in the appropriate fields to edit the
data.
• Select a cable drum row and click Delete.
4. In the data window, type the data in the fields or select the data from the lists
according to the following table:
5.
Column Name Column Description
Name Type the cable drum name.
Description Type the cable drum description if required.
Pulling Area Select the pulling area where the cable drum is located.
Length Type the total cable drum length (utilized + spare).
Utilized Length Displays the utilized cable length of the total drum length.
Length UOM Select the unit of measure used to measure the drum length.
Drum Status Select one of the following:
• Design— cable drum in the design stage (not purchased
yet); available for cable-drum optimizations.
• Purchased— a purchased cable drum of defined length
that you want to include in cable-drum optimizations.
• Locked— a purchased cable drum that is assigned to a
cable and locked against reassignment (cable drum
optimizations).
Spare Length Type the percent of the used cable drum length to allocate to spare
Percent cable length.
6. Click OK to save your changes and close the Cable Drums dialog box.
Note
• SmartPlant Instrumentation creates cable drums automatically when you
assign cables to cable drums and additional cable drums are required.
Related Topics
• Cable Drums Common Tasks, page 918
• Cable Drums: An Overview, page 917
Related Topics
• Cable Drums Common Tasks, page 918
• Cable Drums: An Overview, page 917
Related Topics
• Cable Drums Common Tasks, page 918
• Cable Drums: An Overview, page 917
Related Topics
• Managing Panel Locations Common Tasks, page 924
Note that panel location is defined per domain; therefore, all the panel location
definitions that have been made in the Administration module are available
throughout the entire current domain.
For more information, see Define a New Panel Location, page 924.
Related Topics
• Managing Panel Locations: An Overview, page 923
Related Topics
• Managing Panel Locations Common Tasks, page 924
• Managing Panel Locations: An Overview, page 923
Note
• Also, you can change the location of a panel in the Domain Explorer
without opening the Properties dialog box for a panel. Expand the
Panels by Location folder and select a panel. Drag it to another location,
as you require.
Related Topics
• Managing Panel Locations Common Tasks, page 924
• Managing Panel Locations: An Overview, page 923
Related Topics
• Managing Panel Locations Common Tasks, page 924
• Managing Panel Locations: An Overview, page 923
Related Topics
• Generating Wiring Reports Common Tasks, page 927
• List of Wiring Reports, page 928
Related Topics
• Generating Wiring Reports Common Tasks, page 927
• List of Wiring Reports, page 928
• Making Connections Common Tasks, page 825
• Making Connections in SmartPlant Instrumentation: An Overview, page
824
Related Topics
• Cross Wiring Connections Common Tasks, page 863
• Cross Wiring: An Overview, page 862
• Generating Wiring Reports Common Tasks, page 927
• List of Wiring Reports, page 928
• Click .
• Click Reports > Tag assignment Report.
4. Click Yes to open the print preview of the report or click No to send the report to
your default printer.
Related Topics
• Effecting I/O Assignment Common Tasks, page 845
• Generating Wiring Reports Common Tasks, page 927
• I/O Assignment: An Overview, page 844
• List of Wiring Reports, page 928
4. Under Value, type a string that consists of three digits made up of 0 and 1, for
example, 110.
In the string, the first digit refers to grouping of channels, the second digit refers
to wiring equipment, and the third digit refers to I/O channels. The digit "1"
instructs the software to display the channels and the wiring equipment. Zero
means not to display the channels or the wiring equipment. For example, if you
type 001, the software will display the I/O channels only. If you type 110, the
software will display the grouping of channels and the wiring equipment items but
it will not display the I/O channels. Note that the default setting is 010, which
displays wiring equipment items only.
Related Topics
• Generating Wiring Reports Common Tasks, page 927
• List of Wiring Reports, page 928
• Making Connections Common Tasks, page 825
Cable Block Diagrams are ideal for use in the preliminary planning stages of your
plant to verify the destination panels for cables as no wiring connections or
terminations are needed at this early stage of your project. A CBD is also used for
ordering made to order (MTO) cables at the feed stage of your project, and later after
completion of your project, as part of the maintenance program to show the location
of all major cables, panels, junction boxes, and so forth.
SmartPlant Instrumentation allows you to drag and drop panels from the Domain
Explorer to your drawing and position them exactly where you want. The software
creates a representation of existing cables on the fly, or you can manually connect
cables between item connection points.
Related Topics
• Cable Block Diagram Common Tasks, page 935
Related Topics
• Cable Block Diagrams: An Overview, page 934
4. On the Document Properties (New) dialog box, type a value for the Document
number and Description fields.
5. Click OK.
6. In the Cable Block Diagram folder, right-click your new document, and from the
shortcut menu select Reports > Generate Cable Diagram.
7. At the prompt, click Yes to preview your drawing, a new blank drawing opens in
the Enhanced Report Utility.
8. In the Enhanced Report Utility, open the Domain Explorer by doing one of the
following;
• Press F7
• Click Tools > Domain Explorer
• Click
9. From the Domain Explorer in the Enhanced Report Utility drag the panels you
require, and position them on the drawing.
Tip
• The order that you drag the panels onto the drawing will define the
sorting order that will be used in the generation process of the
connection, for example; if you drag the DCS panel first, then the JB,
and finally the device panel, the software will connect the DCS to the
JB and then the JB to the device panel.
10. Click to allow the software to automatically regenerate your drawing, and
show any cables and there connections between the physically wired items.
11. To make the connections between the items manually, do the following;
a. Select any item on the drawing and do one of the following:
Related Topics
• Cable Block Diagram Common Tasks, page 935
• Cable Block Diagrams: An Overview, page 934
Related Topics
• Cable Block Diagram Common Tasks, page 935
• Cable Block Diagrams: An Overview, page 934
4. At the prompt, click Yes to preview your drawing, the drawing opens in the
Enhanced Report Utility.
Related Topics
• Cable Block Diagram Common Tasks, page 935
• Cable Block Diagrams: An Overview, page 934
• Click .
• Click Edit > Disconnect.
• Right-click, and on the shortcut menu, click Disconnect Items.
4. At the prompt, select the required check box, and click OK.
Notes
• If the cable for disconnection is only connected to one item, no prompt
will appear and the cable is disconnected automatically.
• Disconnecting both sides of the cable results in the loss of any wiring
associated with the connection.
Related Topics
• Cable Block Diagram Common Tasks, page 935
• Cable Block Diagrams: An Overview, page 934
• Click .
• Click Edit > Remove.
• Press the Delete key.
Related Topics
• Cable Block Diagram Common Tasks, page 935
• Cable Block Diagrams: An Overview, page 934
By dragging panels from the Domain Explorer to the Associate Cable with Panels
window you can associate the panel with either side of the cable. You can see which
panels are already associated or connected to the cable and to what side of the cable
the panel is associated. Also you can move a panel from one side of the cable to the
other.
Related Topics
• Associate Cable with a Panel, page 939
• To change a panels cable end association, drag the panel from one
cable end column to the other cable end column.
7. Close the Associate Cable with Panels window, click Yes at the prompt to save
the associations.
Notes
• Cable relationships which were manually associated with panels are not
removed or deleted by the software when physically connected with the
panels.
• The relationship between the physically connected panels and the cable
shown in the Associate Cable with Panels window can not be deleted.
They are removed when the cable is disconnected.
• The Associate Cable with Panels window does not display, or take into
consideration, pre-assigned panels or junction boxes that were assigned
using instrument connection pre-assignment browsers.
Related Topics
• Associate Cable with Panels: An Overview, page 939
The software provides the following features for creating and managing fieldbus
projects:
• Fieldbus device tags, which you create in the Instrument Index module,
include fieldbus properties such as identification references, address,
electrical properties, associated function blocks, and so forth.
• The Fieldbus Tag Numbers browser, where you create and manage
fieldbus instruments and associate them with appropriate segments. Also,
you can generate a validation report for a selected segment.
• Fieldbus connection apparatus and fieldbus bricks, which you create in the
Wiring module. You can quickly and easily create fieldbus junction boxes
and device panels using the Plug-and-Socket Box Wizard.
• As you build segments, the software verifies that you are following basic
connection rules. Later, you can generate reports to verify that you built
the segments according to further connection rules, and according to the
segment-wide parameter profiles that you applied to each segment.
• Segment wiring diagrams and Fieldbus Loop enhanced reports.
Note
• Whenever fieldbus is mentioned in the subsequent topics of the
documentation, we refer to Foundation Fieldbus.
Related Topics
• Flow of Activities for Foundation Fieldbus Design, page 942
• Profibus Design: An Overview, page 1001
• If you exceed cable lengths, or hook too many devices to the same pair of
wires, this can cause attenuation and reduction in the voltage reaching the
instruments. These voltage drops can result in instrument malfunction and
bandwidth problems.
• If you create a spur cable that is too long, the signal propagated along that
spur cable can become attenuated and too weak for the DCS to read.
• If you create a segment whose total capacitance exceeds the maximum,
you may reduce effective bandwidth.
For more information, see Define Segment-Wide Parameters, page 947.
For more information, see Create a User-Defined Function Block, page 951
For more information, see Associate Function Blocks with Instrument Types, page
951.
Related Topics
• Flow of Activities for Foundation Fieldbus Design, page 942
• Foundation Fieldbus Design: An Overview, page 941
c. Per intrinsically safe (IS) segment— Type the maximum number of tag
numbers that can be associated with one intrinsically safe segment.
7. In the Maximum number of assigned function blocks group box, do the
following:
a. Per I/O card— Type the maximum number of function blocks that can be
associated with one I/O card.
b. Per segment— Type the maximum number of function blocks that can be
associated with one segment.
8. In the Electrical parameters group box, do the following:
a. Power supply— Type the available voltage source value, in volts.
b. Minimum receiver voltage— Type the minimum receiver voltage value that
can be read by a DCS, in volts.
c. Allowable current per non IS segment— Type the maximum allowable
value for the current consumption in the non-intrinsic safety segments, in
milliamperes.
d. Allowable current per IS segment— Type the maximum allowable value
for the current consumption in the intrinsic safety segments, in milliamperes.
e. Maximum capacitance— Type the maximum allowable segment
capacitance in the unit of measure selected at right.
9. Click the Cable Lengths tab.
10. In the Recommended spur cable lengths group box, define the rules for spur
cables connecting instruments to home-run cables. Do the following:
a. Select the required unit of measure (meters or feet).
b. In the Number of devices per segment columns, type the number of devices
per segment for which you want to set the spur lengths. Make sure that you
do not exceed the number of devices that you defined in the Maximum
number of devices group box.
c. In the Number of devices per spur columns, type the maximum allowable
length of the spur cables for each definition.
d. You can click New to add a row, or Delete to delete the row marked by .
See Spur Cable Lengths Example, page 949.
11. Click OK to confirm your creation of this profile and return to the Segment-
Wide Parameter Profiles dialog box.
Tip
• You can return to Step 3 to create an additional segment-wide
parameter profile.
12. Click OK to close the Segment-Wide Parameter Profiles dialog box and return
to the main window of the Wiring module.
• 120 meters for 1 to 12 devices per segment and one device per spur;
• 90 meters for 1 to 12 devices per segment and two devices per spur;
• 60 meters for 1 to 12 devices per segment and three devices per spur;
• 30 meters for 1 to 12 devices per segment and four devices per spur;
• 90 meters for 13 to 14 devices per segment and one device per spur; and
so forth.
Related Topics
• Define Segment-Wide Parameters, page 947
Function blocks are associated with particular instrument types. When creating a new
instrument based on an instrument type that has been associated with a function
block, the software creates that instrument and automatically associates it with the
function block have been set for pertinent instrument type. The software allows you
to associate multiple function blocks with a single instrument type. For example, a
basic flow transmitter will have one AI (analog input) block associated with it.
However, a similar instrument may be used to measure also pressure and temperature
(required for gas flow compensation), and may be further equipped with one or more
alarm functions. An AI function block is required for each additional process
measurement and an AA (analog alarm) block for each alarm function. You can also
associate existing instruments with function blocks, or modify associations as needed.
Notes
• You cannot create virtual tags for an instrument that is not associated with
at least one function block.
• A number of Foundation Fieldbus and Profibus PA function blocks are
shipped with the software. You cannot add, delete or modify any of them.
You can see all the available function block types on the Function Block -
Instrument Type Association dialog box (for details, see Associate
Function Blocks with Instrument Types, page 951.
Related Topics
• Associate Function Blocks with Instrument Types, page 951
• Associate Function Blocks with Instruments, page 960
• Create a User-Defined Function Block, page 951
• Create Foundation Fieldbus and Profibus Instruments, page 957
• Preliminary Definitions for Foundation Fieldbus Common Tasks, page
946
• Profibus Design: An Overview, page 1001
Related Topics
• Associate Function Blocks with Instrument Types, page 951
• Associate Function Blocks with Instruments, page 960
• Preliminary Definitions for Foundation Fieldbus Common Tasks, page
946
• Profibus Design Common Tasks, page 1004
• Working with Function Blocks: An Overview, page 950
Related Topics
• Associate Function Blocks with Instruments, page 960
• Create a User-Defined Function Block, page 951
• Define Foundation Fieldbus and Profibus Instrument Type Profiles, page
956
• Manage the Function Blocks Supporting Table, page 952
• Preliminary Definitions for Foundation Fieldbus Common Tasks, page
946
• Profibus Design Common Tasks, page 1004
• Working with Function Blocks: An Overview, page 950
The browser displays all the instruments that exist in your fieldbus system. The
instrument properties are displayed in various columns, such as Tag Number, Loop
Number, Service, Segment Name, and so forth. The columns, their sequence, and
row sorting in this pane depend on the Browser view currently selected in the
Browser Manager. The default display is the New Fieldbus Tag Number List view
in the Browser Manager.
Related Topics
• Associate an Instrument with a Segment, page 963
• Change Instrument / Segment Association, page 964
• Create a Foundation Fieldbus Segment, page 962
• Delete a Fieldbus Segment, page 965
• Flow of Activities for Foundation Fieldbus Design, page 942
• Profibus Design Common Tasks, page 1004
The software allows you to create various types of instruments that can be associated
with the Foundation Fieldbus or Profibus system in your plant. In other words, you
can create instruments that are compatible with Foundation Fieldbus, Profibus DP,
and Profibus PA segments. You add new instruments in the Instrument Index
module, exactly the same way that you create other tags. Once you define an
instrument type for the new tag number and associate a function block with the new
tag's instrument type, the new instrument automatically acquires all of the appropriate
properties that you set for that tag number. You can then create virtual tags for this
instrument.
For more information, see Create Foundation Fieldbus and Profibus Instruments,
page 957.
Related Topics
• Flow of Activities for Foundation Fieldbus Design, page 942
• Foundation Fieldbus Design: An Overview, page 941
18. Click Function Block to associate function blocks with instrument types. For
details, see Associate Function Blocks with Instrument Types, page 951.
19. Click OK in the Instrument Type Profile dialog box.
Related Topics
• Associate Function Blocks with Instrument Types, page 951
• Managing Fieldbus Instruments Common Tasks, page 955
• Profibus Design Common Tasks, page 1004
Tips
• If the tag number does not correspond to an existing loop name,
SmartPlant Instrumentation prompts you to enter a loop name based on
the tag number you have entered. If the loop identifier already
matches an existing loop, the software will automatically associate the
new tag number with the loop.
• If the loop convention includes the loop function parameter, the
prompt will always appear. In this case, you have to complete the loop
number.
If a profile exists for the selected instrument type, any new tags for
that instrument type will be created with the selected reference items.
• For DeltaV compatibility, you must select an instrument type that you
associated with a DeltaV device type during the downloading process.
To display the Associate Foundation Fieldbus Device Types with
Instrument Type supporting table of associations that you built
among DeltaV device types, instrument manufacturers, and SmartPlant
Instrumentation instrument types, see Associate Device Types for DCS
Vendors, page ???.
8. On the Loop Name dialog box, do one of the following:
• Type the loop number that the new tag is associated with.
• Accept the displayed loop number.
• Click Cancel to create the tag number without a loop association.
Note that if a loop with the same name exists, the tag number is
automatically associated with it, without creating a new loop.
9. Click OK to create the loop number.
10. On the Loop Number Properties dialog box, accept the loop number properties
or modify them as you require and then click OK.
11. On the Tag Number Properties dialog box, on the General tab, enter the tag
number attributes that you require.
Tip
• For DeltaV compatibility, make sure that the value that you select
from the Manufacturer list is among the acceptable values for the
instrument type that you selected for the current tag. For details, see
Crucial Fields for the DeltaV Interface, page ???.
12. On the Fieldbus tab, to define the fieldbus properties for the new instrument, type
the fieldbus tag name.
13. Type the field device address if necessary.
14. Type the device ID if necessary.
15. If the new tag functions as a backup that takes over DCS functions in case of DCS
failure in the current segment, select Backup link master.
Related Topics
• Associate Function Blocks with Instrument Types, page 951
• Create a User-Defined Function Block, page 951
• Define Foundation Fieldbus and Profibus Instrument Type Profiles, page
956
• Managing Fieldbus Instruments Common Tasks, page 955
• Profibus Design Common Tasks, page 1004
• Working with Function Blocks: An Overview, page 950
Related Topics
• Flow of Activities for Foundation Fieldbus Design, page 942
• Foundation Fieldbus Design: An Overview, page 941
Related Topics
• Associate an Instrument with a Segment, page 963
• Connect a Home-Run Cable to a Plug-and-Socket Box, page 990
• Managing Segments Common Tasks, page 961
Related Topics
• Create a Foundation Fieldbus Segment, page 962
• Flow of Activities for Foundation Fieldbus Design, page 942
1. On the Wiring module menu bar, click Actions > Fieldbus Tag Numbers
Browser.
2. In the Domain Explorer, double-click the Fieldbus Segments folder and expand
the appropriate segments.
3. Right-click an instrument tag, and then, on the shortcut menu, click Actions >
Dissociate Item from Segment.
4. In the Fieldbus Tag Numbers browser, select the dissociated tag and drag it to
the target segment in the Fieldbus Segments folder.
Notes
• You cannot change the segment association of a connected instrument
before disconnecting its wiring.
• The Segment Name field in the Fieldbus Tag Numbers
Related Topics
• Associate an Instrument with a Segment, page 963
• Create a Foundation Fieldbus Segment, page 962
• Delete a Fieldbus Segment, page 965
• Managing Segments Common Tasks, page 961
• Profibus Design Common Tasks, page 1004
Related Topics
• Change Instrument / Segment Association, page 964
• Create a Foundation Fieldbus Segment, page 962
• Delete a Fieldbus Segment, page 965
• Managing Segments Common Tasks, page 961
• Profibus Design Common Tasks, page 1004
• Click
3. In the Segment Views dialog box, select the required view and then click OK.
Related Topics
• Managing Segments Common Tasks, page 961
• Profibus Design Common Tasks, page 1004
Related Topics
• Flow of Activities for Foundation Fieldbus Design, page 942
• Foundation Fieldbus Design: An Overview, page 941
Related Topics
• Associate a Segment with a Home-Run Cable, page 991
• Create a Cable, page 743
• Define a Cable Configuration, page 740
Related Topics
• Create a Cable, page 743
• Define a Cable Configuration, page 740
• Foundation Fieldbus Design: An Overview, page 941
• Managing Fieldbus Cables Common Tasks, page 967
• Profibus Design Common Tasks, page 1004
You use the Plug-and-Socket Box Wizard to create the required plug-and-socket
boxes or reconfigure the existing ones.
Related Topics
• Flow of Activities for Foundation Fieldbus Design, page 942
• Managing Fieldbus Panels (Plug-and-Socket Boxes) Common Tasks, page
970
• Profibus Design Common Tasks, page 1004
You can create new panels either in the Domain Explorer or the Reference
Explorer. If you are creating a panel that is going to have a frequently used
configuration, we recommend that you create it in the Reference Explorer.
Reference panels facilitate fast creation of plant panels by copying an existing panel
configuration from the Reference Explorer to the Domain Explorer. However, if
you want to create a panel that does not have a configuration that you intend to use
frequently, we recommend that you create this panel in the Domain Explorer and in
the <unit> where it is to be physically located. This is helpful when filtering the
panels in the current <unit>.
Related Topics
• Connect a Home-Run Cable to a Plug-and-Socket Box, page 990
• Flow of Activities for Foundation Fieldbus Design, page 942
• Foundation Fieldbus Design: An Overview, page 941
You create internal terminators using the configuration tools when creating plug-and-
socket boxes or termination blocks. External terminators are added to the termination
block (an apparatus or a plug-and-socket box) during the wiring design phase.
Related Topics
• Flow of Activities for Foundation Fieldbus Design, page 942
• Managing Terminators Common Tasks, page 975
• Profibus Design Common Tasks, page 1004
Related Topics
• Fieldbus Bricks: An Overview, page 979
Related Topics
• Managing Terminators Common Tasks, page 975
• Profibus Design Common Tasks, page 1004
Related Topics
• Managing Terminators Common Tasks, page 975
• Profibus Design Common Tasks, page 1004
• Working with Terminators: An Overview, page 974
Related Topics
• Managing Terminators Common Tasks, page 975
• Profibus Design Common Tasks, page 1004
• Working with Terminators: An Overview, page 974
When creating a fieldbus brick, you can define power supply requirements and
current consumption. Adding an apparatus to a fieldbus brick, entails the definition
of an apparatus configuration and the number of apparatuses that you need. Note that
the power supply requirements and current consumption values are common to all the
existing apparatuses belonging to the apparatus group that exists under a fieldbus
brick. Therefore, changing an electric property values affects all the apparatuses that
exist under that fieldbus brick. For more details about wiring equipment and
apparatuses, see Wiring Equipment: An Overview, page 786.
When generating a segment validation report, the software takes into account the
fieldbus brick electric properties and validates the total current of a segment.
We recommend that first you create your equipment in the Reference Explorer so
that you have as many typical configurations as possible. Then, you can copy these
typical configurations to the Domain Explorer and this way create numerous
fieldbus bricks on the fly.
Related Topics
• Flow of Activities for Foundation Fieldbus Design, page 942
• Managing Terminators Common Tasks, page 975
• Profibus Design Common Tasks, page 1004
We recommend that first you create your equipment in the Reference Explorer so
that you have as many typical configurations as possible. Then, you can copy these
typical configurations to the Domain Explorer and this way create numerous
fieldbus bricks on the fly.
For more information, see Create a Fieldbus Brick Assembly, page 981.
Related Topics
• Fieldbus Bricks: An Overview, page 979
• Flow of Activities for Foundation Fieldbus Design, page 942
• Foundation Fieldbus Design: An Overview, page 941
• Managing Terminators Common Tasks, page 975
Tip
• If you do not have an appropriate apparatus configuration, create one.
(For details, see Configure a Fieldbus Apparatus, page 982).
14. Enter the number of apparatuses that you require.
15. Click Create.
Tip
• SmartPlant Instrumentation automatically assigns sequential position
numbers to each apparatus. You can edit them later if required. (For
details, see Edit Apparatus Terminal Properties, page 810).
16. In the Terminal Strip Properties dialog box, define the new apparatus strip as
required click OK. (For details, see Create a Terminal Strip, page 817).
17. Click Close in the Apparatus dialog box.
Tip
• The new apparatus appears in the Reference Explorer under the
current fieldbus brick.
18. Drag the new fieldbus brick to a panel in the Domain Explorer.
Tip
• The software copies the fieldbus brick assembly that includes the
fieldbus brick and the apparatus.
19. In the Terminal Strip Properties dialog box, rename the fieldbus brick, modify
the other properties as you require, and then click OK.
20. Connect the apparatus to the appropriate cables. Select the apparatus strip you
want to connect and click . The Connection window opens displaying the
apparatus terminals in yellow:
Related Topics
• Fieldbus Bricks: An Overview, page 979
• Managing Fieldbus Brick Assemblies and Apparatuses Common Tasks,
page 980
• Profibus Design Common Tasks, page 1004
b. Select a color of the terminal side from the list, for example red:
16. Repeat steps 17 and 18 for the other terminal side if appropriate. Note that the
line between the two terminal list arrows represents the internal relation between
the input and output terminals.
17. Click Add Terminal to add another terminal to this apparatus configuration if
needed and then repeat steps 14 through 16.
18. Click Delete Terminal if you need to delete a selected terminal from the current
configuration.
19. Click Save and then Close. You can now add the required termination block as
needed.
Related Topics
• Apparatus Common Tasks, page 805
• Apparatus: An Overview, page 804
• Fieldbus Bricks: An Overview, page 979
• Managing Fieldbus Brick Assemblies and Apparatuses Common Tasks,
page 980
• Profibus Design Common Tasks, page 1004
Create a Connector
Connectors are needed for fieldbus home-run cables, telecom cables, and other cables
that require connectors. SmartPlant Instrumentation allows you to build your wiring
system with any of the following connector implementations:
After you drag a terminal or a pin to a wiring equipment channel, the software retains
it in its original place from which you dragged it. However, after expanding the
destination hierarchy, the software also shows the terminal or pin that you dragged.
This means that the terminal or pin is physically located in its original place but it is
associated with the item to which it was dragged.
For more information, see Associate a Pin or a Terminal with a Channel, page 989.
Delete a Connector
This topic shows how to delete a connector. For more information, see Delete a
Connector, page 990.
Related Topics
• Fieldbus Bricks: An Overview, page 979
• Flow of Activities for Foundation Fieldbus Design, page 942
• Foundation Fieldbus Design: An Overview, page 941
• Managing Terminators Common Tasks, page 975
Note
• You can now define a pin configuration for this connector type. For
details, see Define or Edit a Connector Type Pin Configuration, page 987.
Related Topics
• Flow of Activities for Foundation Fieldbus Design, page 942
• Making Connections and Associations for Fieldbus Common Tasks, page
985
• Profibus Design Common Tasks, page 1004
Related Topics
• Flow of Activities for Foundation Fieldbus Design, page 942
• Making Connections and Associations for Fieldbus Common Tasks, page
985
• Profibus Design Common Tasks, page 1004
Create a Connector
1. In the Domain Explorer or Reference Explorer, do one of the following:
• To create a new cable, right-click the Cables folder and on the
shortcut menu click New > Cable.
• Right-click an existing cable, and on the shortcut menu click
Properties.
2. Modify cable properties as needed. For details, see Create a Cable, page 743.
3. Click Connectors.
4. In the Connector Assignments dialog box, do one of the following:
• To manage connector-wire associations for end 1 of the cable, click
the End 1 tab.
• To manage connector-wire associations for end 2 of the cable, click
the End 2 tab.
5. In the Connector Assignments dialog box, click New.
6. In the Connector Properties dialog box that opens, under Connector, type the
name of the new connector.
• From the list, select a connector type as configured.
• To modify or create a connector type, click . For details, see Define
or Edit a Connector Type, page 986.
7. Under Male/female select Male or Female as needed.
8. Click OK to return to the Connector Assignments dialog box.
Related Topics
• Creating and Managing Cables Common Tasks, page 737
• Flow of Activities for Foundation Fieldbus Design, page 942
• Making Connections and Associations for Fieldbus Common Tasks, page
985
• Profibus Design Common Tasks, page 1004
2. Expand a hierarchy to display the terminal or pin that you want to associate.
3. Drag your selection to the required wiring equipment channel.
Related Topics
• Creating and Managing Cables Common Tasks, page 737
• Making Connections and Associations for Fieldbus Common Tasks, page
985
Delete a Connector
1. In the Domain Explorer or Reference Explorer, right-click a cable, and on the
shortcut menu click Properties.
2. In the Cable Properties dialog box, click Connectors.
3. In the Connector Assignments dialog box, do one of the following:
• To manage connector-wire associations for end 1 of the cable, click
the End 1 tab.
• To manage connector-wire associations for end 2 of the cable, click
the End 2 tab.
4. In the Connector Assignments dialog box, select the connectors that you want to
delete.
5. Click Delete.
6. Click OK to return to the Connector Assignments dialog box.
Note
• The software does not allow you to delete a connector that is already
connected (in the Connection window).
Related Topics
• Flow of Activities for Foundation Fieldbus Design, page 942
• Making Connections and Associations for Fieldbus Common Tasks, page
985
• Profibus Design Common Tasks, page 1004
5. Drag the connectors to their ports in the current plug-and-socket box in the Plug-
and-Socket Box Connection window.
Tip
• Before you start dragging a connector, make sure that the cable
connector matches the port type on the plug-and-socket box.
6. In the Cable Connection Options dialog box, select the cable end that you want
to connect and click OK.
7. Repeat the above to connect other cables as needed.
Note
• To disconnect a home-run cable from the current plug-and-socket box,
highlight the cable that you want to disconnect and click .
Related Topics
• Create a Home-Run Cable, page 967
• Making Connections and Associations for Fieldbus Common Tasks, page
985
• Managing Fieldbus Panels (Plug-and-Socket Boxes) Common Tasks, page
970
• Profibus Design Common Tasks, page 1004
• Terminator (Plug-and-Socket Box) — Segment Association, page 978
• Terminator (Terminal Strip) — Segment Association, page 978
5. Right-click the highlighted home-run cable and on the shortcut menu, click
Associate Segment to open Segment Association dialog box.
6. From the Associate segment list, select the segment with which you want to
associate the current home-run cable.
Tip
• If the required segment is not available in the Associate segment list,
select the Include all segments option button in the Segment filter
group box.
7. Click OK to make the association.
Note
• The name of segment you just associated is propagated along the entire
home-run cable.
Related Topics
• Create a Foundation Fieldbus Segment, page 962
• Create a Home-Run Cable, page 967
• Making Connections and Associations for Fieldbus Common Tasks, page
985
• Profibus Design Common Tasks, page 1004
You can create new I/O cards either in the Domain Explorer or the Reference
Explorer. If you are creating an I/O card that is going to have a frequently used
configuration, we recommend that you create it in the Reference Explorer.
Reference I/O cards facilitate fast creation of plant I/O cards by copying an existing
I/O card configuration from the Reference Explorer to the Domain Explorer.
However, if you want to create an I/O card that does not have a configuration that you
intend to use frequently, we recommend that you create this card in the Domain
Explorer and in the <unit> where it is to be physically located. This is helpful when
filtering the I/O cards in the current <unit>.
For more information, see Create a Fieldbus I/O Card, page 993.
Related Topics
• Flow of Activities for Foundation Fieldbus Design, page 942
• Foundation Fieldbus Design: An Overview, page 941
• Select the Apply naming convention check box selected if you want
the software to name the new card automatically according to the
naming conventions that are set for this type of equipment in the
Administration module. For more information, see SmartPlant
Instrumentation Administration Help, Domain Administration >
Naming Conventions.
• Clear the Apply naming convention check box and under Name, type
the name of the new card. Note that if you do not clear the Apply
naming convention check box, the software will ignore the name that
you type under Name.
5. Select the Double width check box if the card occupies a double width slot or
position.
6. In the Details group box, type a description as needed.
7. Select an I/O card type, model, and manufacturer. If the required value is not
available on the list, click to define a new one.
8. Enter a sequence if you need to define the card sequence.
9. Click the Control System tab.
10. In the Control system details group box, under I/O type, select one of the
following I/O types to determine the actual function of the new I/O card:
• Fieldbus
• Profibus DP
• Profibus PA
11. Under Module, type the software address that the current card is assigned to.
Tip
• Module, Controller/Processor, Rack, and Slot are field headers
specific to panel manufacturers. Selecting a different manufacturer
when editing the panel displays the headings used by that panel
manufacturer. For details, see Customize Manufacturer-Specific Field
Headers, page ???.
12. From the Controller/Processor list, select an I/O card controller. If the required
controller is not available on the list, click to define a new one.
13. Click the Category Properties tab.
14. Revise and modify category property values as you require. Click the value for
each property and modify it as needed.
Tip
• A category property is a wiring equipment category property that you
can define yourself. For details, see Add User-Defined Wiring
Equipment Category Properties, page 791.
15. Click the Associated Symbols tab to associate a symbol with this item . The
software will use this symbol when generating a report in the Enhanced Report
Utility. For details, see Associate a Symbol with an Item, page 734.
16. Click OK to accept your settings and close the dialog box.
Related Topics
• Fieldbus Bricks: An Overview, page 979
• Managing Fieldbus Brick Assemblies and Apparatuses Common Tasks,
page 980
• Profibus Design Common Tasks, page 1004
You perform other validations by running a report from the Fieldbus Tag Numbers
browser. SmartPlant Instrumentation notifies you in the report of a failed validation
in the following cases:
• There are fieldbus tags that are associated with a segment but not wired.
• There are fieldbus tags that have wiring, but are not yet connected to a
segment.
• There is a connection discontinuity between the field and a DCS or an I/O
terminal strip.
• The number of instruments in a segment exceeds the maximum specified
for that segment.
• The number of devices on a given spur exceeds the segment-wide
parameter profile.
• A spur length is exceeds the maximum set for that spur.
• Total cable length exceeds the maximum you defined for the segment
profile.
• There are less than two terminators in a segment.
• Actual voltage at instrument terminals is below the minimum operating
voltage.
• Total segment current consumption exceeds the maximum specified value.
• Total capacitance exceeds segment maximum specified capacitance.
Notes
• To define a cable type that supports fieldbus validation, make sure that in
the Cable Type Properties dialog box, you enter the required values for
capacitance, capacitance UOM (unit of measure), cable resistance, cable
resistance UOM, length UOM, and maximum fieldbus length (for details,
see Create a Cable, page 743).
• To define an instrument tag that supports fieldbus validation, make sure
that in the Tag Number dialog box you enter valid information under
Fieldbus Tag Number Properties Create Foundation Fieldbus and
Profibus Instruments, page 957).
• SmartPlant Instrumentation validation supports basic fieldbus networks
consisting of a single segment with no parallel branches and no repeaters.
Related Topics
• Define Segment-Wide Parameters, page 947
• Fieldbus Validation Common Tasks, page 998
• Flow of Activities for Foundation Fieldbus Design, page 942
Related Topics
• Fieldbus Validation: An Overview, page 996
• Flow of Activities for Foundation Fieldbus Design, page 942
Related Topics
• Foundation Fieldbus Design: An Overview, page 941
• Profibus Design Common Tasks, page 1004
8. Associate the PA instruments with the PA segments. For details, see Associate
Profibus PA Instruments with a PA Segment, page 1005.
9. Generate a Profibus layout report. For details, see Generate an Enhanced
Profibus Layout Report, page 1007.
Related Topics
• Profibus Design Common Tasks, page 1004
• Profibus Design: An Overview, page 1001
Related Topics
• Profibus Design Common Tasks, page 1004
• Profibus Design: An Overview, page 1001
You create a PLC or DCS panel compatible with a DP segment exactly the same way
you create any other PLC or DCS panel. While creating such a panel, make sure that
you select the Enable DP Profibus check box so that you can associate this panel
with a DP Profibus segment.
Related Topics
• Profibus Design Common Tasks, page 1004
• Profibus Design: An Overview, page 1001
The advantage of HART instruments is that they can be connected to standard 4-20
milliamperes systems and, at the same time; make use of digital communication to
collect additional data.
Related Topics
• Flow of Activities for HART Instrumentation, page 1009
• Foundation Fieldbus Design: An Overview, page 941
• HART AO
7. On the Wiring and Control System tab, select the appropriate reference device
panel and reference cable. For details, see Define a Wiring and Controls System
Instrument Type Profile, page ???.
8. Click OK in the Instrument Type Profile dialog box.
Related Topics
• Flow of Activities for HART Instrumentation, page 1009
• Working with HART Instruments: An Overview, page 1008
15. Enter the required DC consumption, capacitance, minimum transmit level, and
operating voltage.
16. Create the required virtual digital tags. For details, see Create a Virtual Digital
Tag, page 1012.
Related Topics
• Flow of Activities for HART Instrumentation, page 1009
• Working with HART Instruments: An Overview, page 1008
• HART AI
• HART AO
• AI
• AO
• MIXED
For details on how to create an I/O card, see Create an I/O Card, page 797.
Related Topics
• Flow of Activities for HART Instrumentation, page 1009
• Working with HART Instruments: An Overview, page 1008
Instruments Cards
AI AO HART AI HART AO
AI Yes No Yes (see note 1) No
AO No Yes No Yes (see note 1)
HART AI Yes (see note 2) No Yes No
HART AO No Yes (see note 2) No Yes
Mixed Yes Yes Yes (see note 3) Yes (see note 3)
Notes
• When assigning "non-HART" analog instruments to HART-compatible
I/O cards, the software assigns only the analog signals. (DI or DO are not
allowed anyway).
• You can assign HART instruments to conventional I/O cards (AI to
HART AI, AO to HART AO), but the software assigns only the analog
signals and not the virtual digital tags.
• You can assign HART instruments to I/O cards with MIXED I/O type, but
the software assigns only the analog signals and not the virtual digital tags.
Related Topics
• Flow of Activities for HART Instrumentation, page 1009
• Working with HART Instruments: An Overview, page 1008
Related Topics
• Foundation Fieldbus Design: An Overview, page 941
• Managing Multi-Input Devices Common Tasks, page 1015
You can create new multi-input devices either in the Domain Explorer or the
Reference Explorer. If you are creating a multi-input device that is going to have a
frequently used configuration, we recommend that you create it in the Reference
Explorer. Reference multi-input devices facilitate fast creation of plant multi-input
devices that are based on the configuration of an item in the Reference Explorer.
However, if you want to create a multi-input device that does not have a
configuration that you intend to use frequently, we recommend that you create this
multi-input device in the Domain Explorer and in the <unit> where it is to be
physically located. This is helpful when filtering the panels in the current <unit>.
Related Topics
• Conventional and Fieldbus Multi-Input Devices: An Overview, page 1014
9. Click Next, and on the Define the Plug-and-Socket Box Connectors page, for
each connector, do the following:
a. From the Connector type list, select the required connector, or click to
open the Connectors dialog box.
b. From the Male/female list, define the connector as Male or Female.
c. If these settings are constant for all of the connectors in the panel, select
Apply to all after you set the above.
10. Click Next and then click Finish.
Note
• You can delete the terminals that were created after completing the wizard
only when you delete the multi-input device panel.
Related Topics
• Conventional and Fieldbus Multi-Input Devices: An Overview, page 1014
• Create a Plug-and-Socket Device Panel, page 970
• Managing Multi-Input Devices Common Tasks, page 1015
9. Click Next, and on the Define the Input / Output Configuration page, for each
connector, do the following:
a. From the Input/Output list, select the required input or output.
b. From the Configuration list, select an appropriate configuration.
c. Under First terminal, enter the first terminal as you require.
d. If these settings are constant for all of the inputs and outputs in the panel,
select Apply to all after you set the above.
10. Click Next and then click Finish.
Note
• You can delete the terminals that were created after completing the wizard
only when you delete the multi-input device panel.
Related Topics
• Conventional and Fieldbus Multi-Input Devices: An Overview, page 1014
• Create a Plug-and-Socket Device Panel, page 970
• Managing Multi-Input Devices Common Tasks, page 1015
• For the instrument type upon which you base the multi-input device
panel, make sure that you select the Fieldbus I/O type in the
Instrument Type Profile dialog box and that you associate enough
function blocks for the inputs. For details, see Define Foundation
Fieldbus and Profibus Instrument Type Profiles, page 956.
5. In the Instrument Index module, create the following, based on the instrument
types that you defined:
• Create the instrument tags that feed into the multi-input instrument tag.
• Create the multi-input instrument tag. Make sure that in the New Tag
Number dialog box, you select Fieldbus from the Tag class list.
6. In the Domain Explorer, right click the multi-input device panel that was
created, and on the shortcut menu, click Actions > Connection.
7. In the Plug-and-Socket Connection window, do the following to connect the
input device cables to the multi-input device panel.
a. In the Domain Explorer, expand the device cables that feed into the multi-
input device panel.
b. Drag the appropriate cable connectors to the in-ports of the multi-input device.
8. Do the following to route the multiplexed signal through a plug-and-socket
junction box:
a. In the Domain Explorer, right click the junction box, and on the shortcut
menu, click Actions > Connection.
b. In the Domain Explorer, expand the multi-input device cable.
c. Drag the appropriate cable connector to the desired in-port of the junction box
in the Plug-and-Socket Connection window.
9. Do the following to associate the multi-input tag signal with the available function
blocks in the target fieldbus segment:
a. In the Wiring Module window, click Actions > Fieldbus Tag Numbers
Browser.
b. Drag the multi-input device tag from the Instruments pane to the target
segment in the Fieldbus Segments folder of the Domain Explorer.
c. In the Fieldbus Segments pane, right click the multi-input device tag, and on
the shortcut menu, click Associate Multi-Input Device Tag.
d. Drag each tag from the Connected tags available for association pane to the
Function Block – Tag Association pane.
e. Click Close.
10. Do the following to assign the demultiplexed signals to the segment I/O card:
a. In the Domain Explorer, right-click the desired DCS, then on the shortcut
menu click Actions > I/O Assignment.
b. If the I/O Assignment dialog box opens, select Segment I/O assignment,
and click OK.
c. In the Segment I/O Assignment window, in the Segment list pane, select the
desired segment.
d. In the I/O card details pane, select the channel to which you want to assign
the demultiplexed signals.
e. Click Actions > Assign to a Channel.
Related Topics
• Conventional and Fieldbus Multi-Input Devices: An Overview, page 1014
• Create a Plug-and-Socket Device Panel, page 970
• Managing Multi-Input Devices Common Tasks, page 1015
• Create the multi-input instrument tag. Make sure that in the New Tag
Number dialog box, you select Fieldbus from the Tag class list.
6. In the Domain Explorer, right click the multi-input device panel that was
created, and on the shortcut menu, click Actions > Connection.
7. In the Plug-and-Socket Connection window, connect the input device cables to
the multi-input device panel.
8. Do the following to route the multiplexed signal through a unction box:
a. In the Domain Explorer, right click the junction box, and on the shortcut
menu, click Actions > Connection.
b. In the Connection window, connect the multi-input device cable to the
junction box.
9. Do the following to associate the multi-input tag signal with the available function
blocks in the target fieldbus segment:
a. In the Wiring Module window, click Actions > Fieldbus Tag Numbers
Browser.
b. Drag the multi-input device tag from the Instruments pane to the target
segment in the Fieldbus Segments folder of the Domain Explorer.
c. In the Fieldbus Segments pane, right click the multi-input device tag, and on
the shortcut menu, click Associate Multi-Input Device Tag.
d. Drag each tag from the Connected tags available for association pane to the
Function Block – Tag Association pane.
e. Click Close.
10. Do the following to assign the demultiplexed signals to the segment I/O card:
a. In the Domain Explorer, right-click the desired DCS, then on the shortcut
menu click Actions > I/O Assignment.
b. If the I/O Assignment dialog box opens, select Segment I/O assignment,
and click OK.
c. In the Segment I/O Assignment window, in the Segment list pane, select the
desired segment.
d. In the I/O card details pane, select the channel to which you want to assign
the demultiplexed signals.
e. Click Actions > Assign to a Channel.
Related Topics
• Conventional and Fieldbus Multi-Input Devices: An Overview, page 1014
• Create a Plug-and-Socket Device Panel, page 970
• Managing Multi-Input Devices Common Tasks, page 1015
a. In the Domain Explorer, expand the device cables that feed into the multi-
input device panel.
b. Drag the appropriate cable connectors to the in-ports of the multi-input device.
8. In the Domain Explorer, right-click the DCS panel to which you connect the
output of the multi-input device panel, then on the shortcut menu, click Actions >
Connection.
Tip
• Make sure that the I/O type of the I/O card to which you connect the
multi-input device is SI.
9. In the Connection window, connect the output cable of the multi-input device
panel to the DCS.
10. To view the I/O assignment of the signals, click Actions > I/O Assignment.
Related Topics
• Conventional and Fieldbus Multi-Input Devices: An Overview, page 1014
• Create a Plug-and-Socket Device Panel, page 970
• Managing Multi-Input Devices Common Tasks, page 1015
• For the instrument type upon which you base the multi-input device
panel, make sure that you select the Serial Interface I/O type in the
Instrument Type Profile dialog box and that you associate enough
function blocks for the inputs. For details, see Define Foundation
Fieldbus and Profibus Instrument Type Profiles, page 956.
5. In the Instrument Index module, create the following, based on the instrument
types that you defined:
• Create the instrument tags that feed into the multi-input instrument.
• Create the multi-input instrument tag. Make sure that in the New Tag
Number dialog box, you select Fieldbus from the Tag class list.
6. In the Domain Explorer, right click the multi-input device panel that was
created, and on the shortcut menu, click Actions > Connection.
7. In the Plug-and-Socket Connection window, do the following to connect the
input device cables to the multi-input device panel.
a. In the Domain Explorer, expand the device cables that feed into the multi-
input device panel.
b. Drag the appropriate cable connectors to the in-ports of the multi-input device.
8. In the Domain Explorer, right-click the DCS panel to which you connect the
output of the multi-input device panel, then on the shortcut menu, click Actions >
Connection.
Tip
• Make sure that the I/O type of the I/O card to which you connect the
multi-input device is SI.
9. In the Connection window, connect the output cable of the multi-input device
panel to the DCS.
10. To view the I/O assignment of the signals, click Actions > I/O Assignment.
Related Topics
• Conventional and Fieldbus Multi-Input Devices: An Overview, page 1014
• Create a Plug-and-Socket Device Panel, page 970
• Managing Multi-Input Devices Common Tasks, page 1015
Here are a few examples of telecom equipment that you can create and manage:
Note
• Telecom functionality is available only if it is included in the software
license that you purchased from Intergraph.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Working with Old Equipment, page 1030
The first step in your telecom design is to create the reference telecommunication
equipment.
Then, in the Instrument Index module, you define telecommunication device types
(similar to instrument types for non-telecommunication devices). You can also define
telecom line numbers, field equipment (that is, equipment classification), and signal
levels. Now you can create your telecom tag numbers based on the telecom device
type that you defined. At this stage, you can generate various Instrument Index
reports as needed.
Once all the supporting table data is entered and all the telecom tags are created, you
start creating your telecom panels and telecom equipment based on the reference
equipment and reference panels you created previously. Make the required
connections among the your telecom equipment. You can then generate telecom
wiring reports as needed.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
Related Topics
• Flow of Activities for Telecom Design, page 1026
• Telecom Design: An Overview, page 1025
Supporting Description
Table
Telecom Allows you to create and manage telecom device types. You define
Device Types the required telecom device type profile for your telecom tag numbers
so that new tags that you create can acquire the necessary properties.
SmartPlant Instrumentation provides a number of predefined telecom
device types, such as AL (alarm), CAM (camera), and so forth. You
can add new telecom device types and modify the shipped ones as
desired. You can also delete a telecom device type that is not in use,
but the software does not let you delete a telecom device type that you
already used to create a tag number.
Telecom Line Allows you to maintain the contents of the Telecom line list when
Numbers creating a telecom field device in the Plug-and-Socket Box wizard
and the Line number list on the Tag Number Properties dialog box.
Telecom Field Allows you to maintain the contents of the Field equipment select list
Equipment on the Tag Number Properties dialog box.
Telecom Allows you to maintain the contents of the Signal level select list on
Signal Levels the Tag Number Properties dialog box.
Panel Sub- Allows you to maintain the contents of the Sub-system select list on
Systems the Equipment Panel Properties dialog box.
Supporting Description
Table
Telephone Allows you to define new telephone numbers that you can associate
Numbers with existing switch channels in PABX cabinets.
Telephone Allows you to manage the contents of the Telephone number status
Number select list on the Telephone Number Properties dialog box.
Statuses
Telephone Allows you to manage the contents of the Telephone number usages
Number select list on the Telephone Number Properties dialog box.
Usages
Intercom Allows you to define new intercom numbers that you can later
Numbers associate with amplifiers.
PA Zones Allows you to manage the PA zone definitions which are available for
selection on the Category Properties tab of the Wiring Equipment
Properties (Amplifier) dialog box.
Alarm Zones Allows you to manage the alarm zone definitions which are available
for selection on the Category Properties tab of the Wiring
Equipment Properties (Amplifier) dialog box.
PABX Allows you to manage the contents of the PABX categories select list
Categories on the PABX Cabinet Properties dialog box.
Note
• For the various actions that you can perform with supporting tables, see
Supporting Tables Common Tasks, page ???.
Note that you cannot create additional panels in this folder, but you can add new child
items, modify the properties of the existing items, and delete the old equipment items,
as you require.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
After defining a device type, you set device type profile defaults for new telecom tag
numbers. As result, SmartPlant Instrumentation will create your new tag numbers
with certain predefined properties based on the telecom device type you select for the
new tag number. You set profiles for every telecom device type that you use.
For more information, see Set Telecom Device Type Profile Defaults, page 1033.
You can create a new telecom field device panel in the Domain Explorer or the
Reference Explorer. If you are creating a panel that is going to have a frequently
used configuration, we recommend that you create it in the Reference Explorer.
Reference panels facilitate fast creation of plant panels by copying an existing panel
configuration from the Reference Explorer to the Domain Explorer. However, if
you want to create a panel that does not have a configuration that you intend to use
frequently, we recommend that you create this panel in the Domain Explorer and in
the <unit> where it is to be physically located. This is helpful when filtering the
panels in the current <unit>.
For more information, see Create a Telecom Conventional Field Device, page 1035.
You can create a new telecom plug-and-socket box field device in the Domain
Explorer or the Reference Explorer. If you are creating a plug-and-socket box that
is going to have a frequently used configuration, we recommend that you create it in
the Reference Explorer. Reference plug-and-socket boxes facilitate fast creation of
plant plug-and-socket boxes by copying required configurations from the Reference
Explorer to the Domain Explorer. However, if you want to create a plug-and-
socket box that does not have a configuration that you intend to use frequently, we
recommend that you create it in the Domain Explorer and in the <unit> where it is
to be physically located. This is helpful when filtering the panels in the current
<unit>.
For more information, see Create a Telecom Plug-and-Socket Field Device, page
1036.
If you are creating a cable that is going to have a frequently used configuration, we
recommend that you create it in the Reference Explorer. Reference cables facilitate
fast creation of plant cables by copying an existing cable configuration from the
Reference Explorer to the Domain Explorer. However, if you want to create a
cable that does not have a configuration that you intend to use frequently, we
recommend that you create this cable in the Domain Explorer and in the <unit>
where it is to be physically located. This is helpful when filtering the cables in the
current <unit>.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Creating and Managing Telecom Devices and Cables Common Tasks,
page 1031
• Flow of Activities for Telecom Design, page 1026
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
4. Select the required values from the Type, Manufacturer, Model, Area
classification, and Location lists. If the required value is not available, click
next to the relevant list arrow to open the appropriate supporting table.
5. Under Mounting, type a value if needed.
6. Select the Set as intrinsically safe check box if this field device panel has
intrinsic safety certification.
7. Click Revisions to manage the revisions of the new panel if needed.
8. Click OK to accept your definitions for the new field device panel and close this
dialog box.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Creating and Managing Telecom Devices and Cables Common Tasks,
page 1031
• Flow of Activities for Telecom Design, page 1026
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Creating and Managing Telecom Devices and Cables Common Tasks,
page 1031
• Flow of Activities for Telecom Design, page 1026
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
You can create a telecom panel in the Domain Explorer or the Reference Explorer.
If you are creating a panel that is going to have a frequently used configuration, we
recommend that you create it in the Reference Explorer. Reference panels facilitate
fast creation of plant panels by copying an existing panel configuration from the
Reference Explorer to the Domain Explorer. However, if you want to create a
panel that does not have a configuration that you intend to use frequently, we
recommend that you create this panel in the Domain Explorer and in the <unit>
where it is to be physically located. This is helpful when filtering the panels in the
current <unit>.
4. Select the required values from the Type, Manufacturer, Model, Area
classification, and Location lists. If the required value is not available, click
next to the relevant list arrow to open the appropriate supporting table.
5. Under Dimensions, type a value for the junction box dimensions if needed.
6. Under Maximum number of racks, type a value to set the maximum number of
racks that will be possible to create in this junction box.
Tip
• Type zero if you want to have an unlimited number of racks.
7. Under Mounting, type a value if needed.
8. Under Backplane, type a value if needed.
9. Select the Set as intrinsically safe check box if this junction box has intrinsic
safety certification.
10. Click the Associate Symbols tab to associate a symbol with the current junction
box. The software will use this symbol when generating a report in the Enhanced
Report Utility. For details, see Associate a Symbol with an Item, page 734.
11. Click Revisions to manage the revisions of the new panel if needed.
12. Click OK to accept your definitions for the new panel and close this dialog box.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Creating and Managing Telecom Panels Common Tasks, page 1038
• Flow of Activities for Telecom Design, page 1026
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
Tip
• Type zero if you want to have an unlimited number of racks.
7. Under Mounting, type a value if needed.
8. Under Backplane, type a value if needed.
9. Select the Set as intrinsically safe check box if this splice panel has intrinsic
safety certification.
10. Click the Associate Symbols tab to associate a symbol with the current splice.
The software will use this symbol when generating a report in the Enhanced
Report Utility. For details, see Associate a Symbol with an Item, page 734.
11. Click Revisions to manage the revisions of the new splice panel if needed.
12. Click OK to accept your definitions for the new splice panel and close this dialog
box.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Creating and Managing Telecom Panels Common Tasks, page 1038
• Flow of Activities for Telecom Design, page 1026
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
10. Click the Associate Symbols tab to associate a symbol with the current
distribution frame. The software will use this symbol when generating a report in
the Enhanced Report Utility. For details, see Associate a Symbol with an Item,
page 734.
11. Click Revisions to manage the revisions of the new panel if needed.
12. Click OK to accept your definitions for the new distribution frame and close this
dialog box.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Creating and Managing Telecom Panels Common Tasks, page 1038
• Flow of Activities for Telecom Design, page 1026
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
You can create an equipment cabinet in the Domain Explorer or the Reference
Explorer. If you are creating an equipment cabinet that is going to have a frequently
used configuration, we recommend that you create it in the Reference Explorer.
Reference equipment cabinets facilitate fast creation of plant equipment cabinets by
copying an existing cabinet configuration from the Reference Explorer to the
Domain Explorer. However, if you want to create an equipment cabinet that does
not have a configuration that you intend to use frequently, we recommend that you
create it in the Domain Explorer and in the <unit> where it is to be physically
located. This is helpful when filtering the panels in the current <unit>.
Create a PA Cabinet
This procedure explains how to create a PA cabinet. For more information, see
Create a PA Cabinet, page 1044.
Create an Amplifier
The software allows you to add amplifiers to an existing PA cabinet. Once you have
created an amplifier, you can create strips and connectors under this amplifier. For
more information, see Create an Amplifier, page 1045.
Create a Switch
The software allows you to create switches after adding a rack to a PABX cabinet.
Once you have created a switch, you can add a switch port and a connector. For more
information, see Create a Switch, page 1049.
Create a PA Cabinet
1. In the Domain Explorer, double-click the Panels by Category folder and expand
the Telecom Panels folder.
2. Right-click the Equipment Cabinets folder and then on the shortcut menu click
New > PA Cabinet.
3. On the PA Cabinet Properties dialog box, on the General tab, under Panel, type
the name of the new cabinet.
4. Select the required values from the Type, Manufacturer, Model, Area
classification, and Location lists. If the required value is not available, click
next to the relevant list arrow to open the appropriate supporting table.
5. Under Dimensions, type a value for the cabinet dimensions if needed.
6. Under Maximum number of racks, type a value to set the maximum number of
racks that will be possible to create in this cabinet.
Tip
• Type zero if you want to have an unlimited number of racks.
7. Under Mounting, type a value if needed.
8. Under Backplane, type a value if needed.
9. Select the Set as intrinsically safe check box if this cabinet has intrinsic safety
certification.
10. Click the Associate Symbols tab to associate a symbol with the current cabinet.
The software will use this symbol when generating a report in the Enhanced
Report Utility. For details, see Associate a Symbol with an Item, page 734.
11. Click Revisions to manage the revisions of the new cabinet if needed.
12. Click OK to accept your definitions for the new cabinet and close this dialog box.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 1042
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
Create an Amplifier
1. In the Domain Explorer, double-click the Panels by Category folder and expand
the Telecom Panels folder.
2. Expand the Equipment Cabinets folder and then right-click a PA cabinet to
which you want to add an amplifier.
3. On the shortcut menu click New > Amplifier.
4. On the New Wiring Equipment dialog box, type a name for the new amplifier
and click OK.
5. On the Wiring Equipment Properties - Amplifier dialog box, on the General
tab, under Name, accept or type a name of the new amplifier.
6. Select the Double width check box if the amplifier occupies a double width slot
or position.
7. In the Details group box do the following as you require:
a. Type a description.
b. Select an amplifier type, model, and manufacturer. If the required value is not
available on the list, click to define a new one.
c. Enter a sequence if you need to define the amplifier sequence.
8. Click the Category Properties tab.
9. Revise and modify category property values as you require. Click the value for
each property and modify it as needed.
Tip
• Wiring equipment categories that are shipped with SmartPlant
Instrumentation have predefined properties. You cannot delete or
rename any of these categories or their properties. You can only edit
their values. However, you can add user-defined properties to any
category which you can rename or delete as you wish. For details, see
Customize and Use Wiring Equipment Categories, page 790.
10. Click OK to accept your settings and close the dialog box.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 1042
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 1042
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 1042
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
9. Select the Set as intrinsically safe check box if this cabinet has intrinsic safety
certification.
10. Click the Associate Symbols tab to associate a symbol with the current cabinet.
The software will use this symbol when generating a report in the Enhanced
Report Utility. For details, see Associate a Symbol with an Item, page 734.
11. Click Revisions to manage the revisions of the new cabinet if needed.
12. Click OK to accept your definitions for the new cabinet and close this dialog box.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 1042
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
12. Click OK to accept your definitions for the new rack and close this dialog box.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 1042
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
Create a Switch
1. In the Domain Explorer, expand the Telecom Panels folder, which is located
within the Panels by Category folder.
2. Expand the Equipment Cabinets folder to display the existing PABX cabinets.
3. Double-click a PABX cabinet to display the existing PABX racks.
4. Right-click a PABX rack to which you want to add a new switch and then on the
shortcut menu, click New > Switch.
5. On the New Wiring Equipment dialog box, type a name for the new switch and
click OK.
6. On the Wiring Equipment Properties - Switch dialog box, on the General tab,
under Name, accept or type a name of the new switch.
7. Select the Double width check box if the amplifier occupies a double width slot
or position.
8. In the Details group box do the following as you require:
a. Type a description.
b. Select an amplifier type, model, and manufacturer. If the required value is not
available on the list, click to define a new one.
c. Enter a sequence if you need to define the switch sequence.
9. Click the Category Properties tab.
10. Revise and modify category property values as you require. Click the value for
each property and modify it as needed.
Tip
• Wiring equipment categories that are shipped with SmartPlant
Instrumentation have predefined properties. You cannot delete or
rename any of these categories or their properties. You can only edit
their values. However, you can add user-defined properties to any
category which you can rename or delete as you wish. For details, see
Customize and Use Wiring Equipment Categories, page 790.
11. Click OK to accept your settings and close the dialog box.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 1042
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 1042
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
7. Select an appropriate telephone state and usage. If the values that you need do not
exist on the Telephone state and Telephone usage lists, you can add them in the
Telecom supporting tables in the Wiring module. To do this, in the Wiring
module, click Tables > Telecom > Telephone State or Telephone Usage.
8. Click OK.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 1042
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 1042
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 1042
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
3. On the Hub Cabinet Properties dialog box, on the General tab, under Panel,
type the name of the new cabinet.
4. Select the required values from the Type, Manufacturer, Model, Area
classification, and Location lists. If the required value is not available, click
next to the relevant list arrow to open the appropriate supporting table.
5. Under Dimensions, type a value for the cabinet dimensions if needed.
6. Under Maximum number of racks, type a value to set the maximum number of
racks that will be possible to create in this cabinet.
Tip
• Type zero if you want to have an unlimited number of racks.
7. Under Mounting, type a value if needed.
8. Under Backplane, type a value if needed.
9. Select the Set as intrinsically safe check box if this cabinet has intrinsic safety
certification.
10. Click the Associate Symbols tab to associate a symbol with the current cabinet.
The software will use this symbol when generating a report in the Enhanced
Report Utility. For details, see Associate a Symbol with an Item, page 734.
11. Click Revisions to manage the revisions of the new cabinet if needed.
12. Click OK to accept your definitions for the new cabinet and close this dialog box.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 1042
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
6. Select the Double width check box if the hub occupies a double width slot or
position.
7. In the Details group box do the following as you require:
a. Type a description.
b. Select a hub type, model, and manufacturer. If the required value is not
available on the list, click to define a new one.
c. Enter a sequence if you need to define the hub sequence.
8. Click the Category Properties tab.
9. Revise and modify category property values as you require. Click the value for
each property and modify it as needed.
Tip
• Wiring equipment categories that are shipped with SmartPlant
Instrumentation have predefined properties. You cannot delete or
rename any of these categories or their properties. You can only edit
their values. However, you can add user-defined properties to any
category which you can rename or delete as you wish. For details, see
Customize and Use Wiring Equipment Categories, page 790.
10. Click OK to accept your settings and close the dialog box.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 1042
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
8. Click OK.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 1042
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 1042
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
4. Select the required values from the Type, Manufacturer, Model, Area
classification, and Location lists. If the required value is not available, click
next to the relevant list arrow to open the appropriate supporting table.
5. Under Dimensions, type a value for the cabinet dimensions if needed.
6. Under Maximum number of racks, type a value to set the maximum number of
racks that will be possible to create in this cabinet.
Tip
• Type zero if you want to have an unlimited number of racks.
7. Under Mounting, type a value if needed.
8. Under Backplane, type a value if needed.
9. Select the Set as intrinsically safe check box if this cabinet has intrinsic safety
certification.
10. Click the Associate Symbols tab to associate a symbol with the current cabinet.
The software will use this symbol when generating a report in the Enhanced
Report Utility. For details, see Associate a Symbol with an Item, page 734.
11. Click Revisions to manage the revisions of the new cabinet if needed.
12. Click OK to accept your definitions for the new cabinet and close this dialog box.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 1042
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
a. Type a description.
b. Select a intercom type, model, and manufacturer. If the required value is not
available on the list, click to define a new one.
c. Enter a sequence if you need to define the intercom sequence in the cabinet.
8. Click the Category Properties tab.
9. Revise and modify category property values as you require. Click the value for
each property and modify it as needed.
Tip
• Wiring equipment categories that are shipped with SmartPlant
Instrumentation have predefined properties. You cannot delete or
rename any of these categories or their properties. You can only edit
their values. However, you can add user-defined properties to any
category which you can rename or delete as you wish. For details, see
Customize and Use Wiring Equipment Categories, page 790.
10. Click OK to accept your settings and close the dialog box.
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
• Managing Equipment Cabinets and Equipment Items Common Tasks,
page 1042
• Telecom Design: An Overview, page 1025
• Working with Old Equipment, page 1030
Related Topics
• Arrangement of Telecom Items in the Domain Explorer, page 1028
• Flow of Activities for Telecom Design, page 1026
Related Topics
• Flow of Activities for Telecom Design, page 1026
• Generating Telecom Reports Common Tasks, page 1059
• Telecom Design: An Overview, page 1025
• Click Reports > Telecom Tables > Standard Telecom Type List.
• Click Reports > Telecom Tables > Detailed Telecom Type List.
3. When prompted to preview the new report, click Yes. Click No to print out the
report without opening its print preview.
Related Topics
• Flow of Activities for Telecom Design, page 1026
• Generating Telecom Reports Common Tasks, page 1059
• Telecom Design: An Overview, page 1025
Related Topics
• Flow of Activities for Telecom Design, page 1026
• Generating Telecom Reports Common Tasks, page 1059
• Telecom Design: An Overview, page 1025
Related Topics
• Flow of Activities for Telecom Design, page 1026
• Generating Telecom Reports Common Tasks, page 1059
• Telecom Design: An Overview, page 1025
The Loop Drawings module generates loop drawings by means of a fast build
process. By configuring typical drawing blocks for key instrument types, the loop
components can be automatically initialized with their corresponding graphical
elements. The Loop Drawings module enables you to create loop drawings that
include data retrieved from the database and if required, from an external file.
There must be a correlation between the file formats supported by your CAD
application and the file format in which you save a new drawing block. Standard
drawing blocks exist for each of the following CAD applications (shown with the
appropriate file extension):
You define and manage blocks in the Drawing Block Types folder of the Domain
Explorer. After you define blocks and organize them according to their block types,
you can perform block association procedures, which depend on the block type of the
source block. Blocks that are already associated with specific loops or instruments
appear in the Loops folder of the Domain Explorer. For details of the available
block types, see Block Types: An Overview
You organize blocks according to block types in the Drawing Block Types folder of
the Domain Explorer. At this level, the software displays all the block types that
exist in the current domain and allows you to add general and instrument block types
and manage block type properties. All block types that appear in the current <plant>
also appear in all <plants> that exist in the domain.
The following drawing block types are available in the Drawing Block Types folder
of the Domain Explorer:
• Loop Block ( ) — A shipped block type that allows you to define, edit
or duplicate a block that you can associate with a loop number. The Loop
Block folder is the only folder of the Domain Explorer where you can
define and manage loop blocks. Loop blocks are shown as . After
defining a loop block, you can assign it directly to a loop number in the
Loops folder of the Domain Explorer. When generating a CAD loop
drawing using a loop block, the generation is based on a single template
block file that can include references to all tags in the loop. For more
details, see Loop Blocks: An Overview, page 1069.
• Instrument Block ( ) — A user-defined block type that allows you to
define, edit, or duplicate a block that you can associate with an instrument.
Instrument blocks are shown as . Blocks that you assign to instruments
appear at the instrument level in the Loops folder of the Domain
Explorer. When generating a CAD loop drawing using instrument
blocks, the generation is based on template CAD blocks that contain
macros specific to each instrument tag of the loop. This requires
assignment of individual drawing block files to instruments whose data
you want to display in the loop drawing (one block file per instrument). In
the generated drawing, the software displays the instrument blocks
according to their insertion points that you defined. The macros the
blocks contain retrieve data from SmartPlant Instrumentation for all the
associated instruments. You can create as many instrument block types as
you require. After defining instrument blocks, you can choose a block
assignment method to associate your blocks with specific instruments.
therefore you must define at least one instrument block type before you
can add a new block (apart from the default general block types and the
Loop Block type).
You define loop blocks and manage their properties in the same way as you do with
instrument blocks. You can only assign one loop block to a particular loop.
However, in contrast to instrument blocks, you cannot assign the same loop block to
more than one loop. Therefore, when duplicating a loop that already has a loop block
assigned, the software ignores the loop block for the duplicated loop.
In loop drawing generation, the loop block has the highest generation priority. The
software ignores the instrument blocks when generating a loop drawing if the source
loop has a loop block and also blocks assigned to the loop instruments via the
instrument type using the automatic block assignment method.
The files in the list are the predefined drawing blocks that you can use to represent the
border / title (one of which should be defined as the default border) and the logo (one
of which should be defined as the default logo).
For more information, see Add a Block to a Block Type, page 1073.
For more information, see View a Drawing Block in a CAD Application, page 1074.
For more information, see Define Insertion Points for Blocks, page 1074.
For more information, see Copy Blocks to Another <Plant>, page 1075.
Related Topics
• Block Types: An Overview, page 1067
• Blocks in SmartPlant Instrumentation: An Overview, page 1065
• Loop Blocks: An Overview, page 1069
• Loop blocks that you add become available for association with loops
in the Loops folder of the Domain Explorer. These blocks are shown
as .
• Instrument blocks that you add become available for association with
instrument tag numbers in the Loops folder of the Domain Explorer.
In the Drawing Block Types folder, instrument blocks are shown as
. In the Loops folder, blocks assigned to instruments using the
automatic block assignment method are shown as and blocks
assigned to instruments using the manual block assignment method are
shown as .
Related Topics
• Managing CAD Drawing Blocks Common Tasks, page 1072
Related Topics
• Managing CAD Drawing Blocks Common Tasks, page 1072
Tip
• You can only define insertion points for blocks shown as . These
blocks are assigned to instruments using the manual block assignment
method. If your block selection in the Items pane includes
automatically assigned blocks, (shown as ), you need to redefine
your selection.
3. On the shortcut menu, click Actions > Define Block Origin.
4. On the Define Block Origin dialog box, select a block.
Tip
• If there is a large number of blocks in the data window, under Find,
select a column heading and then type a value. For example, if you
select Tag Number as a column heading and type a specific tag
number, in the data window, the software finds the block assigned to
this tag number.
5. Under Tag assignments, enter the required values (in the CAD application units)
for the block new insertion point X- and Y-coordinates.
Tip
• The block origin can consist of numbers that include decimal values,
for example, 9.85.
Related Topics
• Managing CAD Drawing Blocks Common Tasks, page 1072
Tips
• The blocks that you copy appear in the appropriate block type of the
target plant. The block types you define in the source plant
automatically appear in all the plants in the current domain because
block types are defined at the domain level.
• When copying blocks, the software does not copy any associations you
made for the blocks in the source plant.
Related Topics
• Managing CAD Drawing Blocks Common Tasks, page 1072
Tip
• If there is a large number of instrument types in the data window,
under Find instrument type, select a column heading and then type a
value. For example, if you select Description as a column heading
and type Control, in the data window, the software locates the
instrument types whose description starts with Control.
3. Click Assign.
4. If you defined several instrument block types in the Drawing Block Types folder
of the Domain Explorer, from the Block type list, select the appropriate
instrument block type.
5. Select blocks that you want to assign to the instrument type.
Tips
• If you select Show blocks of all types, the software displays all blocks
belonging to all the instrument block types that you defined n the
Drawing Block Types folder of the Domain Explorer. In addition to
instrument blocks, the software displays all user-defined general
blocks. If you assign a user-defined blocks to the instrument type, the
software displays this block in all loop drawings that include an
instrument belonging to the current instrument type.
• Click View to open a block in your CAD application.
6. Click OK and then check the block assignment in the Loops folder of the
Domain Explorer.
Tip
• In the Loops folder of the Domain Explorer, the instrument blocks
that you assigned appear under the tag numbers belonging to the
instrument type that you selected. These blocks are indicated with the
icon .
Related Topics
• Assigning Blocks Common Tasks, page 1077
Tips
• If there is a large number of blocks in the data window, under Find
block, select a column heading and then type a value. For example, if
you select Block as a column heading and type block name Control,
in the data window, the software locates the block whose name starts
with Control.
• If you want to display only specific blocks in the data window, click
Filter and specify a filter parameter.
4. In the data window, select the blocks that you want to associate and then click
OK.
5. In the Specify Drawing Pages for Blocks Assignment dialog box, under Page,
use spinners to specify pages on which you want the selected blocks to appear
after loop drawing generation.
Tips
• The Specify Drawing Pages for Blocks Assignment dialog box
opens when the source loop number is assigned to a multi-page
drawing or multi-drawing.
• In the Loops folder of the Domain Explorer, the instrument blocks
that you assigned appear under the tag numbers that you selected.
These blocks are indicated with the icon .
Related Topics
• Assigning Blocks Common Tasks, page 1077
• To update block assignments for the displayed tag number only, click
Apply and then click Next to display another tag number.
• To update block assignments for the all the tag numbers you selected
in the Domain Explorer, click Apply to All.
Related Topics
• Assigning Blocks Common Tasks, page 1077
Related Topics
• Assigning Blocks Common Tasks, page 1077
Related Topics
• Assigning Blocks Common Tasks, page 1077
Related Topics
• Assigning Blocks Common Tasks, page 1077
9. Select one or more blocks that you want to assign to the instrument type.
10. Click OK and then generate the appropriate loop drawing to display the assigned
blocks.
Tip
• User-defined general blocks are only shown in the Drawing Block
Types folder of the Domain Explorer.
Related Topics
• Assigning Blocks Common Tasks, page 1077
Loop drawing properties appear in the title block fields. These fields contain
identifying information about the document number, page number, and file name, and
also information about revisions, approvals, and references to other documents.
Related Topics
• Loop Drawing Types and Drawing Properties Common Tasks, page 1089
For more information, see Set the Date Format in CAD Loop Drawings, page 1091.
For more information, see Define a Drawing as a Multi-Page Drawing, page 1092.
For more information, see Modify Properties of a Single-Page Drawing, page 1093.
For more information, see Maintain CAD Loop Drawing Revisions, page 1093.
For more information, see Make CAD Drawing Approvals, page 1095.
For more information, see Modify Loop Drawing Identifying Information, page 1095.
For more information, see Update Paths for CAD Drawings and Block Files, page
1096.
For more information, see Associating an External CAD Drawing, page 1097.
For more information, see View an External CAD Drawing, page 1097.
Tips
• SmartPlant Instrumentation only support date formats that are listed in
this table.
• You can use one of the following characters as separators: dash (-),
slash (/), space, comma, semicolon, colon, or dot.
Related Topics
• Loop Drawing Types and Drawing Properties Common Tasks, page 1089
• You can specify an individual source path for any drawing page by
clicking to the right of the selected drawing file. A source path is a
path which software uses to locate the source file when generating a
CAD drawing that belongs to the multi-drawing type. The path that
you specify does not overwrite the path setting specified in the
Preferences dialog box. The software saves all generated loop
drawings in a designated folder that you define on the Preferences
dialog box.
Related Topics
• Loop Drawing Types and Drawing Properties Common Tasks, page 1089
Related Topics
• Loop Drawing Types and Drawing Properties Common Tasks, page 1089
Tips
• SmartPlant Instrumentation automatically adds a new line with the
next logical character and date each time you click New after you
select the initial method.
• If you are working in an integrated environment in a module that
supports publishing and retrieving of documents, clicking New opens
the Revise dialog box for the integrated environment instead of the
SmartPlant Instrumentation Revisions dialog box.
7. Add or edit the revision data in the appropriate data fields.
Tips
• The By column contains the current user initials by default, if
previously defined by the System Administrator. You can edit this
value as you require.
• You can delete obsolete revisions by clicking Delete.
• You can also maintain revisions in batch mode.
• Each revision is represented by a numbered macro and the revisions
are displayed in the order of the macro numbering, beginning with the
first revision (ascending order) or the last revision (descending order).
If the total number of revisions is greater than the number of lines
available for display in the drawing and you want to see the latest
revisions, you should set your preferences to display the revisions in
descending order so that the latest revision is displayed first.
Related Topics
• Loop Drawing Types and Drawing Properties Common Tasks, page 1089
Tips
• You can view document references to reports generated in the Wiring
module only if you have selected the Display references to wiring
reports automatically check box in the Loop Drawings > General
page of the Preferences dialog box. You cannot edit properties of
these document references.
• The time of reference creation determines the order of the references
in the title block. In the title block, the software displays the
references in descending order, according to the time of creation. This
means that the reference you create first appears in the title block at
the top of the reference list.
• If an instrument in the selected loop has a reference in a P&ID
drawing, this reference automatically appears on the Document
References dialog box. It is possible, you can edit a P&ID drawing
reference in the Instrument Index module.
Related Topics
• Loop Drawing Types and Drawing Properties Common Tasks, page 1089
Related Topics
• Loop Drawing Types and Drawing Properties Common Tasks, page 1089
Tips
• Properties that you can edit are determined by the specified drawing
type.
• The document number does not have to be unique.
• Properties that only apply to CAD drawings are indicated as such.
Other properties, such as document number and loop drawing
description, are used in both CAD loop drawings and in loop drawings
generated by the Enhanced Report Utility.
Related Topics
• Loop Drawing Types and Drawing Properties Common Tasks, page 1089
Related Topics
• Loop Drawing Types and Drawing Properties Common Tasks, page 1089
In addition to using a CAD method, you can also use the Enhanced Report Utility,
which is supplied with SmartPlant Instrumentation. This utility enables you to
generate, view, modify, and annotate loop drawings as needed. The Enhanced Report
Utility has an advantage over CAD as a loop drawing generation method in that it
requires no extra work in creating CAD drawing blocks. The report comes directly
from the database and does not necessarily require additional modifications
You can either assign each loop number to a specific method or apply the same
method to all loop numbers when generating loop drawings in batch mode. In the
Domain Explorer, for the intended method of generation, the software assigns an
appropriate generation indicator to the loop number icons.
• Intergraph SmartSketch
• AutoCAD
• MicroStation
In the generation process, SmartSketch (.sym), AutoCAD (.dwg), or MicroStation
(.dgn) type drawings are created from the selected loops.
Prerequisites
• Before generating loop drawings, make sure that CAD application paths
are set up correctly on the Preferences dialog box. For details, see CAD
Settings for SmartPlant Instrumentation, page 1102.
• If you use SmartSketch, prior to starting the generation process, in the
Preferences dialog box, you must select the check box Use macro
symbol (&) to retrieve data because in SmartSketch all macros have the
`&' prefix. If you clear the check box, the software displays only macro
attributes in the drawings.
• If you use AutoCAD, to ensure that the software displays macro captions,
on the Custom tab of the Preferences dialog box, in the Parameter box,
type TagAsMacroName and in the Value field, type Y.
Basic Principles of CAD Loop Drawing Generation
The following diagram illustrates a (schematic) flow control loop. The loop drawing
includes five drawing blocks for the following components: monitoring system,
control valve, each set of wiring connections to the DCS, and the DCS itself. The
wiring routing and control systems are conceptually the same for both tags (but with
different data), so in this example, the blocks for these items are identical.
Related Topics
• CAD Loop Drawing Generation Common Tasks, page 1111
• CAD Settings for SmartPlant Instrumentation, page 1102
• Loop Drawing Generation Methods: An Overview, page 1098
• Sample Loop Drawing (After Generation), page 1110
• Drawing Preparations
• CAD Loop Drawing Generation: An Overview, page 1099
• Insert Macros in an AutoCAD Drawing Block, page 1130
• Defining Blocks in SmartPlant Instrumentation
• Add a Block Type, page 1072
• Blocks in SmartPlant Instrumentation: An Overview, page 1065
• Loop Blocks: An Overview, page 1069
• Setting CAD Application Parameters
For details on preliminary Intergraph SmartSketch, AutoCAD or
MicroStation settings, see:
• CAD Settings for SmartPlant Instrumentation, page 1102
• SmartPlant Instrumentation and MicroStation: An Overview, page
1147
• Customizing SmartPlant Instrumentation Macro Definitions (if
required)
• Customizing Macro Definitions: An Overview, page 1132
• Working with User-Defined Macro Functions: An Overview, page
1134
• Using External Macro Data Sources: An Overview, page 1139
• Making Block Associations
• Associate Instrument Blocks Automatically (via Instrument Type), page
1079.
• Apply Associated Blocks to all Tag Numbers Belonging to a Specific
Instrument Type, page ???
• Associate Instrument Blocks Manually, page 1081.
• Performing the Generation Process
• Generate CAD Loop Drawings, page 1112
For more information, see Apply Loop Drawing Generation Method, page 1112.
For more information, see Generate CAD Loop Drawings, page 1112.
For more information, see Show the Latest Generated CAD Drawing, page 1115.
The loop generation history feature compares the retrieval values of macros from
different generations. Therefore, the history data is available when you have already
generated at least one loop drawing for a selected loop.
For more information, see Display CAD Loop Drawing Generation History, page
1115.
For more information, see Clear Previous Macro Result Records, page 1117.
Related Topics
• CAD Loop Drawing Generation: An Overview, page 1099
• CAD Settings for SmartPlant Instrumentation, page 1102
• Loop Drawing Generation Methods: An Overview, page 1098
• Sample Loop Drawing (After Generation), page 1110
Tip
• If among the loops that you selected there are loops assigned to the
Manual method (symbol M in the Explorer), the software skips these
loops when generating drawings in batch mode.
3. On the shortcut menu, click Reports > Generate Loop Drawings.
4. On the Generate Loop Drawings dialog box, from the Generation method list,
select CAD.
5. Under Automatic save options, select Save drawing automatically and do one
of the following:
• In the Output drawing path data field, type the exact folder path to
which you want to save the generated drawing.
• Click Browse to navigate to the desired path for saving the file.
6. Click CAD Options, and then, from Save file in format list, specify the CAD file
format in which to save the generated drawings (if your CAD application supports
more than one file format).
7. Select the following check boxes:
• Send to plotter or printer— Sends the generated drawing to the
current CAD plotter.
• Use macro functions — Applies macro functions associated with the
macros.
• Save output data to database— Enables you to compare drawing
data of the current generation to data of a subsequent generation made
for the same loop.
8. Under Generation criteria, do one of the following:
• Click Per loop to generate drawings for all the loops you selected.
• Click Per page and then type the desired page number to generate
only a specific drawing page for the drawings you selected.
• Click Per block to select a block from the list and generate drawings
only for the loops that to which you assigned this block.
Tip
• The Per block option is useful when you select several loops in the
Items pane of the Domain Explorer. If your selection includes loops
that do not contain the block that you selected, the software does not
generate loop drawings for those loops. For the loops that do contain
the selected block, the software includes all of the blocks when
generating loop drawings. For example, if you selected five loops and
each of them has the block that you selected and also has three other
different blocks, the software includes all of these blocks in the
generated loop drawings. The blocks displayed in the lists are blocks
associated with instruments using the manual block assignment
method. In the Loops folder of the Domain Explorer, these blocks
are shown as are shown with the icon.
9. Under Create report about, select which reports you want to generate:
• Null data— Displays macro strings in the drawing for which
SmartPlant Instrumentation data is unavailable.
• Invalid macros— Displays macro strings in the drawing which are
not defined in SmartPlant Instrumentation.
Tip
• You can select to generate both reports if needed.
10. Under Mark drawing using, select the options for which you want to display a
text string, specified in the adjacent text box:
• String for null data— Allows you to type a string that indicates in
the drawing those macros for which SmartPlant Instrumentation data is
unavailable.
• String for invalid macros— Allows you to type a string that
indicates in the drawing those macros which are not defined in
SmartPlant Instrumentation.
11. If you need to use macros from an external source during the current loop drawing
generation, under External data, select the Use external macro source check
box, and then click Define.
12. Click OK to start the loop drawing generation process in your CAD application.
Tip
• If your CAD application is SmartSketch, by default, all drawings that
you generate have the A3 Wide print sheet size. This print sheet size
is defined in the template file pid.igr, which comes shipped with
SmartPlant Instrumentation. This file appears in the CADFunc folder,
for which you specified the path setting on the Preferences dialog
box, Loop Drawings > CAD File Locations page. If you want to
generate loop drawings using a different print sheet size, you must
open the pid.igr file in SmartSketch and modify the sheet settings as
you require. Note, however, that changes that you make in the pid.igr
file affect both loop drawings and hook-up drawings you generate in
SmartSketch. If you want the print sheet size of loop drawings not to
affect the print sheet size of hook-up drawings, duplicate the
CADFunc folder with all its content and define a different path setting
preference for hook-up drawings on the Hook-Ups > CAD File
Locations page.
Related Topics
• CAD Loop Drawing Generation Common Tasks, page 1111
• In the Loop Drawings module, click Actions > Show Latest Generated
Drawing.
Related Topics
• CAD Loop Drawing Generation Common Tasks, page 1111
4. Under History data, select one of the following check boxes or both check boxes:
• Select Display in the drawing to display history data in the generated
drawing.
• Select Display in the report to display the Data Changes Report
before proceeding with the loop generation. The report includes the
tag number, block name, macro name and description, old value and
the new value.
5. Do one of the following:
• Click Show data from previous generation to display the old history
value from the previous generation.
• Click Mark with user-define value and type a new value in the box
below. This marks the drawing or the report with the new value
instead of the old history value from the previous generation.
Tips
• In the generated drawing or report, the software displays the old value
in parentheses.
• If you selected Display in the report, the software displays the Data
Changes Report before proceeding with the loop generation. After
printing or viewing the report, click OK to return to the Generate
Loop Drawings dialog box.
6. Click OK to start the generation process.
Notes
• When comparing a loop drawing that you have just generated with an
older one, you have to set the comparison date range to include both
generations. If that date includes more than one loop drawing, select the
exact loop drawing to which you want to compare the currently generated
one.
• The results show a comparison of the current data in the loop drawing
with the data stored in the history for the specified date range or
generation.
Related Topics
• CAD Loop Drawing Generation Common Tasks, page 1111
Related Topics
• CAD Loop Drawing Generation Common Tasks, page 1111
Related Topics
• CAD Loop Drawing Generation Common Tasks, page 1111
The type of data that the software can retrieve depends on whether you are working
with loop drawings or hook-up drawings. For loop drawings, you can retrieve data for
the following item types:
• Domain definitions
• Plant hierarchy items
• Documents
• Revision information
• Loop data and instrument tag numbers
• Wiring data (including connection information)
• Process data
• Specifications data
• Loop drawing data
• Hook-up drawing data
For hook-up drawings, you can retrieve data for the following item types:
• Domain definitions
• Plant hierarchy items
• Documents
• Revision information
• Instrument tag numbers
• Process data
• Hook-up drawing data
All of the standard SmartPlant Instrumentation macros are displayed on the Macro
Definitions dialog box.
• Enhanced reports — You can add macros to the various symbols used to
represent items that appear in enhanced reports using the Symbol Editor,
or you can add macros directly in an enhanced report after generation. For
further details, see Using Macros: An Overview in the Enhanced Report
Utility User's Guide.
• CAD drawings — To display data in CAD drawings, you must add them
to the blocks that are used in generating the drawings. For further details,
see Using Macros in CAD Blocks: An Overview, page 1129.
Related Topics
• Customizing Macro Definitions: An Overview, page 1132
• SmartPlant Instrumentation Macro Structure, page 1121
• Standard Functions, page 1135
• Working with User-Defined Macro Functions: An Overview, page 1134
Certain SmartPlant Instrumentation macros that include a group level have the
following structure:
[Macro_name.x]
The letter `x' designates the group level. The group level depends on the number of
macros in a group. The software creates a group when several macros of the same
macro type are associated with a tag number. For example, when associating several
tag categories with a tag number, the system combines all the TAG_CAT macros into
a TAG_CAT.x group so that you set a separate level for each macro: TAG_CAT.1,
TAG_CAT.2, TAG_CAT.3, and so forth.
For CAD drawings only, if desired, you can associate each macro with a macro
function, which determines how the software performs string manipulation on the
target data. For example, a macro function can retrieve the entire target data string or
just part of the data string and display it on the generated drawing. Associating a
macro function with a macro is optional. For details, see Working with User-Defined
Macro Functions: An Overview, page 1134.
where F1 is the macro function abbreviation. If you set a macro function as a default,
the software automatically adds the abbreviation of the function to the macro in the
actual CAD drawings (SmartSketch, AutoCAD and MicroStation). If you do not set
a macro function as default, you need to add the macro function abbreviation
manually on the drawing.
Notes
• The separator in a macro string is a period (.), therefore within a macro
name segment, periods are not allowed.
• Some of the wiring macros have a different structure. For details, see
Wiring Module Macros - Conventions, page 1126.
General
Name Description
plant_name or plnt_name Plant name
area_name Area name
unit_name Unit name
unit_num Unit number
unit_note Note added for unit
city City where plant is located
location Location of plant
owner (owner_name) Owner name
domain_name (proj_name) Domain name
domain_desc (proj_desc) Domain description
eng_proj_name or proj_name (engineer_name) Project name
eng_proj_desc or proj_desc (engineer_desc) Project description
date Date of drawing generation
time Time of drawing generation
Loop
Name Value Description
loop_name Loop name
loop_serv Loop service
loop_note Loop note
ref_name 1..5 Loop drawing reference name (for revisions 1 to 5)
ref_desc 1..5 Loop drawing reference description (for revisions 1 to 5)
Telecom Line
Name Description
line_name (tc_line_number_name) Telecom line name
Telecom Class
Name Description
class_name (tc_net_cls_name) Telecom class name
Telecom Speaker
Name Description
cmpnt_name Telecom speaker name
cmpnt_note Telecom speaker note
Cable
Name Description
cable_name (cable_num) Cable name
cable_note Cable note
Cable Harness
Name Description
harness_name (cable_harness_name) Cable harness name
Location
Name Description
location_name (panel_loc_name) Panel location
Rack
Name Description
rack_name (cabinet_rack_name) Cabinet rack name
Hook-Up
Name Description
hu_name Hook-up name
gen_output_file Hook-up output file name
Drawing
Name Value Description
dwg_name Drawing name
dwg_desc Drawing description
dwg_num Drawing number
cl_ck_by or cl_chk_by Client checked by
cl_ck_date or cl_chk_date Client checked date
cl_engr_by Client engineered by
cl_engr_date Client engineered date
cl_appr_by Client approved by
cl_appr_date Client approved date
ven_appr_by Vendor approved by
ven_appr_date Vendor approved date
ven_chk_by or ven_ck_by Vendor checked by
ven_ck_date or ven_chk_date Vendor checked date
ven_drwn_by Vendor drawn by
ven_drwn_date Vendor drawn date
ven_dsgn_by Vendor design by
ven_dsgn_date Vendor design date
ven_prop_by Vendor proposed by
ven_prop_date Vendor proposed date
loop_func (loop_func_name) Loop function
dwg_udf_c01... - ...dwg_udf_c102 Drawing user-defined character
fields
loop_udf_c01... - ...loop_udf_c50 Loop user-defined character fields
curr_rev_name (current revision 1 Current revision name
number)
pid_name P&ID drawing name
Sheetno Current sheet number
Sheettotal Total number of sheets
Revisions
These macros have the structure [Macro_name.x.f1] where x is the revision number
(max.value =5), and f1 is the abbreviation for a user-defined function (optional).
When you create a tag number and a matching device panel, the software creates a
group that includes all the wires associated with that specific tag. Each wire can
belong to one group only. Once you connect a cable with the device panel, the
software sorts the wires into different group levels. Every connection of a wire to a
terminal is assigned a group sequence that maps and numbers the connections
starting with the value `1' that is usually on the device panel side.
The following diagram is an example that explains the meaning of wire groups.
Before you can start to build typical wiring drawing blocks, you need to know:
Syntax
The syntax used for wiring macros is as follows:
[Macro_name.x.y]
where the letter `x' designates the group level and the letter `y' designates the group
sequence.
Examples
The following examples show how the wiring macro syntax is used to retrieve
specific data for a terminal and for a wire:
• For CAD drawings only, if desired, you can associate each macro with a
macro function, which determines how the software performs string
manipulation on the target data. For example, a macro function can
retrieve the entire target data string or just part of the data string and
display it on the generated drawing. Associating a macro function with a
macro is optional.
The general format of a wiring macro that includes a user-defined macro
function is [Macro_name.x.y.F1].
For further details, see Working with User-Defined Macro Functions: An
Overview, page 1134.
You can assign one or more macros to each block. Some macros are used for
retrieving data for instruments with the same function. For example, flow
transmitters, flow elements, and I/P transducers have a common function. Therefore
the same macros are used to retrieve the data for each of these instruments. The
macros required for each of these instruments are the tag prefix (TAG_PRFX),
instrument type (FUNC_ID), tag number (TAG_NUMC), and tag suffix
TAG_SUFF).
The diagrams below display a loop drawing that was generated along with its related
macros. This example illustrates how the same macros can be used to extract the
same or different data for different tag numbers - the Tag Prefix and Tag Number are
identical for each of the three instruments. However, the instrument type is different,
although represented by the same macro.
Note
• For the instruments in this example, the tag suffix was not used.
Loop Drawing with Macros Generated Loop Drawing
If you have used the standard drawing blocks supplied with SmartPlant
Instrumentation, or if you created your own drawing blocks with the predefined
macros, SmartPlant Instrumentation recognizes these macros when generating the
loop drawings, and you do not need to make any modifications to them. However,
you may want to modify macros in the following circumstances:
• If your drawings include macro names other than the predefined ones, you
can customize the default macro definitions as required. For details, see
Customizing Macro Definitions: An Overview, page 1132.
• If you want to modify certain display formatting of the macros, you can
specify user-defined macro functions. For details, see Working with User-
Defined Macro Functions: An Overview, page 1134.
• If you want to use an external data source other than the SmartPlant
Instrumentation database for displaying information defined by a macro,
you can connect to the appropriate database and use the macros defined in
that database. For details, see Using External Macro Data Sources: An
Overview, page 1139.
Related Topics
• Blocks in SmartPlant Instrumentation: An Overview, page 1065
• Macros in SmartPlant Instrumentation: An Overview, page 1119
• Steps in Loop Drawing Generation Using a CAD Application, page 1101
Tip
• You can have AutoCAD automatically enter most of the above
parameters by using the ATT AutoLISP application. This application
is automatically installed if you select AutoCAD as your default CAD
interface. By using the ATT application you only need to enter the
macro name once, and enter the start point, height and rotation
parameters.
Related Topics
• Define Insertion Points for Blocks, page 1074
Notes
• Other users working in the same domain or in the same project (when the
domain type is Owner operator) can use your customized macro
definitions.
• A macro name can contain a maximum of 30 characters.
• If you want to assign a macro function to a macro directly on a drawing,
you can add a function abbreviation of up to 4 characters to the macro.
The total number of allowed characters, including separators (periods) is
50.
• To see the entire list of SmartPlant Instrumentation macros, you can
generate a macro report for the type of drawings you are working with
(hook-ups or loop drawings). For more details, see Generate a Macro
Report, page 1128.
• Plug and Socket macros, for example PIN_NAME, are not supported in
CAD generation.
Related Topics
• Create a New Macro Definition, page 1132
• Delete a Macro Definition, page 1133
• Using Macros in CAD Blocks: An Overview, page 1129
Tip
• If there are a large number of macro definitions in the Macro
definition details data window, under Find macro definition, select a
column heading and then type a value. For example, if you select
Function as a column heading and type a macro function value, in the
data window, the software locates the macro definition to which that
macro function belongs.
4. To create a customized macro definition, do one or more of the following:
a. Under User-Defined Macro Name, type the desired user name for your
macro.
b. Click in the Description field and change the description as desired.
c. Under Macro Function, select a macro function to modify the appearance of
the retrieved data.
5. To add another customized macro definition, click New and repeat the previous
step.
6. Click Apply to accept your customized macro definitions.
Related Topics
• Customizing Macro Definitions: An Overview, page 1132
• Using Macros in CAD Blocks: An Overview, page 1129
The macro function affects the display formatting of the data which the macro returns
after generation. For example, you can specify a user-defined function that removes
all the spaces in the retrieved values and displays the remaining characters as upper
case.
You can apply functions to macros directly on the CAD drawing or in the database.
The general format of a wiring macro that includes a user-defined macro function is:
[Macro_name.x.y.F1]
Example
The following is an example of a macro with a function:
W_CLR.1.1.RS
In this example, the macro name is W_CLR.1.1 and the macro function is RS
(remove spaces).
Notes
• Use a period (.) as the separator to separate the individual macro segments.
• The software uses the macro function parameters.
• When using a macro function at the database level, you should not define
that macro function on the drawing block or in the generated drawing. For
the software to recognize macro functions defined at the database level, on
the Preferences dialog box, under Loop Drawings > General, select the
Use macro functions check box. If you set a macro function as default,
the software automatically adds the abbreviation of the function to the
macro in the actual CAD drawings, and you do not need to add it with
every block and macro. If you do not set a macro function as default, you
need to add the macro function abbreviation manually on the drawing.
Related Topics
• Customizing Macro Definitions: An Overview, page 1132
• Macros in SmartPlant Instrumentation: An Overview, page 1119
• Standard Functions, page 1135
Standard Functions
A standard macro function is a function that is supplied with the software and
contains a set of predefined commands. You can associate a standard function with
SmartPlant Instrumentation macros or specify a combination of standard functions to
create a user-defined macro function.
SmartPlant Instrumentation has six standard macro functions. The following table
shows how each of the standard functions modifies the macro string.
Note
• You cannot change the code of standard macro functions.
Related Topics
• Working with User-Defined Macro Functions: An Overview, page 1134
Caution
• If you want to use macro function abbreviations in loop block macros,
make sure the macro function abbreviation is different from an
instrument type abbreviation, which is a required segment in the loop
macro function string. For details about loop blocks and loop block
macro structure, see Loop Blocks: An Overview, page 1069.
4. To superpose a standard function, do the following:
a. Click Insert to open the Standard Macro Functions dialog box.
b. Select a standard function and click OK.
c. If you selected a standard function that can accept parameters, specify
appropriate values in the fields. For details, see Standard Functions, page
1135.
Tip
• The user-defined macro function operates in the macro string
according to the order of the standard functions superposition. Use
Move Up and Move Down to change the order of the standard
functions.
5. Click OK to confirm your changes and close the User-Defined Macro Function
Properties dialog box.
6. Do one of the following:
• Select Set macro function as default to apply the specified macro
function to all existing macros.
• Clear Set macro function as default to be able to associate the
specified macro function with a specific macro.
Related Topics
• Delete a User-Defined Macro Function, page 1138
• Modify a User-Defined Macro Function, page 1137
• Standard Functions, page 1135
Related Topics
• Modify a User-Defined Macro Function, page 1137
Notes
• To be able to use an external macro source, you need to establish a
connection to the macro source in the Define External Macro Source
dialog box.
• In your target drawing blocks or symbols, you need to add the E_ prefix to
the name of the macro that you want to use to retrieve data from the
external macro source.
For example, if a drawing contains an external macro named PROCESS which is
used to retrieve the string Flow, the macro label must be written as E_PROCESS.
This means that after generation, every occurrence of the label E_PROCESS in the
drawing will be replaced with the value Flow.
Related Topics
• Assigning an External Macro Data Source, page 1146
• Connecting to an External Data Source, page 1142
• External Macro Structure Conventions, page 1141
The following table is an example of an external source structure (the table headers
below exemplify column names):
In the above example, using the macro macro1 in a loop drawing generated for
instrument tag 108-PI-2212, will display the retrieved value Pressure instead of the
macro1 string. You can create the above structure by using any text editing
application (for Text format files), dBase (*.dbf) editing tools, or any other
appropriate database editing utility. For further details, see the user's guide for your
database platform.
Important
• The name of the first (leftmost) column name must always be
cmpnt_name (representing the tag number).
Related Topics
• Assigning an External Macro Data Source, page 1146
• Connecting to an External Data Source, page 1142
• External Macro Naming Conventions, page 1140
You can connect to any of the following database platforms and files:
• Oracle (only if you have selected Oracle as your current database platform
during Setup or you installed an Oracle client manually)
• Microsoft SQL Server (only if you have select SQL Server as your current
database platform during Setup or you installed a SQL Server client
manually)
• Sybase Adaptive Server Anywhere (only if you have selected Sybase
Adaptive Server Anywhere as your current database platform during Setup
or you installed a Sybase Adaptive Server Anywhere client manually)
• Microsoft Access
• *.dbf
• ASCII delimited files
• Excel worksheets
• Text files
Important
• The external database file with source macros must not reside in the
SmartPlant instrumentation home folder.
Note
• You can connect to database platforms (Oracle, SQL Server or Sybase
Adaptive Server Anywhere) other than your current database platform but
you have to comply with the external database platform requirements. For
example, if your current database platform is Sybase Adaptive Server
Anywhere and you want to import data from Oracle, you must have an
Oracle client installed and running on your computer. See Internal Setup
Utility to learn how to configure your environment to connect to database
platforms other than your current database platform.
Related Topics
• Assigning an External Macro Data Source, page 1146
• Connecting to an ODBC Profile, page 1144
• Connecting to Database Platforms Other Than ODBC, page 1145
• External Macro Structure Conventions, page 1141
• Prerequisites for Connecting to a dBase ODBC Profile, page 1143
• dBase (.dbf)
• Excel worksheets
• ASCII delimited files
• Text files
Note
• If you want to connect to dBase (.dbf file), you must create an ODBC
profile in accordance with your Windows system. For more details, see
Prerequisites for Connecting to a dBase ODBC Profile, page 1143.
Related Topics
• Assigning an External Macro Data Source, page 1146
• Connecting to an External Data Source, page 1142
Related Topics
• Assigning an External Macro Data Source, page 1146
Notes
• To be able to use an external macro source, you need to establish a
connection to the macro source in the Define External Macro Source
dialog box.
• In your target drawing blocks or symbols, you need to add the E_ prefix to
the macros which you want to use to retrieve data from an external macro
source.
Notes
• SmartPlant Instrumentation use of the term block corresponds to the term
cell in MicroStation.
• This section explains how MicroStation works with SmartPlant
Instrumentation. All the topics in this section require a basic level of
familiarity with MicroStation. Refer to the MicroStation user manual for
detailed explanations of MicroStation functionality.
Related Topics
• Set MicroStation for SmartPlant Instrumentation, page 1148
System Requirements
Minimum hardware and software requirements must be met before installing
MicroStation on your computer.
Tip
• When working with MicroStation 95, SE or J, the Conserve Memory
check box must be cleared.
3. Under Category, select Operation and ascertain that your settings are as follows:
Setting Value
Locate Tolerance 10
Pointer Size Normal
Pointer Type Orthogonal
Display Levels Names
Immediately Save Design Changes Selected
Save Settings on Exit Cleared
Compress Design on Exit Cleared
Enter into Untitled Design Selected
Reset Aborts Fence Operations Selected
Level Lock Applies for Fence Operations Selected
Use Semaphore File for Locking Cleared
Tip
• When working with MicroStation, the Immediately Save Design
Changes check box must be selected to enable viewing or generation
of loop drawings if MicroStation was not previously launched.
4. Under Category, select Tags and ascertain that your settings are as follows:
Setting Value
Prompt on Duplicate Tag Sets Cleared
Use Design File Tag Sets by Default Cleared
Place Tags in Same Graphic Group Cleared
Related Topics
• SmartPlant Instrumentation and MicroStation: An Overview, page 1147
5. Double click the cursor to open the Attach Tags dialog box.
Tip
• If you want to display another tag set, such as the loop tag set, open
the Attach Tags dialog box and repeat steps 3 - 5.
6. Click OK to display the tags on the desktop.
7. Move the tags, without clicking, to the desired location. Below is a typical
example.
8. Click the left mouse button when the tag position is appropriate.
The tag is now associated with the design element (the rectangle in this case).
Related Topics
• Add a Cell to the Cell Library, page 1157
Tip
• Fencing an area automatically opens the Cell Library window. Prior
to saving a cell in the cell library you need to define the cell origin.
Related Topics
• Previewing a Cell, page 1158
Previewing a Cell
When several cells are listed in the cell library, it is recommended that you preview a
cell to make sure that you have selected the correct one. This procedure explains how
to generate a thumbnail view of the cell.
Preview a Cell
• Open the appropriate cell library, and click the cell that you want to
preview.
A thumbnail view of the cell appears in the Print Preview pane.
You can perform various actions in the Reference Explorer, the Domain Explorer,
and the Hook-Ups module.
In the Hook-Up Item Libraries folder of the Reference Explorer, you define your
item libraries, create and manage hook-up items. You need to set a specific library as
the active item library, which becomes your <plant> default library. The
completeness of this library is up to the user.
In the Hook-Ups folder of the Domain Explorer, which depicts the hierarchy of
hook-up data, you can organize hook-ups in hook-up types and associate hook-ups
with instrument tags and hook-up items. You can determine the name of each hook-
up and hook-up type based on your specific requirements. After that, you can
generate hook-up drawings using the Enhanced Report Utility or your CAD
application.
Using the Hook-Ups module options, you generate various hook-up reports and a Bill
of Material, define hook-up item manufacturers, make hook-up macro definitions,
and so forth.
Related Topics
• Hook-Up Drawing Generation: An Overview, page 1184
• Hook-Up Reports: An Overview, page 1205
• Managing Hook-Up Drawings Common Tasks, page 1186
• Managing Hook-Up Items and Libraries Common Tasks, page 1164
• Managing Hook-Ups Common Tasks, page 1173
SmartPlant Instrumentation allows you to define a large number of hook-up items and
group them in item libraries and sub-libraries. You create and manage item libraries
in the Reference Explorer. A new item library that you create automatically
contains a default sub-library, which you can use for assigning hook-up items if you
do not work with pipe specs. For more information on implementation of pipe specs
in SmartPlant Instrumentation, see Pipe Specs: An Overview, page ???. When
defining a new item in SmartPlant Instrumentation, you can enter a number of hook-
up item properties, such as item size, model, material, storage number, unit of
measure, and so forth. Also, it is possible to define hook-up item manufacturers in
the Item Manufacturers the supporting table and then assign the appropriate
manufacture to the item.
You must set one item library as the active item library for your <plant>. After you
create hook-up items in this library, you can use the Domain Explorer options to
associate the appropriate sub-library with hook-ups, and then, associate specific items
with these hook-ups. After making the associations, you can generate Hook-Up Item
List reports and a Bill of Material. In the Bill Of Material, you can sort the items by
the item order. After associating hook-up items with a hook-up, the software
generates new sequence numbers automatically and allows you to sort the items by
their order of their assignment to a hook-up.
In the Reference Explorer, hook-up items are displayed in the Hook-Up Item
Libraries folder, under sub-libraries. In the Domain Explorer hook-up items are
displayed in the Hook-Ups folder, under hook-ups. Hook-up items are indicated with
the icon.
Related Topics
• Calculating the Total of Hook-Up Items for a Bill of Material, page 1207
• Hook-Up Item Libraries and Sub-Libraries: An Overview, page 1163
• Managing Hook-Up Items and Libraries Common Tasks, page 1164
• Managing Hook-Ups Common Tasks, page 1173
You must set one item library as the active item library for your <plant>. After you
create hook-up items in this library, you can associate the appropriate sub-library with
hook-ups, and then, associate specific items with these hook-ups. In the Reference
Explorer, the active item library is indicated with the icon.
Related Topics
• Hook-Up Items: An Overview, page 1162
• Managing Hook-Up Items and Libraries Common Tasks, page 1164
• Managing Hook-Ups Common Tasks, page 1173
Assign the Same Active Item Library to More Than One Plant
Use this procedure if you need to assign an existing active item library to more than
one <plant> in your domain. For more information, see Assign the Same Active Item
Library to More Than One Plant, page 1166.
Related Topics
• Hook-Up Item Libraries and Sub-Libraries: An Overview, page 1163
• Hook-Up Items: An Overview, page 1162
• Hook-Ups in SmartPlant Instrumentation: An Overview, page 1161
4. On the shortcut menu, click Actions > Set As Active item Library and change
the library icon from to .
5. Repeat this procedure for every plant to which you want to assign the same active
item library.
Related Topics
• Hook-Up Item Libraries and Sub-Libraries: An Overview, page 1163
• Managing Hook-Up Items and Libraries Common Tasks, page 1164
Tip
• The default sub-library exists in every library that you create. In
addition, you can create user-defined sub-libraries if you want to
associate pipe specs to hook-ups.
3. Right click the default or user-defined sub-library.
4. On the shortcut menu, click New > Hook-Up Item.
5. Type a unique name for the hook-up item and define other properties as needed.
6. Click OK to create the hook-up item.
Tip
• If you created a new item in a user-defined sub-library, this item
automatically appears in the default sub-library too.
Related Topics
• Create Hook-Up Items in Batch Mode, page 1168
• Hook-Up Items: An Overview, page 1162
• Managing Hook-Up Items and Libraries Common Tasks, page 1164
8. In the Increment by box, use the spinner to change the incrementing value as
needed.
Tip
• The default value in the Incremented by box is 1. When using the
default value, to ensure item name uniqueness within the current
default sub-library, the software increments every subsequent item
number in the batch of items by one digit. you can change this value
as needed. For example, if your want to create three items with prefix
MyItem, the Start from number value 5, and the Increment by
value 2, the software creates the following items: MyItem5,
MyItem7, and MyItem9.
9. Click OK to open the Hook-Up Item Properties dialog box, where you can
define properties for each item and complete the item creation.
Related Topics
• Hook-Up Items: An Overview, page 1162
• Managing Hook-Up Items and Libraries Common Tasks, page 1164
• In the tree view pane, select an item library and then, in the Items
pane, select one or more user-defined sub-libraries.
2. On the shortcut menu, click Actions > Associate Items with Sub-Libraries.
Tips
• On the dialog box that opens, the software displays all the items
available in the default sub-library of the library you selected. You
can set a filter to display only those items that you require for
association. In the filter that you require in not available in the Filter
available items list, you can click and define a new filter.
• In the dialog box panes, you can double-click a column header in the
to sort the items in ascending order. Double-click again to sort the
items in descending order.
• In the dialog box panes, there is a vertical bar that you can drag to the
right and view your data in a split display. To find the vertical bar,
place the cursor to the left of the left scroll box arrow so that the cursor
changes its shape as shown:
.
3. Under Available items, select one or more hook-up items and do one of the
following:
• Click Associate.
• Drag the selected items to the Associated items pane.
4. If you selected more than one user-defined sub-library in the Reference
Explorer, click Next to display another sub-library and associate hook-up items
as you require.
Tip
• You can associate the same items with more than one user-defined
sub-library.
Related Topics
• Managing Hook-Up Items and Libraries Common Tasks, page 1164
2. On the shortcut menu, click Actions > Associate Items with Sub-Libraries.
Tips
• On the dialog box that opens, the software displays all the items
available in the default sub-library of the library you selected. You
can set a filter to display only those items that you require for
association. In the filter that you require in not available in the Filter
available items list, you can click and define a new filter.
• In the dialog box panes, you can double-click a column header in the
to sort the items in ascending order. Double-click again to sort the
items in descending order.
• In the dialog box panes, there is a vertical bar that you can drag to the
right and view your data in a split display. To find the vertical bar,
place the cursor to the left of the left scroll box arrow so that the cursor
changes its shape as shown:
.
3. Under Associated items, select one or more hook-up items and do one of the
following:
• Click Dissociate.
• Drag the selected items to the Available items pane.
4. If you selected more than one user-defined sub-library in the Reference
Explorer, click Next to display another sub-library and dissociate hook-up items
as you require.
Related Topics
• Managing Hook-Up Items and Libraries Common Tasks, page 1164
Tips
• The software only allows you to delete those items that are not
associated with hook-ups.
• If you created user-defined sub-libraries, the software automatically
deletes the items from all the sub-libraries that exist in the library.
You can also perform item deletion from a user-defined sub-library.
Related Topics
• Managing Hook-Up Items and Libraries Common Tasks, page 1164
Create Hook-Ups
Use this procedure to add one or more hook-ups to existing hook-up types. Hook-ups
that you create under hook-up types only appear in the current <plant>. A hook-up is
a graphical representation of an assembly drawing — a drawing prototype. Adding
a hook-up to a hook-up type is a prerequisite for assigning instruments tags to hook-
ups. For more information, see Create Hook-Ups, page 1175.
You can associate a hook-up with a sub-library when performing the following
activities:
• Adding a new hook-up to a hook-up type — You can assign any new
hook-up to any sub- library.
• Editing properties of an existing hook- up
• Duplicating a hook-up
When editing or duplicating hook-up properties, you can change the existing
association of a hook- up sub-library under the following conditions:
• If the hook-up has associated instrument tags with pipe spec data, the
target user-defined sub-library must also have pipe specs suitable for
association of these tags.
• The target user-defined sub-library must contain all hook-up items that are
associated with the hook-ups.
For more information, see Change a Hook-Ups Sub-Library Association, page 1179.
Delete Hook-Ups
This option enables you to delete a hook-up which is not associated with any tag
numbers. If an association exists, first dissociate the tag numbers from this hook-up
and then delete the hook-up. For more information, see Delete Hook-Ups, page 1182.
Related Topics
• Hook-Ups in SmartPlant Instrumentation: An Overview, page 1161
• Managing Hook-Ups Common Tasks, page 1173
Create Hook-Ups
Prerequisite
• Set a specific hook-up item library as the active item library for the
current <plant>. For details, see Set an Item Library As the Active Item
Library, page 1166.
1. Press F7 to open the Domain Explorer.
2. Expand the item hierarchy of the current <plant> and do one of the following:
• Right-click the Hook-Ups folder.
• Double-click the Hook-Ups folder and then, in the Items pane, select
and right-click the hook-up type to which you want to add a new hook-
up.
3. On the shortcut menu, click New > Hook-Up.
4. If you right-clicked the Hook-Ups folder, from the Hook-up type list, select the
target hook-up type.
5. In the appropriate boxes, enter a unique name for the new hook-up and an
optional description.
6. Type a unique name for the item sub-library and an optional description.
7. From the Item sub-library list, select a sub-library to which you want to assign
the hook-up.
Tip
• If you do not work with user-defined sub-libraries, the software
assigns the hook-up to the default sub-library automatically. If you
work with user-defined sub-libraries, we recommend that you read the
topic Change a Hook-Ups Sub-Library Association, page 1179.
8. Beside Drawing block file name and path, click Browse to navigate to the
drawing block file name and path.
Tips
• Click View to open the selected drawing in the CAD application
installed on your computer.
• The path setting that appears in the Generation output path box is the
path that you specified in the Generate Hook-Up Drawings dialog
box. The software only displays the path if you already generated a
hook-up drawing for the source hook-up.
9. Click OK to create the hook-up.
Tip
• It is possible to create more than one hook-up by duplicating several
existing hook-ups that you can select in the Items pane. To display
the hook-ups in the Items pane, in the tree view pane, select the parent
hook-up type or the Hook-Ups folder. When duplicating a hook-up,
the software also duplicates all of the hook-up items that are associated
with the source hook-ups.
Related Topics
• Hook-Ups in SmartPlant Instrumentation: An Overview, page 1161
• Managing Hook-Ups Common Tasks, page 1173
• In the dialog box panes, you can double-click a column header in the
to sort the items in ascending order. Double-click again to sort the
items in descending order.
4. Under Available instrument types, select one or more instrument types and do
one of the following:
• Click Associate.
• Drag the selected items to the Associated instrument types pane.
5. If you selected more than one hook-up type in the Domain Explorer, click Next
to display another hook-up type and associate instrument types as you require.
Related Topics
• Hook-Ups in SmartPlant Instrumentation: An Overview, page 1161
• Managing Hook-Ups Common Tasks, page 1173
• In the dialog box panes, there is a vertical bar that you can drag to the
right and view your data in a split display. To find the vertical bar,
place the cursor to the left of the left scroll box arrow so that the cursor
changes its shape as shown:
.
• Under Available tag numbers, tags displayed in italics indicate tags
that are already assigned to another hook-up. You can still associates
these tags with the current hook-up. Click the Hook-Ups button above
the Available tag numbers pane to display tag numbers available for
association with hook-ups and also display existing hook-up
associations.
• If the specified hook-up is assigned to a user-defined sub-library with
pipe specs, the software filters the tag numbers so that only tag
numbers with the appropriate pipe spec data are displayed. The
software only displays tag numbers whose pipe spec data fits the pipe
specs assigned to the sub-library to which the hook-up belongs.
• You can display the available tag numbers either on the highest or
lowest level of your plant hierarchy defined by the Domain
Administrator. The default highest level is Plant. The default lowest
level is Unit.
5. Under Available tag numbers, select one or more tags and do one of the
following:
• Click Associate.
• Drag the selected tags to the Associated tag numbers pane.
6. If you selected more than one hook-up or hook-up type in the Domain Explorer,
click Next and make associations for another hook-up.
Related Topics
• Generate a Hook-Up Tag List Report, page 1211
• Managing Hook-Ups Common Tasks, page 1173
• In the dialog box panes, you can double-click a column header in the
to sort the items in ascending order. Double-click again to sort the
items in descending order.
• In the dialog box panes, there is a vertical bar that you can drag to the
right and view your data in a split display. To find the vertical bar,
place the cursor to the left of the left scroll box arrow so that the cursor
changes its shape as shown:
.
4. Under Items available for association, select one or more hook-up items and do
one of the following:
• Click Associate.
• Drag the selected items to the Associated items pane.
5. In the Quantity column, type a value for the quantity of items for a Bill of
Material. For example, if you associated a male connector and the current hook-
up requires twenty male connectors, type 20.
6. In the Spares Percentage column, type or modify the percentage of total units of
measure specified for the current hook-up item on the Hook-Up Item Properties
dialog box.
Tips
• The software uses the values that you add in the Quantity and Spares
Percentage columns when calculating the total quantity of items for a
Bill of Material. For details, see Calculating the Total of Hook-Up
Items for a Bill of Material, page 1207
• After associating hook-up items with a hook-up, the software
generates new sequence numbers automatically and displays the
numbers in the Order column, where you can sort the items by their
order of their assignment to a hook-up. You can type a new sequence
number if needed. You can open a Bill Of Material and sort the items
by the item order. For more information, see Sort Data in a Bill of
Material, page 1210.
Related Topics
• Generate a Hook-Up Item List Report, page 1210
• Hook-Up Items: An Overview, page 1162
• Managing Hook-Up Items and Libraries Common Tasks, page 1164
• Managing Hook-Ups Common Tasks, page 1173
.
4. Under Associated items, select one or more hook-up items and do one of the
following:
• Click Dissociate.
• Drag the selected items from the Associated items pane to the Items
available for association pane.
Related Topics
• Managing Hook-Up Items and Libraries Common Tasks, page 1164
• Managing Hook-Ups Common Tasks, page 1173
Tips
• In the dialog box panes, you can double-click a column header in the
to sort the items in ascending order. Double-click again to sort the
items in descending order.
• In the dialog box panes, there is a vertical bar that you can drag to the
right and view your data in a split display. To find the vertical bar,
place the cursor to the left of the left scroll box arrow so that the cursor
changes its shape as shown:
.
4. Under Associated tag numbers, select one or more tags and do one of the
following:
• Click Associate.
• Drag the selected tags to the Available tag numbers pane.
5. If you selected more than one hook-up or hook-up type in the Domain Explorer,
click Next and dissociate tag numbers from another hook-up.
Related Topics
• Managing Hook-Ups Common Tasks, page 1173
Delete Hook-Ups
1. Press F7 to open the Domain Explorer, and expand the hierarchy to the hook-up
type level in the Hook-Ups folder.
2. Do one of the following:
• In the tree view pane, select a specific hook-up you want to delete.
• In the tree view pane, select a hook-up type, and then, in the Items
pane, select and right-click one or more hook-ups.
3. On the shortcut menu, click Delete.
Tip
• When deleting hook-ups, the software automatically dissociates all the
hook-up items and instrument tags.
Related Topics
• Managing Hook-Ups Common Tasks, page 1173
• In the tree view pane, right-click a hook-up type that does not have
hook-ups.
• In the Items pane, select and right-click several hook-up types that do
not have hook-ups.
3. On the shortcut menu, click Delete.
Related Topics
• Managing Hook-Ups Common Tasks, page 1173
Important
• Make sure the macro names you enter in the drawing template match
the macro names you defined on the Macro Definitions dialog box in
the Hook-Ups module.
6. If you want to edit the hook-up drawing identifying fields, associate the document
and revision numbers, in the Domain Explorer, open the Hook-Up Drawing
List dialog box and define data accordingly.
7. In the Domain Explorer, open the Generate Hook-Up Drawings dialog box and
set the generation options as you require.
8. Generate a hook-up drawing from the Generate Hook-Up Drawings dialog box.
Enhanced Hook-Up Drawing Generation Scenario
1. On the Preferences dialog box, on the Enhanced Reports > Hook-Up > View
page, select the options you want to see in your drawing.
2. On the Enhanced Reports > Hook-Up > File Locations page, set the file paths
for the various options.
3. If required, change the text appearance by changing the settings on the Fonts
page.
4. On the Enhanced Reports > Hook-Up > Title Block page, select the title block
you require for your drawing.
5. On the Enhanced Reports > Hook-Up > Pagination and Revisions page, set the
revision display order.
Tip
• You can display a number of revisions in the title block of a hook-up
drawing. Each revision is represented by a numbered macro and the
revisions are displayed in the order of the macro numbering, beginning
with the first revision (ascending order) or the last revision
(descending order). If the total number of revisions is greater than the
number of lines available for display in the drawing and you want to
see the latest revisions, you should select to display the revisions in
descending order so that the latest revision is displayed first.
6. If you want to edit the hook-up drawing identifying fields, associate the document
and revision numbers, in the Domain Explorer, open the Hook-Up Drawing
List dialog box and define data accordingly.
7. Assign the required hook-up symbol file to the hook-up. For more information,
see Assign an Enhanced Symbol to a Hook-Up, page 1193
8. .
9. In the Domain Explorer, open the Generate Hook-Up Drawings dialog box and
set the generation options as you require.
10. Generate a hook-up drawing from the Generate Hook-Up Drawings dialog box.
For each hook-up drawing, SmartPlant Instrumentation displays the hook-up name
and hook- up description. You can use this procedure to edit the hook-up name,
description, and the output file name. For more information, see Edit Hook-Up
Drawing Identifying Fields, page 1189.
The revision feature is used to keep track of the changes made to the hook-up
drawing during its lifetime. It is important and useful to have a chronological
description of the changes, dates of change, and a list of persons who approved them.
Using this procedure, you can add, edit, and delete revisions. For more information,
see Maintain Hook-Up Drawing Revisions, page 1191.
Related Topics
• Hook-Up Drawing Generation: An Overview, page 1184
• HookUp_CV.sym
• HookUp_DPtransmit.sym
They are located in the SmartPlant Instrumentation home folder > RAD >
Symbols > Custom.
These shipped files can be used, as is, to produce enhanced hook-ups drawings for
control valves, or data process transmitters. They can also be customized to produce
enhanced hook-up drawings for other hook-up items. For more information on
editing and customizing symbols, see the Symbol Editor or Catalog Manager User
Guides.
Related Topics
• Assign an Enhanced Symbol to a Hook-Up, page 1193
Tips
To view an existing generation method assignment, you can right-click the
appropriate hook-up and click Properties to open the Hook-Up Properties
dialog box.
Tip
• If you type an existing document name, the software prompts you to
confirm the multiple use of the name.
6. In the Document Description field, type a description.
7. To change the default output file name, do one of the following:
• In the Output File Name field, type a different file name over the
default name.
• Beside the output file name string, click to set a name of an
existing file as the output file name for the current hook-up drawing.
Tip
• The default output file name is the same as the hook-up name. If there
are any spaces in the hook-up name, the software replaces the space
with an underscore (_). The file name ends with an underscore (_) and
a two-digit sequence number representing the page number of a multi-
page drawing. For example, flow_transmitter_03.dwg. When the
drawing consists of a single page, the file name ends with _01.
8. Repeat the appropriate steps of this procedure for any other hook-up drawing.
Related Topics
• Managing Hook-Up Drawings Common Tasks, page 1186
Related Topics
• Managing Hook-Up Drawings Common Tasks, page 1186
Related Topics
• Managing Hook-Up Drawings Common Tasks, page 1186
Related Topics
• Hook-Up Drawing Generation: An Overview, page 1184
2. Click Actions > Update Paths for Existing Drawings and Blocks.
3. Under Path for associated block files, do one of the following:
• Click Apply to drawings in the domain or project to apply the new
path to all the <plants> in the current domain, or to the current project
in an owner operator domain.
• Click Apply to drawings in the current <plant> only to apply the
new path to the current <plant> only.
4. Type the full path to the folder where you keep your drawing blocks files or click
Browse to navigate to the desired folder.
5. Under, Path for generated hook-up drawings do one of the following:
• Click Apply to blocks in the domain or project to apply the new
path to all the <plants> in the current domain, or to the current project
in an owner operator domain.
• Click Apply to blocks in the current <plant> only to apply the new
path to the current <plant> only.
6. Type the full path to the folder where you keep your generated hook-up drawings
or click Browse to navigate to the desired folder.
Related Topics
• Managing Hook-Up Drawings Common Tasks, page 1186
7. If you want to save the generated hook-up drawing as external CAD files, select
the Save file in format check box, and then beside the Target folder path box
click Browse to specify the folder. To select a folder, you have to select any file
that exists in that folder.
Tips
• In the Target folder path box, the software displays the default folder
you specified on the Preferences dialog box, in the Hook-Ups > CAD
File Locations page, in the Output drawing folder box.
• The file format that the software uses when saving a hook-up drawing
depends on your CAD application. If you use AutoCAD, the software
saves the drawing file in .dwg format. If you select MicroStation, the
software saves the drawing file in .dgn format.
• When using SmartSketch, you can save the drawings in any format
available in the list. From the box below Save file is format, select a
desired format. If you select SmartSketch, the software saves the
drawing file in .sym format.
• The output filename is the same as the hook-up name. If there are any
spaces in the hook-up name, the software replaces the space with an
underscore (_). The filename ends with an underscore (_) and a two-
digit sequence number representing the page number of a multi-page
drawing. For example, flow_transmitter_03.dwg.
8. If needed, select Send to plotter or printer to send the generated drawings to the
current CAD plotter or printer.
9. If you want to apply the macro functions associated with macros, select Use
macro functions.
10. For a multi-page hook-up drawing generation, under Drawing for subsequent
pages, select one of the following:
• Same as first— Allows you to display the generated hook-up
drawing on the first page as well as on all the subsequent pages as
well.
• General drawing — Allows you to display the generated hook-up
drawing on the first page and the general drawing on all the
subsequent pages. The general drawing is a predefined drawing that
you specified on the Preferences dialog box.
Tips
• The software generates a multi-page drawing automatically. If the
number of tag numbers associated with the selected hook-up is greater
than the number of macros that can be accommodated on the first
hook-up drawing page, then all the tag numbers appear on the second
page (including those that already appeared on the first page). For a
multi-page drawing, you can enter the page number of the first
generated page of the hook-up drawing in the Generate from page
box. For example, if you enter the value 2 and then generate a hook-
up drawing, the first page of the hook-up drawing displays the value 2.
A multi-page drawing is a drawing in which the number of tags
associated with the current hook-up is larger than the number of
macros that can be accommodated in the generated hook-up drawing.
• If your CAD application is SmartSketch, by default, all drawings that
you generate have the A3 Wide print sheet size. This print sheet size
is defined in the template file pid.igr, which comes shipped with
SmartPlant Instrumentation. This file appears in the CADFunc folder,
for which you specified the path setting on the Preferences dialog
box, Hook-Ups > CAD File Locations page. If you want to generate
hook-up drawings using a different print sheet size, you must open the
pid.igr file in SmartSketch and modify the sheet settings as you
require. Note, however, that changes that you make in the pid.igr file
affect both hook-up drawings and loop drawings you generate in
SmartSketch. If you want the print sheet size of hook-up drawings not
to affect the print sheet size of loop drawings, duplicate the CADFunc
folder with all its content and define a different path setting preference
for loop drawings on the Loop Drawings > CAD File Locations
page.
Related Topics
• Managing Hook-Up Drawings Common Tasks, page 1186
Tip
• In the Domain Explorer, you can also select hook-up types instead of
hook- ups. In this case, you can generate hook-up drawings that
belong to all the hook-ups that are assigned to the selected hook-up
types.
4. Assign the required hook-up symbol file to the hook-up. For details, see Assign
an Enhanced Symbol to a Hook-Up, page 1193.
5. On the shortcut menu, click Reports > Generate Hook-Up Drawings to display
the General tab of the Generate Hook-Up Drawings dialog box.
6. From the Generation method list, select Enhanced Report.
Tip
• Under Automatic save options for enhanced hook-up drawings,
you can select Save drawings automatically to overwrite the default
folder specified on the Preferences dialog box, Enhanced Report >
Hook-Ups > File Locations page. You can click Browse and specify
a different folder for saving the hook-up drawings automatically as
files at the time of generation.
7. Click OK to generate the drawings for the selected hook-ups.
Note
• Generating an enhanced hook-up drawing with a Tag List and /or an
Associated Item List, results in the lists being randomly positioned on
your drawing. You can drag the lists and position them on the drawing as
required. Each time you regenerate the drawing, the lists are randomly
repositioned. You have to save the enhanced hook-up drawing as an
external document to save the lists current position, using Save Custom.
Related Topics
• Displaying CAD Hook-Up Drawings with the Enhanced Report Utility
Common Tasks, page 1200
• Managing Hook-Up Drawings Common Tasks, page 1186
Related Topics
• Managing Hook-Up Drawings Common Tasks, page 1186
Important
• The Enhanced Report utility recognizes only tag and hook-up item macros
within a given CAD block.
Display SmartSketch Hook-Up Drawings with the Enhanced Report
Utility
Use this procedure to display a SmartSketch hook-up drawing in .sym format in the
Enhanced Report Utility. You can display the drawing, block, and macros leaving the
title block. For details, see Display SmartSketch Hook-Up Drawings with the
Enhanced Report Utility.
Related Topics
• Title Block Macro List, page 1122
• The Enhanced Report utility recognizes only tag and hook-up item
macros within a SmartSketch block.
Related Topics
• Displaying CAD Hook-Up Drawings with the Enhanced Report Utility
Common Tasks, page 1200
6. On the Properties dialog box, in the Drawing block file name and path data
field, type the name and path of the desired AutoCAD block and click Ok.
7. Set the drawing generation method for this hook-up item to Enhanced Report.
For details, see Apply a Drawing Generation Method to Hook-Ups, page 1188
8. Generate the hook-up drawing. See Generate Enhanced Hook-Up Drawings, page
1196.
Important
• The Enhanced Report utility recognizes only tag and hook-up item
macros within an AutoCAD block.
Related Topics
• Displaying CAD Hook-Up Drawings with the Enhanced Report Utility
Common Tasks, page 1200
Related Topics
• Displaying CAD Hook-Up Drawings with the Enhanced Report Utility
Common Tasks, page 1200
2. Select the desired macro by choosing the item type and property, and where
applicable, the relation between a specified item type and its parent. To do this,
make a selection from each of the lists at the top of the dialog box.
3. In the Macro definition details data window, select the desired macro definition.
Tip
• If there are a large number of macro definitions in the Macro
definition details data window, under Find macro definition, select a
column heading and then type a value. For example, if you select
Function as a column heading and type a macro function value, in the
data window, the software locates the macro definition to which that
macro function belongs.
4. To create a customized macro definition, do one or more of the following:
a. Under User-Defined Macro Name, type the desired user name for your
macro.
b. Click in the Description field and change the description as desired.
c. Under Macro Function, select a macro function to modify the appearance of
the retrieved data.
5. To add another customized macro definition, click New and repeat the previous
step.
6. Click Apply to accept your customized macro definitions.
Related Topics
• Customizing Macro Definitions: An Overview, page 1132
• Using Macros in CAD Blocks: An Overview, page 1129
Related Topics
• Customizing Macro Definitions: An Overview, page 1132
• Using Macros in CAD Blocks: An Overview, page 1129
Related Topics
• Calculating the Total of Hook-Up Items for a Bill of Material, page 1207
• Hook-Up Reports Common Tasks, page 1208
Notes
• If the unit of measure of the hook-up item is either Item or Piece, the
software rounds up the calculated total quantity value so that no fraction
remains.
• You define the number of the additional tags on the Associate Tag
Numbers with Hook-Ups dialog box.
• You define the item quantity and spares percentage on the Associate
Items with Hook-Ups dialog box. It is also possible to define item spares
percentage on the Hook-Up Item Properties dialog box.
Related Topics
• Generate a Bill of Material, page 1209
• Hook-Up Reports: An Overview, page 1205
Related Topics
• Hook-Up Reports: An Overview, page 1205
Related Topics
• Generate a Bill of Material, page 1209
Related Topics
• Generate a Bill of Material, page 1209
• Generate a Hook-Up Item List Report, page 1210
• Generate a Hook-Up Tag List Report, page 1211
The core of the Browser module is the Browser Manager that contains a number of
predefined browsers categorized by data type. Each browser is associated with a
particular SmartPlant Instrumentation module but in some cases, it is possible to
present data from several different modules in a single browser view. In addition to
the predefined browsers, you can also create custom browsers such as specification
form browsers and PowerSoft browsers. The browsers are grouped according to their
category. Such a group is referred to as a browser group. For example, by defining a
browser view for the Control Valve browser in the Process Data & Calculation
group, you can display information for all instrument tags which have the same
process function, for example, flow meters.
You access and manipulate module data and various items by creating customized
browser views for each of the predefined and custom browsers in the Browser
Manager. You customize each browser view by defining its style, sorting sequence,
and filter. You can define a number of different browser views for each browser to
organize your data according to different requirements. Each browser view will have
its own style settings, sorting sequence, and filter to present your instrument index
data in the most efficient and informative manner. The browser view style settings
determine which columns and items will be displayed. The sorting sequence
organizes the selected fields in a particular order and the filter lets you display the
data filtered according to the condition you define.
In addition to the database fields provided to you by default, the Browser Manager
also allows you to display custom fields, which you can use to complement data
attributes not supported by the given database fields in a particular module. You can
modify the names of custom fields, as you desire. Depending on your SmartPlant
Instrumentation license, you can also import browser views into SmartPlant
Instrumentation. The views are available as add-ons, and once added you can use
them to access the required data.
Related Topics
• Adding New Browsers: An Overview, page 1235
• Browser Manager Overview, page 1213
• Browser Views: An Overview, page 1266
• Sort Settings: An Overview, page 1253
• Style Settings: An Overview, page 1242
• View Filter Settings: An Overview, page 1259
The first step in defining view settings, is to create a browser view profile (viewing
template) for a browser that you select from the Browser groups list. Each browser
view must be based on a view profile that is defined before any other settings can be
selected. A browser view can contain style, sorting sequence, and filter settings:
• Style— select the fields to be displayed, define the field layout (that is,
the order in which these fields will be displayed), define the data field
headers which will be used for the current style, and set the field length
(number of characters) which will be displayed for each selected field.
• Sort — determine the sorting sequence of the fields in the Browser
View window. You can also select a different sorting sequence when
viewing the data in the Browser View window.
• Filter — set a filtering condition that is used to filter the selected data
rows displayed in the Browser View window.
After you have defined all the view settings that you require, you can open the
Browser View window, where the current settings are applied to the data with which
the selected browser is associated.
Related Topics
• Browser Groups, page 1223
• Browser Manager Common Tasks, page 1215
• Browser Manager Hierarchy, page 1214
• Browser Group — The first level of the hierarchy stands for a Browser
Group which represents a module or an item (for example, Control
System). Each group can contain one or more predefined Browsers.
• Browser — Each browser is associated with the relevant module data
(for example, Loop and Equipment in the Instrument Index) or item whose
data it displays. A Browser contains one or more viewing templates or
Views that you can select and modify to customize the way the
corresponding data will be displayed in the Browser View window. Note
that you cannot add or delete any browser group or browser, nor can you
change their names. You can only delete a custom browser.
• View — Each view contains the following viewing settings that will be
used to display the data with which that view is associated: the viewing
style, sorting order, and filtering condition. You can add, delete,
modify, and duplicate the view profile to customize the way the data will
be displayed in the Browser View window.
Related Topics
• Add a New View, page 1218
• Browser Groups, page 1223
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
• Delete a View, page 1221
• Display the Current Sorting Sequence, page 1254
• Display the Current Style Setting, page 1244
• Duplicate a View, page 1218
• Modify a View Profile, page 1220
Duplicate a View
This procedure shows you how to duplicate an existing view. Creating several
different views for the same browser can be very useful when you need to work with
the same module data organized in a different manner. Duplicating an existing view
within the same browser is a fast way to create a new view on the fly. After
duplicating a view, you can modify it as needed. For more information, see
Duplicate a View, page 1218.
Delete a View
This option shows you how to delete a browser view that is no longer required.
Remember that when deleting a browser view you also delete its Style, Sort and
Filter settings. For more information, see Delete a View, page 1221.
Related Topics
• Browser Groups, page 1223
• Browser Manager Hierarchy, page 1214
• Browser Manager Overview, page 1213
13. Select another browser to define a View profile, or close the Browser Manager.
Related Topics
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
• Create a Sorting Sequence View, page 1255
Related Topics
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
• Select a Default Browser, page 1216
Duplicate a View
1. Start the Browser Manager by doing one of the following:
• Click File > Browser Manager.
• Click .
2. If the Browser View is open, then open the Browser Manager by doing one of
the following:
• Click .
• Click Actions > Copy.
• Right-click the view you want to copy and then, on the shortcut menu,
click Copy.
6. Select the target browser and do one of the following:
• Click .
• Click Actions > Paste.
• Right-click the target browser and then, on the shortcut menu, click
Paste.
Notes
• You can duplicate the view with all its settings or only with the setting
(view, sort, or filter) that you select.
• You can duplicate browser views only if they belong to the same browser.
• If you close the Browser Manager, the item you copied will be lost.
Related Topics
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
Note
• If the same view name already exists in the target plant browser, the
software does not overwrite the settings of the target view, but creates
another view with the same name.
Related Topics
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
Delete a View
1. Start the Browser Manager by doing one of the following:
• Click File > Browser Manager.
• Click .
2. If the Browser View is open, then open the Browser Manager by doing one of
the following:
• Click Actions > Manager.
• Click .
3. In the Browser Manager, select the target browser in the Browser groups data
window.
4. In the Browser groups data window, select the view you want to delete.
5. Do one of the following:
• Click
• Click Actions > Delete.
• Right-click and on the shortcut menu select Delete.
Related Topics
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
• Click .
• On the menu bar, click Actions > Find.
2. Select the Browser or View option button, depending on what you want to find.
3. In the data field, type the value that you want to find.
4. To match the retrieved values with the value you are searching for, do one of the
following:
• Select Whole Value to find only occurrences that are whole words
(this is the default selection).
• Select String to find occurrences that are either whole words or part of
a word.
5. Click Find.
Tips
• During the search, the Find button changes to Stop, allowing you to
stop the search, if required.
• When an appropriate occurrence is found, the corresponding row is
automatically selected.
6. Click Find to find the next occurrence.
7. Click Close when finished.
Related Topics
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
Browser Groups
The following browser groups are available in the Browser Manager. It is not
possible to add new groups.
Browser Description
Calibration Results Displays instruments and their attributes that include instrument
Browser calibration results. After filtering the fields, create a calibration
result analysis for a certain period, an instrument calibration list,
and so forth.
Calibration Settings Displays calibration settings (ranges, set points, alarm points,
Browser and so forth) for a selected instruments.
Circuit Related Displays data for tag numbers derived from SmartPlant
Electrical Tag Electrical signals for circuits. If a circuit relates to more than
Browser one electrical item, a separate data row appears for each item.
Browser Description
DDP and Index Displays instruments and their associated dimensional data for
Browser piping.
Document Allows you to generate a document list for selected instruments.
Summary Browser A document list may include specifications, process data sheets,
loop and hook-up drawings.
Electrical Power Displays electrical properties owned by SmartPlant
Element Browser Instrumentation and SmartPlant Electrical for instruments and
cabinets.
Electrical Tag Displays data for all tag numbers derived from SmartPlant
Browser Electrical signals for all items but does not retrieve data values
of associated attributes for signals created under circuits. The
software displays data for the main item and also associated
circuit data.
Equipment Browser Process equipment list for the current plant, area, or unit.
Fieldbus Tag Displays fieldbus instruments and their associated segments.
Number List You can create browser views to be used in the Fieldbus Tag
Browser Numbers browser to associate tags with segments.
Function Displays existing function requirement tag numbers and their
Requirement properties. The browser allows you to view and edit the data.
Browser
Instrument Allows you to pre-assign specific panels to selected device
Connection Pre- panels. This pre-assignment facilitates faster and more efficient
assignment Browser wiring design. The purpose of this pre-assignment is to enable
you to define an auto-wiring task for the pre-assigned panels as
well as providing a criterion by which to filter the cables so that
only pre-assigned device cables are displayed for connection
with panels.
Instrument In addition to the options available for the Instrument
Connection Pre- Connection Pre-assignment Browser, you can also display the
assignment Control System Tag data in the browser view.
(Advanced)
Browser
Instrument Index Allows you to display and edit tag numbers from the Instrument
Standard Browser Index module.
Instrument Type Displays a list of instrument types and their default profiles.
Browser This browser is especially useful when you need to define a
default profile for numerous instrument types at the start of a
project design.
Browser Description
JB – Index Displays existing field devices and their connections to junction
Browser boxes and terminals. Note that you can view only those field
devices that are connected to the junction box whose wiring is
continued from the other side of the terminal.
Line Browser Lists existing lines and their properties (except for process data),
and allows you to edit the properties.
Loop Browser Lists existing loop numbers and their properties, and allows you
to edit the properties. This browser does not show associated tag
numbers. In the Loop Browser view, you can select a P&ID
drawing number from the P&ID list and have this drawing
number propagated to all instruments associated with a
particular loop. After saving the settings, the new P&ID appears
selected in both the Loop Browser View window in the
Browser module and on the Tag Number Properties dialog
box in the Instrument Index module. Before using this feature,
make sure that in the Instrument Index module, on the Loop
Number Properties dialog box, the Apply P&ID drawing to
tags check box is selected.
Maintenance Lists existing instruments for which work requests or repair
Schedule Browser forms have been issued. Also, displays the instruments for
which preventive maintenance has been scheduled.
Range Browser Displays the following range values: calibration range, process
data range, alarm and trip settings.
Tag Category Displays existing instrument tag numbers that have been
Browser associated with a tag category.
Tag Number Lists existing instrument tag numbers and their properties, and
Browser allows you to edit the properties.
Related Topics
• Browser Groups, page 1223
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
Browser Description
Analyzer Browser Lists the existing analyzers, and allows you to edit the associated
data. You can also include custom fields.
Control Valve Lists the existing control valves for process and calculation data,
Browser and allows you to edit the control valve properties. You can also
include custom fields.
Flow Instrument Lists the existing flow instruments for process and calculation
Browser data, and allows you to edit the flow instrument properties. You
can also include custom fields.
General Process Lists all the General Process Data field records, tag number
Browser custom field data, as well as specification and process data
custom field information.
Level Instrument Lists the existing level instruments for process data, and allows
Browser you to edit the level instrument properties. You can also include
custom fields.
Line Component Lists existing line measuring components for analyzers and
Browser allows you to edit the components.
Line Process Data Lists the line data for process data and calculation, and allows
Browser you to edit the line data. You can also include line custom field
data.
Pressure Lists the existing pressure instruments for process data, and
Instrument allows you to edit the pressure instrument properties. You can
Browser also include custom fields.
Relief Valve Lists the existing relief valves for process data and calculation,
Browser and allows you to edit the relief valve properties. You can also
include custom fields.
Temperature Lists the existing temperature instruments for process data and
Instrument calculation, and allows you to edit the temperature instrument
Browser properties. You can also include custom fields.
Related Topics
• Browser Groups, page 1223
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
Browser Description
Specifications Lists specifications and allows you to edit them. You can also
Browser include drawing custom field data. This browser comes shipped with
SmartPlant Instrumentation.
Single-Form A custom browser whose format you generate and save in the Spec
Browser Data Dictionary of the Specifications module. You add such single-
form browsers to the Specifications browser group using the using
the Browser > Form Browser option on the Browser Manager
menu bar. The browser name is user-defined.
Multi-Form >A custom browser hat allows you to display field headers and the
Browser values of field that are assigned to these headers in different
specification forms. You generate such browsers using the Multi-
Form Browser Wizard of the Specifications module. The software
adds multi-form browsers automatically to the Specifications
browser group. The names of multi-form browsers always start with
the Multi-Form.
Related Topics
• Adding New Browsers Common Tasks, page 1236
• Browser Groups, page 1223
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
Browser Description
Auto-Wiring Routing Allows you to define and execute auto-wiring tasks for
Task Browser selected junction boxes and control system panels.
Cable Browser Lists all the available cables and their attributes.
Cable Set Browser Displays all the cable sets in the existing cables and allows you
to edit the cable sets. Only the cable set data can be edited.
Device Panel Displays field devices and their connections.
Browser
General Panel Displays existing panel data and allows you to edit the data.
Browser
I/O Card Browser Displays I/O card data and allows you to edit the data. This
browser also includes I/O card custom fields.
I/O Terminal Displays I/O terminal data and allows you to edit the data. You
Browser can also view the panels and I/O cards to which the terminals
belong.
Local Signal Browser Displays the existing local signals.
Rack Browser Displays the existing hardware racks and allows you to edit
them.
Slot Browser Displays existing slot data and allows you to edit the data.
Strip Browser Displays all the existing terminals and allows you to edit them.
You can also view the appropriate strips and panels.
Telecom Channel Displays channel data for telecom objects and allows you to
Data Browser edit the data.
Terminal Browser Displays the existing terminals and allows you to edit them.
Terminal Connection Displays terminal connection data. The data includes the
Browser connection on both sides of the terminals.
Wire Browser Displays wire data and also displays the cable sets and cables
to which the wires belong. You can edit the wire data as you
require.
Wire Connection Displays wire connection data. The data includes the
Browser connection on both sides of the wires.
Wiring Equipment Displays existing wiring equipment data and allows you to edit
Browser the data.
Browser Description
Hook-Up Display and edit the existing hook-up types, and the associated
Browser hook-ups.
Item List Lists all the items from the hook-up library.
Browser
Related Topics
• Browser Groups, page 1223
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
Browser Description
Block Browser Displays all the existing blocks and allows you to edit them.
Display the loop and tag numbers to which the blocks belong.
Enhanced Report Displays all loop numbers that are assigned to Enhanced Report
Utility Browser Utility drawing layouts. You can reassign loop numbers to any
available layout.
Loop Browser Displays all the existing loop drawings with their revisions and
generation types.
Related Topics
• Browser Groups, page 1223
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
Browser Description
NIM General Browser Displays all the tag numbers that have been assigned to
channels and associate these tags with appropriate point
types. This browser uses Honeywell-specific terminology.
Control System Tag Display all the tag numbers that have been assigned to
Browser channels and enter custom information for the displayed
tags.
Delta V Conventional Displays all the conventional tag numbers available for
Tag Browser publishing to Delta V.
Delta V Fieldbus Tag Displays all the fieldbus tag numbers available for
Browser publishing to Delta V.
NIM Analog Input Displays all the tag numbers with the point type defined as
Browser NIM Analog Input. You can also set the control system tag
parameters. This browser uses Honeywell-specific
terminology.
NIM Analog Output Displays all the tag numbers with the point type defined as
Browser NIM Analog Output. You can also set the control system
tag parameters. This browser uses Honeywell-specific
terminology.
NIM Digital Input Displays all the tag numbers with the point type defined as
Browser NIM Digital Input. You can also set the control system tag
parameters. This browser uses Honeywell-specific
terminology.
NIM Digital Output Displays all the tag numbers with the point type defined as
Browser NIM Digital Output. You can also set the control system
tag parameters. This browser uses Honeywell-specific
terminology.
Publish Yokogawa CST Displays Yokogawa conventional control system tags
(Conventional) Browser intended for publishing.
Publish Yokogawa CST Displays Yokogawa fieldbus control system tags intended
(FF) Browser for publishing.
Important
• The DeltaV and Yokogawa browsers are intended specifically for viewing
the DCS data as described, and you should not make any customizations
to these browsers using InfoMaker.
Browser Description
Default Data Displays default dimensional data for piping and allows you to
Browser edit the data.
Vendor Data Displays vendor dimensional data for piping and allows you to
Browser edit the data.
Working Data Displays working dimensional data for piping and allows you to
Browser edit the data.
Related Topics
• Browser Groups, page 1223
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
Browser Description
Cable Schedule Installation Lists all the cables for the current unit or plant where you
Index Browser can change the Electrical Installation Index, edit cable
descriptions, and so forth.
Cable Schedule Installation Lists all the plant or unit cables, their attributes,
Index Changes Browser installation index status and version.
Instrument Installation Allows you to generate an electrical, instrument, and
Index Browser mechanical installation report that includes the
appropriate drawing references.
Instrument Installation Displays electrical, instrument, and mechanical
Index Changes Browser installation changes that include the installation status
and version.
Panel Termination Displays the plant or unit device panels and their
Installation Index Browser electrical index.
Panel Termination Displays the plant or unit device panels with their
Installation Index Changes electrical installation index and installation changes.
Browser
Terminal Schedule Displays the plant or unit termination schedule and the
Installation Index Browser appropriate installation indexes.
Browser Description
Terminal Schedule Shows the plant or unit termination schedule and the
Installation Index Changes installation index changes.
Browser
Wiring Schedule Displays the plant or unit cable, cable set, and wire
Installation Index Browser connections and their appropriate installation indexes.
Wiring Schedule Displays the plant or unit cable, cable set, and wire
Installation Index Changes connections and their installation index changes.
Browser
Related Topics
• Browser Groups, page 1223
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
Browser Description
Spec Binder Allows you to generate a browser that includes tag numbers
Package belonging to a Specification Binder package, tag number attributes,
Browser package item number, and specification data.
Related Topics
• Browser Groups, page 1223
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
Browser Description
Archive Allows you to generate a document list of all archived documents
Browser associated with the report names that you selected in the Administration
module for archiving, and then view and compare archived reports.
Drawing Allows you to generate a document list that shows the document name,
Browser type (P&ID, process data, calculation, specification, loop, or hook-up
drawing), and custom field data.
Browser Description
Revision Allows you to generate a document revision browser that includes all
Browser drawings in the plant hierarchy and all their revisions.
Changes Log These browsers allow you to generate reports that show when changes
Browsers were made to the item type. You can generate reports for Cables,
Control System Tags, Equipment, Instruments, Lines, Loops, Panels,
and Wiring Equipment.
Related Topics
• Browser Groups, page 1223
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
Browser Description
Changes Log Displays changes to property values for items at the selected plant
Browser hierarchy level. This browser is only visible when the System
Administrator selects the Item registry check box for the domain.
Task Displays tasks available in the To Do List (that is, tasks generated after
Browser you retrieve documents.
Related Topics
• Browser Groups, page 1223
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
Browser Description
End Point Amplifier Displays existing end point amplifier data and allows you
Browser to edit the data.
End Point Hub Browser Displays existing end point hub data and allows you to
edit the data.
End Point Intercom Displays existing end point intercom data and allows you
Browser to edit the data.
End Point Miscellaneous Displays existing end point miscellaneous equipment data
Browser and allows you to edit the data.
End Point PABX Browser Displays existing end point PABX data and allows you to
edit the data.
Hub Cabinet Browser Displays existing hub cabinet data and allows you to edit
the data.
Hub Equipment Browser Displays existing hub equipment data and allows you to
edit the data.
Intercom Cabinet Browser Displays existing intercom cabinet data and allows you to
edit the data.
Intercom Equipment Displays existing end point intercom equipment data and
Browser allows you to edit the data.
Miscellaneous Cabinet Displays existing miscellaneous cabinet data and allows
Browser you to edit the data.
Miscellaneous Equipment Displays existing miscellaneous equipment data and
Browser allows you to edit the data.
PA Cabinet Browser Displays existing PA cabinet data and allows you to edit
the data.
PABX Cabinet Browser Displays existing PABX cabinet data and allows you to
edit the data.
Port-Data Browser Displays existing port data and allows you to edit the data.
Related Topics
• Browser Groups, page 1223
• Browser Manager Common Tasks, page 1215
• Browser Manager Overview, page 1213
• A single-form browser only displays those fields that you set as available
for the browser in the Spec Data Dictionary.
• A form browser displays the field headers that you set in the Spec Data
Dictionary. The header names can differ from the header names in the
actual forms and in the specifications based on these forms.
• You can add one form browser for each form.
For more information, see Add a Single-Form Browser, page 1237.
Notes
• You must have a connection to the SmartPlant Instrumentation database to
be able to select SmartPlant Instrumentation tables and fields.
• The procedure includes only those steps in InfoMaker that are required for
creating a new browser for SmartPlant Instrumentation.
For more information, see Create a PowerSoft Browser in InfoMaker, page 1238.
Important
• Only proficient users who have advanced knowledge of the database
structure should attempt this advanced feature.
• You cannot perform report comparison for PowerSoft browsers.
For more information, see Add a PowerSoft Browser, page 1240.
Related Topics
• Adding New Browsers: An Overview, page 1235
Related Topics
• Add a PowerSoft Browser, page 1240
• Adding New Browsers Common Tasks, page 1236
8. From the Primary table list, select the primary table for the new browser. This
list contains all the tables that you selected when creating the report in InfoMaker.
9. From the Primary value list, select the value for the primary key name of the
new browser. For example, in the COMPONENT table, the primary value is
CMPNT_NAME.
10. From the Browser group list, select a browser group to which you want to assign
the new browser.
11. From the Access right item list, select the item for the access rights definition.
For example, MODULE ACCESS – INDEX.
12. From the Default sort list, select the default sort value.
13. From the Item for enhanced reports list, select an item on which to apply the
Enhanced Report Utility macro filter.
Important
• An Enhanced Report Utility macro filter is a filter for which you
define conditions for displaying macro attributes in Enhanced Report
Utility drawings. After you select an item from this list, in the Loop
Drawings module, you can set filter conditions for Enhanced Report
Utility drawings that use this browser data. For details, see Set Filter
Conditions for Item Properties in the Enhanced Report Utility Guide,
under Using the Enhanced Report Utility, Using Filters, Set Filter
Conditions for Item Properties.
Tip
• If you want to work with the new browser in the Instrument Index
module, select the Define as browser for Instrument Index module
check box.
Related Topics
• Adding New Browsers Common Tasks, page 1236
• Adding New Browsers: An Overview, page 1235
Related Topics
• Style Settings: An Overview, page 1242
Related Topics
• Style Settings Common Tasks, page 1243
• Style Settings: An Overview, page 1242
• Click .
2. If the Browser View is open, then open the Browser Manager by doing one of
the following:
• Click Actions > Manager.
• Click .
3. In the Browser Manager, add a new view profile or edit an existing one.
4. Do one of the following:
• In the Browser groups data window, click .
• In the upper-right data window, double-click .
5. On the lower Style pane, click Edit.
6. In the Name data field, type the new style name (defaults to Style followed by a
number).
7. Select the Enable in explorer windows check box to make the current browser
view available in the Domain Explorer, Reference Explorer, and all the other
explorer windows in SmartPlant Instrumentation. After selecting this check box
and saving the style settings, the current browser view becomes available in the
Show Browser dialog box that you open from an explorer window.
8. Do one of the following to select the fields to be displayed in the browser view:
• Select the appropriate View check boxes, by scrolling down the Style
settings data window and selecting the required fields individually.
Note that the primary value field is always selected, and a check mark
appears in its View check box by default.
• Select the All check box in the Select group box, to select all the
available fields.
• Select the Custom check box in the Select group box to select all the
custom fields.
• Select the Non-custom check box in the Select group box to select all
the fields that are not custom fields.
9. Click the Data Field Header box to customize the header.
Tips
• Data field headers that you customize appear in the browser view
column headers when using the current style to view the data. You
can customize any data field header.
• In addition to the database fields provided to you by default, the
Browser Manager also provides you with custom fields, which you
can use to complement data attributes. A user with Domain
Administrator rights can make default custom field definitions in the
Administration module.
Note
• In the Style settings data window, red is used to symbolize a selected
field. Yellow is used to symbolize a read-only field which cannot be
accessed in the browser for data editing. You can set a different color for
the read-only fields.
Related Topics
• Add a New View, page 1218
• Style Settings Common Tasks, page 1243
• Style Settings: An Overview, page 1242
• Click .
• Click Actions > Delete.
Related Topics
• Style Settings Common Tasks, page 1243
• Style Settings: An Overview, page 1242
• Click .
3. In the Browser Manager display the style settings you want to modify.
4. On the lower Style pane, click Edit.
5. In the Name field, type the new style name (defaults to Style followed by a
number).
6. Do one of the following to select the fields to be displayed in the browser view:
• Select the appropriate View check boxes, by scrolling down the Style
settings data window and selecting the required fields individually.
Note that the primary value field is always selected, and a check mark
appears in its View check box by default.
• Select the All check box in the Select group box, to select all the
available fields.
• Select the Custom check box in the Select group box to select all the
custom fields.
• Select the Non-custom check box in the Select group box to select all
the fields that are not custom fields.
7. Click the Data Field Header box to customize the header name.
Tips
• Data Field Headers that you customize appear in the browser view
column headers when using the current style to view the data. You
can customize any Data Field Header.
• In addition to the database fields provided to you by default, the
Browser Manager also provides you with custom fields, which you
can use to complement data attributes. A user with Domain
Administrator rights can make default custom field definitions in the
Administration module.
• It is not possible to display an apostrophe in a custom field header. If
your definition includes an apostrophe character, this character
changes in the header to a double quote character ". If your definition
includes a double quite character, it changes in the header to a tilde
character ~. Other special characters appear in custom field header as
defined.
8. Click in the Length data field to edit the field's maximum number of characters
displayed in the Browser View when using the current style to view the data.
9. If you want to display in the Browser View print preview or print out the sum or
average value of any numeric field, select its Sum and/or Avg. check box. For
non-numeric fields, the Sum and Avg. check boxes are disabled.
10. To set the sorting options, do one of the following:
• Click any header (Data Field Header, Table Column Name, Length,
View, Sum, or Avg.) to sort the fields that appear in the Style settings
section in an ascending order (click again on the same header to sort
the displayed fields in a descending order.)
• Select the Default Sort check box when available to revert to the
default sorting order (the way the fields are arranged in the database).
The Default Sort option is available only if you changed the sort order
by clicking any header in the Style settings screen section.
11. To set the width and sequence of the selected fields, do the following:
a. Click Customize to open the Column Layout dialog box.
b. To change the field sequence, drag the header of the field that you want to
move to the left or to the right, then release the mouse button to drop the
column in the new location.
c. To resize the column width, point to the right or left edge of the column you
want to resize so that the mouse pointer changes its shape to a double-headed
arrow. Drag the column edge either to the left or to the right until the column
matches the required width.
12. Click OK to close the Column Layout dialog box and save the changes that you
made to the field layout and the style settings.
Tip
• Clicking OK in the Column Layout dialog box saves the new field
layout and the changes you made to the style settings in the Browser
Manager . Therefore, when you return to the Browser Manager the
Save button automatically changes to Edit. Clicking Cancel returns
you to the Style settings to continue creating your view style.
13. If changes have been made that have not been saved, the Save button will be
visible, click Save to save your new style settings.
Note
• In the Style settings data window, red is used to symbolize a selected
field. Yellow is used to symbolize a read-only field which cannot be
accessed in the browser for data editing. You can set a different color
for the read-only fields.
Related Topics
• Style Settings Common Tasks, page 1243
• Style Settings: An Overview, page 1242
• Click .
2. If the Browser View is open, then open the Browser Manager by doing one of
the following:
• Click Actions > Manager.
• Click .
3. In the Browser Manager display the style settings you want to modify.
4. Click Edit.
5. Click Layout to open the Define Print Layout dialog box.
6. Select a field from the Column Header pop-up window and drag it to the field
where you want it to appear. Your print layout can take the form of single fields
in each column or multiple (no more than 5) fields in a column. Remember that
the fields that you do not select from the Column Header pop-up window will
not show up in the printout even though they exist in the current browser. Note,
however, that if you decide to display two or more fields in a column, the printed
out report will not display the Group Row Count, nor will it show the sum
and/or average field values even if you have selected these options.
7. Click Font to open the Customize Font Size dialog box, where you can
customize the column and header font size as well as the column and header
height.
8. Set the font sizes as required using the spinners:
a. Use the Column Font Size spinner to define the font size.
b. Use the Column Height spinner to define the column height. Note that if you
do not define the column height before generating the layout, the Define Print
Layout dialog box does not display any data.
c. Use the Header Font Size spinner to define the header font size.
d. Use the Header Height spinner to define header height size.
9. Click OK to accept your settings and return to the Define Print Layout dialog
box.
10. Click Generate to open the Generate Print Layout dialog box where you
customize the column sequence and size.
11. Set the layout structure as follows:
a. Set the column sequence by dragging the column header to the required
position.
b. Set the column size by dragging the edge of the column either to left or to the
right.
c. Click OK to accept the settings and return to the Define Print Layout dialog
box.
12. Click Save to save all the settings and close to the Define Print Layout dialog
box.
Related Topics
• Style Settings Common Tasks, page 1243
• Style Settings: An Overview, page 1242
• Click .
• Click Actions > Copy.
• Right-click the highlighted style in the Browser groups data window
and then, on the shortcut menu, click Copy.
6. Navigate to the target style whose settings you want to replace with ones you
copied.
7. Highlight the selected target style.
Important
• If you close the Browser Manager at this stage, you cannot paste the
duplicated style settings.
8. Do one of the following:
• Click .
• Click Actions > Paste.
• Right-click and on the shortcut menu, click Copy.
Related Topics
• Style Settings Common Tasks, page 1243
• Style Settings: An Overview, page 1242
Related Topics
• Sort Settings: An Overview, page 1253
• Click .
3. In the Browser Manager, expand the required browser group, to navigate to the
browser view in the Browser groups data pane. For more information on how
the browsers are organized, see Browser Manager Hierarchy, page 1214.
4. Expand the required browser view in the Browser groups data pane and do one
of the following:
Tips
• For any browser view that supports sorting data by tag numbers, you
can sort tag numbers according to the numeric segment. From the
Data Field Header list, select Tag Trans Name, and define the sort
sequence in the Start Char and Length fields.
• For any browser view that supports sorting data by loop numbers, you
can sort loop numbers according to the numeric segment. From the
Data Field header list, select Loop Trans Name, and define the sort
sequence in the Start Char and Length fields.
8. In the Start Char. data field, type the starting position of the current segment,
i.e., the selected sorting field leftmost character.
9. In the Length data field, type the total number of characters (from the starting
character) the selected sorting field will contain.
10. Under Order, clear the Ascending check boxes if you want the data to be sorted
and displayed in the Browser in a descending order. The default setting is
Ascending.
11. Click Insert to insert a sorting field before the one currently selected in the Sort
settings group box.
12. Click Delete to remove the currently selected field from the sorting sequence.
13. To resize and re-sequence the fields currently displayed in the Sort settings group
box, do the following:
a. Drag and drop a field to a new position to change the field sequence.
b. To change the width of a field, position the cursor on the border between two
fields and then drag the order to the right or to the left.
14. Click Save to save the new sorting sequence. The Sort Field List data window
displays the sorting sequence you have created.
Related Topics
• Add a New View, page 1218
• Sort Settings Common Tasks, page 1254
• Sort Settings: An Overview, page 1253
• Click .
3. Expand the required browser view in the Browser groups data pane and do one
of the following:
Related Topics
• Sort Settings Common Tasks, page 1254
• Sort Settings: An Overview, page 1253
• Click .
• Click Actions > Copy.
5. Navigate to the target sorting sequence whose setting you want to replace with the
copied settings.
6. Highlight the sorting sequence, and do one of the following:
• Click .
• Click Actions > Paste.
Related Topics
• Sort Settings Common Tasks, page 1254
• Sort Settings: An Overview, page 1253
• Click .
• Click Actions > Delete.
Related Topics
• Sort Settings Common Tasks, page 1254
• Field name
• Operator or function
• Value
• Logical expressions: And -or- Or (for complex filter conditions)
Important
• A complex filter condition may take longer to retrieve your data. For this
reason, performing an OR operation is more time-consuming than
performing an AND operation.
The following table lists the built-in operators and functions available to you when
defining the filter settings:
Related Topics
• View Filter Settings Common Tasks, page 1261
Related Topics
• View Filter Settings: An Overview, page 1259
3. In the Browser Manager, highlight the required browser in the Browser groups
data pane. For more information on how the browsers are organized, see Browser
Manager Hierarchy, page 1214.
4. Expand the required browser view in the Browser groups data pane and do one
of the following:
• In the Browser groups data pane, click .
• In the upper-right data pane, double-click .
Note
• The filter condition you define is displayed in the Filter field list in the
right data pane.
Related Topics
• View Filter Settings Common Tasks, page 1261
• View Filter Settings: An Overview, page 1259
Tip
• The Data Field Header list contains all the field headers used for the
data that the current browser is associated with.
8. Click Operator and select a suitable operator to determine how the tag number
attribute selected from the Column Name list will relate to the expression in the
Value field. For more information on filter operators, see View Filter Settings:
An Overview, page 1259.
9. In the Value data field, select or type a suitable value to determine how the tag
number attribute selected from the Column Name list are specified.
10. Depending on whether you want to add another filtering condition, in the Logical
data field, do one of the following:
• Leave the field empty if the condition is the last one in the list.
• Click the field and select either And or Or as the logical function from
the list if the condition is to be followed by another one. Select And to
include the following expression in the filter condition. Select Or to
accept either the previous or the following expression in the filter
condition.
11. Click Verify to verify the current filtering condition.
12. Perform any of the following actions as required:
• Click Insert to append new a data line.
• Click Delete to delete the currently selected data line.
• Click Save to save the new filter settings.
Tip
• The Filter field list data pane displays the filter condition you have
just defined.
Related Topics
• Add a New View, page 1218
• View Filter Settings Common Tasks, page 1261
• View Filter Settings: An Overview, page 1259
• Click .
3. Expand the browser view you want to modify in the Browser groups data pane
and do one of the following:
• In the Browser groups data pane, click .
• In the upper-right data pane, double-click .
4. Click Edit.
5. In the Name data field, type the required filter condition name (defaults to Filter
followed by a number).
6. Click the Data Field Header and select the field from the list.
Tip
• The Data Field Header list contains all the fields that are used for the
data that the current browser is associated with.
7. Click the Operator data field and select the required operator from the list.
8. In the Value data field, select or type a suitable value.
9. Depending on whether you want to add another filtering condition, in the Logical
data field, do one of the following:
• Leave the field empty if the condition is the last one in the list.
• Click the field and select either And or Or as the logical function from
the list if the condition is to be followed by another one.
10. Click Verify to verify the current filtering condition.
11. Perform any of the following actions as required:
• Click Insert to append new a data line.
• Click Delete to delete the currently selected data line.
• Click Save to save the new filter settings.
Tip
• The Filter field list data pane displays the filter condition you have
just defined.
Related Topics
• View Filter Settings Common Tasks, page 1261
• View Filter Settings: An Overview, page 1259
• Click .
2. If the Browser View is open, then open the Browser Manager by doing one of
the following:
• Click Actions > Manager.
• Click .
3. Expand the browser view you want to duplicate in the Browser groups data pane
and do one of the following:
• Click .
• Click Actions > Copy.
4. Navigate to the target filter condition that you want to replace with the one you
copied.
5. Highlight the selected filter condition, and do one of the following:
• Click .
• Click Actions > Paste.
Related Topics
• View Filter Settings Common Tasks, page 1261
• View Filter Settings: An Overview, page 1259
• Click .
• Click Actions > Delete.
You can also select a default browser whose settings will be used to display data in
the Browser View window. Default settings take effect only when you start the
Browser module from one of the other modules.
Browser view access rights correspond to the access rights of the appropriate item
type.
Related Topics
• Browser Groups, page 1223
• Browser Views Common Tasks, page 1267
• Column sequence.
• Column width.
For more information, see Modify and Save a Field Layout, page 1270.
Related Topics
• Browser Views: An Overview, page 1266
• Click .
• Click File > Browser Manager.
2. To select a Browser View other than the default view, with the browser default
view open, do one of the following:
• Click .
• Click .
• Click File > Browser Manager.
3. In the Browser Manager, expand the Browser groups hierarchy and select the
browser you want to open.
4. Do one of the following:
• Click .
• Click Actions > Open View.
Note
• If you have not defined a default Browser View clicking the browser
button or Actions > Open View opens the Browser Manager where
you can create a default view. For more details, see Define a View Profile,
page 1216.
Related Topics
• Browser Views Common Tasks, page 1267
• Browser Views: An Overview, page 1266
Tip
• Press Tab to move to the next data field. Press Tab + Shift to move
to the previous data field.
Notes
• If you wish to add or delete some of the options in a list, you can access
that list from the Tables menu in the Instrument Index Module window.
For more details, see Supporting Tables: Overview, page ???.
• Fields that hold naming convention data (Name, Prefix, Number, and
Suffix) cannot be edited.
Related Topics
• Browser Views Common Tasks, page 1267
• Browser Views: An Overview, page 1266
Related Topics
• Browser Views Common Tasks, page 1267
• Browser Views: An Overview, page 1266
Related Topics
• Create a Sorting Sequence View, page 1255
• Define a View Filter, page 1262
• Define a View Profile, page 1216
• Click .
• Click Edit > Copy to Buffer.
4. To copy a field to the Windows Clipboard, select the appropriate field and then
press either Ctrl + Ins or Ctrl + C.
5. In the Browser View window, highlight the rows or the fields that you want to
update.
Tips
• Use the scrollbar to view all parts of the Buffer pane and check the
data they contain before pasting data from the Buffer pane to the
Browser View window.
• To select more than one row, hold down Ctrl and click the required
rows.
6. To paste the data from the buffer to the currently selected row, do one of the
following:
• Click .
• Click Edit > Paste From Buffer.
Tip
• Empty Buffer columns do not update the target fields.
7. To paste the data from the Windows Clipboard to a selected field, press Ctrl + V.
Related Topics
• Browser Views Common Tasks, page 1267
• Browser Views: An Overview, page 1266
b. Click .
Related Topics
• Browser Views Common Tasks, page 1267
• Browser Views: An Overview, page 1266
3. Double click the header again, and the displayed rows are sorted in a descending
order according to the selected column.
Related Topics
• Browser Views Common Tasks, page 1267
• Browser Views: An Overview, page 1266
• Click .
• Click Actions > Count.
Note
• If the data window contains a large number of rows, the counting process
may require a few seconds to refresh the data.
Related Topics
• Browser Views Common Tasks, page 1267
• Browser Views: An Overview, page 1266
• Click .
• Click Edit > Refresh.
3. If you are prompted to save changes:
• Click Yes to save the modified data before refreshing the data from the
database.
• Click No to discard the changes that you made to the displayed data.
Related Topics
• Browser Views Common Tasks, page 1267
• Browser Views: An Overview, page 1266
Related Topics
• Browser Views Common Tasks, page 1267
• Browser Views: An Overview, page 1266
• Click the approximate color on the color palette, and then use the
control bar to adjust the color to your requirements. You can save this
color as a custom color by selecting a Custom colors box, and then
clicking Add to Custom Colors.
• Enter the Red, Green, and Blue numeric values, or the Hue; Sat; and
Lum; numeric values in the relevant fields.
4. Click OK.
Related Topics
• Browser Views Common Tasks, page 1267
• Browser Views: An Overview, page 1266
Related Topics
• Browser Views Common Tasks, page 1267
• Browser Views: An Overview, page 1266
Important
• The software does not allow you to perform revisions for Specification
Binder packages when working in an integrated environment.
You can group documents according to any criteria you require. However, for
instrument specification sheets, a given instrument specification may only be
assigned to one Specification Binder package or to any number of General Document
Binder packages, but not to both types of binder packages.
For details of the options available in the tree for each binder package type, see:
• Specification List— This is a cover sheet with instrument tag data for all
the specifications included in the Specification Binder package.
• Form Notes— This contains user notes that apply to specific form
numbers. There must be at least one specification associated with a
particular form number in the Specification Binder package in order for
you to be able to add form notes.
• General Notes— General notes provide a means of adding user
comments that are associated with the Specification Binder package as a
whole.
• Specification Sheets— This category shows the specifications included
in the Specification Binder package, and provides you with the options to
access and edit individual sheets, to totally or partially revise the sheets in
the list, and to print all or some of the sheets.
• Change Summary Report— This shows details of the changes that were
made to the specifications since the last revision.
When the documents are created, each document type is numbered sequentially using
the following method:
• Specification Sheets: S-1, S-2, S-3, and so forth. The pages of a multi-tag
specification are identified by a number with a different suffix for each
page, for example, S-2.1, S-2.2, S-3.1, S-3.2, and so forth.
• Form Notes— G-1, G-2, G-3, and so forth.
• Change Summary Report— C-1, C-2, C-3, and so forth.
• General Notes— N-1, N-2, N-3, and so forth.
Page numbers are calculated from the relative position of the document in the
Specification Binder package. To recalculate the page numbers after modifying
specifications, click Actions > Repaginate.
Related Topics
• Document Management Common Tasks, page 1279
• Document List— This is a cover sheet with data for all the documents
included in the General Document Binder package.
• Document Notes— This contains user notes that apply to specific
document numbers. There must be at least one document associated with
a particular document number in the General Document Binder package in
order for you to be able to add document notes.
• General Notes— General notes provide a means of adding user
comments that are associated with the General Document Binder package
as a whole.
• Documents— This category shows the documents included in the
General Document Binder package, and provides you with the options to
access and edit individual documents, to totally or partially revise the
documents in the list, and to print all or some of the documents.
Related Topics
• Document Management Common Tasks, page 1279
For more information, see Start the Document Binder Module, page 1281.
For more information, see Create a New Binder Package, page 1281.
For more information, see Edit Binder Package Properties, page 1282.
For more information, see Number Pages in a General Document Binder Package,
page 1283.
For more information, see Remove All Instrument Specifications From a Specification
Binder Package, page 1285.
For more information, see Associate External Files with a Binder Package, page
1286.
Related Topics
• Document Binder Module: An Overview, page 1276
• General Document Binder Packages, page 1278
• Specification Binder Packages, page 1277
Related Topics
• Assign a General Note to a Binder Package, page 1295
• Assign an Instrument Specification to a Specification Binder Package,
page 1282
• Create a Form Note, page 1294
• Requisition number.
Note
• If you select Apply purchase order and requisition number to all
tags, the software updates all tags currently associated with the binder
package. As long as this checkbox is selected, the software adds this
data to every tag that you associate with the binder package.
4. Click OK.
Related Topics
• Create a New Binder Package, page 1281
• Document Management Common Tasks, page 1279
b. In the Prefix column, next to the selected document type, type the prefix you
want to apply.
c. In the Suffix column, next to the selected document type, type the suffix you
want to apply.
d. Click Apply, to add another prefix and suffix to a different document type.
7. Click OK to close the dialog box.
Related Topics
• Document Management Common Tasks, page 1279
Troubleshooting
Errors may occur when you are working in the Document Binder module. This
section describes the common ones, with recommendations for solving the problems.
Revision problems
Problem Suggested Reason Recommended Solution
Description
Cannot revise the One or more of the documents in Close the edit location
binder package the binder package are being (specification or note editor).
edited.
One or more of the instrument tags Release all instrument tags
associated with the specification from any workflow
are locked for process data. assignments.
Cannot save Target is not defined for the Your Domain Administrator
revised revision. needs to define the path or
documents location.
Printing problems
Problem Suggested Reason Recommended Solution
Description
Cannot prepare Open specifications or Close all specifications and notes, then
pages for printing notes. re-select the print option.
The binder One or more of the Search for the missing reports according
package includes documents in the to the names displayed in the error
blank reports binder package is messages, and move them to the
missing. appropriate document location.
Cannot print Binder package Assign a spec to the binder package, or
binder package contains no documents. add a General Note.
Cannot repaginate A problem exists with Open the specification in the
before printing the specification, the Specifications module and follow the
form, or the format. instructions.
For more information, see Create a Form Note Template, page 1293.
For more information, see Edit a Form Note Template, page 1293.
For more information, see Delete a Form Note Template, page 1294.
For more information, see Assign a General Note to a Binder Package, page 1295.
Edit a Note
This procedure shows you how, after creating a note, you can edit the name,
description, and note text if desired.
Related Topics
• Delete a Form Note Template, page 1294
• Document Binder Notes Common Tasks, page 1292
• Edit a Form Note Template, page 1293
Related Topics
• Create a Form Note Template, page 1293
• Delete a Form Note Template, page 1294
Related Topics
• Create a Form Note Template, page 1293
• Document Binder Notes Common Tasks, page 1292
• Edit a Form Note Template, page 1293
Related Topics
• Assign a General Note to a Binder Package, page 1295
• Document Binder Notes Common Tasks, page 1292
• Edit a Note, page 1296
Notes
• On SQL Server, the Note sheet can accept up to 255 characters; on Oracle
or Sybase Adaptive Server Anywhere, you can type up to 2000 characters.
• Non-English, special character ASCII code, used in a note, is not
displayed correctly in print preview.
Related Topics
• Create a Form Note Template, page 1293
• Create a Form Note, page 1294
• Document Binder Notes Common Tasks, page 1292
• Edit a Form Note Template, page 1293
Edit a Note
1. Select one of the following folders:
• Form Notes.
• Document Notes.
• General Notes.
2. Do one of the following:
• Click Actions > Open to open the Note Editor window. (Continue at
step 3.)
• Expand the folder by double-clicking it. (Continue at step 4.)
3. Select the desired note from the list in the dialog box and click OK.
The Note Editor window opens. (Continue at step 5.)
4. Open the Note Editor window as follows:
a. Select the required note in the tree.
b. Do one of the following:
• Double-click the note.
• Click Actions > Open.
5. Edit the note name, description, and note text as required.
Caution
• The text editor only allows you to paste text from the clipboard. You
can copy text from other text editors or word processing applications,
for example, Notepad or Microsoft Word. However, any formatting in
the original document will be lost when you paste the text into this
field. You should not attempt to paste graphics images as this may
cause problems in the file later.
6. When done, click .
Important
• The software does not allow you to perform revisions for Specification
Binder packages when working in an integrated environment (on the
Revisions dialog box, the OK, New, and Delete commands are disabled).
In general, the software allows you to save a revision only for documents that you
have changed and saved. You are also allowed to save a revision in the following
situations:
Notes
• To be able to generate revisions, a Specification Binder package must
have at least one specification assigned to it (if the binder package
contains only general notes, for example, you cannot generate a revision
for it).
• You cannot delete or rename a Specification Binder package once a
revision has been performed on it.
• Before performing a revision in the Document Binder module, verify that
none of the designated documents are open for editing in any other
SmartPlant Instrumentation modules.
If the tag data was modified, the report will display the following:
• Tag number
• The column where the change was made
• The old and new values for the specific column
• The person who made the change
• The date of change
Notes
• The Change Summary Report uses data stored in the Audit Trail
repository, therefore to enable generation of this report, in the
Administration module Domain Definition window, the Domain
Administrator has to select the Audit trail options check box.
• If changes were made to the main page of a multi-tag spec, each item in
the list will be displayed separately in the report, along with its changes.
• Before a revision is saved for the first time or if no changes were made to
items in the binder package after a certain revision, a report will not be
generated.
• On SQL Server, the Note sheet can accept up to 255 characters; on Oracle
or Sybase Adaptive Server Anywhere, you can type up to 2000 characters.
• Non-English, special character ASCII code used in a note, is not displayed
correctly in print preview.
Related Topics
• Revisions Common Tasks, page 1302
• Specification Binder Package Revisions, page 1297
• The revision number of the specification will be incremented the next time
a revision is made to the Specification Binder package to which it is
assigned.
• Changes to the specification appear in the Change Summary Report.
Note
• The Change Summary Report uses data stored in the Audit Trail
repository, therefore to enable generation of this report, in the
Administration module Domain Definition window, the Domain
Administrator has to select the Audit trail options check box.
After a Specification Binder package has undergone a revision, the changes
notification is removed (on the Specification Change Notification dialog box, No
appears under the Changed column for all the specifications), and any documents
associated with it (Specifications, Form Notes, and General Notes) are saved.
• Mark this item as changed — When this option is selected, the change
you made in the Specifications module will also be indicated in the
Document Binder module. In the Specification Change Notification
dialog box, the Changed column for the specification will display Yes.
Consequently, the specification revision number will be updated the next
time you revise the Specification Binder package to which it is assigned. If
any change was made to the specification, the instrument tags associated
with the specification will appear in the Change Summary Report.
• Do not change existing notification — When this option is selected, the
change will not be notified in the Document Binder module. In the
Specification Change Notification dialog box, the Changed column for
the specification will display No. It is recommended that you select this
option only when the change is minor and you do not want it to be
included in the next saved revision.
The revision archive data can be saved in the database or in a file, depending on the
setting that the Domain Administrator selects in the Administration module.
Related Topics
• Convert Binder Package Revisions to .Zip Format Files, page 1304
• Revisions Common Tasks, page 1302
• Specification Binder Package Revisions, page 1297
For more information, see Add a Revision to a Binder Package, page 1303.
For more information, see Delete a Revision From a Binder Package, page 1304.
When you save revisions to the database, the software compresses the data
automatically to save space. To further streamline your database, you can also
remove specification, binder package, and construction revisions from the database
by converting them to .psr or .psr-within-.zip format files, which you save in folders
external to the database. This feature is useful when you have made a large number
of revisions, and want to reduce the size of the active and backup databases.
For more information, see Convert Binder Package Revisions to .Zip Format Files,
page 1304.
For more information, see Modify the Change Notification of a Specification, page
1305.
Related Topics
• Specification Binder Package Revisions, page 1297
• In the data window, select the revisions that you want to convert.
• To select all of the displayed revisions for conversion, click Select all.
4. Under Convert revisions to, click ZIP files.
Tips
• To convert revisions to uncompressed .psr format, click PSR files.
• To restore .psr or .zip format files to the database, click Database.
5. Click Convert.
Notes
• The Domain Administrator sets the default revision storage method in the
Administration module. This gives you the option of storing binder
package revisions directly to .zip files external to the database.
• You can vary this procedure to convert binder package revisions back-
and-forth among .psr, .zip, and SmartPlant Instrumentation database
format.
Related Topics
• Binder Package Revision Archive, page 1301
• Revisions Common Tasks, page 1302
• Save From a Binder Package to a .Zip File, page 1309
For more information, see Print Documents in a Binder Package, page 1308.
For more information, see Print From a Binder Package to a PDF File, page 1308.
After setting the path and file name, you choose between current documents on the
one hand, and previous revisions on the other hand. You then specify what to save as
follows:
Related Topics
• Printing from a Binder Package: An Overview, page 1306
• Accept the file path displayed under Path. In this case, the software
will create a unique file name in the currently displayed folder.
• Click and navigate to the folder where you want the software to
save your .pdf files. After selecting this folder, you have the following
File name options:
• Type a file name.
• Select an existing file name from the current folder.
• Leave the File name box blank to let the software create a unique
file name.
4. On the Print to File dialog box, under Select revision, do one of the following:
• Click Working issue for current files.
• For a previous revision, click Formal issue and select the desired
revision from the Revision name list.
5. Under Print what, do one of the following:
• Click All documents in binder package to print to file all the
documents of the revision you selected, or of the working issue.
• Click Changed documents only to print to file documents associated
with specifications marked as changed since the previous revision.
This option is available only if you selected Working issue above.
• Click Selected documents to print to file the specifications and notes
of your choice from the revision you selected, or from the working
issue.
6. Click OK to print the documents to a .pdf file.
7. If you clicked Selected documents, the Select Documents dialog box opens.
Highlight the documents that you want to print and click OK.
Related Topics
• Printing from a Binder Package Common Tasks, page 1307
Related Topics
• Printing from a Binder Package Common Tasks, page 1307
You can store and maintain default instrument dimensional data by classifying it per
group, manufacturer, or process connection.
The DDP module also enables you to store and maintain dimensional data received
from a vendor. This data can also be classified per group, manufacturer, or process
connection.
Most significantly, the DDP module provides the means to transfer, store, and
maintain certified vendor dimensional data for your instruments. This certified
vendor data will then be transferred to your Working data which you use for the
actual instruments in your database.
You can use the DDP module to transfer external dimensional data to your
SmartPlant Instrumentation database and export of dimensional data from your
database to an external 3-D piping design application.
In addition, the DDP module enables you to generate and print out various
dimensional data reports that facilitate your dimensional data management. These
reports can help you keep track of suspected data, data status, default dimensional
data, and vendor dimensional data, and so forth.
Note
• The Dimensional Data for Piping module is available only if it is included
in the software license that you purchased from Intergraph.
Related Topics
• Additional Settings, page 1313
• Preliminary Procedures, page 1315
• Principles of the DDP Module, page 1312
At the initial stage, you should select the appropriate instrument types and define their
instrument profiles so that dimensional data handling is clearly specified. Based on
the existing dimensional library and practices of dimensional data processing, you
also classify the instruments by their type and pre-assigned DDP group by defining
this group in the instrument type profile.
Group definition coupled with basic information enables the dimensional data
designer to provide piping designers with preliminary dimensions filled from the
standard dimensional data library based on specified basic instrument parameters.
When requests for quotations are issued and vendor bids are evaluated, more detailed
dimensional information supplied by vendors and manufacturers in electronic or hard
copy form can be automatically imported or manually entered as vendor data.
This vendor data lets the designer re-evaluate dimensional data, if desired, and issue
vendor-certified dimensional data to the piping.
Starting from the moment when the preliminary dimensional data was selected for the
instruments, you are able to release this information to the piping design. This can be
done in two forms — electronically or by providing a hard copy. Electronic form is
an automatic transfer and processing of the structured data to a 3-D CAD system.
Alternatively, dimensional data report or dimensional data sheet can be printed out
and transferred to the piping design department in paper form.
The status of the dimensional data design can be tracked through the instrument
status. You can also view the history information for the selected instrument
modifications.
Additional Settings
You also have to make some additional settings for the dimensional data. These
settings include the following:
For a detailed explanation about the above-mentioned settings, see the Instrument
Index module documentation.
Related Topics
• Dimensional Data for Piping Module, page 1311
Note
• The DDP module is available only if it is included in the software license
that you purchased from Intergraph.
Preliminary Procedures
There are two preliminary procedures that you have to carry out before you start
entering dimensional data. These procedures are:
• Defining the setting for the Dimensional Data for Piping module. To
carry out this procedure, you must log on to the Administration module as
System Administrator and enter the desired data on the Dimensional Data
Settings Dialog Box.
• Associating an Instrument Type with a DDP Group, page 1322
Note
• The Domain Administrator first needs to import DDP library data,
including default groups.
Related Topics
• Associating an Instrument Type with a DDP Group, page 1322
• Duplicating a Dimensional Group, page 1320
• Principles of the DDP Module, page 1312
Thirty parameters are available for each dimensional group. You create an active
parameter by typing its description, selecting it for use, and setting its allowed
minimum value to be zero or greater than zero.
Related Topics
• Defining Dimensional Groups, page 1318
Related Topics
• Defining Dimensional Groups, page 1318
Related Topics
• Defining Dimensional Groups, page 1318
• Principles of the DDP Module, page 1312
Related Topics
• Defining Dimensional Group Properties, page 1319
• Defining Dimensional Groups, page 1318
• Principles of the DDP Module, page 1312
Instead of inserting raw Vendor data manually, use the Import Utility to import a
large amount of raw vendor information. After importing the Vendor data, you revise
the raw vendor data to assign it to a dimensional group, verify the instrument tags,
and, if desired, manually modify the vendor data details.
Sometimes multiple records for the same instrument can exist. This can happen if
you import vendor data from several manufacturers. You can copy vendor data to the
Working data if the manufacturer, model, the Dimensional Group, and the process
connection values match the Working data values.
You can also indicate whether the imported data has been copied to the Working data.
You can reset this indication every time import is performed for a specific record,
thus creating a clear indication if the latest information has been copied to the
Working data.
Managing Vendor data involves editing it and entering new dimensional vendor data
for a selected instrument.
Related Topics
• Managing Vendor Data, page 1323
You can also add more records to the Working data by copying from Vendor data or
by copying preliminary default data from the Default Library if the Dimensional
Group, manufacturer, model, and the process connection values match the Working
data.
Managing Working data involves editing it, modifying the data status, entering the
piping design area, and finally generating and printing out a Dimensional Data Sheet
for a particular instrument.
Tip
• You can customize the display and layout of the data in the Working
Data window. The following options are available:
• Determining the fields to be displayed
• Sorting the data
• Filtering the data
Related Topics
• Editing Working Data, page 1326
Related Topics
• Managing Working Data, page 1325
You can select only a single instrument at a time. This instrument will serve as a
default example. For each selected instrument, the software can then search a default
record with corresponding dimensional group, manufacturer, model, and process
connection values.
You can select numerous instruments whose default data you want to copy. For
every selected tag number, the software can then search for values matching the
working data. Only after matching dimensional group, manufacturer, model, and
process connection values are found, the software copies the default data.
After successfully copying default data, the status of the copied records is set as
Preliminary and its revision number as 0 (zero). The revision number will then be
incremented from the last preliminary status by one, for example, Preliminary 1.
Notes
• If the instrument contains no working data, the copied default dimensions
will be marked as ready for release.
• If the instrument contains working data, you will be prompted if you want
the working data to be overwritten by the default data. The copied
dimensions will be marked as suspected.
• If the instrument contains working data whose status is certified, a
warning message appears informing you that the working data for this
instrument is certified by vendor. You will be prompted whether you
want the working data to be overwritten by the default data. If you choose
to overwrite it, the dimensional data status will marked as suspected.
4. Click Copy.
Notes
• For every instrument with matching values, vendor dimensional values are
copied including the vendor revision number. This data is marked as
copied to working data.
• If the instrument contains no working data and all desired dimensional
data is defined, the data is marked as ready for release.
• If the instrument contains working data, you are prompted if you want the
working data to be overwritten by the vendor data. The copied
dimensions are marked as suspected data and copied from vendor.
Notes
• When you modify the data status because of any dimensional data
management, you will be able to reset the suspected data flag and mark
the data as correct and ready for release to piping.
• You can select multiple instruments for status modification.
Caution
• Note that you must first define the appropriate dimensional group, the
process connection data, and the manufacturer before you can start
entering default data. Remember that only one set of default dimensional
data can exist for a domain.
Related Topics
• Editing Default Data, page 1336
• Entering Data into the Default Library, page 1335
Related Topics
• Managing Default Dimensional Data, page 1334
Related Topics
• Managing Default Dimensional Data, page 1334
A dimensional data sheet includes general tag information, dimensional data of the
specific group, and the graphic schematic or detailed presentation of the instrument
and its dimensions.
Report Description
Group List Contains a detailed list of all existing Dimensional Groups and their
parameters, such as group name, description, associated picture file,
cad group identifier, and dimensional parameter definitions.
Dimensions Displays a detailed list of all dimensional data for each instrument
List that is associated with dimensional data.
Suspected Data Presents a list of all the instruments for which dimensional data must
List be re-evaluated due to some changes made to the instrument
definitions. For example, if the process connection or any other key
parameter has been changed, the data is marked as suspected. This
report shows the cause of the suspected data flag.
Status History Contains all the dimensional data status history per all Tags whose
dimensional data status has been changed.
Suspected Data Displays a list of all Tags whose dimensional data was or still is
History marked as suspected. The report also presents the reasons for the
suspected data indication.
Default Contains a list of general default definitions for the elements of the
Library List Default Library.
Default Lists detailed definitions of the elements in the Default Library.
Dimensional
Data
Vendor Contains a detailed list of vendor dimensional data.
Dimensional
Data
Data Sheets Allows you to display data sheets associated with specific tag
numbers.
Empty Sheet Allows you to display field names and dimensional properties only,
Forms without displaying the values. An empty sheet form also displays a
dimensional group diagram.
• With the Dimensional Data for Piping Module window open, on the
Reports menu, click a report menu command.
Related Topics
• Printing Dimensional Data Sheets, page 1342
• Printing Empty Sheet Forms, page 1343
Batch preview and printing is available either from the Dimensional Data for Piping
Module window or from the Working Data window.
Related Topics
• Generating DDP Reports, page 1340
• Printing Dimensional Data Sheets, page 1342
You may only edit installation index categories that do not have any indexes assigned
to them.
Note
• If you change the electrical index in one of the report views — tag, panel,
or cable — SmartPlant Instrumentation updates the electrical index of all
the relevant items.
Construction Options
The procedures described in this section explain how to create, maintain, and use
installation indexes for tracking the tasks performed by contractors.
• In the Installation Index Manager window, you can view a list of the
indexes in each category by selecting the category from the Index
category list.
• In the Installation Indexes dialog box, you can view a list of the indexes
in each category, or from all the categories.
b. In the Installation Indexes dialog box, from the Index category list, select a
category.
Tip
• Selection of an installation index category is a prerequisite for
defining an installation index. If no category is available in the
list, you can create one by clicking to open the Index
Categories dialog box. Select at least one of the check boxes:
Wiring Category or Instrument Category for one or more of the
installation index categories.
c. Click New.
Tip
• The category prefix is entered by default as the prefix for the
Installation Index number.
d. Type the installation index number and description in the appropriate fields.
Tip
• Installation Index numbers must be unique. If you do not modify
the default, you will be prompted to keep it on saving.
e. From the Contract number. list, select a contract.
f. Repeat steps c) through e) for each installation index you want to add.
g. Click OK to save your changes and close the dialog box.
At this stage, it is assumed that you have defined all your installation indexes as
described in the previous sections.
2. Beside Report for, select the required report (if more than one report is available
for the selected category).
3. Do one of the following:
• Click .
• Click Actions > Open General Browser.
Tip
• The appropriate Browser View window opens for the report you
selected. For example, if you selected the Electrical Index, and you
chose Panels in the Report for field, the Panel Terminations Report
will be displayed. In the default category definition, the Panels report
(as part of the Wiring Category) only appears in the Electrical Index,
and therefore only the Electrical Index column will appear in the
Browser View. In this view, all the panels in the database are
displayed.
4. In the Electrical Index column, select the required index from the list for each
instrument tag as required.
5. Do one of the following:
• Close the window.
• Click .
• Click Actions > Refresh.
6. At the prompt, click OK to save the changes.
Generating Reports
You can display and print a report for each installation index revision you create.
Two types of report are available: a general report showing details of all the items in
the selected revision, and a change report showing only the differences between the
current revision and the previous one.
• Click .
• Click Reports > Print Report.
• Click .
• Click Actions > Revision.
4. Select one of the revision numbering methods (use P0, P1, P2... for preliminary
revisions or 0, 1, 2 /A, B, C, and so forth, for normal serial revisions).
Tip
• When you first select a revision numbering method, several options
are available to you, including preliminary revisions (designated by
P0, P1, P2…). Once you select one of the other revision methods, you
will not be able to return to the preliminary revision method and this
option will be disabled.
5. Click New to add new revision data.
6. Add the revision data in the appropriate data fields.
Tip
• The By data field contains the current user's initials by default, if
previously defined by the SmartPlant Instrumentation System
Administrator.
7. When done, click OK.
The revision archive data can be saved in the database or in a file, depending on the
setting selected in the Administration module.
Notes
• If you select to save your previous revisions in a file, make sure that: the
path to the appropriate file is added to your environment path parameter
(see your Windows User Guide to learn about defining paths in your
environment).
• If the revision file is shared by a number of users via a local network
connection, make sure that the resource on which that file is located is
appropriately shared (users should have both read and write access rights
to the revision files).
• Identical drive mapping is used for all the appropriate workstations to
indicate the location of the psr files.
• Click .
• Click .
• Click Actions > Revision.
Tip
• When you open the Revisions dialog box from the archive, you
can only edit existing revisions; you may not create new ones.
c. Edit the revision data as required in the appropriate data fields.
d. When done, click OK
You are returned to the Installation Index Manager Archive window.
5. To return to the current Installation Index Manager window, do one of the
following:
• Click .
• Click Actions > Working Installation Index Manager.
Total Plant
This property is a single character (numeric or alphabetic).
System Code
System Code Prefix (optional) — Single digit.
Component Code
Component Classification — Two-character alphabetic key, selected from a
standard list, that represents the type of component.
Cable Suffix — The fourth position of the cable number can be a numeric or
alphabetic character, mostly used for grouping purposes.
Note
• 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.
Process Identification Prefix and Notation Characters
Process Identification usually uses the equal (=) character as a prefix. Identification
may include space (" ") or pipe (|) characters.
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:
For a flow transmitter, the KKS identification 1 0PAE01 CF013 – B01 could be
used, where the values are designated as follows:
Notes
• 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.
Related Topics
• Propagation of KKS Names in SmartPlant Instrumentation, page 1368
• Working in KKS Mode in SmartPlant Instrumentation, page 1364
For a specific example of loop naming propagation, see Example of KKS Naming
Propagation, page 1368.
Notes
• The software performs propagation according to hard-coded rules. Name
segments that are not included in a propagation rule remain blank.
• On connecting a cable to a panel, the KKS naming is propagated to the
cable. On disconnection, the cable retains the name received by
propagation until you reconnect it.
Related Topics
• Working in KKS Mode in SmartPlant Instrumentation, page 1364
2. Click OK to open the Instrument Number dialog box, where you can create a
new instrument tag number. At this stage, the software has already propagated all
the loop naming settings.
3. Accept the propagated settings, and then define the component classification as
shown (-B 01):
4. Click OK to display the Select Instrument Type dialog box, where the software
displays the instrument type that matches the component classification key value
in the instrument tag name:
Tip
• To display the matching instrument types, you must first populate the
Instrument Type supporting table with applicable KKS entries.
5. Select the instrument type and click OK to display the loop and its tag in the
Domain Explorer:
Related Topics
• Rename an Item in KKS Mode, page 1371
• Working in KKS Mode in SmartPlant Instrumentation, page 1364
• When renaming a panel, the software does not update the cable naming
according to KKS rules.
• If you change the naming convention, it only affects new items. Existing
items retain their names according to the previous naming convention.
• The software does not make any validations between the item type and the
KKS code.
• The software does not validate imported data. For this reason, you need to
check the source data before importing it. It is recommended to use the
comparison list before importing line, equipment, or wiring data. For
instrument tags and loops, you can map the appropriate segments of the
source data to the KKS data segments in SmartPlant Instrumentation.
• Moving a loop to another plant group or associating an instrument or a
loop with another loop does not affect the tag naming.
• The software correlates instrument types by name using the KKS
component classification. The KKS seed database includes a
representative list of instrument types, which you should review and
update as needed prior to project execution.
Related Topics
• Working in KKS Mode in SmartPlant Instrumentation, page 1364
To import data, you need to have some knowledge of the SmartPlant Instrumentation
database structure and concepts such as naming conventions. You should also know
how to connect to the source and target databases (for example, correct ODBC
profile, or native connection to the database).
The Import Utility is essential because inserting data into SmartPlant Instrumentation
is not a trivial matter. Since the SmartPlant Instrumentation table structure is
relational, there is a constant maintenance of integrity constraints. You have to keep
the relation between the tables and create unique values in the primary key.
Therefore, you have to insert data into SmartPlant Instrumentation only through the
SmartPlant Instrumentation interface or by using the Import Utility.
If you are importing a value for which the number of characters exceeds the
maximum allowed, the Import Utility truncates the extra characters in the target field
in the SmartPlant Instrumentation database. If, as a result of truncating the value, the
string is identical to an existing value in the database, the Import Utility rejects the
import if the value is required to be unique and the import mode in the import link
properties is set not to overwrite the existing value.
Important
• If you intend to import a large number of records (more than 400 records)
in one import session, you must create a new section in the Intools.ini file
called [Rules] and add the following parameter: disable = y.
Related Topics
• General Import Prerequisites, page 1468
• Import Links: An Overview, page 1388
• Importing Data Common Tasks, page 1470
• Oracle (only if you have selected Oracle as your current database platform
during Setup)
• SQL Server (only if you have selected SQL Server as your current
database platform during Setup)
• Sybase Adaptive Server Anywhere (only if you have selected Sybase
Adaptive Server Anywhere as your current database platform during
Setup)
• Microsoft Access
• DBF (SmartPlant Instrumentation comes shipped with .dbf files. These
files appear in the path <SmartPlant Instrumentation home folder>Import.
You can use these files as examples when learning how to import source
data from .dbf files.)
• ASCII delimited files
• Excel worksheets
• Text files
Note
• To install drivers and profiles of ODBC platforms other than those listed
above, you need to install the appropriate software, for example, Excel 7
or later, Microsoft Access, and so forth.
You can import data from a database platform (for example, Oracle, SQL Server or
Sybase Adaptive Server Anywhere) other than your current SmartPlant
Instrumentation database platform. To do this, you have to comply with the
appropriate system requirements of the external database platform. For example, if
your current SmartPlant Instrumentation database platform is Sybase Adaptive Server
Anywhere and you want to import data from an Oracle database, you must have
Oracle client installed and running on your computer.
You can also import from database platforms other than those specified above. To do
this, you need to provide drivers and modify the appropriate configuration files.
Related Topics
• Create an Import Link for a File Source, page 1394
• Create an Import Link for an ODBC Source, page 1392
• Create an Import Link for an Oracle Source, page 1393
• Define a Data Import Source in Excel Spreadsheets, page 1396
Important
• You must have Domain Administrator access rights to be able to perform
import activities.
You can start the Import Utility in one of two ways:
Every link must belong to a link group, so if you do not create an group, links that
you create automatically appear in the All link group. Other link groups that you
create are considered user-defined. You can create as many user-defined link groups
as you require, edit or delete them when needed, move links from one group to
another, duplicate links, or associate the same link with more than one group.
Changing properties of such a link in one group results in changing the properties of
all instances of this link in all the groups it is associated with. You can only delete a
link group together with the links this group contains. Deleting a link group results in
deletion of all the group links from the All group as well.
You can import data either from a specific link or from all links in the group in batch
mode. For batch mode, the Import Utility runs the group links one after another with
the link that appears right under the group name in the Link Explorer having the
highest priority.
Related Topics
• Import Links: An Overview, page 1388
• Managing Import Link Groups Common Tasks, page 1379
Delete Links
Use this procedure to delete one or more links that you no longer require. For details,
see Delete Links, page 1386.
Related Topics
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Link Groups: An Overview, page 1378
Related Topics
• Link Groups: An Overview, page 1378
• Managing Import Link Groups Common Tasks, page 1379
• Rename a Link Group, page 1381
Related Topics
• Import Links: An Overview, page 1388
• Managing Import Link Groups Common Tasks, page 1379
• Rename a Link in the Link Explorer, page 1381
Tip
• If you have a link that appears right above the link that has the lowest
priority and you want to swap the positions of these links, move the
higher link down.
Related Topics
• Link Groups: An Overview, page 1378
• Managing Import Link Groups Common Tasks, page 1379
Caution
• We recommend that you do not modify the import method when
duplicating a link. This is because the source link properties are also
duplicated and might be not applicable for a new link if you change
the import method. For example, suppose your source import link
properties include multi-tag spec options and the link is assigned to the
Module (multiple tables) import method. If you change the import
method to Single table, select a specification table, and save the link
under a new name, the multi-tag spec option properties are applied to
the new link as well. You cannot manually dissociate these properties
from the duplicated link because the multi-tag spec options are
disabled on the Link Properties dialog box when the link is assigned
to the Single table method.
4. On the toolbar, click to display the duplicated link in the link group.
Related Topics
• Import Links: An Overview, page 1388
• Link Groups: An Overview, page 1378
• Managing Import Link Groups Common Tasks, page 1379
Related Topics
• Import Links: An Overview, page 1388
• Link Groups: An Overview, page 1378
• Managing Import Link Groups Common Tasks, page 1379
Related Topics
• Import Links: An Overview, page 1388
• Link Groups: An Overview, page 1378
• Managing Import Link Groups Common Tasks, page 1379
Related Topics
• Link Groups: An Overview, page 1378
• Managing Import Link Groups Common Tasks, page 1379
Delete Links
Caution
• Link deletion is irreversible. When deleting a link, the software
permanently removes this link from all link groups it is associated with,
including the shipped group All. For this reason, you should exercise an
extreme caution when deleting links.
1. In the Link Explorer, click the group containing the links you want to delete.
2. In the right pane, select links that you want to select (press Ctrl or Shift for
multiple selections).
3. On the toolbar, click (Delete).
4. When prompted, click Yes to confirm the deletion.
Tip
• You can delete links by deleting the entire link group. For details, see
Delete a Link Group, page 1386.
Related Topics
• Link Groups: An Overview, page 1378
• Managing Import Link Groups Common Tasks, page 1379
The first step in building a new link is to define the source data using your database
tools or a file source. When defining an import link, you need to establish a
connection to the source database or file that contains predefined source data. Your
import source must contain at least one field, even if you want to specify an import
value manually. You either map existing source fields or specify import values
manually in the Import Link window.
The second step in creating an import link is to specify the import method. The
import method can be either Single table or Module (multiple tables). The Single
table method is useful when you need to or to import specific items or update
properties of items that already exist in SmartPlant Instrumentation. This method is
especially useful when importing wiring data. First, you import your panels into the
PANEL table. Then, you import terminal strips into the PANEL_STRIP table and
make appropriate associations with the previously imported panels. Then, you import
terminals into the PANEL_STRIP_TERM table, and so forth. You can also use the
Single table method in conjunction with data import into reference tables. The
Module (multiple tables) method is useful for massive data import. For example,
you need to use this method to import multiple tag numbers, loop numbers,
supporting table values, and automatically associate appropriate supporting table
values to the imported instrument and loops. This method, however, is not useful for
wiring data import due to the complexity of wiring connections and parent item –
child item relations in SmartPlant Instrumentation.
When creating an import link, you must define a unique link name. If you create
several links, you might need to categorize them into link groups. For details, see
Link Groups: An Overview, page 1378. You create, rename, delete import links, and
associate them with link groups in the Link Explorer window. Also, you can move
import links between databases or domains. For details, see Moving Links Between
Databases or Domains: An Overview, page 1390. It is possible to run import links in
batch mode, in order of priorities.
After creating an import link, you need to set various properties for the link on the
Link Properties dialog box. The properties that appear on this dialog box depend on
your import method and target table or module selection. For details, see Defining
Import Link Properties Common Tasks, page 1401.
Important
• If you intend to import a large number of records (more than 400 records)
in one import session, you must create a new section in the Intools.ini file
called [Rules] and add the following parameter: disable = y.
Related Topics
• Defining Import Links Common Tasks, page 1391
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Formulas and Arithmetic Functions in Import Links, page 1447
• Prioritize Links in a Link Group, page 1382
• String Operators in Import Links, page 1446
Cautions
• Make sure that instrument naming convention is the same in the source
and target domains. Otherwise, you will not be able to carry out the
import process automatically. In this case, you will first need to modify
the links of the naming convention of the required part of the name.
• The source and the target domain or database for the links must be of the
same version of SmartPlant Instrumentation.
Related Topics
• Defining Import Links Common Tasks, page 1391
• Export a Group of Links, page 1399
• Import Links, page 1399
• Import Links: An Overview, page 1388
Export Links
Use this procedure when moving a link or exporting a group of links to another
database or domain. When you export a group of links you transfer the information
about a group of links to an ASCII file which has the .imp extension. You can then
use the exported links in other domains or databases. The link information is saved to
an ASCII file which you can use for import. For more information, see Export a
Group of Links, page 1399.
Import Links
Use this procedure to import the link or group of links you exported. You can use a
file with the .imp extension to create a group of links based on the information you
have saved in this file. For more information, see Import Links, page 1399.
Related Topics
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Import Links: An Overview, page 1388
3. On the Link Definitions dialog box, under Import method, click Single table or
Module (multiple tables) and select the appropriate target table or module from
the list.
Important
• You can import data only into a target table which has a table
definition (for example, a table which has a correct definition of a
primary key, foreign keys, and reference tables). If you import data
into a target module, all the tables in the target module must have a
table definition.
4. Under Source, from the Database type list, select ODBC as the source database
platform.
5. From the ODBC profile list, select the required database profile or a file that
contains source table definitions.
Tip
• Your selection affects the way you connect to the SQL data source and
the dialog box options change accordingly.
6. Do one of the following:
• If you selected a database profile, specify the user name and password
for connecting to the source database and click Connect; then, from
the Table list, select a table from which you want to import data.
• If you selected a data source file, beside File name and path, click
Browse and specify the data source file.
Tip
• If you are creating a new link on the basis of an existing link, select
Save as new link.
7. Click Apply and then Close.
8. Click to display the link you defined in the Link Explorer.
Related Topics
• Create an Import Link for a File Source, page 1394
• Create an Import Link for an Oracle Source, page 1393
• Defining Import Links Common Tasks, page 1391
• Import Links: An Overview, page 1388
• On the Actions menu, click New Group (or click ) to create a new
link group.
Related Topics
• Create an Import Link for a File Source, page 1394
• Create an Import Link for an ODBC Source, page 1392
• Defining Import Links Common Tasks, page 1391
• Import Links: An Overview, page 1388
• Target Table Definition: An Overview, page 1413
• On the Actions menu, click New Group (or click ) to create a new
link group.
• In the link list, select an existing link group.
Related Topics
• Define a Data Import Source in Excel Spreadsheets, page 1396
• Defining Import Links Common Tasks, page 1391
• Import Links: An Overview, page 1388
Related Topics
• Create an Import Link for a File Source, page 1394
• Defining Import Links Common Tasks, page 1391
• Import Links: An Overview, page 1388
• Set Properties for an Excel Data Source, page 1411
Related Topics
• Create an Import Link for a File Source, page 1394
• Defining Import Links Common Tasks, page 1391
Related Topics
• Defining Import Links Common Tasks, page 1391
• Import Links, page 1399
• Import Links: An Overview, page 1388
• Moving Links Between Databases or Domains: An Overview, page 1390
Import Links
1. On the Service menu, click Import Links.
2. In the Open File dialog box, navigate to the required ASCII file with the .imp
extension which you want to use for import and click OK.
3. When prompted, click Yes to import the group of links from the .imp file.
4. On the Database Table Definition dialog box, select the Import link table
definition check box to import the table definition saved in the group of links as
well as the links themselves, or clear the check box to import only the group of
links.
5. Under Duplicate table definition names, do one of the following:
• Click Create new to import the link table definition if the imported
table definition name is the same as the current table definition. This
way, the Import Utility appends a $ sign to the imported table
definition name. For example, Process Data will be renamed as
Process Data$.
• Click Skip to skip the import of the table definition if the current table
definition name is the same as the imported table definition.
6. Click OK to import the group of links.
Tip
• If the links groups or links that you import already exist, the software
appends a $ sign to the imported link or group name.
When duplicating an import link, all the source import link properties are retained.
Related Topics
• Defining Import Link Properties Common Tasks, page 1401
If the Import Utility detects a change in the selected source refreshing key contents
(in comparison to the selected target refreshing key contents), the target table column
contents will be updated accordingly. For more information, see Refresh Previously
Imported Data, page 1411.
Related Topics
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Link Properties: An Overview, page 1400
Tip
• Selecting the Use default value option overrides any selections
you make in the Default column on the Target Table Definition
dialog box. To learn how to use the Target Table Definition
dialog box, see Target Table Definition: An Overview, page 1413.
• Select Reject rows to set the Import Utility to reject all source rows
that contain reference columns that do not appear in the appropriate
reference table during the import process.
Related Topics
• Common Error Messages, page 1517
• Defining Import Link Properties Common Tasks, page 1401
• Link Properties: An Overview, page 1400
c. Do not insert
• Select to skip inserting source rows that do not exist in the target
table.
• Clear to insert source rows that do not exist in the target table.
Related Topics
• Defining Import Link Properties Common Tasks, page 1401
• Refresh Previously Imported Data, page 1411
• Target Table Definition: An Overview, page 1413
• The condition in the data window is valid - in this case the message
also indicates the number of rows which match the condition.
• The condition in the data window is invalid - in this case you can
correct the condition and try again.
7. To view the way the filtering condition affects the source data, click View
Source.
8. Click OK to close the Import Source Filter dialog box and return to the Source
tab where your condition appears in the data window.
Tip
• You can disable the current filtering condition without deleting it. To
do this clear Filter the source table after you define a condition.
9. Under Associate source tables, select Apply to associate additional source data
with the source data that you selected when you started this import session. To
make the source data definitions, click Define. See Associate Additional Source
Data, page 1434 to learn how to do this.
10. Under Process function, select Assign to assign SmartPlant Instrumentation
process functions to the imported data based on their instrument types. To make
the source data definitions, click Define. For details, see Associate Source Fields
with Existing Instrument Types, page 1486 or Set Source Fields as Instrument
Type Fields, page 1484.
Related Topics
• Defining Import Link Properties Common Tasks, page 1401
• Viewing the Source Data, page 1431
• Working with Source Data, page 1432
• Clear Use the loop reference data to disregard any loop reference
data during the import process.
Caution
• To prevent import failure, clear Use Loop reference data if the
imported COMPONENT table contains empty loop reference columns.
6. If you selected in the beginning of the current import session to import into the
Instrument Index module, the Use Tag data check box appears in the Tag/Loop
tab folder. In this case, do one of the following:
• Select the check box to include source tag number data from
supporting tables in the current import. You will need to redefine the
naming conventions for all target <units> in the Administration
module before you start the import process.
• Clear the check box to exclude tag supporting table data from the
current import session.
Related Topics
• Define Links for Naming Conventions, page 1442
• Defining Import Link Properties Common Tasks, page 1401
5. To select the dimensional group to be used in the Import Link window for
importing data to the Dimensional Data for Piping module custom fields, under
Select dimensional group for custom name, select Apply to enable a selection
to be made from the list, and then from the list, select the browser view style
whose custom fields you want to show in the Import Link window. The
following options are available:
• Computed group name — Automatically creates the source for the
Dimensional Group Name field in the Import Link window, using
the group from the COMPONENT_DIMENSIONAL table to which
the tag defined in the link belongs.
• All Groups — Allows you to import data for all custom fields in the
module. The Dimensional Group Name section in the Import Link
window consists of two table columns: Dimensional Group CAD
Code and Dimensional Group Description. With this option
selected, you can enter an existing group or a new group for the source
name.
Tip
• All the custom fields are displayed in the Import Link window and
are assigned sequential numbers.
Related Topics
• Defining Import Link Properties Common Tasks, page 1401
Related Topics
• Defining Import Link Properties Common Tasks, page 1401
Caution
• Changing the settings in the Target Table Definition dialog box alters the
relations between the tables. We therefore recommend you do not change
these settings unless absolutely necessary and only if you are familiar with
the SmartPlant Instrumentation database structure.
When importing data using the Comparison List options, table definitions allow you
to control the way in which the Import Utility regards the source and the target rows
as identical during the import process. This is important, because when the Import
Utility encounters identical source and target rows, it can overwrite the target row or
leave it intact, depending on the Comparison options which you select on the Link
Properties dialog box. You can therefore control the import process result by
selecting the appropriate import comparison criteria.
Every SmartPlant Instrumentation table has a key definition, which is used to specify
a unique set of values. You can use one or more table columns in each table as
constituents of the key definition.
Reference table column — Appears in every table and is used by the user to access
the table. For the COMPONENT table, the reference column is CMPNT_NAME.
This means that each row in the COMPONENT table has a different value in the
CPMNT_NAME column. You can select an appropriate reference table column for
every table in the database. This way you can create a different comparison criteria
for each table.
Foreign key — In some tables, the key name is designated as a foreign key, which
is used as a reference column to link to another table called a reference table. For
example, the CPMNT_MFR_ID foreign key in the COMPONENT table contains the
COMPONENT_MFR table value in its key definition. This way, the CPMNT_MFR
foreign key column links the COMPONENT table to the COMPONENT_MFR table.
This allows SmartPlant Instrumentation to obtain the required instrument
manufacturer data from the COMPONENT_MFR table. You can create a link to
other tables by defining appropriate foreign keys. This way the Import Utility
imports additional reference data during the import process, depending on the
selection you make on the Source tab of the Link Properties dialog box.
Regular column — Appears in most tables and contains the appropriate table data
such as display color, item price, remarks, specifications, and so forth.
Notes
• Both the key name and the reference table column provide access to the
SmartPlant Instrumentation database, but only the reference table column
is accessible to you (the key name is for SmartPlant Instrumentation
internal use only).
• When comparing rows, the Import Utility treats source and target rows as
identical only if both the source and the target reference table column
values are the same. For example, if the COMPONENT table in both
source and target rows contains the same values in the reference table
column data fields, both rows are considered as identical.
• When the Import Utility encounters identical source and target rows it can
either replace the contents of the target row with the source row contents
or leave this target row intact, depending on the import process settings.
Related Topics
• Comparison Options Common Tasks, page 1457
• Import Comparison, page 1455
• Setting the Import Comparison List Options, page 1456
Related Topics
• Modify a Table Definition, page 1421
• Target Table Definition: An Overview, page 1413
• The value in the Reference Key data column is the same as the one
specified under Key Name; in this case the Reference Key data column is
left empty, as in the following example:
If using the CABLE_MOD_ID from the CABLE table in the key definition,
the key name CABLE_ID is identical to the reference key.
• The value in the Reference Key data column is different from the one
specified under Key Name; in this case the appropriate value appears
under the Reference Key data column, and the column title Reference
Key is displayed in bold text, as in the following example:
If using the CONNECTOR_SIDE1_ID from the CABLE table in the key
definition, the key name CABLE_ID is different from the reference key, the
value of which in this case is CONNECTOR_ID.
Related Topics
• Modify a Table Definition, page 1421
• Target Table Definition: An Overview, page 1413
Related Topics
• Modify a Table Definition, page 1421
• Target Table Definition: An Overview, page 1413
Key Levels
The key level operation is designated for tables that contain terminal strip data, such
as PANEL_STRIP, STRIP_CONFIG, STRIP_MFR, and so forth. You can specify
what fields the Import Utility creates during the import process prior to generating a
selected target column. You do this by activating the key level option and specifying
the required target field to create prior to generating the selected target field.
Example
The STRIP_MFR_MOD table primary key contains two columns: STRIP_MFR_ID
and STRIP_MOD_NAME.
To generate the STRIP_MOD_NAME column, the Import Utility will create the
STRIP_MFR_ID and the STRIP_MOD_ID columns prior to generating the
STRIP_MOD_NAME column.
If you select Define parameters for key levels, in the Column definition pane, the
Import Utility automatically creates the fields which you specify under Key Level
prior to generating the corresponding table column under Column Name.
Caution
• The software does not validate whether your table definition is correct.
Importing wiring data using incorrect table definitions or altering default
definitions might result in severe data integrity problems in SmartPlant
Instrumentation.
For more information, see Modify a Table Definition, page 1421.
Related Topics
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Target Table Definition: An Overview, page 1413
5. When prompted to set the selected definition as the active definition instead of the
existing one, click Yes.
Related Topics
• Table Definitions Common Tasks, page 1419
• Target Table Definition: An Overview, page 1413
• Select the Local check box to follow the previous- level numbering to
make the currently defined table column address unique in the target
database.
• Clear the Local check box to follow the global numbering in
SmartPlant Instrumentation.
12. To modify the definition of the additional column of the current table, do the
following:
a. Drag the appropriate table columns from the Column definition pane to the
Key definition working area.
b. If needed, select Define parameters for Level Key to specify the columns for
automatic creating during the import process. This way, in the Column
definition pane, the Import Utility creates the table columns specified under
Level Key before creating the corresponding table columns under Column
Name.
c. In the Column definition pane, click to display the Level Key fields.
d. Under Level Key, do one of the following:
• Type the names of the table columns to be created by the Import
Utility during the import process before it creates the
corresponding table columns under Column Name.
• Clear Define parameters for Level Key to discard the table
columns specified under Level Key.
13. Click Apply.
14. When prompted, click Yes to confirm the changes and clear the Key definition
working area.
15. Click Save to save your selection of table keys.
16. Click Close to close the Table Definition dialog box.
Related Topics
• Import Wiring Connection Data, page 1516
• Table Definitions Common Tasks, page 1419
• Target Table Definition: An Overview, page 1413
8. Click Close.
Related Topics
• Table Definitions Common Tasks, page 1419
• Target Table Definition: An Overview, page 1413
Related Topics
• Table Definitions Common Tasks, page 1419
• Target Table Definition: An Overview, page 1413
Related Topics
• Working with Log Files Common Tasks, page 1427
For more information, see Create a New Log File, page 1428.
For more information, see Open an Existing Log File, page 1428.
For more information, see View the Current Log File, page 1428.
For more information, see Check the Name of the Current Log File, page 1429.
For more information, see Close the Current Log File, page 1429.
Caution
• This action deletes the selected log file from your hard disk.
For more information, see Delete an Existing Log File, page 1429.
For more information, see Log the Import Parameters, page 1430.
Related Topics
• Working with Log Files: An Overview, page 1426
Tip
• The current log file is opened for viewing by Notepad. SmartPlant
Instrumentation uses Notepad to view the log file. However, Notepad
is limited by file size that it can handle. If your log file becomes too
large for Notepad, you will get an appropriate message. In this case
you can view your log file using Windows Write or another
appropriate utility.
Related Topics
• Working with Log Files Common Tasks, page 1427
Related Topics
• Working with Log Files Common Tasks, page 1427
Note
• You can use associations which have been previously saved in a link. To
do this you have to start the import process using a previously saved link.
For more information, see Associate Additional Source Data, page 1434.
Related Topics
• Working with Source Data, page 1432
Caution
• In SmartPlant Instrumentation, table columns contain numbers (num
type columns) and characters (char type column). You cannot
associate a num type column with a char type column or the other
way around.
8. Repeat the previous step to associate other data items as desired.
Tip
• You can associate several items with a single data set item, however,
you cannot associate data from a data set with itself.
• To delete an association, select the desired item in the Source for
association data window and press Delete on the keyboard.
9. Click Verify to make sure your selections are valid (this way you can check, for
example, whether the associated table columns are both of the same data type –
numeric or alphanumeric).
An appropriate message is displayed: if the associations are valid, the total
number of rows of the source data set (including the associated data) is
indicated, or else you are notified that the associations are invalid, in which
case you should correct your selection in the Source Associations dialog box.
10. Click Confirm.
11. At the prompt, click Yes to save your associations.
The data sets disappear from the right data window and appear at the top of
the left data window.
12. To make the fields of the associated data appear in future dialog boxes, do the
following:
a. Expand the associated data sets by double-clicking them.
b. Click once on every item you want to view.
The icons appear as follows:
• Item selected:
Related Topics
• Specify a Filtering Condition, page 1405
• SQL Functions Native to the Source Database, page 1437
Example:
The COMPONENT table contains a primary key table column, CMPNT_ID, which is
an internal SmartPlant Instrumentation database key, and a primary key
CMPNT_NAME, which contains the tag number.
If you import data using the Single table method you can:
• Allow the Import Utility to generate the primary key data field
automatically according to the naming conventions that you will enter; to
do this you will need to manually define appropriate naming conventions
for both the tag and the loop. This way, the primary key data field will
contain the value Computed which means that its contents have been
predetermined by the Import Utility, based on the naming conventions you
entered.
• Use the naming conventions in the link; this way you will need to
manually create the primary key data field contents and naming
conventions by specifying the appropriate parts (for example, PREFIX,
SUFFIX). This way, you define the value of all the target data fields that
you require either by typing in the appropriate value in the target data
field, or by selecting the appropriate source table column and linking it to
the desired target data field.
Note
• If you select to import data using the Single table method you must define
the links of all primary key data fields. If you have selected to import data
using the Module (multiple tables) method, you do not need to define the
links to all the primary key data fields, because it is possible to limit the
import of data only into certain target tables.
At this stage you can also::
• Make a more precise selection by selecting the required source and target
rows which will be processed during the import process.
• Select the reference tables you want to import.
• Save the current link to be used in future import sessions.
• View the source rows.
When you finish defining the mapping between the target and the source, you will
come to the end of the import setup process at which point you will be able to carry
out the actual import of data.
Related Topics
• Configure Source Data for Variable Length Data Fields, page 1445
• Formulas and Arithmetic Functions in Import Links, page 1447
• Map Source and Target Fields Common Tasks, page 1441
• Tag Class Mapping Codes for Instrument Index Import, page 1448
• You have selected the Redefine the naming conventions check box in
the Tag/Loop tab on the Link Properties dialog box.
• You have started a new import session but you did not clear Define the
naming conventions in the link check box in the Tag/Loop tab on the
Link Properties dialog box.
You define the links for the naming conventions on the Define Tag Name Structure
dialog box and/or on the Define Loop Name Structure dialog box depending on
whether the target contains component names, loop names or both. You have to
complete the definitions in one or both dialog boxes depending on whether the target
table or tables contain one or both naming conventions.
The current naming conventions are those that the Domain Administrator previously
defined in the Administration module. For more information, see Define Links for
Naming Conventions, page 1442.
Related Topics
• Example of Concatenated Sources, page 1491
Tip
• You should ensure that your source data configured correctly if the
loop or tag names are likely to be of variable length. For details, see
Configure Source Data for Variable Length Data Fields, page 1445.
8. In the Start column of the Name Convention data window, enter the starting
location of the string within the naming convention.
Tip
• If you click Cancel in the Define Tag Name Structure dialog box or
in the Define Loop Name Structure dialog box without completing
the tag or loop definition, an appropriate message will be displayed,
after which you will return to the Link Explorer.
9. Select Enable any source name for prefix to allow you to enter any value for the
prefix or clear the check box to restrict the prefix to a fixed value based on the
current plant hierarchy item.
Tip
• If you are importing data for both loops and tag numbers, you must
select or clear this option for both the loop and tag name structures.
10. Click View Source to view the source table. For further details, see Viewing the
Source Data, page 1431.
11. Click OK to proceed with the import setup process.
Related Topics
• Define the Import Mapping, page 1444
Related Topics
• Define the Import Mapping, page 1444
• Map Source and Target Fields Common Tasks, page 1441
• Viewing the Source Data, page 1431
Tip
• If you need to define import mapping for a process function
(PROC_FUNC_NAME column), note that you can set the software to
use the @PROC_FUNC_NAME macro, so that you do not need to
define manual mapping for process function and instrument type
fields. The software uses this macro if you have assigned process
functions to instrument type fields using the Source tab options of
Link Properties dialog box. For details, see Set Source Fields as
Instrument Type Fields, page 1484. This macro appears in the Import
Link window whenever the PROC_FUNC_NAME column exists in
the target table.
5. After defining all desired settings in the Import Link window, do one of the
following:
• Click to start an import test run which helps you evaluate the import
results without saving data to the target table or tables. For details, see
Test the Import Process, page 1471.
• Click to start the import process.
• Click to save the current link settings in the Import Utility. You
can use the saved link in other import sessions.
Related Topics
• Example of Concatenated Sources, page 1491
• Map Source and Target Fields Common Tasks, page 1441
• String Operators in Import Links, page 1446
For example, the source table may contain the following tags (the instrument type is
indicated in bold type):
108FT100
108ICP100
108FT100
108ILP100
In this case the data field in bold type varies in length according to the particular tag.
Therefore, you need to create a separate data field for each of the parts of the
instrument type, for example:
108 FT 100
108 ICP 100
108 FT 100
108 ILP 100
If you have defined a fixed-name string as a prefix, you do not have to link source
data to this part of the naming convention. The Import Utility will create this part
automatically during the import process.
Related Topics
• Formulas and Arithmetic Functions in Import Links, page 1447
• Map Source and Target Fields Common Tasks, page 1441
• String Operators in Import Links, page 1446
Tip
• You can use any combination of the string operators in an import link.
Related Topics
• Configure Source Data for Variable Length Data Fields, page 1445
• Example of Concatenated Sources, page 1491
• Formulas and Arithmetic Functions in Import Links, page 1447
• Map Source and Target Fields Common Tasks, page 1441
The source can be composed of several different functions using the arithmetic
operators (+, -, /, *) in addition to the string operators. The following conventions
apply:
• Arithmetic operators are treated as such only in data fields whose table
column type is number.
• Each arithmetic operator is preceded by the '!' character, for example:
param1 !+ param2 !- param3(If the values are: param1 = 2, param2 = 10, and param3
= 5, the result of the above formula will be 7.)
In the following example, the fluid temperatures are calculated using the base
temperatures in the following formulas:
Related Topics
• Configure Source Data for Variable Length Data Fields, page 1445
• Example of Concatenated Sources, page 1491
• Map Source and Target Fields Common Tasks, page 1441
• String Operators in Import Links, page 1446
• When defining a link for importing data using the Module method, the
Import Link window displays Tag Class under the Target Name column
and also displays CMPNT CAT ID under the Column Name column.
• When defining a link for importing data directly into the COMPONENT
table, using the Single table method, the Import Link window only
displays CMPNT CAT ID under the Target Name column.
The following table lists ID values for all possible instrument tag classes that
SmartPlant Instrumentation supports. Note that there is no 4 value.
Related Topics
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Import Instrument Index, page 1488
• Importing Data Common Tasks, page 1470
• Map Source and Target Fields Common Tasks, page 1441
Caution
• Do not import data into the PROCESS_FUNCTION table. This might
damage your database.
Related Topics
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Import Instrument Index, page 1488
• Importing Data Common Tasks, page 1470
• Map Source and Target Fields Common Tasks, page 1441
Note
• In the Import Link window, the Fluid State (PD_FLUID_PHASE)
column is also referred to as Upstream Condition.
Fluid State (PD_FLUID_PHASE) Mapping Code
Gas/Vapor G
Liquid L
Steam S
Water W
Solid/Powder P
Related Topics
• Create Specs Using the Module Import Method, page 1492
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Importing Data Common Tasks, page 1470
• Map Source and Target Fields Common Tasks, page 1441
The following table lists all the codes that you need to use for correct import of
wiring data. You must either include the codes in the import source in a separate
column or define the code values manually when mapping the wiring data columns in
the Import Link window.
Related Topics
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Importing Data Common Tasks, page 1470
• Importing Wiring Data Common Tasks, page 1504
• Importing Wiring Data, page 1502
• Map Source and Target Fields Common Tasks, page 1441
Import Comparison
After you have run an import session on a set of data at least once, you can run
subsequent sessions by comparing the new rows to be imported with previously
imported rows. You can do this from the Import Comparison List dialog box as
well as from the Comparison tab in the Link Properties dialog box. You can also
start transferring data after you have selected specific rows that you want to import
from the source to the target.
Related Topics
• Comparison Options Common Tasks, page 1457
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Setting the Import Comparison List Options, page 1456
• Target Table Definition: An Overview, page 1413
This feature provides you with the means to coordinate between the rows to be
inserted, deleted or updated during the import process. You do this by reviewing the
source and target rows and selecting the appropriate rows which will be processed
during the import process.
Note
• The Comparison tab only becomes active after the first time you have
imported data and saved the selected link.
Related Topics
• Comparison Options Common Tasks, page 1457
• Import Comparison, page 1455
• Target Table Definition: An Overview, page 1413
Related Topics
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Import Comparison, page 1455
• Setting the Import Comparison List Options, page 1456
2. If you selected the By mode option, under Import mode, do one or more of the
following:
• Select Inserted to select all the source rows whose status is Insert (for
example, the letter I appears in the Mode column).
• Select Updated to select all source and target rows whose status is
Update (for example, the letter U appears in the Mode column).
• Select Deleted to select all source rows whose status is Delete (for
example, the letter D appears in the Mode column).
• Select Refreshed to select all source and target rows whose status is
Refresh (for example, the letter R appears in the Mode column).
Tip
• You can select more than one import mode by which the data in the
data window will be displayed. This way you show the source and
target data by more than one import mode.
3. Click Display to display rows in the Comparison data pane according to the
specified filtering options.
Related Topics
• Comparison Options Common Tasks, page 1457
Tip
• Placing the cursor on the scroll box displays the current page number.
Scroll the box down in the scroll bar to display the total number of
pages that the printout includes.
3. Click Print.
Related Topics
• Comparison Options Common Tasks, page 1457
Suppose a source table contains a code (for example, A) that is used as a reference in
another source table. This code may be different from the one used in your
corresponding target SmartPlant Instrumentation database (for example, psia).
Therefore, prior to running import, you have to make the appropriate adaptations for
the system codes and unit of measure codes.
Note
• If you want to use system codes in your current import session, you must
select the appropriate source system and adapt its code prior to starting the
import of data (see the procedure below for details). Also note that the
target code values are predefined in the system and cannot be modified.
When importing process data and/or calculation data and the units of
measure are not defined, the Import Utility will insert default unit of
measure values belonging to the SmartPlant Instrumentation <unit> with
which the imported tag data is associated.
To adapt source system and unit of measure codes you need to do the following:
• Select the source system whose codes you want to adapt. for details, see
Define Source Systems, page 1462.
• Adapt the source codes to the target codes. for details, see Adapt System
Codes, page 1463.
Using this feature you can also keep the code adaptation data in a text file (with a .cds
extension) and use it in future import sessions. You can do the following:
• Import a code file that contains adapted system codes, unit of measure
codes or both. For details, see Import Codes, page 1465. Importing codes
this way does not overwrite the current code adaptations.
• Export a code file that contains adapted system codes, unit of measure
codes or both. For details, see Export Codes, page 1466.
• Display the name of the source system set as the currently source system.
For details see View the Currently Selected Source System Name, page
1466.
Import Codes
This feature allows you to import from the same code file (with a .cds extension) both
the system codes and the unit of measure codes or just one of them, depending on
whether these codes exist in the ASCII file you are going to use. This way you can
use code adaptation settings that were previously saved in files without having to
redefine the code adaptation for every case. For more information, see Import Codes,
page 1465.
Export Codes
This feature allows you to export the current code settings of any selected source
system to a code file (with a .cds extension). You can export both the system codes
and the unit of measure codes or just one of them. This way you can keep code
adaptation settings in a file and use them in future import sessions without having to
redefine the code adaptation for every case. For more information, see Export Codes,
page 1466.
Related Topics
• System Codes Table, page 1522
• System Codes: An Overview, page 1460
• Unit of Measure Codes Table, page 1531
Related Topics
• Working with System Codes Common Tasks, page 1461
Related Topics
• Working with System Codes Common Tasks, page 1461
Related Topics
• Adapt Unit of Measure Codes, page 1464
• Unit of Measure Codes Table, page 1531
• Use Source Codes in an Import Link, page 1466
• Working with System Codes Common Tasks, page 1461
Import Codes
1. On the Codes menu, click Import Codes.
2. On the Import Codes dialog box, do one of the following:
• Under File, type the full path and filename of the ASCII file from
where you want to import the codes, if you know it.
• Click to navigate to the required file.
3. Under Import data, select the code type you want to import: system codes, unit
of measure codes, or both.
Tip
• The code type that will be imported depends on whether the file you
selected in step 2 in this procedure actually contains the code type that
you select in the Import data section.
4. Click OK to import the selected codes.
Note
• Importing codes from an external file does not overwrite existing code
settings.
Related Topics
• Working with System Codes Common Tasks, page 1461
Export Codes
1. On the System Codes menu, click Export Codes.
2. On the Export Codes dialog box, select one or more source systems whose code
settings you want to export to a .cds file. To deselect a system, click it again.
3. Under Export data, select the code type you want to import: System codes, Unit
of measure codes, or both.
4. Click OK.
5. On the Enter Export File Name dialog box, select the file where you want to
keep the codes of the system you selected in step 2 in this procedure.
6. Click Save to export the codes to the selected file.
Related Topics
• Working with System Codes Common Tasks, page 1461
9. In the Import Link window link, select the check boxes in the target window
under the Code column for those link parameters for which you want to use
source codes.
Tip
• To use all available source codes in the link, on the menu bar, click
Actions > System Codes > Check All.
Related Topics
• Working with System Codes Common Tasks, page 1461
101-AAAA-BBBB
In this convention, 101 is the <unit> number prefix, AAAA represents the instrument
type segment and BBBB represents the tag number segment; the hyphens are segment
separators. Therefore, an instrument with tag number 101FE22212 is represented in
the demonstration domain as 101-FE -2212.
Before starting the import setup process, you need to pay attention to the source table
columns that construct the source instrument and loop and how they match the
SmartPlant Instrumentation instrument and loop data.
When you select an import link that is associated with either instruments or loops,
you are prompted to define the naming convention structure.
Caution
• When redefining the naming convention structure, make sure that no data
redundancy is created. Such a redundancy may be caused, for example, if
the source table columns use data segments that are shorter than those
used in the target table columns. For example, the 101PS2212 source tag
number uses only a two character table column for the instrument type. In
SmartPlant Instrumentation, this tag number appears as 101-PS - 2212.
This situation may cause data redundancy, since this tag number can stand
for either 101-PSH -2212 or 101-PSL-2212.
Related Topics
• General Import Prerequisites, page 1468
• Importing Instrument Index Common Tasks, page 1481
Testing the import process can be useful when testing a single link before carrying
out a large batch operation. A test can also give you an indication on the rejected
rows and allow you to fix the problem prior to a batch operation. A test run is carried
out slightly faster than the actual import operation. For more information, see Test
the Import Process, page 1471.
Related Topics
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• General Import Prerequisites, page 1468
• Matching Naming Conventions, page 1469
Important
• SmartPlant P&ID must be closed before starting the import session, to
ensure that any modifications made to the drawings are properly imported
to SmartPlant Instrumentation.
• Before importing data, familiarize yourself with import prerequisites. For
details, see General Import Prerequisites, page 1468. Also, if you intend
to import a large number of records (more than 400 records) in one import
session, you must create a new section in the Intools.ini file called [Rules]
and add the following parameter: disable=y.
1. Select the import method, which can be either Module (multiple tables) or
Single table.
2. Select the target SmartPlant Instrumentation table or module for the import.
Tip
• When importing data to tables, the order of the import is important.
You should first import data into a table that the next table refers to.
For example, before importing data into the COMPONENT table,
you should import data into the COMPONENT_LOCATION table,
if you want import both instrument locations and instrument tag
numbers.
3. Define the import link properties as you require, using the Link Properties dialog
box options. For details, see Defining Import Link Properties Common Tasks,
page 1401.
4. Establish a link between the source and the target data. You can do one of the
following:
• Use an existing link that was saved previously
• Build a new link and save it (see step 5).
5. To build a new link, do the following:
a. Set the appropriate parameters for the import.
b. Where appropriate, define the structure of the import link.
c. Define the link mapping between the source and the target table columns.
Tips
• You can modify the source definition after creating the link to insure
that all required data exists in your source database. Use the
SmartPlant Instrumentation Data Dictionary to help you identify target
SmartPlant Instrumentation tables.
• If required, you can reset the import order as well as select the
reference tables to import. To learn how to control the import order,
see Target Table Definition: An Overview, page 1413.
6. Run an import test (recommended) For details, see Test the Import Process, page
1471.
7. Perform the import process by clicking in the Import Link window.
On the Import Progress dialog box, review the following information:
Related Topics
• Importing Data Common Tasks, page 1470
• Test the Import Process, page 1471
2. On the Run dialog box, type the following string on the same line:
<
home folder>\import <user name>,<password>,<domain>, <plant>,
<intermediate plant hierarchy item 1>/<intermediate plant
hierarchy item 2>/<intermediate plant hierarchy item
3>...,<unit>,<link> - or - @<link group>,<project>
The string segments in chevrons stand for the following parameters:
The following are two examples of using the command line syntax.
a. Importing data to the demonstration domain by executing a link named Flow
in an owner operator domain:
import DBA,DBA,Demo Domain,Plant 1 - DEMO,Main
Building/North/Room 1,Unit 3,Flow,Demo Project
Important
• The parameter strings must be typed on the same line.
• Plant hierarchy item names into which you intend to import data must
not contain slash / characters because the software interprets these
characters as separators between successive hierarchy levels.
3. Press Enter.
You see the links that you specified in the statement being carried out.
Related Topics
• General Import Prerequisites, page 1468
• Importing Data Common Tasks, page 1470
• Importing Data into Multiple Plant Hierarchy Items or Projects, page
1476
Related Topics
• Importing Data Common Tasks, page 1470
• Test the Import Process, page 1471
When importing data that includes more than one plant hierarchy item, some of the
source rows may recur (due to the existence of several plant hierarchy items). In this
case, you can instruct the Import Utility to differentiate rows of different plant
hierarchy items during the import process, thus importing data into the appropriate
plant hierarchy items. When you select to import data into multiple plant hierarchy
items, you can also specify the level of import, for the Import Utility to differentiate
rows per <plant>, per <area> or per <unit>.
If you select to import data per <plant> or per <area>, the Import Utility rejects rows
defined per <unit>. If you do not specify a plant hierarchy level, the Import Utility
rejects all recurring source rows during the import process. In this case, the Import
Utility does not differentiate between rows of different plant hierarchy items. After
you select the level for which the Import Utility distinguishes unique data during the
import process, you need to select the naming convention to be used during the
import process.
In SmartPlant Instrumentation, database tables are defined per plant hierarchy item.
When a table is defined at a specified level, it contains data which is unique at that
level.
• You select the same import level as the level of the target table (this is the
default option): in this case only the table columns regarding this level (for
example, UNIT_ID, AREA_ID, and so forth) is automatically defined by
the Import Utility as a Primary Key in the target table.
For example:
The target table is COMPONENT (a table defined per <unit>) and you select
on the Import Level tab the <unit> level: the UNIT_ID table column is also
defined as a Primary Key column in the target table.
• You select a higher import level than the level of the target table: in this
case all the table columns regarding the level of the target table and the
levels above (for example, PLANT_ID, AREA_ID) will be automatically
defined as Primary Key columns in the target table.
For example:
The target table is COMPONENT (a table defined per <unit>) and you select
on the Import Level tab the <area> level. In this case both the AREA_ID
table column and the UNIT_ID table column become Primary Key columns in
the COMPONENT Table.
• You select a lower import level than the level of the target table: In this
case all the table columns regarding the level you select and the levels
below will be automatically defined as Foreign Key columns in the target
table.
Related Topics
• Common Error Messages, page 1517
• Import Data Into Multiple Plant Hierarchy Items, page 1478
• Import Data into Several Projects, page 1479
• Importing Data into Multiple Plant Hierarchy Items or Projects Common
Tasks, page 1478
Related Topics
• Importing Data into Multiple Plant Hierarchy Items or Projects, page
1476
• Run an Import Session from the Command Line, page 1473
4. Open the link in the Import Link window and make your link definitions as you
require.
5. Test and import data to the target projects.
Related Topics
• Importing Data into Multiple Plant Hierarchy Items or Projects Common
Tasks, page 1478
• Importing Data into Multiple Plant Hierarchy Items or Projects, page
1476
Related Topics
• Importing Data into Multiple Plant Hierarchy Items or Projects Common
Tasks, page 1478
• Importing Data into Multiple Plant Hierarchy Items or Projects, page
1476
COMPONENT table as the target table for data import. This procedure is useful if
you have already created instrument index in SmartPlant Instrumentation and only
need to assign certain properties to a large number of existing tag numbers. These
properties can be custom field values, supporting table values, or text string
properties, such as Service, Note, and so forth. For more information, see Import
Instrument Properties, page 1490.
Related Topics
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• General Import Prerequisites, page 1468
• Matching Naming Conventions, page 1469
After you select the source table columns to be used as the instrument type name
(abbreviation) and description, when importing data, the Import Utility creates in
SmartPlant Instrumentation new instrument types and instrument type descriptions
according to the existing conventions. For example, when importing instrument type
abbreviation, all characters exceeding the first six characters are truncated. To carry
out a successful import, you need to select the source table columns which are most
compatible with the SmartPlant Instrumentation instrument type, instrument type
description, and process function conventions.
Use the following table as guidelines when selecting source table columns and setting
them as instrument type abbreviation fields and instrument type description fields:
Important
• Both instrument type abbreviation and description are required
parameters. A combination of instrument type abbreviation and
description must be unique.
b. From the Source pane, drag one or more source table columns to the
Instrument type description pane. The values in the source column fields
become instrument type description fields after data import.
Tips
• You can use concatenated sources. For details, see Example of
Concatenated Sources, page 1491.
• Instrument type abbreviation characters that exceed six characters are
truncated. For details about instrument type conventions that exist in
SmartPlant Instrumentation, see Prerequisite for Importing Instrument
Types, page 1483.
4. Click OK to close the Define Instrument Type Fields dialog box.
5. On the Process Function Mapping dialog box, for each instrument type in the
left section, drag the appropriate process function from the right section to either a
light-blue field (unassigned process function) or a white field (previously assigned
process function) in the Process function column next to the appropriate
instrument type.
6. To filter the instrument type fields displayed in the left pane, under Display
process function assignments, do one of the following:
• Select All to display assigned and unassigned instrument types.
• Select Unassigned only to display only instrument types which are not
assigned yet with process functions.
• Select Assigned only to display only instrument types which are
assigned with process functions.
Tips
• If you previously imported instrument types using the current link,
some of the instrument types are already assigned to process functions
and exist in SmartPlant Instrumentation. These instrument types are
displayed in a gray background, and you cannot reassign the process
functions for them.
• The Process Function Mapping dialog box displays all the source
fields that belong to the source table columns you set as instrument
type and description columns on the Define Instrument Type Fields
dialog box.
7. When done, click OK to return to the Source tab.
8. On the Source tab, under Process function, select Assign.
9. Click OK.
Note
• When you open the Import Link window, the process function macro
@PROC_FUNC_NAME appears in the Source Name column mapped
to the PROC_FUNC_NAME column. You do not need to define any
manual mapping for the process function and instrument type fields.
When importing data, the software uses the source fields that you set as
the instrument type fields.
Related Topics
• Formulas and Arithmetic Functions in Import Links, page 1447
• Importing Instrument Index Common Tasks, page 1481
Note
• When you open the Import Link window, the process function macro
@PROC_FUNC_NAME appears in the Source Name column mapped
to the PROC_FUNC_NAME column. You do not need to define any
manual mapping for the process function and instrument type fields.
When importing instrument tags, the software uses the source fields that
you set as the instrument type field to automatically associate the tags with
the appropriate instrument types.
Related Topics
• Formulas and Arithmetic Functions in Import Links, page 1447
• Importing Instrument Index Common Tasks, page 1481
d. To use the same function type name with more than one description for
different instrument tags, click Duplicate and for the new row select the
required description from the list.
9. Click OK after you finish associating all function type names and tag numbers
with SmartPlant Instrumentation component function types.
Caution
• To import the tag successfully, you must associate all the tag numbers.
Related Topics
• Working with Source Data, page 1432
cmpn_func + cmpnt_name(2,5)
The imported instrument type description is made up of the source instrument type
plus five characters of the source description starting from the second character.
cmpn_func + cmpnt_name(2)
The imported instrument type description is made up of the source instrument type
plus all the characters of the source description starting from the second character.
Related Topics
• Formulas and Arithmetic Functions in Import Links, page 1447
• Import Instrument Index, page 1488
• Prerequisite for Importing Instrument Types, page 1483
• String Operators in Import Links, page 1446
Related Topics
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• General Import Prerequisites, page 1468
• Importing Instrument Index Common Tasks, page 1481
• Importing Revisions, page 1498
Related Topics
• Creating Specifications by Data Import Common Tasks, page 1492
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Importing Data Common Tasks, page 1470
• Map Source and Target Fields Common Tasks, page 1441
• Process Function Mapping Codes for Instrument Index Import, page 1450
Caution
• When creating specs using the Single table method, the Import Utility
does not validate whether the process function of source tags matches the
process function of the target form. Therefore, to prevent database
problems in SmartPlant Instrumentation after data import, you must
exercise an extreme caution when defining tag process functions in the
source columns.
1. On the Link Definitions dialog box, create an import link as follows:
a. In the Link box, type a unique link name.
b. Under Import method, select Single table.
c. Under Name of module or table, select SPEC_SHEET_DATA.
d. Complete the import link creation.
2. Open the Link Properties dialog box, and then, on the General tab, under
Create complementary elements do one of the following:
• Select the Create check box beside Drawing & Revision to create
automatically a default document number for each spec and insert a
zero revision row for each spec (invisible the SmartPlant
Instrumentation interface).
• Clear the Create check box beside Drawing & Revision if you want
to map the document numbers and revisions from the source or if you
do not want to create any document numbers or revisions for specs
during the import process.
3. Click the Specs tab, and then, from the Specification item type list, select the
item type for which you want to create specs.
4. In the Import Link window, open the import link.
5. In the Target pane, define the import mapping as follows:
a. If the selected item type is Instrument but the source tags do not have process
data cases, in the CASE_NAME/CASE ID field, type '' (or '*' if the database
platform is SQL Server).
b. Select the item type field (the Tag Number field if you want to create
instrument specs), and then, from the Source pane, drag the column
containing the source items.
c. Map the SPEC FORM CNUM/SPEC FORM ID column to match the
source and target form numbers.
d. If you want to import document numbers and revisions from the source, map
the DWG NAME/DWG ID column to import the document numbers from
the source and also map the REV NO/REV ID column to import the source
revisions.
Related Topics
• Creating Specifications by Data Import Common Tasks, page 1492
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Import Revisions into the REVISION Table, page 1499
• Importing Data Common Tasks, page 1470
• Map Source and Target Fields Common Tasks, page 1441
Tip
• The Use custom drawing name check box is selected automatically
because you must define manually one document number for all the
instrument tags when mapping the source and target table columns in
the Import Link window.
5. In the Import Link window, open the import link.
6. In the Target pane, define the import mapping as follows:
a. If the source tags do not have process data cases, in the CASE_NAME field,
type '' (or '*' if the database platform is SQL Server).
b. Select the Tag No field, and then, from the Source pane, drag the column
containing the tag numbers.
c. In the Spec Drawing Name field, type one alpha-numeric value for the multi-
tag spec document number you want to create.
7. If needed, complete the import mapping by dragging the appropriate column
names from the Source pane or by entering strings or values in the fields in the
Target pane.
8. Import the data.
Related Topics
• Creating Specifications by Data Import Common Tasks, page 1492
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Fluid State Mapping Codes for Process Data Import, page 1450
• Importing Data Common Tasks, page 1470
• Map Source and Target Fields Common Tasks, page 1441
Importing Revisions
The Import Utility allows you to import revision data into any document that has a
document number. Therefore, your import source must contain a column with
document numbers that already exist in SmartPlant Instrumentation. When importing
data, the Import Utility matches the source and target document numbers and imports
the revision data into the appropriate document, be it a calculation or process data
sheet, a spec, or any other document for which it is possible to define revisions in
SmartPlant Instrumentation.
In the database, revision data is stored in the REVISION table columns. There are
two types of revision data fields: custom fields (REV_UDF columns) and non-custom
(other than REV_UDF). Non-custom fields appear in SmartPlant Instrumentation on
the Revisions dialog box and in document title block fields. You can import data to
any of these fields. Custom fields do not appear in the SmartPlant Instrumentation
interface by default. You can add custom fields as additional revision fields when
customizing title blocks in InfoMaker. You cannot import data into the REV_UDF
fields.
The required columns for import mapping are DWG_NAME (document number) and
REV_NO (revision number).
If you assign an import link to the Single table import method and select the
REVISION table, you can import revision data to any SmartPlant Instrumentation
document, provided that the target document and the import source have the same
document number. If you assign an import link to the Module (multiple tables)
import method, and select the Process Data or Specifications module, you need to
define revision import options on the Link Properties dialog box (General tab
options for importing process data or calculation sheet revisions, or Specs tab for
importing specification revisions).
Related Topics
• Creating Specifications by Data Import Common Tasks, page 1492
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Import Process Data and Calculation Sheet Revisions, page 1500
• Import Revisions into the REVISION Table, page 1499
• Importing Data Common Tasks, page 1470
• Map Source and Target Fields Common Tasks, page 1441
Prerequisites
• Make sure that the documents for which you want to import revisions
already exist in SmartPlant Instrumentation.
• Make sure that the document numbers are defined both in the import
source and in the target documents.
1. On the Link Definitions dialog box, create an import link as follows:
a. In the Link box, type a unique link name.
b. Under Import method, select Single table.
c. Under Name of module or table, select REVISION.
d. Complete the import link creation.
2. On the Link Properties dialog box, define the import link properties as you
require.
3. In the Import Link window, open the import link.
4. In the Target pane, define the import mapping as follows:
a. Select the DWG NAME/DWG ID field, and then, from the Source pane,
drag the column containing the source document numbers.
b. Select the REV NO field, and then, from the Source pane, drag the column
containing the source revision numbers.
5. If needed, complete the import mapping by dragging the appropriate column
names from the Source pane or by entering strings or values in the fields in the
Target pane.
Tip
• You cannot import data into the REV UDF fields. These fields are
custom fields that you can add as additional revision fields when
customizing title blocks in InfoMaker. You can import revision values
to any non-custom fields (other than REV UDF). The display names
of these fields are shown on the Revisions dialog box in SmartPlant
Instrumentation.
6. Import the data.
Related Topics
• Creating Specifications by Data Import Common Tasks, page 1492
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
Prerequisite
• Make sure that the tag numbers for which you want to import process data
or calculation sheet revisions already exist in SmartPlant Instrumentation.
1. On the Link Definitions dialog box, create an import link as follows:
a. In the Link box, type a unique link name.
b. Under Import method, select Module (multiple tables).
c. Under Name of module or table, select Process Data.
d. Complete the import link creation.
2. On the General tab of the Link Properties dialog box, select a combination of
the following check boxes: Import revisions, Use custom drawing names, and
Create calculation sheet. Use the following table as a guide to the check box
selection combinations you can use and the data for which you need to define the
links:
Data to Link Import Use custom Create
revisions drawing names calculation
sheet
Process data revisions Select Clear Clear
Process data sheet document Clear Select Clear
numbers
Process data sheet document Select Select Clear
numbers and revisions
Calculation data Clear Clear Select
Calculation and process data Select Clear Select
sheet revisions
Calculation and process data Clear Select Select
sheet document numbers
Calculation and process data Select Select Select
sheet document numbers and
revisions
a. Map the Tag Number and Case Name fields by dragging the appropriate
column names from the Source pane.
b. Map the appropriate revision and document number (drawing name) fields by
dragging the appropriate column names from the Source pane.
Tip
• If the source tags do not have process data cases, in the Case Name
field, type '' (or '*' if the database platform is SQL Server).
6. If needed, complete the import mapping by dragging the appropriate column
names from the Source pane or by entering strings or values in the fields in the
Target pane.
7. Import the data.
Related Topics
• Creating Specifications by Data Import Common Tasks, page 1492
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Importing Data Common Tasks, page 1470
• Importing Revisions, page 1498
• Map Source and Target Fields Common Tasks, page 1441
SmartPlant Instrumentation allows you to use non-unique wiring item names. This is,
however, not possible in the Import Utility because the default table definitions used
in import links require name uniqueness. If you are an advanced user, you can define
a new table definition to enable the software to import items with non-unique names.
If you imported data incorrectly into your <plant>, you might have to delete your
plant or spend a lot of time fining the problems manually. Since wiring data import
involves data insertion into so many tables and because wiring data import links are
likely to be complex due to a large number of mapped columns in various tables, we
recommend that you create a special domain where you can check the import results.
After you are satisfied with the results, you can export the import links and then
import them into the domain into which you want import wiring data. For details, see
Moving Links Between Databases or Domains: An Overview, page 1390.
You can either import wiring data using the Single table import method or Single
table import method + reference tables. Selecting the method for wiring data import
largely depends on your import source. If your import source includes several files
with wiring item definitions, for each file, you can create an individual single-table
import link as you require. Single-table links are easy to manage and troubleshoot. If
your import source is complex and contains, for example, panels with corresponding
cables for each panel, you can include reference tables into the link.
A link whose properties include data insertion into reference tables allows you to
import wiring data into a specific table that you selected when creating the link and
also import data into any related table depending on your import source. Note,
however, that such a link opens more slowly than a single-table link due to a large
number of reference tables that a given wiring table has. Also, when running such a
link, you are more likely to come across various errors due to the mapping
complexity. Troubleshooting these errors may be time consuming. In any case,
before importing wiring data, familiarize yourself with the structure of wiring items
in the SmartPlant Instrumentation Demonstration database (IN_DEMO.db).
You can actually import most of your wiring data by running just three complex links
created for the following tables: PANEL_STRIP_TERM, WIRE, and
WIRE_TERMINAL. When importing data into the PANEL_STRIP_TERM table
and its reference tables, you can import all related panel information such as panels,
terminal strips, terminals, and so forth. When importing data into the WIRE table and
its reference tables, you can import all the related cable information such as cable
sets, wires, wire colors, and so forth. When importing data into the
WIRE_TERMINAL table and its reference tables, you can import all the connections
between panels and cables. You can create a link group with these links and import
all your panels, cables and connections in batch mode.
Note
• The Wiring module is unavailable for assigning to an import link.
Related Topics
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Importing Wiring Data Common Tasks, page 1504
• Map Source and Target Fields Common Tasks, page 1441
• Mapping Codes for Wiring Data Import, page 1451
• Defining one import link for the WIRE table and enabling the software to
insert data into the reference tables
• Defining individual import links for the CABLE, CABLE_SET, and
WIRE tables and then running them in the following order: cables, cable
sets, wires.
For more information, see Import Cables, Cable Sets, and Wires, page 1514.
Import Panels
Use this procedure to import panels. In the SmartPlant Instrumentation database, all
panels, regardless of the panel category, are stored in the PANEL table; therefore, to
distinguish between various panel categories, in the Import Link window, you must
specify correct mapping for the panel category you want to import and also map the
panel sub-category. Note that wiring equipment is stored in the APPARATUS table,
whereas, apparatuses appear in the CHANNEL table. Table names of other panel
constituents are easy to recognize because they include the actual item names in
SmartPlant Instrumentation; for example, columns of the PANEL_STRIP_TERM
table hold all terminals. For more information, see Import Panels, page 1505.
• Defining one import link for the WIRE table and enabling the software to
insert data into the reference tables
• Defining individual import links for the CABLE, CABLE_SET, and
WIRE tables and then running them in the following order: cables, cable
sets, wires.
For more information, see Import Cables, Cable Sets, and Wires, page 1514.
Related Topics
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Importing Wiring Data, page 1502
• Mapping Codes for Wiring Data Import, page 1451
Import Panels
1. Create a link group for placing the link you are going to create and also links
defined for panel constituents, for example, wiring equipment, terminal strips, and
terminals.
2. On the Link Definitions dialog box, create an import link for panels as follows:
a. In the Link box, type a unique link name, for example Panels.
b. Under Import method, select Single table.
c. Under Name of module or table, select PANEL.
d. Complete the import link creation.
3. Open the Link Properties dialog box, and, on the General tab, do the following:
2. Open the Link Properties dialog box, and, on the General tab, do the following:
a. Make sure that Import to supporting tables is cleared.
b. Under Undefined NOT NULL fields, select Reject rows.
Tip
• Selecting Reject rows is recommended to set the software to reject all
source values that do not match foreign key values in the PANEL
table. For example, if a cabinet model in your source does not match
the model that already exists in SmartPlant Instrumentation, the
software indicates that this model does not exist. If you select the Use
default value, in the PANEL table, the Import Utility will enter 0
(zero) values in all the columns whose values do not match the values
in the import source.
3. Since your import source contains device panels, you will need to associate them
with instruments that exist in various <units> in SmartPlant Instrumentation.
Therefore, on the Import Level tab, under Hierarchy levels, select Apply and
also select the lowest plant hierarchy level. For details, see Import Data Into
Multiple Plant Hierarchy Items, page 1478.
Tips
• For an import source that contains device panels, we recommend that
the target <unit> for importing device panels be the same as the <unit>
where the associated instrument tags appear.
• Although, <plant> is the default import level for wiring data,
specifying a <unit> level for wiring items allows you to filter the
imported wiring data per <unit> in the Domain Explorer.
4. Click Table Definition and create a new table definition on the basis of the
Default definition. For details, see Create a Table Definition on the Basis of
Another Definition, page 1420.
5. To create a new key definition, do the following:
a. Select Foreign Key and close the Foreign Key List pop-up window.
b. Click Clear to clear the Key definition working area and then, from the
Column definition pane, drag the PARENT_ID column to the Key
definition working area.
c. Add the following key definition:
d. In the Column definition pane, scroll right to display the Key Level column.
e. Manually remove all the key levels from the PARENT_ID column.
a. Save the new definition.
Tip
• Adding the PARENT_ID foreign key into the PANEL table enables
you to define cabinets as parent items of device panes in the same
table. The new key definition allows the Import Utility to find cabinet
names in the PANEL_NAME column of the PANEL table and write
the matching PANEL_ID column values into the PARENT_ID
column.
6. In the Import Link window, open the import link.
7. In the Target pane, define the import mapping as follows:
a. Click the PANEL_NAME row, and then, from the Source pane, drag the
column containing the source device panel names.
b. Click the PARENT_ID row, and then, from the Source pane, drag the
column containing the cabinets within which you want the device panels to
appear.
c. For the PANEL_CATEGORY column, type 4 as the mapping value.
d. For the PANEL_SUB_CATEGORY column, type 410 as the mapping value.
For details of various panel category mapping values, see Mapping Codes for
Wiring Data Import, page 1451.
e. For the DEF_FLG flag, enter N so that the in SmartPlant Instrumentation, the
imported panels appear in the Domain Explorer.
Tip
• If you define Y as a mapping value for the DEF_FLG flag, in
SmartPlant Instrumentation, the imported items appear in the
Reference Explorer.
8. If needed, complete the import mapping by dragging the appropriate column
names from the Source pane or by entering strings or values in the fields in the
Target pane.
9. Run the import link.
Related Topics
• Defining Import Link Properties Common Tasks, page 1401
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Importing Wiring Data Common Tasks, page 1504
• Importing Wiring Data, page 1502
• Mapping Codes for Wiring Data Import, page 1451
If you select the Use default value, in the APPARATUS table, the
Import Utility will enter 0 (zero) values in all the columns whose
values do not match the values in the import source.
4. On the Link Properties dialog box, click Table Definition and do the following:
a. On the Table Definition dialog box, click Definition.
b. On the Table Definition Name dialog box, select the definition that you
require.
Tip
• If you do not find the definition that you require, you can create a new
definition on the basis of the Default definition. For details, see
Create a Table Definition on the Basis of Another Definition, page
1420.
5. In the Import Link window, open the import link.
6. In the Target pane, define the import mapping as follows:
a. Click the APPAR_NAME row, and then, from the Source pane, drag the
column containing the wiring equipment names.
b. Depending on your table definition, map the remaining required columns
marked in red bold.
c. Depending on your source wiring equipment type, define a mapping value for
the CATEGORY NAME/APPAR_CAT_ID column. For details, see
Mapping Codes for Wiring Data Import, page 1451.
d. For the DEF_FLG flag, enter N so that the in SmartPlant Instrumentation, the
imported panels appear in the Domain Explorer.
Tip
• If you define Y as a mapping value for the DEF_FLG flag, in
SmartPlant Instrumentation, the imported items appear in the
Reference Explorer.
7. If needed, complete the import mapping by dragging the appropriate column
names from the Source pane or by entering strings or values in the fields in the
Target pane.
8. If you have not imported panels yet, do the following:
a. Add the created Wiring Equipment link into the group containing the link
defined for importing panels.
b. Prioritize the links so the Wiring Equipment link appears under the links
defined for panels. For details, see Prioritize Links in a Link Group, page
1382.
c. Run the links in this order.
Related Topics
• Create a Link Group, page 1380
5. This message is typical for the case in which you select the Reject rows on the
General tab of the Link Properties dialog box. See Set Properties for Handling
Mismatched Data, page 1403 to learn how to handle mismatched data.
6. This message is typical for the case in which you import a table whose primary
key is derived from another table's primary key. In this case the table the primary
key belongs to must also be imported. For example, the PD_GENERAL table
primary key, CMPNT_ID, is derived from the COMPONENT table. Therefore,
the PD_GENERAL table primary key value must exist in the COMPONENT
table.
7. This message is reported by your SQL platform. The name of the field the
problem occurred in appears under Column Name in the Import Report. In this
case we highly recommend that you refer also to the information regarding this
import attempt in your log file.
8. Most SmartPlant Instrumentation tables contain a Zero-ID row which is used to
maintain the linkage between the tables in the database. During the import
process this row is not transferred from the source data to the target data, in which
case the Import Utility displays an appropriate message in the Import Report.
Related Topics
• Flow of Activities for Importing Data into SmartPlant Instrumentation,
page 1376
• Importing Data Common Tasks, page 1470
• Map Source and Target Fields Common Tasks, page 1441
Related Topics
• Adapt System Codes, page 1463
• Working with System Codes Common Tasks, page 1461
Related Topics
• Adapt Unit of Measure Codes, page 1464
• Working with System Codes Common Tasks, page 1461
Important
• If you get a message stating that the connection has failed, make sure
you typed in the correct path and filename of the database file (see step
3 of this procedure).
5. Under the Select link group section, select one or more of the link groups to
import.
6. Locate the source path of all the links in the imported group in one of the
following ways:
• In the Source file path data field, type the source path.
• Click Browse to navigate to the required source path.
7. Clear the Import only source codes check box if it was selected.
8. If you are importing the PDS/SmartPlant P&ID link, select or clear the Import
typical instruments check box as desired.
9. Click Import to add the selected link group to the database.
Related Topics
• Flow of Activities for Creating Control Systems, page 1544
• SmartPlant Electrical Interface, page 1541
Tip
• If a signal is associated with a circuit in SmartPlant Electrical, it
inherits its power distribution board (PDB) item tag as an associated
field and is considered as a preassigned signal for the PDB cabinet.
For circuit signals, SmartPlant Instrumentation automatically creates a
cabinet with the name of the power distribution board to which the
circuit was connected in SmartPlant Electrical. For other signals, you
need to create device panels manually in SmartPlant Instrumentation.
For details, see Create a Local Signal for Electrical Tags, page 1551.
8. Publish the data to SmartPlant Electrical. This creates an .xml document
containing SmartPlant Instrumentation data such as the control system
configuration, I/O assignment, PLC I/O card and channel, instrument tags, loop
number, and so forth. For details, see Publish Data for SmartPlant Electrical,
page 1553.
Tip
• The software creates the file in the path: <SmartPlant Instrumentation
home folder>\XML\IO Assignment_data.xml.
9. Retrieve (import) the configured data in SmartPlant Electrical.
10. Display the I/O assignment data in a SmartPlant Electrical schematic by including
in the schematic macros related to SmartPlant Electrical signal data. For details,
see SmartPlant Instrumentation Macro Structure, page ???.
Tip
• In Enhanced Report Utility reports and CAD drawings for a signal that
applies to a circuit, the loop macros cannot retrieve main or associated
electrical equipment names and types because the signal is not directly
linked with these items. Furthermore, it is possible for a circuit to feed
more than one item of equipment, and this is incompatible with the
way that macros function, where each macro can retrieve only a single
data value at a time. Likewise, if a signal is linked to an item of
electrical equipment, you cannot use macros to retrieve circuit data.
Notes
• You can repeat this procedure as many times as you want to; SmartPlant
Instrumentation recognizes new, modified, and deleted data that is
published from SmartPlant Electrical.
• The data is owned by the application that created it. If you modify or
delete the data in the application that does not own it, the next time you
retrieve the data from the owner application, it overwrites any modified
data, or reinserts data if it was deleted. A specific data property usually
belongs to one or other of the applications; however, the Sys I/O type
property is owned by both applications and in this case the software
overwrites the value in whichever application you retrieve the data.
Notes
• Some tag number properties apply to SmartPlant Electrical data only, and
are read-only. You can edit other properties such as Service, I/O type,
and Notes.
• When you retrieve a SmartPlant Electrical PDB (power distribution board)
preassigned circuit signal, SmartPlant Instrumentation automatically
creates a cabinet with the name of the power distribution board associated
with the signal. If you delete such a cabinet, its preassignment
relationship with the signal is lost and you will no longer be able to find
the tag for that signal when you select Pre-assigned signals only in the
Signal Filter dialog box. However, the next time you publish the signal
from SmartPlant Electrical and retrieve it into SmartPlant Instrumentation,
the cabinet is created afresh.
• When you download electrical tags from SmartPlant Electrical, after
making the I/O assignments, SmartPlant Instrumentation automatically
assigns a control system tag to each electrical tag.
• There are three categories of electrical signals, for each of which the user
interface differs slightly, as follows:
• Signals related directly to PDB circuits that are associated with main
equipment; for example, a signal created in a feeder circuit that feeds a
motor.
• Signals directly related to main equipment; for example, a signal
created under a motor or a transformer.
• Signals associated directly with control stations that are associated
with main equipment such as motors.
In the Domain Explorer, electrical tag numbers can be viewed by expanding the
Electrical Tags folder.
In the Browser module, you can view electrical tag numbers from one of the
following browsers:
• Electrical Tag Browser— Displays data for all tag numbers derived
from SmartPlant Electrical signals for all items but does not retrieve data
values of associated attributes for signals created under circuits. The
software displays data for the main item and also associated circuit data.
Related Topics
• Flow of Activities for Creating Control Systems, page 1544
• SmartPlant Electrical Interface, page 1541
Related Topics
• Flow of Activities for Creating Control Systems, page 1544
• SmartPlant Electrical Interface, page 1541
Notes
• The power distribution board data is also available for displaying in loop
drawings.
• You can repeat this procedure as many times as you want to; SmartPlant
Instrumentation recognizes new, modified, and deleted data that is
published from SmartPlant Electrical.
• The data is owned by the application that created it. If you modify or
delete the data in the application that does not own it, the next time you
retrieve the data from the owner application, it overwrites any modified
data, or reinserts data if it was deleted. A specific data property usually
belongs to one or other of the applications.
Related Topics
• Prerequisites for Working with the SmartPlant Electrical Interface, page
1542
• SmartPlant Electrical Interface, page 1541
Tip
• When publishing in point-to-point mode, clicking New on the
Revisions dialog box just adds a new line in which you can type the
revision details.
12. Click OK to close the Revisions dialog box.
13. Click SmartPlant > Publish.
14. On the Publish SmartPlant Electrical Data dialog box, select Publish
document and data.
Important
• You must always choose this option when publishing in the
SmartPlant Electrical Interface.
15. On the Publish dialog box, from the Operation list, select Publish Now or
Background Publish.
16. Click OK to publish the data.
17. From the Publish message box, click Close if the publish operation was
successful, or View Log if there were errors.
Related Topics
• Flow of Activities for Creating Control Systems, page 1544
• SmartPlant Electrical Interface, page 1541
You import the P&ID data first by connecting to the appropriate SmartPlant P&ID
database from which the Import Utility will import the drawing data.
After you connect to the SmartPlant P&ID database you select the source unit and
source P&ID. With the source data selected, you can perform the import setup
process and import the selected P&ID data.
Note
• In the SmartPlant P&ID Interface, when you create a new link for
importing data into a table while connected to a plant, the software
automatically creates the correct connection in the link properties.
Important
• SmartPlant P&ID must be closed before starting the import session, to
ensure that any modifications made to the drawings are properly imported
to SmartPlant Instrumentation.
• Importing Data Common Tasks, page 1470
• Prerequisites for Importing SmartPlant P&ID Data, page 1557
After the Domain Administrator imports SmartPlant P&ID link groups from the
In_ctlog.db file using the Administration module options, the link groups appear in
the Link Explorer in the Import Utility. The links in these groups have predefined
mapping which you need to modify as you require. You cannot change the import
method or table/module assignment of these links. It is possible to restore deleted
SmartPlant P&ID links or link groups by re-importing the link groups from the
In_ctlog.db file. Note, however, that to restore deleted links or link groups, you must
first rename all the existing link groups or delete all the groups.
Important
• Before being able to import data, the predefined import links for
SmartPlant P&ID must be available. To make the links available, you
need to import the appropriate system interfaces into SmartPlant
Instrumentation from the Administration module (for details, see Import
System Interfaces, page 1539).
• SmartPlant P&ID must be closed before starting the import session, to
ensure that any modifications made to the drawings are properly imported
to SmartPlant Instrumentation.
Setup and Database Platform Prerequisites
The following prerequisites address installation, software version, and database
and connection issues:
Important
• Before using this procedure, make sure you meet all the prerequisites. For
details, see Prerequisites for Importing SmartPlant P&ID Data, page
1557.
1. Do one of the following:
• On the Link Explorer menu bar, click .
• Click Options > SmartPlant P&ID.
2. On the SmartPlant P&ID dialog box, click Open Plant and select the .ini file
associated with the plant containing the source data.
3. In the Tree pane, select a folder representing the desired hierarchy level.
Tip
• To select multiple drawings, in the Tree pane, select a plant hierarchy
item at the lowest level (for example, a unit), and then in the Contents
pane, hold down the Ctrl key while selecting the desired drawings.
4. Under Item types, select at least one check box, or select All item types.
Tip
• If you select multiple drawings and more than one item type, the
software may take some time to retrieve the source data.
5. If desired, select the other options using the check boxes.
Important
• When selecting item types that have 1000 or more attributes, you must
specify a limited number of attributes for importing. To do this, click
Attributes and on the Attributes dialog box, select the check boxes
only beside the attributes you want to import. Then, on the
SmartPlant P&ID dialog box, select Use attribute list.
• You must only select those attributes that are split in the import source
into two separate attributes: one holding a field numeric and the other
holding the appropriate unit of measure. For details, see P&ID
Attributes Split into Numeric and UOM Fields for Import, page ???.
• Since the mapping of the SmartPlant P&ID links you imported from
the In_ctlog.db file must be modified to fit the target naming
conventions in SmartPlant Instrumentation, clear the Run link group
automatically check box.
Related Topics
• Importing Data Common Tasks, page 1470
• Importing SmartPlant P&ID Component Data, page 1556
PDS Interface
The PDS (Plant Design System) interface allows you to import P&ID components
(for example, drawings, tags, and so forth) into your database from a PDS database.
You import the P&ID data first by connecting to the appropriate PDS database from
which the Import Utility will import the drawing data. There are two PDS databases /
schemas from which you need to import data:
• Project Control Database— this database contains the unit data and it
has the same functions as the SmartPlant Instrumentation Administration
data.
• P&ID Source Database— this database contains the actual P&ID
drawing data.
After you connect to the PDS database you select the source unit and source P&ID.
With the source data selected, you can perform the import setup process and import
the selected P&ID data.
Related Topics
• Importing PDS Data, page 1564
Important
• Before being able to import data, the predefined import links for PDS
must be available. To make the links available, you need to import the
appropriate system interfaces into SmartPlant Instrumentation from the
Administration module (for details, see Import System Interfaces, page
1539).
Notes
• PDS and SmartPlant Instrumentation cannot work from the same SQL
Server database server. This is because the sort order is different for the
two applications, and databases with different sort orders cannot be
located on the same server.
• The source text file profile is defined in the ODBC.ini registry folder.
Related Topics
• Importing PDS Data, page 1564
Each database table includes a data type code that refers to a file containing a list of
fields that belong to the table together with their codes. For example, the data type
for table 109, instr_comp_type is C510. This refers to the file LIST.0510, part of
which is as follows:
MAX=999
; 0510, Instrument Component Type (999)
1 ' '
;
16 'Instrument to Process line'
17 'Capillary tube'
18 'Mechanical link'
19 'Electric signal'
Also, when retrieving the PDS link group from the In_ctlog.db file, the software also
retrieves the system codes and unit of measure codes. These codes are already
adapted to SmartPlant Instrumentation, that is, every source code value in PDS is
associated with its appropriate target value in SmartPlant Instrumentation.
It is possible to run all the PDS group links automatically in order of their appearance.
Advanced users can perform a manual import process which allows you to carry out a
step-by-step procedure. Importing data this way enables you to view and modify the
default import parameters and link settings.
The following links are available in the link PDS link groups retrieved from the
In_ctlog.db file:
Important
• Before using this procedure, make sure you meet all the prerequisites. For
details, see Prerequisites for Importing PDS Data, page 1561.
• When importing PDS data, you must always use the PDS interface to
connect to the source data files before you can run the links from the Link
Explorer. You cannot create and run links outside of the interface.
1. Do one of the following:
• On the Link Explorer menu bar, click .
Notes
• If you choose to use the code description option and an equivalent for
the code in SmartPlant Instrumentation is not found, the field code will
be imported from the PDS database.
•If you know that SmartPlant Instrumentation will recognize all the
source field names, clear the Use code description check box, so that
the software will not check the Attribute and Codes files, thus
speeding up the import process.
9. Click Connect to connect to the database specified in the PDS dialog box.
Note
•If the connection fails, an appropriate message is displayed, in which
case you need to correct the database logon information.
10. On the Drawing Selection dialog box, select the desired drawings that contain
PDS data to be imported as follows:
a. From the Unit list, select the desired source PDS Unit. This displays the
P&ID drawings in this PDS unit in the Drawings pane.
b. Do one of the following:
• Select the Select all check box to select all the P&ID drawings so
that all data in the PDS unit will be imported.
• Select any P&ID drawings that you want to include in the import
process. Use Ctrl or Shift to make multiple selections.
Note
• SmartPlant Instrumentation will only import the data in the selected
drawings.
11. If desired, you can translate (expand) P&ID tags to instrument tags as follows:
a. Click Macro to define associations between PDS macros and SmartPlant
Instrumentation typical tags.
b. Select Additional tags based on macros to use the macro association
definitions to create new tags in SmartPlant Instrumentation based on the
imported data. On selecting this option, you can also select the Insert
original PDS tag check box to include in the import the P&ID tags that were
expanded (for details, see PDS Macro Expansion, page 1568).
c. Select Use measured variable to use the measured variable in the PDS
database (in the instr_comp table) to modify the typical tag name when
creating the instrument type in SmartPlant Instrumentation. Clear the check
box to use the typical tag name as is.
Tip
• An instrument type will be created for the tag only if it has a unique
description in the SmartPlant Instrumentation database.
For example, suppose you have a P&ID drawing with a tag number V-999. This tag
actually consists of a positioner and an I/P transducer. If the Additional tags based
on macros check box is selected, the original tag will be translated (expanded) and
two new tags, one representing the positioner and the other representing the I/P
transducer, will be imported into SmartPlant Instrumentation. If the Insert original
PDS tag check box is selected, the original V-999 tag will also be imported into the
SmartPlant Instrumentation database; if the check box is cleared, the V-999 tag will
not be imported.
Notes
• You can include custom fields in your typical tag definitions. The
information you include in these fields will then be copied to the tags that
are created from the typical tags when expanding the P&ID tag data. You
can view the custom fields by defining a new style in an Instrument Index
Standard Browser view that includes these fields. For details of how to
create typical loops and typical tags, see Working with Typical Loops and
Tags: An Overview, page ???.
• Macro expansion will be performed only for the P&ID tags that are
associated with the drawings you selected on the Drawing Selection
dialog box and for which macros exist.
3. Click Assign and use the Find Tag dialog box to select the desired typical
instrument to assign to the macro.
4. Repeat steps 2 and 3 for each typical instrument you want to assign to a macro.
11. If desired, you can display the source codes for this link (PDS instrument type
code and instrument type functional ID) as follows:
a. Click .
b. Click File > Exit to return to the Import Link window.
12. Click to import the data.
13. For each of the links in this group, and for all the links in the group 2.PDS, repeat
the above steps of this procedure (if prompted to overwrite existing data, click
Yes).
Notes
• For certain links in the group 2.PDS, you are required to enter the
source fields for defining naming conventions before running the link.
• Some links import fields from more than one table. In such cases, the
field name (excluding the table prefix) appears in the Source Name
column. If you attempt to run the import process, an error message is
displayed (Condition is not valid). To correct this, delete the field
name indicated in the message from the Source Name column, and
drag the appropriate field name (which includes the table prefix) to the
Source Name column.
14. Open SmartPlant Instrumentation and examine the imported data in the Browser
or Instrument Index module.
Notes
• All DCS vendors support both conventional and Foundation Fieldbus
instruments. In addition, DeltaV supports HART instruments.
• You are allowed to specify only one DCS vendor per domain.
• A number of shipped rules apply to SmartPlant Instrumentation items
when used for specific DCS vendors. You can view these rules in the
Rule Manager under Interfaces.
Related Topics
• Flow of Activities for Configuring DeltaV, page 1576
• Flow of Activities for Configuring Yokogawa CENTUM CS 3000, page
1588
• Prerequisites for Working with DCS Vendor Interfaces, page 1573
Related Topics
• DCS Vendor Interfaces, page 1571
Make sure that you have Internet access to the URL from which you download the
particular DCS vendor definitions document.
Before you can work with any DCS vendor interface, you must perform the following
actions:
1. Install the SmartPlant Schema Component from the SmartPlant Instrumentation
CD Browser (click Add-In Software, and then click Schema Component
Installation).
Tip
• On the Select Optional Features page, clear the Schema Editor
check box if you do not need to use the Schema Editor.
2. Install the SmartPlant Client from the SmartPlant Instrumentation CD Browser
(click Add-In Software, and then click SmartPlant Client Installation).
Tip
• On the Select Features page, make sure that you clear the SmartPlant
Automatic Retrieval check box.
3. Configure SmartPlant Instrumentation to work in file mode. For details, see
Configure SmartPlant Instrumentation to Publish and Retrieve Data in File
Mode, page 1575.
4. The System Administrator must enable the item registry. For details, see Enable
Item Registry in the Administration User's Guide, under System Administration,
Domain Management.
5. The System Administrator must specify the XML path to the folder in which the
IntoolsMap.xml and ContextMap.xml files are located; this must be done for each
domain where you intend to publish DCS vendor data. By default, these files are
located in the path: <SmartPlant Instrumentation home folder>\XML\.
6. The Domain Administrator must register the items. For details, see Register
Items in the Administration User's Guide, under Working in an Integrated
Environment.
7. The Domain Administrator must ensure that he SmartPlant Instrumentation and
DeltaV naming conventions are identical and that function blocks are defined
using free segment naming conventions as shown.
Related Topics
• Flow of Activities for Configuring DeltaV, page 1576
• Flow of Activities for Configuring Yokogawa CENTUM CS 3000, page
1588
Related Topics
• Prerequisites for Working with DCS Vendor Interfaces, page 1573
Notes
• Before publishing or retrieving DeltaV data for the first time, make sure
that you perform the prerequisite activities indicated: retrieving DeltaV
definitions, updating your plant design, and if appropriate, associating
Foundation Fieldbus device types.
• You may perform any of the stages of this flow of activities multiple times
during the project life cycle.
Retrieve DeltaV Definitions
Retrieving DeltaV definitions is a prerequisite for both publishing and retrieving
DeltaV data. The DeltaV item definition documents that you download and retrieve
in SmartPlant Instrumentation constitute the engineering library of DeltaV objects -
the DeltaV DCS (Distributed Control System), Foundation Fieldbus and HART
elements, and entries for supporting tables such as Manufacturer, Model, and so
forth. For more information, see Retrieve DeltaV Definitions, page 1581.
Important
• In the Reference Explorer, do not change any of the values in the items
that you retrieved from the DCS vendor.
Publish Data for DeltaV
After you complete the process of designing your DeltaV-compatible plant in
SmartPlant Instrumentation, use this procedure to publish (export) the required data
for accurate and efficient DeltaV configuration. The software publishes a partial set
of the SmartPlant Instrumentation database, including data such as the DeltaV
configuration, I/O assignment, instrument tags, and so forth (the process does not
export specification data, for example). For details of the procedure to publish data,
see Publish Data for DeltaV, page 1587.
After retrieving the published data in DeltaV, validate and, if necessary, reconcile the
data with the DeltaV database.
Important
• If using fieldbus tags, after retrieving the DeltaV data, but before running
any To Do List tasks, you must make associations between device types
for Foundation Fieldbus or HART instruments with instrument
manufacturers, and SmartPlant Instrumentation instrument types. For
more information, see Associate Device Types for DCS Vendors, page
1595.
Related Topics
• Crucial Fields for the DeltaV Interface, page 1583
• DCS Vendor Interfaces, page 1571
• Prerequisites for Working with DCS Vendor Interfaces, page 1573
Important
• SmartPlant Instrumentation validates the data only if the DCS
manufacturer name is Emerson Process.
• If you intend to publish fieldbus data, set the relevant option on the
Preferences dialog box. For details, see Interfaces > DCS Vendors
(Preferences), page ???.
• Spaces are not allowed in DeltaV tags, therefore, when publishing data,
SmartPlant Instrumentation removes spaces in instrument and Control
System tags. You can specify a substitute character, such as an
underscore, to replace the spaces; to do so, you must add the following
line in the Intools.ini file under the [API] section:
NameSpacesReplacement = "_"
It is recommended not to select any character that appears in the tag names
as the substitute character because when retrieving data back from DeltaV,
SmartPlant Instrumentation replaces that character with spaces again.
Related Topics
• DCS Vendor Interfaces, page 1571
• Flow of Activities for Configuring Yokogawa CENTUM CS 3000, page
1588
• Publish Data for Yokogawa CENTUM CS 3000, page 1592
4. On successful completion of the retrieval, click Close on the message box that
appears, or if errors occurred, click View Log to troubleshoot them.
5. Click SmartPlant > To Do List.
Important
• If using fieldbus tags, after retrieving the DeltaV data, but before
running any tasks from the To Do List, you must make associations
between Foundation Fieldbus device types, instrument manufacturers,
and SmartPlant Instrumentation instrument types. For more
information, see Associate Device Types for DCS Vendors, page 1595.
6. In the To Do List window, select all the Create tasks for the DeltaV items;
however, do not select the Update task for the CS Tag.
7. From the To Do List toolbar, click Run Task .
Tips
• Performing this action creates the DeltaV controllers, slots, I/O cards,
and so forth in the Domain Explorer under the Controllers folder.
• For more details of available options when running tasks, see Run
Tasks from the To Do List, page 1709.
8. In the Domain Explorer, create a DCS and rack as needed, and then drag a DeltaV
slot to the rack.
9. In the To Do List window, run the Update task for the CS Tag.
Related Topics
• Flow of Activities for Configuring DeltaV, page 1576
• Using the To Do List: An Overview, page 1706
• View the Log File for a DCS Vendor, page 1596
Important
• If you diverge from the following table and its notes, the software does not
validate the data; however, the DeltaV reconciliation program will reject
data values that are incompatible. For complete details of the exact
DeltaV values to use, please refer to your DeltaV Hardware Manual.
• If you intend to publish fieldbus data, set the relevant option on the
Preferences dialog box. For details, see Interfaces > DCS Vendors
(Preferences), page ???.
Notes
1. The value Y (Yes) is an indication to act according to the column header as
follows:
• Accept DeltaV Value— Do NOT change the value of this field.
• Enter Valid Value— Accept the value retrieved from DeltaV, if one
exists, or enter a different valid value.
• Optional Value— Accept the value retrieved from DeltaV, if one
exists, or enter a different valid value, or enter no value.
2. Although there are additional optional fields in the dialog boxes listed, the table
only includes optional fields for which data is retrieved from DeltaV.
3. In the Racks dialog box, under Rack position numbering, accept the default
selection of Start from one. In the data window, for each rack that you create,
type the value 8 under Number of slots.
4. A controller name must be upper case, and not more than 16 characters. You
must assign each controller to those slots that share the associated I/O card.
5. If you are defining a DeltaV redundant I/O card for a DCS panel, make sure that
in the Primary location group box the value under Position is an odd number,
and that the secondary location position value is an even number one greater than
the position value for the primary location.
6. DeltaV redundant I/O cards are wide and therefore they occupy two adjacent slots
in their carriers. Note that the cards can only be placed in odd-numbered slots.
DeltaV I/O cards have their terminations on the I/O cards themselves, and so there
is no need for separate termination cards to be connected to the I/O cards. On the
Control System tab of the I/O Termination dialog box, you must select the
Define a redundant I/O card check box. On publishing the data, this indicates to
DeltaV that the card is defined as a redundant double-width I/O card.
7. You can use only the following DeltaV cards as redundant I/O cards:
• AI_8CH_HART_4-20_RED
• AO_8CH_HART_4-20_RED
• RFIC
• DI_8CH_24VDC_DCT_RED
• DO_8CH_24VDC_HSS_RED
• RED_PROG_SERIAL_32DS
• RED_SERIAL_32DS
8. After you retrieve DeltaV definitions, the Channel Types supporting table is
populated with DeltaV-compatible channel types for DeltaV-compatible I/O strip
types. These are the only DeltaV-compatible values for the Channel Type field in
the Channels dialog box.
9. When you create a fieldbus tag based on an given instrument type, on the
General tab of the Tag Number Properties dialog box, make sure that the value
that you select from the Manufacturer list is among the acceptable values that
you set for this instrument type during retrieval from DeltaV.
10. On the Fieldbus tab of the Tag Number Properties dialog box, under Field
device address, you must type a value between 20 and 35 (inclusive). If you
select the Backup link master check box, type the value 20 under Field device
address.
11. The values available on the Fieldbus tab of the Tag Number Properties dialog
box under Fieldbus device revision are determined by the value that you select
from the Manufacturer list on the General tab.
12. On the Fieldbus tab of the Tag Number Properties dialog box, select the
Backup link master check box only for a device that you verified is capable of
being a backup.
Important
• In the Reference Explorer, do not change any of the values in the items
that you retrieved from the DCS vendor.
For information on how to make associations between Foundation Fieldbus device
types, instrument manufacturers, and SmartPlant Instrumentation instrument types,
see Associate Device Types for DCS Vendors, page 1595.
After you complete the process of designing your Yokogawa CENTUM CS 3000-
compatible plant in SmartPlant Instrumentation, use this procedure to publish (export)
the required data for accurate and efficient Yokogawa CENTUM CS 3000
configuration. You publish a partial set of the SmartPlant Instrumentation database,
including data such as the Yokogawa CENTUM CS 3000 configuration, I/O
assignment, instrument tags, and so forth. (The process does not export specification
data, for example.) For more information, see Publish Data for Yokogawa CENTUM
CS 3000, page 1592.
Related Topics
• DCS Vendor Interfaces, page 1571
• Prerequisites for Working with DCS Vendor Interfaces, page 1573
Important
• SmartPlant Instrumentation validates the data only if the DCS
manufacturer name is CENTUM CS 3000.
• If you intend to publish fieldbus data, set the relevant option on the
Preferences dialog box. For details, see Interfaces > DCS Vendors
(Preferences), page ???.
• Only ONE I/O card is allowed per slot.
• Spaces are not allowed in Yokogawa CENTUM CS 3000 tags, therefore,
when publishing data, SmartPlant Instrumentation removes spaces in
instrument and Control System tags. You can specify a substitute
character, such as an underscore, to replace the spaces; to do so, you must
add the following line in the Intools.ini file under the [API] section:
NameSpacesReplacement = "_"
It is recommended not to select any character that appears in the tag names
as the substitute character because when retrieving data back from
Related Topics
• DCS Vendor Interfaces, page 1571
Related Topics
• Flow of Activities for Configuring Yokogawa CENTUM CS 3000, page
1588
• View the Log File for a DCS Vendor, page 1596
Note
• When retrieving ABB definitions, the software automatically adds new
definitions and updates any modifications to definitions that already exist
in the SmartPlant Instrumentation database. However, you must delete
any redundant definitions manually from the Reference Explorer.
Related Topics
• View the Log File for a DCS Vendor, page 1596
Important
• After you have retrieved data from your DCS vendor interface, you can
determine the manufacturer and device type of each Foundation Fieldbus
device that you need to associate with a SmartPlant Instrumentation
instrument type. To do so, display the To Do List window and double-
click a fieldbus device. On the Details tab, the value of the MFR
COMPANY IDENTIFICATION property corresponds to the
manufacturer's identification number. This number appears in parentheses
beside the name of the manufacturer in the Tree View pane of the
Associate Foundation Fieldbus Device Types with Instrument Type
dialog box. The value of the FieldBus Device ID task property
corresponds to the number in the Device Type column on the Details pane
of the Associate Foundation Fieldbus Device Types with Instrument
Type dialog box. The adjacent Device Type Description column assists
you in selecting the appropriate instrument type to associate.
1. Click Tools > Interfaces > Associate Foundation Fieldbus Device Types.
2. In the Tree View pane, click to expand the Certified Fieldbus Instruments list
and display the available manufacturers.
3. Do one of the following:
• Select a manufacturer to view details of all the device types available
for that manufacturer.
• For a particular manufacturer, click and select a device type to view
its details.
4. In the Details pane, select the desired device type and click Associate.
5. In the Instrument Types dialog box, do one of the following:
• Select an existing fieldbus instrument type for which the I/O type
value is Fieldbus, for association with the current device type. You
can check the I/O type by viewing the profile of the instrument type.
• Create a new fieldbus instrument type or edit an existing one. For
details, see Define Foundation Fieldbus and Profibus Instrument Type
Profiles, page ???.
Important
• When you create fieldbus tags that are compatible with the DCS
vendor, the only acceptable values for instrument type are those that
you associated with device types for that vendor during the
downloading process.
6. Click OK to associate the selected instrument type with the current device type
and close the Instrument Types dialog box.
Important
• When you create a fieldbus tag based on the displayed instrument type,
the only acceptable values for the manufacturer are those displayed in
this dialog box. If you select other manufacturers, this will prevent
validation in the DCS vendor's database.
•You can associate only one function block for each device type with a
particular instrument type.
7. When done, click OK.
Notes
• For general guidelines regarding fieldbus devices, see Foundation
Fieldbus Design: An Overview, page ??? and Profibus Design: An
Overview, page ???.
• For details of how to create fieldbus devices, see Create Foundation
Fieldbus and Profibus Instruments, page ???.
NE-100 Interface
The SmartPlant Instrumentation NE-100 interface is designed to map SmartPlant
Instrument attributes to their corresponding NE-100 attributes and allow for the
transfer of data between SmartPlant Instrumentation databases and NE-100 compliant
databases.
Important
• To view the NE-100 interface options, in the Intools.ini file, you must add
the setting NE100=Y. For more details, see Activate the NE-100 Interface
Menu Commands, page 1598.
Related Topics
• NE-100 Interface Common Tasks, page 1598
For more information, see Activate the NE-100 Interface Menu Commands, page
1598.
For more information, see Publish SmartPlant Instrumentation Spec Data to NE-100,
page 1600.
Related Topics
• NE-100 Interface, page 1597
6. Open the Domain Definitions window, and set the required path for XML files in
the Path for SmartPlant XML Files text box. For more details, see Make
Domain Definitions in the Administration User's Guide, under System
Administration > Domain Management.
7. Close the Domain Definitions window, and log off as System Administrator.
8. Log on as Domain Administrator.
9. Run Register Items. For more details, see Register Items in the Administration
User's Guide, under Using SmartPlant Instrumentation in an Integrated
Environment.
10. Close the Administration module.
Related Topics
• NE-100 Interface Common Tasks, page 1598
Related Topics
• NE-100 Interface Common Tasks, page 1598
FirstVue Interface
The FirstVue interface allows you to exchange control valve data between SmartPlant
Instrumentation and the Fisher-Rosemount FirstVue application using ASCII
delimited .csv files. After exporting your control valve data from SmartPlant
Instrumentation and performing all the desired calculations in FirstVue, you can
import the calculation results back to SmartPlant Instrumentation where this data can
be used in specification sheets, reports, and other SmartPlant Instrumentation features
such as browsers. You can also print out the information as a standard ISA
specification, the same way as you do it in FirstVue.
The FirstVue interface supports the Fisher-Rosemount FirstVue application fields and
field order, so importing calculation results from FirstVue to SmartPlant
Instrumentation automatically updates fields that you require.
Related Topics
• Importing Data Common Tasks, page 1470
• Prerequisites for Importing FirstVue Data, page 1609
Notes
• The source text file profile is defined in the odbc.ini registry folder.
• When you install SmartPlant Instrumentation, you can also install the
predefined ASCII file profile for use with FirstVue.
• You must define your own Microsoft driver using the Windows ODBC
Data Source Administrator.
• When defining a profile for FirstVue data, make sure you use a comma
delimiter and the Column Names option.
Caution
• If you change an instrument type that was exported from SmartPlant
Instrumentation in the FirstVue interface before re-importing it to
SmartPlant Instrumentation, the new instrument type will be created in
SmartPlant Instrumentation. You can avoid this by modifying the
appropriate FirstVue import links.
Related Topics
• FirstVue Interface, page 1601
• Prerequisites for Importing FirstVue Data, page 1609
At this stage, you can also define process data parameters specific to the selected
control valve (for example, Leakage). (These parameters can be viewed in the
Additional Properties window in the Process Data module.)
• Fields that are required for sizing calculations, including line data
• ISA format specification fields
• Fields that contain export-only data (for example, revision data)
• Fields that allow insertion of new data, when you import data from the
ASCII file back to SmartPlant Instrumentation
Note
• During the export process, the 'U' character is added to the FirstVue
unitnumber field string.
Related Topics
• Prerequisites for Exporting Data to FirstVue, page 1605
• Click .
• Click Actions > Browse Index.
3. In the browser view, select the tags whose control valve data you want to export
to FirstVue. To select more than one tag, hold down either the Ctrl key or the
Shift key and click the desired fields.
4. Click Tools > Interfaces > Fisher FirstVue.
5. On the Export to FirstVue dialog box, enter data as follows:
a. To select the appropriate FirstVue ASCII file with a .csv extension to which
the SmartPlant Instrumentation control valve data will be exported, do one of
the following:
• In the File text box, type in the path and location of the FirstVue
export file name.
• Click Browse to navigate to the FirstVue file location.
b. If you selected in the previous step to export to an existing ASCII file, do one
of the following:
• Select the Overwrite check box to overwrite the existing ASCII
file.
• Clear the Overwrite check box to keep the existing ASCII file. In
this case, if you enter an existing file in the File Name data field,
you will be prompted to confirm the overwrite.
c. To select the level on which you want to export the SmartPlant
Instrumentation data to FirstVue, do one of the following:
• Click Plant to export all the control valve tags and their data
belonging to the current plant.
• Click Unit to export all the control valve tags and their data
belonging to the current unit.
• Click Filter to export only the control valve tags and their data that
comply with the filter parameters that you have set for the current
Instrument Index Standard Browser view.
• Click Selected tags to export only the tags and their data that you
selected in the Instrument Index Standard Browser view (see step 3
in this procedure).
Caution
•If you select to export selected tags, make sure you select the
appropriate tags before clicking OK on the Export to FirstVue
dialog box.
d. Under Use field length from, do one of the following:
• Click SmartPlant Instrumentation to truncate the exported fields
to match the lengths indicated in the SmartPlant Instrumentation
database.
• Click FirstVue to truncate the exported fields to match the lengths
indicated in the FirstVue field table.
6. Click OK to start the export process.
Tip
• If the export process is successful, an appropriate message is
displayed, notifying you that the Log file is empty.
Caution
• Failing to convert units of measure will generate an error message.
This means that the associated data was exported without the required
units of measure (that is, the unit of measure fields in FirstVue will be
empty). In this case, you should select the desired units of measure
manually in FirstVue.
7. On completion of the export process, click Log File to open the Export.log file,
located in the same folder where you exported the ASCII file, where you can view
any errors that occurred during the export process.
8. Click Close to close the Export to FirstVue dialog box and return to the browser
view.
Important
• Before being able to import data, the predefined import links for FirstVue
must be available. To make the links available, you need to import the
appropriate system interfaces into SmartPlant Instrumentation from the
Administration module (for details, see Import System Interfaces, page
1539).
Prepare a source ASCII file with a .csv extension. Make sure that the following
requirements are met for this file:
Also, when retrieving the FirstVue link group from the In_ctlog.db file, the software
also retrieves the system codes and unit of measure codes. These codes are already
adapted to SmartPlant Instrumentation, that is, every source code value in FirstVue is
associated with its appropriate target value in SmartPlant Instrumentation.
It is possible to run all the FirstVue group links automatically in order of their
appearance. Advanced users can perform a manual import process which allows you
to carry out a step-by-step procedure. Importing data this way enables you to view
and modify the default import parameters and link settings.
The following links are available in the FirstVue link group the Domain
Administrator imported from In_ctlog.db file:
Important
• Before using this procedure, make sure you meet all the prerequisites. For
details, see Prerequisites for Importing FirstVue Data, page 1609.
• When importing FirstVue data, you must always use the FirstVue
interface to connect to the source data files before you can run the links
from the Link Explorer. You cannot create and run links outside of the
interface.
1. Do one of the following:
• On the Link Explorer menu bar, click .
• Click Options > Fisher FirstVue.
2. Beside the Source file box, click Browse and select a .csv ASCII file containing
data exported from FirstVue.
3. Click Open to display the file path in the Source file box.
4. Do one of the following:
• Select Insert new data if you are importing FirstVue data into
SmartPlant Instrumentation for the very first time.
• Clear Insert new data If you previously imported FirstVue data into
SmartPlant Instrumentation and you only need to update the existing
sizing data in the target database.
5. Select Run link group automatically and click OK to minimize the Fisher
FirstVue window.
6. On the Select Link Group dialog box, select FirstVue and click OK to start the
import.
7. If notified that the link requires system codes, click OK in the message box, and
then, do the following:
a. On the Source System List dialog box, which opens automatically, select the
FirstVue system codes, which the Domain Administrator imported from the
In_ctlog.db file.
b. Click OK to continue the import process.
Tip
• When running the first import session, the software prompts you to
select the source system codes because, for each FirstVue import link,
on the Source tab of the Link Properties dialog box, the Use system
codes check box is selected.
8. Open SmartPlant Instrumentation and examine the imported data in the Browser,
Process Data, or Instrument Index module.
Related Topics
• Importing FirstVue Data, page 1610
Important
• Before using this procedure, make sure you meet all the prerequisites. For
details, see Prerequisites for Importing FirstVue Data, page 1609.
• When importing FirstVue data, you must always use the FirstVue
interface to connect to the source data files before you can run the links
from the Link Explorer. You cannot create and run links outside of the
interface.
1. Do one of the following:
• On the Link Explorer menu bar, click .
• Click Options > Fisher FirstVue.
2. Beside the Source file box, click Browse and select a .csv ASCII file containing
data exported from FirstVue.
3. Click Open to display the file path in the Source file box.
4. Do one of the following:
• Select Insert new data if you are importing FirstVue data into
SmartPlant Instrumentation for the very first time.
• Clear Insert new data If you previously imported FirstVue data into
SmartPlant Instrumentation and you only need to update the existing
sizing data in the target database.
5. Clear Run link group automatically.
6. Click OK to minimize the Fisher FirstVue window.
7. In the Link Explorer, in the FirstVue group, select and open the link FirstVue -
PD/Calcs in the Import Link window.
8. Modify the displayed mapping as follows:
a. Map the source fluidstate field to the Fluid State field in the PD_GENERAL
table.
b. Select the Code check box next to the Fluid State field to use code adaptation
when importing data to this field.
c. Map the following source FirstVue fields with the appropriate target
SmartPlant Instrumentation fields:
Link Source Field Target Field
All plantname Change if required
All areaname Change if required
All unitnumber Change if required
All itemtag Check whether the tag instrument convention in
each target unit matches the source data
Specification specformnumber SPEC_FORM_CNUM/SPEC_FORM_ID
Data
Related Topics
• Importing Data Common Tasks, page 1470
• Prerequisites for Importing Masoneilan ValSpeQ Data, page 1620
At this stage, you can also define process data parameters specific to the selected
control valve (for example, Leakage). (These parameters can be viewed in the
Additional Properties window in the Process Data module.)
• Fields that are required for sizing calculations, including line data
• ISA format specification fields
• Fields that contain export-only data (for example, revision data)
• Fields that allow insertion of new data, when you import data from the
ASCII file back to SmartPlant Instrumentation
Note
• During the export process, the 'U' character is added to the Masoneilan
ValSpeQ unitnumber field string.
Related Topics
• Prerequisites for Exporting Data to Masoneilan ValSpeQ, page 1616
• Click .
• Click Actions > Browse Index.
3. In the browser view, select the tags whose control valve data you want to export
to Masoneilan ValSpeQ. To select more than one tag, hold down either the Ctrl
key or the Shift key and click the desired fields.
4. Click Tools > Interfaces > Masoneilan ValSpeQ.
5. On the Export to Masoneilan ValSpeQ dialog box, enter data as follows:
a. To select the appropriate Masoneilan ValSpeQ ASCII file with a .csv
extension to which the SmartPlant Instrumentation control valve data will be
exported, do one of the following:
• In the File text box, type in the path and location of the Masoneilan
ValSpeQ export file name.
• Click Browse to navigate to the Masoneilan ValSpeQ file location.
b. If you selected in the previous step to export to an existing ASCII file, do one
of the following:
• Select the Overwrite check box to overwrite the existing ASCII
file.
• Clear the Overwrite check box to keep the existing ASCII file. In
this case, if you enter an existing file in the File Name data field,
you will be prompted to confirm the overwrite.
c. Under Export for, select the desired specification to be used for the exported
data, from either:
• Spec#1
• Spec#75
d. To select the level on which you want to export the SmartPlant
Instrumentation data to Masoneilan ValSpeQ, do one of the following:
• Click Plant to export all the control valve tags and their data
belonging to the current plant.
• Click Unit to export all the control valve tags and their data
belonging to the current unit.
• Click Filter to export only the control valve tags and their data that
comply with the filter parameters that you have set for the current
Instrument Index Standard Browser view.
• Click Selected tags to export only the tags and their data that you
selected in the Instrument Index Standard Browser view (see step 3
in this procedure).
Caution
• If you select to export selected tags, make sure you select the
appropriate tags before clicking OK on the Export to Masoneilan
ValSpeQ dialog box.
e. Under Use field length from, do one of the following:
• Click SmartPlant Instrumentation to truncate the exported fields
to match the lengths indicated in the SmartPlant Instrumentation
database.
• Click Masoneilan to truncate the exported fields to match the
lengths indicated in the Masoneilan field table.
6. Click OK to start the export process.
Tip
• If the export process is successful, an appropriate message is
displayed, notifying you that the Log file is empty.
Caution
• Failing to convert units of measure will generate an error message.
This means that the associated data was exported without the required
units of measure (that is, the unit of measure fields in Masoneilan
ValSpeQ will be empty). In this case, you should select the desired
units of measure manually in Masoneilan ValSpeQ.
7. On completion of the export process, click Log File to open the Export.log file,
located in the same folder where you exported the ASCII file, where you can view
any errors that occurred during the export process.
8. Click Close to close the Export to Masoneilan ValSpeQ dialog box and return
to the browser view.
Important
• Before being able to import data, the predefined import links for
Masoneilan ValSpeQ must be available. To make the links available, you
need to import the appropriate system interfaces into SmartPlant
Instrumentation from the Administration module (for details, see Import
System Interfaces, page 1539).
Ensure that you have performed the following prerequisite actions:
Also, when retrieving the Masoneilan link group from the In_ctlog.db file, the
software also retrieves the system codes and unit of measure codes. These codes are
already adapted to SmartPlant Instrumentation, that is, every source code value in
Masoneilan is associated with its appropriate target value in SmartPlant
Instrumentation.
SmartPlant Instrumentation features a standard ISA form which you can use to print
out sizing data imported from Masoneilan ValSpeQ as an ISA specification. This
specification is based on library form 75. The specification printout is identical to the
one generated by Masoneilan ValSpeQ, yet retains the SmartPlant Instrumentation
revision system. Alternatively, you can use library form 1.
It is possible to run all the Masoneilan group links automatically in order of their
appearance. Advanced users can perform a manual import process which allows you
to carry out a step-by-step procedure. Importing data this way enables you to view
and modify the default import parameters and link settings.
The following links are available in the link Masoneilan ValSpeQ link groups
retrieved from the In_ctlog.db file:
Important
• Before using this procedure, make sure you meet all the prerequisites. For
details, see Prerequisites for Importing Masoneilan ValSpeQ Data, page
1620.
• When importing Masoneilan ValSpeQ data, you must always use the
Masoneilan interface to connect to the source data files before you can run
the links from the Link Explorer. You cannot create and run links
outside of the interface.
1. Do one of the following:
• On the Link Explorer menu bar, click .
• Click Options > Masoneilan.
2. On the Masoneilan dialog box, do one of the following:
• If you want to import data to control valve specifications based on
standard form 1 only, beside Source file for Spec #1, click Browse
and select the .csv ASCII file containing the appropriate data exported
from Masoneilan.
• If you want to import data to control valve specifications based on
special form 75 only, Source file for Spec #75, click Browse and
select the .csv ASCII file containing the appropriate data exported
from Masoneilan.
• If you want to import data to control valve specifications based on
forms 1 and 75, specify both source files.
Tip
• Spec form 75 is a SmartPlant Instrumentation library form designed
for printing out control valve data imported from Masoneilan ValSpeQ
as an ISA specification. The specification printout is identical to the
one generated by Masoneilan, yet retains the SmartPlant
Instrumentation revision system.
3. Click Open to display the file name and path on the Masoneilan dialog box.
4. Do one of the following:
• If you are importing Masoneilan ValSpeQ data into SmartPlant
Instrumentation for the very first time, select Insert new data.
Related Topics
• Importing Data Common Tasks, page 1470
Related Topics
• Importing Data Common Tasks, page 1470
At this stage, you can also define process data parameters specific to the selected
control valve (for example, Leakage). (These parameters can be viewed in the
Additional Properties window in the Process Data module.)
• Fields that are required for sizing calculations, including line data
• ISA format specification fields
• Fields that contain export-only data (for example, revision data)
• Fields that allow insertion of new data, when you import data from the
ASCII file back to SmartPlant Instrumentation
Note
• During the export process, the 'U' character is added to the Flowserve
Performance! unitnumber field string.
Related Topics
• Prerequisites for Exporting Data to Flowserve Performance!, page 1626
• Click .
• Click Actions > Browse Index.
3. In the browser view, select the tags whose control valve data you want to export
to Flowserve Performance!. To select more than one tag, hold down either the
Ctrl key or the Shift key and click the desired fields.
4. Click Tools > Interfaces > Flowserve Performance!.
5. On the Export to Flowserve Performance! dialog box, enter data as follows:
a. To select the appropriate Flowserve Performance! ASCII file with a .csv
extension to which the SmartPlant Instrumentation control valve data will be
exported, do one of the following:
• In the File text box, type in the path and location of the Flowserve
Performance! export file name.
• Click Browse to navigate to the Flowserve Performance! file
location.
b. If you selected in the previous step to export to an existing ASCII file, do one
of the following:
• Select the Overwrite check box to overwrite the existing ASCII
file.
• Clear the Overwrite check box to keep the existing ASCII file. In
this case, if you enter an existing file in the File Name data field,
you will be prompted to confirm the overwrite.
c. Under Export for, select the desired specification to be used for the exported
data, from either:
• Spec#1
• Spec#71
d. To select the level on which you want to export the SmartPlant
Instrumentation data to Flowserve Performance!, do one of the following:
• Click Plant to export all the control valve tags and their data
belonging to the current plant.
• Click Unit to export all the control valve tags and their data
belonging to the current unit.
• Click Filter to export only the control valve tags and their data that
comply with the filter parameters that you have set for the current
Instrument Index Standard Browser view.
• Click Selected tags to export only the tags and their data that you
selected in the Instrument Index Standard Browser view (see step 3
in this procedure).
Caution
• If you select to export selected tags, make sure you select the
appropriate tags before clicking OK on the Export to Flowserve
Performance! dialog box.
e. Under Use field length from, do one of the following:
• Click SmartPlant Instrumentation to truncate the exported fields
to match the lengths indicated in the SmartPlant Instrumentation
database.
• Click Performance to truncate the exported fields to match the
lengths indicated in the Performance field table.
6. Click OK to start the export process.
Tip
• If the export process is successful, an appropriate message is
displayed, notifying you that the Log file is empty.
Caution
• Failing to convert units of measure will generate an error message.
This means that the associated data was exported without the required
units of measure (that is, the unit of measure fields in Flowserve
Performance! will be empty). In this case, you should select the
desired units of measure manually in Flowserve Performance!.
7. On completion of the export process, click Log File to open the Export.log file,
located in the same folder where you exported the ASCII file, where you can view
any errors that occurred during the export process.
8. Click Close to close the Export to Flowserve Performance! dialog box and
return to the browser view.
Important
• Before being able to import data, the predefined import links for
Flowserve Performance! must be available. To make the links available,
you need to import the appropriate system interfaces into SmartPlant
Instrumentation from the Administration module (for details, see Import
System Interfaces, page 1539).
Ensure that you have performed the following prerequisite actions:
Also, when retrieving the Flowserve Performance! link group from the In_ctlog.db
file, the software also retrieves the system codes and unit of measure codes. These
codes are already adapted to SmartPlant Instrumentation, that is, every source code
value in Flowserve Performance! is associated with its appropriate target value in
SmartPlant Instrumentation.
SmartPlant Instrumentation features a standard ISA form which you can use to print
out sizing data imported from Flowserve Performance! as an ISA specification. This
specification is based on library form 71. The specification printout is identical to the
one generated by Flowserve Performance!, yet retains the SmartPlant Instrumentation
revision system. Alternatively, you can use library form 1.
It is possible to run all the Flowserve Performance! group links automatically in order
of their appearance. Advanced users can perform a manual import process which
allows you to carry out a step-by-step procedure. Importing data this way enables
you to view and modify the default import parameters and link settings.
The following links are available in the link Flowserve Performance! link groups
retrieved from the In_ctlog.db file:
Important
• Before using this procedure, make sure you meet all the prerequisites. For
details, see Prerequisites for Importing Flowserve Performance! Data,
page 1630.
• When importing Flowserve Performance! data, you must always use the
Flowserve Performance! interface to connect to the source data files
before you can run the links from the Link Explorer. You cannot create
and run links outside of the interface.
1. Do one of the following:
• On the Link Explorer menu bar, click .
• Click Options > Flowserve Performance.
2. On the Flowserve Performance dialog box, do one of the following:
• If you want to import data to control valve specifications based on
standard form 1 only, beside Source file for Spec #1, click Browse
and select the .csv ASCII file containing the appropriate data exported
from Flowserve Performance!.
• If you want to import data to control valve specifications based on
special form 71 only, Source file for Spec #71, click Browse and
select the .csv ASCII file containing the appropriate data exported
from Flowserve Performance!.
• If you want to import data to control valve specifications based on
forms 1 and 71, specify both source files.
Tip
• Spec form 71 is a SmartPlant Instrumentation library form designed
for printing out sizing data imported from Flowserve Performance! as
an ISA specification. The specification printout is identical to the one
generated by Flowserve Performance!, yet retains the SmartPlant
Instrumentation revision system.
3. Click Open to display the file name and path on the Flowserve Performance
dialog box.
4. Do one of the following:
• If you are importing Flowserve Performance! data into SmartPlant
Instrumentation for the very first time, select Insert new data.
Related Topics
• Importing Data Common Tasks, page 1470
Note
• You can only use the SmartPlant menu commands after your plant is
registered.
Registering Tools
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.
Important
• Tool registration information is not upgraded in SmartPlant Foundation
2007; therefore, each tool must re-register with SmartPlant Foundation
after upgrading SmartPlant Foundation to Version 2007.5. 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 Support.
Related Topics
• Access the SmartPlant Foundation Web Client, page 1636
• Publishing in an Integrated Environment: An Overview, page 1682
• Retrieving in an Integrated Environment: An Overview, page 1700
• Using the To Do List: An Overview, page 1706
Tip
• This command is available only if the active plant has been registered.
For more information, see Configuring SmartPlant Instrumentation for
Integration in the Administration User's Guide, under SmartPlant
Integration and Item Registry and Related Topics.
Note
• From the SmartPlant Foundation Web Client, you can perform a number
of tasks, such as publishing or retrieving documents, comparing
documents, subscribing to document changes, and so forth. Many of these
tasks can be performed from the authoring tools, such as SmartPlant P&ID
or SmartPlant Electrical, but the Web Client provides unique access to
other features such as the Web Client To Do List and search capabilities.
Related Topics
• Working with SmartPlant Integration, page 1634
Notes
• For the .brw, .ssf, and .spd file types, SmartPlant Foundation uses the
following component address (ProgID):
SPITitleBlock.TitleBlockInfo
• These file types are already configured in the delivered database dump
files.
For a detailed flow of activities, see Updating SmartPlant Information in Title
Blocks: Flow of Activities, page 1638.
Related Topics
• Updating SmartPlant Information in Title Blocks, page 1637
PowerSoft Reports
The title block files for the reports in .psr format are in the location <SmartPlant
Instrumentation installation folder>\PSR\ and the available files are as follows:
• A3tall_inchunit.psr
• A3tall_pbunit.psr
• A3wideborder_inchunit.psr
• A3wideborder_pbunit.psr
• A4tall_inch.psr
• A4tall_pbunit.psr
• A4tall_pbunit_general.psr
• A4widerborder_inchunit.psr
• A4widerborder_pbunit.psr
If you are creating your own custom reports in .psr format in which you want to
include issue data, you must create a custom title block and add macros as shown in
the following table.
For the macro names, 'x' represents an integer used to specify the sequence, for
example, issueno_1, issueno_2, and so forth.
Enhanced Reports
The title blocks that use the .sma format are designed to be used by all the tools that
communicate in an integrated environment; however, if you use them in SmartPlant
Instrumentation as delivered, parts of the drawing may overlap the margins of the
drawing area. For this reason, you need to set values of the working area margins for
any templates that you intend to use for generating reports in an integrated
environment. To prepare the templates, you define the settings under Preferences >
Enhanced Reports (for all layouts of a particular report type) or for a specific layout
as desired.
The template files are installed on the SmartPlant Instrumentation machine. The
default location for enhanced report templates for the reports used in an integrated
environment is:
<SmartPlant Instrumentation installation folder>\RAD\Template\Generic\*.sma
The title block files are installed on the SmartPlant Instrumentation machine. The
default location for enhanced report title blocks for the reports used in an integrated
environment is:
<SmartPlant Instrumentation installation
folder>\RAD\Template\Generic\TitleBlocks\*.sym
The following settings represent the minimum values required for the working area
margins:
Note
• To place issue data on other title blocks for enhanced reports, use the
SmartPlant Instrumentation Place Drawing Property Label command in
the Enhanced Report Utility. For more information, see Place Property
Labels on a Drawing Sheet in the Enhanced Report Utility User's Guide,
under Working with Templates and Title Blocks.
Related Topics
• Updating SmartPlant Information in Title Blocks, page 1637
• Updating SmartPlant Information in Title Blocks: Flow of Activities, page
1638
Note
• There are title blocks that come shipped with SmartPlant Instrumentation.
For the list of available title blocks and their descriptions, see Title Block
Descriptions in the Administration User's Guide, under Domain and
Project Administration, Report Management
4. Click Open.
5. In the Title Block Properties dialog box, do the following if required:
a. Under Revision custom field headers, in the Header column, type the name
for each custom field.
b. In the Title block name field, type the name that you have selected for the
title block.
c. Under Document custom field headers, in the Header column, type the
name for each custom field.
Tip
• If you want to modify the number of revisions of custom title blocks,
you need to add more revision rows and create appropriate macros in
InfoMaker. The Revision rows box displays the number of revision
rows that you have customized for your title block.
6. Click OK to save the edited title block and add it to the inventory of title blocks
in SmartPlant Instrumentation.
7. In the Title Blocks dialog box, click Close to return to the main window.
5. To accept the default installation location for the SmartPlant Instrumentation Title
Block component, click Next.
Tip
• If you want to change the installation location, click Browse and
navigate to the new folder. Then, click Next.
6. Click Finish.
Related Topics
• Updating SmartPlant Information in Title Blocks, page 1637
• Updating SmartPlant Information in Title Blocks: Flow of Activities, page
1638
This section describes the structure of the tool schema and how it is used by the
authoring tool SmartPlant integration adapter in support of the publish and retrieve
operations. This topic does not provide a list of the classes, properties, or enumerated
lists (select lists) that are mapped by the delivered SmartPlant Instrumentation tool
schema. You can obtain this information by viewing the tool schema directly. This
set of topics does not describe the user interface of the Schema Editor.
Before modifying the mapping for SmartPlant Instrumentation, you must understand:
The adapter does not handle tool schema files directly, but uses them indirectly. The
tool schema files are used to define the retrieve map file, which is then used by the
adapter. Direct use of the schema files would mean that the adapter accessed them
directly to do its work. Both retrieve and publish operations only work through map
files.
Mapping Configuration
The SmartPlant Instrumentation adapter uses the tool schema map file and the
Schema Editor, delivered with the SmartPlant Schema Component, to perform
mapping between the SmartPlant Instrumentation object structure and the structure of
objects in SmartPlant integration. The map file is installed with SmartPlant
Instrumentation Setup. This file includes all objects that are mapped for SmartPlant
integration (not the entire set of objects in SmartPlant Instrumentation, nor all
properties, but only those that are relevant for other applications that use SmartPlant
Integration).
Domain Definition window, by typing it in the Path for SmartPlant XML files
box. This allows you to specify a different tool schema for each domain.
Related Topics
• Schema Mapping: An Overview, page 1644
Caution
• Before removing the previous version of SmartPlant Instrumentation, be
sure to back up your existing INtoolsMap.xml file so that you do not lose
your custom changes. The INtoolsMap.xml file is located in the path
<SmartPlant Instrumentation home folder>\XML\.
Related Topics
• Define a Schema for SmartPlant Instrumentation, page 1672
• Export a New Schema Configuration, page 1676
• Workflow for Extending the Schema, page 1648
Related Topics
• Define a Schema for SmartPlant Instrumentation, page 1672
• Schema Mapping: An Overview, page 1644
• Workflow for Extending the Schema, page 1648
The following example illustrates how the hierarchy is organized for two
object types, 'Loop' and 'Instrument', both belonging to the document type
'InstrumentIndex':
TEFPublish(publish)
InstrumentIndex
Loop
ILoop
LOOP_NAME
LOOP_SERV
Instrument
IInstrument
CMPNT_NAME
CMPNT_SERV
Important
• To be able to publish data that includes the new classes, you need to
rename the target .xml file to 'INtoolsMap.xml'.
Related Topics
• Define a Schema for SmartPlant Instrumentation, page 1672
• Export a New Schema Configuration, page 1676
• Schema Mapping: An Overview, page 1644
• The values in the Mapped To column are for this example only. You
should substitute the appropriate values for your hierarchy.
• You will need to create new map classes ICity, IDistrict, and IPrecinct.
For details of the procedure, see Creating New Objects and
Relationships in the Schema: An Overview in the Schema Editor
User's Guide.
3. Launch Schema Editor.
4. On the Workflows dialog box, click the Tool Schema tab.
5. Click Open.
6. Navigate to the file path: Program Files > Common Files > Intergraph >
EFSchema > EFSchema.xml.
Tip
• The file may take some time to open.
7. Click Open to select the tool schema file.
10. On the View Tool Schema dialog box, from the Form list, select Tree/Table
Horizontal, and then click OK.
11. In the tree view, expand the SPMapClassDef node.
12. Scroll down to the TEFRetrieve_PBSDocument_Plant node.
13. Right-click this SPMapClass and on the shortcut menu, click Edit
INTL_TEFRetrieve_PBSDocument_Plant.
14. On the Edit Map Class Definition dialog box, under the Retrieve map section,
clear the value IPlant and click the ellipsis button as shown:
Tip
• The top level interface (IPlant in this example) cannot be renamed.
Therefore in the custom hierarchy, the top level will always be mapped
to IPlant. Consequently, the IPlant interface remains mapped to the
IPlant interface (as shown in the graphic) and no mapping changes are
required.
17. Click OK to close the Edit Map Class Definition dialog box.
18. Right-click the TEFRetrieve_PBSDocument_Area node, and on the shortcut
menu, click the Edit option.
19. On the Edit Map Class Definition dialog box, under the Retrieve map section,
clear the value IFunctionalArea and click the ellipsis button.
20. On the dialog box Possible ClassToMapClass\Classes for TEF
Retrieve_PBSDocument_Area, map the intermediate level interface to ICity and
IDistrict.
21. Click OK to close the Edit Map Class Definition dialog box.
22. Right-click the TEFRetrieve_PBSDocument_Unit node, and on the shortcut
menu, click the Edit option.
23. On the Edit Map Class Definition dialog box, under the Retrieve map section,
clear the value IFunctionalUnit and click the ellipsis button.
Related Topics
• Export a New Schema Configuration, page 1676
• Schema Mapping: An Overview, page 1644
• Workflow for Extending the Schema, page 1648
Notes
• Mapping two adjacent segments to the same property results in
concatenation of the values when you publish.
• If you use the value 'Exception' for the InterfaceDefUID property, the
software looks for the <Exception Name> tag with a value equivalent to
the PropertyDefUID attribute. For example:
<Instrument>
...
<Segment Seq="2"
InterfaceDefUID="Exception"
PropertyDefUID="INSTRUMENT_TYPE"
Related Topics
• General Information About Schema Mapping, page 1645
• Schema Mapping: An Overview, page 1644
Synchronizing Schemas
This section describes how to use the Schema Editor to synchronize the tool metadata
(stored in the tool's database) and the map schema file (INtoolsMap.xml) when you
define new properties for publishing or retrieving.
You can begin the update by first adding a new property to the tool metadata and then
synchronizing the map schema file to it, or you can first modify the map schema file
and then synchronize the metadata with it.
Note
• For SmartPlant Instrumentation, new properties are created using custom
fields.
Important
• You are not allowed to delete a property that you have already
synchronized between the tool metadata and the map schema file because
the software cannot determine whether data values exist for that property.
Related Topics
• Define a Schema for SmartPlant Instrumentation, page 1672
• Export a New Schema Configuration, page 1676
• Workflow for Extending the Schema, page 1648
For example:
http://<SPFServer>/SPFASP.
Tips
• 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.
11. Click Next.
12. On the SmartPlant Foundation Plant page, select from the Plant name list the
SmartPlant Foundation plant in which you want to synchronize your data.
13. Click Next.
14. On the Engineering Application Options page, select from the Engineering
application/map schema list the schema for the tool that you want to
synchronize.
15. Under Startup options, select the Load map schema check box.
Tip
• For SmartPlant Instrumentation, the software automatically selects the
Connect to application schema check box.
16. If desired, select the Automatically synchronize schemas check box.
Tip
• You can select more than one schema from the Engineering
application/map schema list (if available) and specify the startup
options. In this case, the software will load the map schema for each
application and perform connection and synchronization as specified.
17. Click Finish to complete the connection.
The Synchronize window opens with all the properties selected by default for
synchronizing in the map schema file (located in this example in the path
C:\Program Files\SmartPlant\Instrumentation\XML\INtoolsMap.xml).
19. Click OK to synchronize the data and open the Map Environment window.
Tip
• The remainder of this procedure describes an example where you are
going to map the custom fields that you defined to a map class for
retrieving instruments from a SmartPlant P&ID drawing. The actual
map class that you select depends on how you want to map the fields
that you defined, and on whether you choose to publish or retrieve the
data.
21. Under the Map Classes node, scroll down to
TEFRetrieve_PIDDrawing_Instrument (the map class that defines instrument
retrieval from SmartPlant P&ID drawings) and right-click the map class.
22. On the shortcut menu, click the Edit... option as shown.
23. In the Edit Map Class Definition window, click the Retrieve tab.
24. From the Unmapped application properties pane, scroll down until you find the
values that you added to the custom field.
25. Select the field that you want to map, then from the Unmapped SmartPlant
properties pane, select the property that you want to map to.
Tip
• If you cannot find a suitable property in the SmartPlant Foundation
schema to map to, you can create a new one.
26. Click the Map icon to map the selected properties.
27. Repeat for other property values that you want to map.
28. Exit the Schema Editor, and click Yes in the message boxes when prompted to
save changes.
Related Topics
• Define a Schema for SmartPlant Instrumentation, page 1672
• Schema Mapping: An Overview, page 1644
• Workflow for Extending the Schema, page 1648
For example:
http://<SPFServer>/SPFASP.
Tips
• 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.
8. Click Next.
9. On the SmartPlant Foundation Plant page, from the Plant name list, select the
SmartPlant Foundation plant in which you want to synchronize your data.
10. Click Next.
11. On the Engineering Application Options page, select from the Engineering
application/map schema list the schema for the tool that you want to
synchronize.
12. Under Startup options, select the Load map schema check box.
Tip
• For SmartPlant Instrumentation, the software automatically selects the
Connect to application schema check box.
13. If needed, select the Automatically synchronize schemas check box.
Tip
• You can select more than one schema from the Engineering
application/map schema list and specify the startup options. This
allows you to load the map schema for each application and perform
connection and synchronization as specified.
14. Click Finish to complete the connection and open the Synchronize dialog box,
which displays the property selected by default for synchronizing in the map
schema file. In this example, the map schema file name and path is C:\Program
Files\SmartPlant\Instrumentation\XML\INtoolsMap.xml.
15. Leave the property selected because in this case, you want the software to
synchronize the map schema file by updating it with the value from the
application database.
16. Click OK to synchronize the data and open the Map Environment window.
Tip
• The remainder of this procedure describes an example where you are
going to map the new select list value that you defined to a map class
for publishing I/O types. The actual map class that you select depends
on how you want to map the fields that you defined, and on whether
you choose to publish or retrieve the data.
18. Under the Map Enumerated Lists node, scroll down to the SystemIOTypes
select list.
19. Right-click SystemIOTypes, and then, on the shortcut menu, click Edit
SystemIOTypes.
20. In the Edit Map Enumerated List Definition window, click the Advanced tab
to view the new select list value that you added.
23. Exit the Schema Editor, and click Yes in the message boxes when prompted to
save changes.
Related Topics
• Define a Schema for SmartPlant Instrumentation, page 1672
• Schema Mapping: An Overview, page 1644
• Workflow for Extending the Schema, page 1648
3. On the Logon Information dialog box, type your user name and password.
4. In the SmartPlant Instrumentation Schema Configuration Wizard, on the
Welcome page, click Next.
5. Select a SmartPlant Instrumentation domain and click Next.
6. On the Schema Options page, select whether to create an entirely new schema
definition or to modify an existing schema definition.
7. Do one of the following:
• For a new schema, on the Define New Schema Configuration page,
type a schema name and select the appropriate option according to
whether the purpose of the schema is to publish or retrieve
information. If you select to use the schema for publishing, type the
name of the target application.
• For an existing schema, on the Select Schema page, select the desired
schema and click Next.
Tip
• When selecting an existing schema, the word 'publish' or 'retrieve' in
parentheses indicates the purpose of the schema.
8. On the Select Document Type page, select from the list the document type that
you want to add to the schema and click Next.
Tips
• You can select only one document type at a time to add to the schema.
• Document types that have already been added to the schema are
indicated with an asterisk.
9. On the Select Object Types page, select the objects, representing a class of items
that you want to represent in the schema and click Next.
Tip
• All object types are available for any document type that you have
selected, although it is recommended that you select related object
types for a particular document type, for example, Cable, CableSet,
Wire.
10. On the Define Object Levels and Restrictions page, select the level at which to
set each object for determining parent-child relationships.
Tips
• The highest level must always be 0.
• The software publishes or retrieves data for object types at each
successive level associated with the object type at the next highest
level. For example:
Line (level 0)
Instrument (level 1)
Piping port (level 2)
Loop (level 2)
11. Select the check boxes as desired beside each object type to specify restrictions
according to the requirements of the target application.
12. When done, click Next.
13. For a publish schema, if desired, on the Define Filter Condition page, specify a
filter condition for each level 0 object type by selecting the object type and typing
an appropriate SQL command.
14. When done, click Next.
15. On the Select Object Interfaces page, select for each object type the desired
interfaces and click Next.
Tip
• Double-click an interface to view its properties.
16. On the Completing the Schema Configuration Wizard page, select the desired
options and click Finish.
Tip
• To prepare for the next stage of the mapping, select the Export to tool
schema check box.
Related Topics
• Export a New Schema Configuration, page 1676
• Schema Mapping: An Overview, page 1644
• Workflow for Extending the Schema, page 1648
• For an existing schema, on the Select Schema page, select the desired
schema and click Next.
Tip
• When selecting an existing schema, the word 'publish' or 'retrieve' in
parentheses indicates the purpose of the schema.
7. On the Select Document Type page, select from the list, the document type to
which you want to add a custom field and click Next.
Tips
• You can select only one document type at a time.
• Document types that have already been added to the schema are
indicated with an asterisk.
8. On the Select Object Types page, select the objects, representing a class of items,
that you want to represent in the schema, and click Next.
Tip
• All object types are available for any document type that you have
selected, although it is recommended that you select object types
related to a particular document type, for example, Cable, CableSet,
Wire.
9. On the Define Object Levels and Restrictions page, select the level at which to
set each object for determining parent-child relationships.
Tips
• The highest level must always be 0.
• The software publishes or retrieves data for object types at each
successive level associated with the object type at the next highest
level. For example:
Line (level 0)
Instrument (level 1)
Piping port (level 2)
Loop (level 2)
10. Select the check boxes as desired beside each object type to specify restrictions
according to the requirements of the target application, and click Next.
11. For a publish schema, if desired, on the Define Filter Condition page, specify a
filter condition for each level 0 object type by selecting the object type and typing
an appropriate SQL command, and click Next.
12. On the Select Object Interfaces page, select for the desired object type, a
custom-field interface, click Add, and click Next. For example, for the object
type Controller, you can select IUnitUDF, or IStripUDF.
Tip
• Double-click an interface to view its properties.
13. On the Object Interfaces Properties page, select the desired interface properties
and click Add. Once you finished adding all the desired properties, click Next.
14. On the Completing the Schema Configuration Wizard page, select the desired
options and click Finish.
Tip
• To prepare for the next stage of the mapping, select the Export to tool
schema check box.
Related Topics
• Export a New Schema Configuration, page 1676
• Schema Mapping: An Overview, page 1644
• Workflow for Extending the Schema, page 1648
Related Topics
• Define a Schema for SmartPlant Instrumentation, page 1672
• Schema Mapping: An Overview, page 1644
• Workflow for Extending the Schema, page 1648
Note
• On a Vista operating system with User Access Control turned on, in order
to publish a DDP document through SmartPlant Foundation, the output
document folder cannot be any sub-folder under either the 'Program Files'
or 'Windows' folders.
1. The SmartPlant 3D user must define a symbol in the catalog for each instrument
that is going to be published from SmartPlant Instrumentation.
2. The SmartPlant 3D user must inform the SmartPlant Instrumentation user which
DDP attributes for the instrument need to be published.
3. Add the appropriate DDP attributes to the SmartPlant schema using the Schema
Editor.
4. The SmartPlant 3D user must map the DDP attributes to the SmartPlant schema.
5. Define the appropriate DDP attributes for the instrument in SmartPlant
Instrumentation.
6. Define the mapping between SmartPlant Instrumentation and the SmartPlant
schema.
Related Topics
• Define a Schema for SmartPlant Instrumentation, page 1672
• Schema Mapping: An Overview, page 1644
• Workflow for Extending the Schema, page 1648
Select Domain
Select the SmartPlant Instrumentation domain for which you want to define a new
schema for publishing or retrieving data, modify an existing schema, or delete an
existing schema.
Schema Options
Select the desired schema option.
Select Schema
Select the existing schema that you want to modify or delete. Note that there may be
more than one schema for a particular application and that separate schemas are
defined for publish and retrieve operations.
Source tool schema — The name and path of the XML file that you use as the map
source. Click the ellipsis button to navigate to the desired location.
Target tool schema — The name and path of the XML file that you will obtain as
the output. Click the ellipsis button to navigate to the desired location.
Connect to Domain — Opens the Logon dialog box where you select the desired
SmartPlant Instrumentation domain.
Object schema — Select from the list the object schema that you want to export.
Export — Exports the selected object schema to the target tool schema.
When you publish documents, the software does the following things:
For more information about revisions and versions, see the SmartPlant Foundation
Web Client User's Guide.
Reasons to Publish
You can publish documents and associated data for several reasons:
You can also publish a document by not assigning the document to a workflow, but
rather by using the default workflow from SmartPlant Foundation. When you do not
select a workflow for a document during publishing, the SmartPlant Loader loads the
document into SmartPlant Foundation as soon as it reaches the top of the Loader
queue.
The project breakdown structure, project definition document, and project list contain
information about projects and their statuses.
The project breakdown structure contains a single project and the hierarchy of
contracts under that project in a plant/project structure. The project definition
document contains information for a single project that needs to be created in the
authoring tool. The project list contains a list of all projects in a plant, and it is used
by those authoring tools that create all projects at one time.
Note
• The plant breakdown structure and project breakdown structure used in the
authoring tools must match the structure in SmartPlant Foundation for
publishing from the authoring tools and object correlation to work
correctly.
Note
• When you publish data from an authoring tool, you may not be able view
all the properties that you published in the SmartPlant Foundation client.
You can customize view definitions to allow you to see additional
properties. For more information about defining view definitions in the
SmartPlant schema, see Working with View Definitions: An Overview and
Create a View Definition in the Schema Editor User's Guide. For further
assistance with visualizing data in SmartPlant Foundation, contact
Intergraph Support Services.
Related Topics
• Access the SmartPlant Foundation Web Client, page 1636
• Publish Documents from SmartPlant Instrumentation, page 1690
Notes
• You set the graphical report format for view files on the SmartPlant
Instrumentation Preferences dialog box, under SmartPlant Integration >
General.
• In order to publish successfully the 'Panel-Strip With Adjacent
Connections' and 'Panel Strip Without Adjacent Connections (Style 2)'
wiring reports, in the Administration module, the Domain Administrator
needs to open the Report Management dialog box and change the
Revision Management settings for these reports from Per Item to Per
Document. For more information, see SmartPlant Instrumentation
Administration Help, Domain Administration > Define Report Revision
Management Settings.
Group Description
IA1 Annubar Type 1
IA2 Annubar Type 2
ICM1 Coriolis Flowmeter Type 1
ICM2 Coriolis Flowmeter Type 2 Liquid
ICM3 Coriolis Flowmeter Type 2 Gas
ICM4 Coriolis Flowmeter Type 3 Liquid
ICM5 Coriolis Flowmeter Type 3 Gas
IDCO Orifice_Double Chamber Fitting
IDL1C Valve_Rotary Diaph. Act. Pos C1
IDL1D Valve_Rotary Diaph. Act. Pos D1
IDL4C Valve_Rotary Diaph.Act.Pos C4(Vert.Line)
IDL4D Valve_Rotary Diaph.Act.Pos D4(Vert.Line)
IDR1A Valve_Rotary Diaph. Act. Pos A1
IDR1B Valve_Rotary Diaph. Act. Pos B1
IDR4A Valve_Rotary Diaph.Act.Pos A4(Vert.Line)
IDR4B Valve_Rotary Diaph.Act.Pos B4(Vert.Line)
IEAM1 Valve_Electric Actuator Type 1
IEAM2 Valve_Electric Actuator Type 2
IEAM3 Valve_Electric Actuator Type 3
IEAM4 Valve_Electric Actuator Type 4
IEAM5 Valve_Electric Actuator Type 5
IIOL Orifice_Integral Type 2
IIOR Orifice_Integral Type 1
Group Description
IIV Insert Venturi
IKG1 Knife Gate Valve Typ 1_Piston Actuator
IKG2 Knife Gate Valve Typ 2_Piston Actuator
ILSV Long or Short Venturi
IMFM1 Magnetic Flowmeter Type 1
IMFM2 Magnetic Flowmeter Type 2
IMFM3 Magnetic Flowmeter Type 3
IMFM4 Magnetic Flowmeter Type 4
IMOP1 Meterrun_Orifice Flanges & Plate
IMRSV Meterrun_Short Venturi
IOP Orifice Plate
IPDA1 Valve_Double Acting Dual Cyl Act. TYP 1
IPDA2 Valve_Double Acting Sngl Cyl Act. TYP 2
IPDA3 Valve_Double Acting Piston Act. TYP 3 FC
IPDA3A Valve_Double Acting/Sprg Rtrn Act. 90 RS
IPDA4 Valve_Double Acting Sngl. Piston Act. FO
IPDA4A Valve_Double Acting/Sprg Rtrn Act. 90 LS
IPDA5 Valve_Double Acting Dual Cyl Act TYP 5
IPL1C Valve_Rotary Piston Act. POS C1
IPL1D Valve_Rotary Piston Act. POS D1
IPL4C Valve_Rotary Piston Act.POS C4(Vert.Line)
IPL4D Valve_Rotary Piston Act.Pos D4(Vert.Line)
IPR1A Valve_Rotary Piston Act. POS A1
IPR1B Valve_Rotary Piston Act. POS B1
IPR4A Valve_Rotary Piston Act.POS A4(Vert.Line)
IPR4B Valve_Rotary Piston Act.POS B4(Vert.Line)
IPSR1 Valve_Spring Return Piston Act. Typ1 FC
IPSR2 Valve_Spring Return Piston Act. Typ2 FO
IPSR3 Valve_Spring Return Piston Act. Typ3 FC
IPSR4 Valve_Spring Return Piston Act. Typ4 FO
IR1 Rotameter Type 1
IR2 Rotameter Type 2
IR3 Rotameter Type 3
Group Description
IR4 Rotameter Type 4
IR5 Rotameter Type 5
IR6 Rotameter Type 6
IR7 Rotameter Type 7
IR8 Rotameter Type 8
IR9 Rotameter Type 9
IREG1 Regulator Type 1
IREG2 Regulator Type 2
IREG3 Regulator Type 3
IREG4 Regulator Type 4
IREG5 Regulator Type 5
IRVT3 Relief Valve Type 3 (Pilot)
IRVT4 Relief Valve Type 4 (Pilot)
IRVT7 Relief Valve Type 7 (Specials)
IRXPA Valve_Rack & Pinion Actuator
ISSDA Valve Angle_Linear Diaphragm Actuator
ISSDS Valve Linear Diaphragm Actuator
ISSPS 3 Way Valve_Linear Piston Actuator
ITM Turbine Meter
IVM1 Vortex Flowmeter Type 1
IVM2 Vortex Flowmeter Type 2
IVM3 Vortex Flowmeter Type 3
IVM4 Vortex Flowmeter Type 4_Dual Head
IWFE Wedge Flow Element
Related Topics
• Publish Documents from SmartPlant Instrumentation, page 1690
• Publishing in an Integrated Environment: An Overview, page 1682
3. Add any additional documents to the Selected documents list by clicking the
Engineering Tool, File System, or Find toolbar buttons and choosing other
documents to publish.
4. In the Document Selection Wizard, on the Select Document Type page, select
the check boxes for the types of documents you want to publish.
5. Click Next.
6. On the Select Unit page, navigate to the lowest level plant hierarchy item, such as
a unit, from which you want to publish documents.
Tips
• Double-click the icons to expand the plant hierarchy.
• The Next command is enabled only after you select a unit.
7. Click Next.
8. Depending on your document type selection, select engineering documents on
each Select page that opens as follows:
• Specify search parameters as necessary, and then click Find.
• In the Search results data window, select the rows for the documents
that you want to publish, and then click Next.
Note
• If you select the Instrument Index check box on the Select
Document Type page, the software automatically finds the instrument
index document that exists in the unit.
9. On the Document Selection Summary page, review your selections, and click
Finish to exit the Document Selection Wizard and return to the Publish dialog
box.
Tip
• To redefine your selections, click Back.
10. On the Publish dialog box, review the documents that you want to publish and
edit information as necessary.
Tip
• When multiple documents are selected, only property values shared by
all the selected documents appear in the table. Changing a value in the
table changes that value for all of the selected documents.
11. Specify a method of publishing in the Operation box:
• Click Publish now to immediately start the publishing process as soon
as you click OK.
• Click Background publish to publish the selected documents
immediately as a separate process, allowing you to perform other tasks
at the same time. When you use this feature, an e-mail message alerts
you when the process is complete.
• Select the Scheduled publish option to indicate that the publish
process should be run in batch mode, if the authoring tool supports
scheduled batch publishing.
12. Click OK to complete the publish operation.
Note
• When the publish is complete, a dialog box appears indicating whether the
publish operation was completed successfully or with errors. If the View
Log button on the dialog box is enabled, you can click it to view messages
concerning the operation. These may be errors, warnings or informational
messages.
Related Topics
• Retrieve Documents to SmartPlant Instrumentation, page 1702
Tips
• This command is available only if you have registered the active plant
using the SmartPlant Registration Wizard.
• If you logged onto SmartPlant Instrumentation with a user name that is
not defined in the integrated environment, you are prompted to log on
when you use this command.
• The documents that appear in the Selected documents list on the
dialog box when it first appears are documents that were selected
within SmartPlant Instrumentation before you accessed the Publish
command.
3. Click the Issue Request tab.
4. In the Issue to box, select the contract to which you want to assign the document
or documents.
5. To add any additional documents to the Selected documents list, click the
Engineering Tool button.
6. In the Document Selection Wizard, on the Select Document Type page, select
the check boxes for the types of documents you want to publish.
7. Click Next.
8. On the Select Unit page, navigate to the lowest level plant hierarchy item, such as
a unit, from which you want to publish documents.
Tips
• Double-click the icons to expand the plant hierarchy.
Related Topics
• Retrieve Documents to SmartPlant Instrumentation, page 1702
Tip
• You can quickly select the entire list by clicking Select All, or you can
clear the entire list by clicking Clear All.
3. Click OK to accept the selections. The documents you selected to publish now
appear in the Documents to Publish list on the Publish dialog box, and are ready
to be published.
Note
• The lists displayed on the Find Documents to Publish dialog box are
compiled at the time indicated in the Last search performed box. You
can update the lists by clicking Update, but this process can be time-
consuming, depending on whether you are running the applications in
synchronous or asynchronous mode.
Related Topics
• Publish Documents from SmartPlant Instrumentation, page 1690
For each project (or even at the plant level) you can reserve a certain number of
revisions that are held for that particular project. If the document is used within a
different project and revised, it is given either a later revision number or its own set of
numbers.
For more information about reserving revision numbers, see the Online Help for the
Revise dialog box.
Related Topics
• Revise a Document, page 1698
Revise a Document
1. Do one of the following to open the Revise dialog box:
• From any module that supports publishing and retrieving of
documents, on the Revisions dialog box, click New
• .
• From within SmartPlant Instrumentation, click SmartPlant > Revise
Documents
• .
Tips
• This option is available only if you have registered the active
SmartPlant Instrumentation plant.
• If you are logged on to SmartPlant Instrumentation with a user name
that is not defined in SmartPlant Foundation for the specific plant, you
are prompted to log on to SmartPlant Foundation when you use this
command.
• The documents that appear in the Selected documents list on the
Revise dialog box when it first appears are documents that were
selected within the authoring tool before you clicked the Revise
Documents command.
2. For a new document, or a document that does not yet have a defined revision
scheme, select the revision scheme you want to use from the Revision Scheme
list.
Tip
• If you selected a document that already has a defined revision scheme,
it is displayed in the Revision Scheme field and cannot be changed.
3. In the Revise in Tool section, choose the next available major and minor revision
numbers.
Tip
• Any revision numbers that have been reserved by another project are
not available and are skipped in the revision scheme, if applicable. In
other words, if the current version of the document is B and there are
three outstanding revision reservations for that document in other
projects, the next available revision number will be F.
4. Click OK.
Notes
• When you click OK to revise the document, it is saved to the authoring
tool database. The document stored in SmartPlant Foundation is not
updated until your publish it from SmartPlant Instrumentation.
• Using the Revise dialog box, you can reserve revision numbers, revise
documents, or do both at the same time.
Related Topics
• Revising Documents in an Integrated Environment: An Overview, page
1697
The authoring tools provide commands that let you select a document and retrieve it
into that tool. You can use either the SmartPlant > Retrieve command to open a
wizard that assists you in retrieving applicable documents, or with some authoring
tools, you can configure an automatic retrieval feature.
Note
• The software trims all leading and trailing spaces from all strings and from
all values without units of measure. These spaces do not appear in the
retrieved data file.
Additionally, you can access the Web Client through the SmartPlant > Browser
command. This allows you to select the document or documents that you want to
retrieve from your Web Client To Do List, the tree view, or by using the Web Client
search functionality. After you select the documents that you want to retrieve, you
can use the Retrieve command on the Web Client SmartPlant menu to start the
retrieval process.
The Retrieve command provided in the authoring tools is slightly different from the
Retrieve command available in the SmartPlant Foundation Web Client. The Web
Client presents a list of documents from which you can select those you want to
retrieve. However, when you use the command from an authoring tool without first
selecting documents, the software searches the SmartPlant Foundation project for
documents to retrieve, and these are presented in a list on the Retrieve dialog box.
Notes
• Retrieving the project breakdown documents and the PBS into SmartPlant
Engineering Manager creates the appropriate structures automatically.
• When using SmartPlant Instrumentation, you must create the plant
hierarchy according to the PBS information in SmartPlant Foundation
before you retrieve either the PBS or the project definition document.
You must create a plant hierarchy with at least three levels with a
minimum of one PBS item at the lowest level before you can retrieve the
PBS and project definition document.
Data Handling After Retrieval
The authoring tool that you use also determines how the system deals with changes in
downstream data when you retrieve a document. SmartPlant P&ID, SmartPlant
Instrumentation, SmartPlant Electrical, and Zyqad analyze the impact of the newly
retrieved data on the existing database, then place tasks on the authoring tool's To Do
List that allow you to create, delete, or modify items at the appropriate time in the
design process. The To Do List gives you the opportunity to view and understand
potential changes before accepting, deleting, or modifying those changes.
Design Basis
Objects that tools retrieve from other authoring tool documents can become the
design basis for objects in downstream documents. Objects that become the design
basis for other objects can be specific objects that get richer as they move through the
lifecycle or they can be schematic or logical objects in one application that evolve
into more detailed objects downstream.
Design basis is implicit based on retrieval; you do not have to define it. For example,
a pump retrieved from a PFD becomes the design basis for a pump in the P&ID.
When you change common properties for the pump and retrieve the changes into
SmartPlant P&ID, tasks to update the pump automatically appear in the To Do List.
The same process works for logical items that are a design basis for other items, such
as a P&ID tag in SmartPlant P&ID can evolve into a control loop with associated tag
numbers in SmartPlant Instrumentation.
Related Topics
• Open the To Do List, page 1708
• Retrieve Documents to SmartPlant Instrumentation, page 1702
5. In the Documents to retrieve list, select the check box beside each document you
want to retrieve. To help identify the documents, review the details in the Type,
Revision, Version, and Last Retrieved columns.
Tip
• To quickly select the entire list, click Select All. To quickly cancel the
selections, click Clear All.
6. For each document you checked, use the Retrieve Option column to specify
whether you want to retrieve the document with the latest data or retrieve it as
published.
7. Click OK to retrieve the specified documents.
Notes
• Check the Batch retrieve option if you want the retrieve process to run in
batch mode. If you select this option, an e-mail message will alert you
when the process is complete. Otherwise, the retrieval process begins
when you click OK.
• The Deleted and Unclaimed Objects document is retrieved automatically
every time you retrieve, if there is a newer version of this document since
the last retrieval. The document is not included in the list, but it is
retrieved automatically, when necessary, to ensure that the applicable
information is updated.
• When the retrieve is complete, a dialog box appears indicating whether the
retrieve operation was completed successfully or with errors. If the View
Log button on the dialog box is enabled, you can click it to view messages
concerning the operation. These may be errors, warnings or informational
messages.
Related Topics
• Find Documents to Publish from SmartPlant Instrumentation, page 1694
• Publish Documents from SmartPlant Instrumentation, page 1690
The following diagram shows an example of a P&ID involving pipe runs and related
control valves.
All the users of a plant database share a single To Do List. You can view the entire
To Do List and see the tasks that have been completed and those that are pending.
Some types of tasks have associated code and when you run those tasks, the software
modifies the database.
From the To Do List, you can run, defer, or delete tasks, or specify tasks that you
want the software to ignore in future retrievals. Additionally, you can view properties
for each task in the To Do List and, if desired, specify that certain task properties are
ignored when the task is retrieved. The information that is available is specific to the
type of task that is selected: Create tasks and Update tasks, for instance, but certain
information is provided for all types. The available task types are:
Notes
• When an Update task is created in the To Do List, the units of measure
used in properties are automatically converted to the defaults for the plant.
The software converts units of measure used for properties in Create tasks
to the plant defaults when the task is run.
• By clicking the To Do List column headings, you sort the list by the
values in that column. You can change the order in which these columns
appear by selecting a column heading and dragging it to the left or right to
the desired position.
Related Topics
• Defer Tasks from the To Do List, page 1712
Related Topics
• Using the To Do List: An Overview, page 1706
Related Topics
• To Do List Common Tasks, page 1707
• Using the To Do List: An Overview, page 1706
Related Topics
• Using the To Do List: An Overview, page 1706
• Working with SmartPlant Integration, page 1634
Note
• The properties available for each task depend on the type of task. For all
types, you can edit the name and notes for the task. For Create tasks, you
can ignore task properties when running a task (for details, see Ignore
Task Properties, page 1713). You can also edit the item being created and
turn off or on the values assigned to different properties for that item. For
Update tasks, you can turn off or on the new values assigned to properties
for the item.
Related Topics
• Using the To Do List: An Overview, page 1706
• Working with SmartPlant Integration, page 1634
Related Topics
• Using the To Do List: An Overview, page 1706
• Working with SmartPlant Integration, page 1634
Task Dependencies
When you run tasks, there are some task types that require other tasks to run first.
For example, if two tasks exist for an item, one to move it to another <unit>, and the
other to update some of the item properties, the software cannot run the update task
until the Move task is complete. The software analyzes the To Do List for these
dependencies to ensure that the tasks run in the appropriate sequence. The following
table indicates the dependencies that can exist between different task types.
Task dependencies influence the way in which the result of running a master task
affects the status of the dependent tasks. On running a task, the software checks the
To Do List for prerequisites, and changes the status of relevant tasks from New to
Submitted. If the status of a prerequisite task is Deferred, Deleted, or Failed, then
the software marks all dependent tasks as Failed.
Another example of task dependencies is where you have related tasks for items in a
hierarchical relationship; for example Panel - Rack - Slot - I/O card -Terminal. You
can select a particular task, such as a Create task for an I/O card, and use the Select
Parent Tasks or Select Sub-Tasks commands to highlight the desired set of
related tasks.
Related Topics
• Run Tasks from the To Do List, page 1709
Related Topics
• Using the To Do List: An Overview, page 1706
• Working with SmartPlant Integration, page 1634
Related Topics
• Using the To Do List: An Overview, page 1706
• Working with SmartPlant Integration, page 1634
4. Specify the filter condition by selecting the desired parameters from the
Property, Operator, and Value columns; for example, you can specify the
condition:
Task Type = Create
Related Topics
• Using the To Do List: An Overview, page 1706
• Working with SmartPlant Integration, page 1634
Related Topics
• Remove Tasks from the To Do List, page 1712
• Using the To Do List: An Overview, page 1706
• Working with SmartPlant Integration, page 1634
Tip
• When you select to ignore a property, the software does not update
that property when you run the task for the current or for subsequent
retrieve sessions. If the new value of the property changes in the
published data, on the next retrieve, that property is no longer ignored.
If you want to ignore the property only for the current retrieve session,
clear both the Activate and Ignore check boxes beside the property.
Note
• After running a task that includes ignored properties, that task is copied
from the To Do List to the ignored tasks list, where only the properties
that were selected to be ignored appear on the Details tab.
Related Topics
• Ignore To Do List Tasks, page 1713
• Using the To Do List: An Overview, page 1706
• Working with SmartPlant Integration, page 1634
Related Topics
• Using the To Do List: An Overview, page 1706
• Working with SmartPlant Integration, page 1634
• You need to transfer all the data from a source domain to a target domain.
• You need to transfer all the data from a source plant hierarchy item to a
target plant hierarchy item at the same level.
Notes
• Only the Domain Administrator has access to the Merger Utility.
• The source and target domains must be of the same SmartPlant
Instrumentation version. If they are not the same version, you must
upgrade the domain that belongs to the earlier version.
• The Merger Utility only supports domains of type Engineering company
when merging plant data. For configuration data, the Merger Utility
supports engineering company and owner operator domains.
• The Merger Utility changes the contents of your target database.
Therefore, we recommend that you backup your target database before
proceeding with the merge process.
Related Topics
• Configuring Your Environment, page 1717
• Database Platform Support, page 1375
• Start the Merger Utility, page 1717
• Oracle
• Microsoft SQL Server
• Sybase Adaptive Server Anywhere
You can use any of the above database platforms after you configured that database
platform to work with SmartPlant Instrumentation.
You can also import data from database platforms other than those specified above.
To do this, you need to install the appropriate drivers manually and configure the
appropriate configuration files.
Note
• SmartPlant Instrumentation uses a database engine developed by Sybase
for SmartPlant Instrumentation repository. This engine is called Sybase
Adaptive Server Anywhere.
Related Topics
• Configuring Your Environment, page 1717
• Merger Utility: An Overview, page 1715
• Start the Merger Utility, page 1717
• HKEY_CURRENT_USER\Software\ODBC\ODBC.INI
• HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBCINST.INI
Caution
• Do not change the setting in the configuration files if you are not familiar
with the database configuration.
Related Topics
• Database Platform Support, page 1375
• Merger Utility: An Overview, page 1715
• Start the Merger Utility, page 1717
• You must have a previously defined source and target domains with at
least one plant hierarchy item at the lowest level of the hierarchy (by
default, this is a unit).
• Both the source and target domains must be of the same SmartPlant
Instrumentation version and sub-version.
See Installation Guide, SmartPlant Instrumentation Setup Maintenance and Database
Selection, Installing SmartPlant Instrumentation Components to learn more about
SmartPlant Instrumentation programs and utilities.
1. Select Merger Utility from the Intergraph SmartPlant Instrumentation
program group in the Windows Start menu.
2. On the Logon Information dialog box, type the Domain Administrator name and
password.
3. On the Open dialog box, expand the hierarchy as needed by clicking and select
the desired <unit> .
Tips
• Whenever you start the Merger Utility, the software prompts you to
select a target <unit>. If you have already started a merge process in a
previous Merger Utility session, you are prompted to resume that
merge process.
• You need to select a single target <unit> before starting the merge
process, the same way you do when you enter every SmartPlant
Instrumentation module. You can select additional target plant
hierarchy items as you proceed through the merge process. (For
details of how to select additional target data, see Merging Data: An
Overview, page 1725 .)
Related Topics
• Configuring Your Environment, page 1717
• Database Platform Support, page 1375
• Merger Utility: An Overview, page 1715
When you start the Merger Utility for the first time, you create a new log file. The
log file keeps growing as you continue merging data unless you decide to change the
current log file. The information in the log file describes chronologically the events
which have taken place during the merge process. This information includes:
Note
• SmartPlant Instrumentation uses Notepad to view the log file; however,
Notepad is limited by file size that it can handle. If your log file becomes
too large for Notepad, an appropriate message appears. In this case, you
can view your log file using Windows Write or another appropriate utility.
Related Topics
• Log File: Common Tasks, page 1722
• Setting the Merger Comparison Criteria, page 1720
For example:
The COMPONENT table contains all the tags together with the appropriate links to
other tables, which utilize tags, such as: COMPONENT_MFR (Manufacturers table),
CABLES (Cables table), and so forth.
You can use one or more columns in each table as the primary keys of this table. The
value of the primary key of each table is unique in this table. For example, the
primary key of the COMPONENTS Table is CMPNT_ID. This means that each row
in the COMPONENT Table has a different value in the CMPNT_ID field.
Note
• Primary key columns are not accessible to you when you work in
SmartPlant Instrumentation. The primary keys are designed only for
SmartPlant Instrumentation internal use.
When comparing rows, the Merger Utility treats the source and target rows as
identical only if both the source primary key and target primary key contain the same
value. For example, if the COMPONENT table in both source and target rows
contains the same values in the columns defined as primary keys, then the software
considers both rows as being identical. In this case, the Merger Utility can either
replace the entire target row with the source row or leave this target row intact,
depending on the merge process settings.
You can select the appropriate primary key of every table in the database. This way
you can create a different comparison criterion for each table.
Caution
• Changing the settings in the Target Definition dialog box alters the
relations between the tables. We therefore recommend that you do not
change these settings unless you find it necessary and only if you are
familiar with the SmartPlant Instrumentation database structure. In most
cases when you merge data, you do not have to modify the Merger Utility
comparison criteria. If you decide to modify the comparison criteria,
make sure you enter the appropriate data, as this feature changes the
contents of the target.
Related Topics
• Selecting Source Data Using the Comparison List Common Tasks, page
1747
• Selecting Source Data Using the Comparison List: Overview, page 1746
Related Topics
• Working with Log Files, page 1719
After selecting the source data, you match the source and the target <units>. You
need to do this because the source and target domains may differ in the domain
hierarchy. For example, there may be more <units> in the selected source area than
in the target area.
The next stage is to select the data to be merged. There are two ways you can select
the data to be merged:
• Transfer all the data of selected modules or sub-modules using the module
list feature. When you select this option, the software transfers the entire
data for the selected item types.
• Transfer only the data that you select using the comparison list feature.
With this option, you can generate comparison reports which help you to
identify exactly which data needs to be merged. We recommend that you
save the comparison reports as .psr files. The advantage of having the
comparison reports in the .psr format is that you can re-use them in other
Merger Utility sessions if needed. There are, however, some limitations:
• .psr files reflect the situation at the time they were created. If the data
has changed during the time between the report creation and its
restoration, you cannot be certain that the data contained in the report
is up- to-date.
• Restore only supporting tables and reports for main item types (loops,
tags, cables, panels, and so forth). Do not select composite tables such
as tag and block relations.
Note
• If you want to delete data that is present in the target but not in the source,
you can do so only through the comparison list option.
You can manipulate, view, and print a .psr file from both InfoMaker and SmartPlant
Instrumentation. SmartPlant Instrumentation provides the best interface to deal with
the .psr files, as there are built-in features to filter, sort and column selection. If you
edit a .psr file outside SmartPlant Instrumentation, the hidden columns become
visible. This is a technical limitation that you should be aware of.
If you intend to merge data based on saved .psr files, do not save any changes made
through InfoMaker (you can make changes temporarily in order to adjust the layout
of the printed document, but do not save it).
Generate and save the comparison reports as .psr files. If there is a lot of data in the
source and target databases, consider doing this on a per <unit> basis for the basic
engineering. In this case, save the comparison reports in different folders.
If you use InfoMaker, set it so it does not retrieve the data from the database when the
document is opened. To do this, do the following:
1. Open the .psr file in InfoMaker in design mode.
2. Click Design > Options.
3. Clear the Retrieve on Preview option.
4. Make sure that the Retain Data to Design option is selected.
In order not to run out of resources during the different comparisons, run this process
in different sessions as recommended.
To improve performance, make sure that the Build table list for merging data check
box in the Compare Source-Target Data window is cleared (there is no need to
build a table list for merging if you do not intend to use it at that time).
The next stage is to set the Merger Utility settings which include the general options,
setting the date from which to start merging the data, and selecting the tag custom
field data to be merged.
When you start to merge data, you can monitor the transfer process in the Merger
Progress window.
Related Topics
• Merger Session: Common Tasks, page 1727
Related Topics
• Merging Data: An Overview, page 1725
Related Topics
• Merger Session: Common Tasks, page 1727
Related Topics
• Merger Session: Common Tasks, page 1727
Related Topics
• Merger Session: Common Tasks, page 1727
Related Topics
• Merger Session: Common Tasks, page 1727
Related Topics
• Selecting the Source Domain: An Overview, page 1729
Related Topics
• Selecting and Matching Source Domains: Common Tasks, page 1730
Related Topics
• Selecting and Matching Source Domains: Common Tasks, page 1730
Related Topics
• Selecting and Matching Source Domains: Common Tasks, page 1730
Tip
• If you need to merge the entire plant data; that is, matching all the
source and target <units>, you should consider merging the data in
several separate sessions. Merging the entire plant data in one session
may take a long time because it increases the time required to generate
the comparison reports. Also, a single merge session requires more
client and server computer resources.
Related Topics
• Selecting and Matching Source Domains: Common Tasks, page 1730
• When you drag the source name, the software displays the number of
the source segment in the Source Segment column instead of copying
the full string. You can add a substring and include fixed text in the
source segment name. For example: #2 (1,3) + 'DD'. This means that
the name of the second segment in the source is used. The segment
itself consists of the first three characters of the source segment name,
and has suffix DD without the quotes.
Note
• After matching naming conventions, it is recommended that you run the
comparison list to view loop and tag names before merging the data.
For example, you can select the entire Instrument Index module or you can double
click the Instrument Index module icon to expand it and select the required
module data (for example, Line, Equipment, and so forth). You can also expand any
Instrument Index module data, such as supporting tables.
Note
• You cannot proceed with the merge process until you select the source
module and/or module data. The data window in the Select Items dialog
box does not contain module data with the caption Tags. This is because
the source tags are automatically selected when you select the Instrument
Index module. Therefore, to merge the source tags, select the source
Instrument Index module without expanding it.
For more information, see Select the Source Modules and Module Data, page 1739.
You open the Advanced Selection dialog box by clicking Advanced in the Select
Items dialog box.
• Filter: Select the criteria that are used to filter the displayed tables.
• Sort: Select whether to sort the tables by name or by merge order.
• (Table data): Select the required source table to transfer to the target
domain. You can also type additional data to append to the target domain
during the transfer process.
Note
• If you resume a previous merge session, you see in the Advanced
Selection dialog box the source tables which were selected in that merge
session.
Now you can:
• Source columns
• Operators or functions
• Alphanumeric values
For more information, see Specify an Insertion Condition, page 1741.
Note
• Filtering and sorting the source data in this dialog box does not affect the
results of the merge process.
For more information, see Filter And Sort the Displayed Source Table List, page
1744.
Tip
• Using the Select all check box to select items is not the same as
selecting all the items in the data window. If you select the Select all
check box, the software selects all plant items and all configuration
data items (excluding User Group and Access Rights), regardless of
which items appear in the data window.
7. To make a more precise selection of the source data by selecting the required
source table (applies only if you selected All plant items), do the following:
a. Click Advanced.
b. On the Advanced Selection dialog box, select the source table to be merged
to the target domain.
8. Click OK to save the Merger Utility settings.
9. When prompted, click Yes to confirm your selection of the source data.
Related Topics
• Merging Browser Views, page 1745
• Select the Source Tables to Be Merged, page 1740
• Start the Transfer Process, page 1761
Tip
• To locate a table by name, click Search and type the table name in the
text box.
2. Select the check box in the Insert Only column if you want to specify an
insertion condition for the selected table — any updated data in the table does
not get merged in this case.
3. To merge the reference tables of any selected source table, click Reference
Tables.
Note
• All the reference tables associated with the selected source table are
automatically selected for merging.
Related Topics
• Filter And Sort the Displayed Source Table List, page 1744
• Select the Source Modules and Module Data, page 1739
• Specify an Insertion Condition, page 1741
• Start the Transfer Process, page 1761
Tips
• Use the horizontal scroll bar to display the pertinent section of the
dialog box.
•Selecting the check box under the Insert Only column causes the
Merger Utility to insert any source rows (of the selected source table)
which comply with the condition specified in the adjacent Condition
column.
2. Under the Condition column, type the appropriate insertion condition.
Caution
• Make sure you type the appropriate condition, as this will affect the
merge process results.
The Merger Utility provides you with the following inherent operators and functions.
Tip
• The above operators and functions are those used in the WHERE string of
the SQL statement.
You can also use special functions which are native to the source database.
The following table describes some of the most common functions. The source
databases which provide each function are specified beneath the function name (in
italics) in the Function column. The function output is described in the Example
column.
Note
• When a table is defined on a specified level, it contains data which is
unique on that specified level. For example, the CABLE Table is defined
per area. Therefore, the CABLE Table contains data which is unique only
on the area level of the domain.
• Select Per domain to display only tables that relate to the domain
level.
• Select Per plant to display only tables that relate to the plant level.
• Select Per area check box to display only tables that relate to the area
level.
• Select the Per unit check box to display only tables that relate to the
unit level.
Related Topics
• Select the Source Tables to Be Merged, page 1740
• Specify an Insertion Condition, page 1741
Related Topics
• Merging Data: An Overview, page 1725
• Select the Source Modules and Module Data, page 1739
After running the comparison list, you should examine the comparison results
carefully and select the desired data transfer mode and transfer parameters. For
example, you can determine whether you want to delete target data that does not exist
in the source or whether you want to delete all the tags associated with a deleted loop,
and so forth. You can also access specific comparison data, such as Specs, Process
Data, Cross Wiring, Signals, and so forth, depending on the item type you selected to
compare. Furthermore, you can customize the comparison list data display by
filtering and/or sorting the data according to your needs.
Related Topics
• Selecting Source Data Using the Comparison List Common Tasks, page
1747
For more information, see Define a Comparison List Style, page 1751.
For more information, see Compare Source And Target Data, page 1752.
For more information, see Compare Data Using Group Mode, page 1753.
For more information, see Check for Duplicate Items, page 1756.
For more information, see Restore a Saved PSR File, page 1757.
For more information, see Run the Comparison List by Making an Individual Item
Type Selection, page 1757.
For more information, see Filter the Comparison List Data, page 1759.
For more information, see Display Specific Data Columns in the Comparison List,
page 1759.
For more information, see Sort the Comparison List Data, page 1759.
For more information, see Display the Comparison List for a Child Item Type, page
1760.
For more information, see Start the Transfer Process, page 1761.
Related Topics
• Selecting Source Data Using the Comparison List: Overview, page 1746
c. Under Complementary data, beside each item, select the Select check box to
merge complementary data (specifications, process data, hook-ups, loop
module data, calibration data, custom field data, and other items).
Related Topics
• Selecting Source Data Using the Comparison List Common Tasks, page
1747
• Selecting Source Data Using the Comparison List: Overview, page 1746
10. Click Actions > Save to save the style for the selected item type.
11. Click Actions > Close to return to the Compare Source- Target Data window.
Related Topics
• Selecting Source Data Using the Comparison List Common Tasks, page
1747
• Selecting Source Data Using the Comparison List: Overview, page 1746
Related Topics
• Selecting Source Data Using the Comparison List Common Tasks, page
1747
• Selecting Source Data Using the Comparison List: Overview, page 1746
• All– This option selects all the existing item types (for example,
instrument, loop, panel, cable, and so forth) This option is
recommended to get all the wiring and connection changes.
• Deleted– This option selects the item types that appear in the target
domain only.
• Inserted– This option selects the item types that appear in the source
domain only.
• Updated– This option selects the item types that exist both in the
source and target and need to be updated.
• Saved previously– This option includes previously saved comparison
data.
Tip
• It is recommended that you select the Deleted, Inserted, and Updated
options.
7. Under Additional options, select the required types of comparison reports to be
generated based on the selections you made under Select data:
• 1 Side– This report is for cables and panels. It reports the wire and
terminal connections.
• Cable levels – Generate two additional reports for cables: cable sets
and wires of the cable (not mandatory if 1 Side is selected.)
• Panel level – Generate two additional reports for panels: panel,
strips, and sets and wires of the cable (not mandatory if 1 Side is
selected.)
• Jumper– This report identifies the jumpers by listing the two
terminals that the jumpers are connected to.
• Cross Wire– This report identifies the crossed wires by listing the
two terminals/strips and panel names that the crossed wires are
connected to.
• 2 Sides– This report lists the connections on both sides of a terminal
strip. Note that this report and the relevant comparison list data cannot
be used to select connections: it is for your information only.
• Signal– This report lists the connections for the selected tag numbers.
Note that this report and the relevant comparison list data cannot be
used to select connections – it is for your information only.
• Specs– This report lists the differences in specifications. This is a
generic report that displays the changed data only. You cannot select
single attributes for an update.
• Process Data– This report lists the differences in process data. This
is a generic report that displays the changed data only. You cannot
select single attributes for an update.
• For all data – Generate comprehensive comparison reports for
selected item types under Additional options (recommended).
• For selected data – Generate comparison reports based on your
selections under Select data for the item types selected under
Additional options.
8. Click to specify the path and format of the file in which you will save the
comparison data. Several file formats are available, for example, .psr, .dbf, .xls.
After you make your selection, the Group Mode Parameters dialog box displays
the information in the Save data in section.
Caution
• Make sure that you select the .psr format so that you can use the report
in the merge process.
9. Click OK to accept your selections and to return to the Compare Source-Target
Data window.
10. Make your selections in the data window by clicking the desired item type. The
icon beside the selected item type changes to . The software automatically
selects all the child item types belonging to a selected item type. You can select
or deselect individual child item types if required as follows:
a. Double-click an item type to expand it. (Certain child item types may contain
other child item types.)
b. Click the desired item type to select or deselect it. The icon beside selected
item types changes to . If a check mark appears beside an item type, it
means that the item type has already been used in a previous run of the
comparison list.
Caution
• To ensure correct merging of specification data, make sure that you
select all the tag numbers associated with multi-tag specifications,
especially the master tag number. If you do not do so, the
specification information will not be updated.
11. Click Actions > Build Item List if you want make additional source selections in
the module list after running the comparison list. Note that selecting this option
will slow down the merge process. Do not select this option if you do not intend
to use the module list feature.
12. Do one of the following:
• On the menu bar, click Actions > Compare Data.
• On the toolbar, click .
Note
• The comparison procedure may take some time depending on the size of
the database tables. At the end of the comparison procedure, you can view
the comparison reports by opening the appropriate .psr files.
Related Topics
• Selecting Source Data Using the Comparison List Common Tasks, page
1747
• Selecting Source Data Using the Comparison List: Overview, page 1746
• Select the Select all check box to include all of the items or clear the
check box to include none of the items.
Tip
• Selecting or clearing Select all affects the displayed items only.
Related Topics
• Selecting Source Data Using the Comparison List Common Tasks, page
1747
• Selecting Source Data Using the Comparison List: Overview, page 1746
Related Topics
• Open a Merger Session, page 1728
• Selecting Source Data Using the Comparison List Common Tasks, page
1747
• Selecting Source Data Using the Comparison List: Overview, page 1746
1. In the Compare Source-Target Data window, expand the items in the tree so
that you can highlight the individual item type for which you want to run a
comparison list.
2. To start running the comparison list and, at the end of this process, open the
Merger Comparison List dialog box, do one of the following:
• Click Actions > Compare Data.
• On the toolbar, click .
• Right-click the item type, and on the shortcut menu, click Compare
Data.
• Double-click the selected item type.
3. If available, select an option on the Reports menu to display the Connection,
Process Data, and Specifications comparison data to facilitate the selection of
rows to be merged.
Tip
• Some of these options are disabled if they are not relevant for the item
type you selected in the Compare Source-Target Data window.
4. To customize the displayed data in the comparison list, on the Actions menu,
point to Display Records and click one of the following options:
• All Records— Displays all the available records.
• Selected— Displays only those records selected for merging
• Modified— Displays modified records only, where the source and
target data differs.
5. Do one of the following:
• Under the Select column, click the check box for each row you want to
select to be merged.
• Make a batch selection by right-clicking in the window, pointing to
Select Records and clicking one of the commands: All, Updated,
Inserted, or Deleted to specify the rows to include in the merge
process.
6. Click Actions > Save.
Related Topics
• Selecting Source Data Using the Comparison List Common Tasks, page
1747
• Selecting Source Data Using the Comparison List: Overview, page 1746
Related Topics
• Selecting Source Data Using the Comparison List Common Tasks, page
1747
• Selecting Source Data Using the Comparison List: Overview, page 1746
2. Under Column list, drag the required columns to be used for sorting to Sorted
columns. The data will be sorted according to the columns that appear under
Sorted columns in the order that they appear.
3. To remove a column to be used for sorting, drag it from Sorted columns to
Column list.
Tip
• To change the sort order, drag all the columns to Column list, and
then drag them in the required order under Sorted columns.
4. Click OK to accept your selections and return to the comparison list.
Related Topics
• Selecting Source Data Using the Comparison List Common Tasks, page
1747
• Selecting Source Data Using the Comparison List: Overview, page 1746
Related Topics
• Selecting Source Data Using the Comparison List Common Tasks, page
1747
• Selecting Source Data Using the Comparison List: Overview, page 1746
3. Do one of the following to determine how fast the software merges data:
• Leave the contents of the fields unchanged (the default values are:
1000 rows in the Source rows to retrieve data field, and 500 rows in
the Target rows to commit data field).
• Type a larger number of rows than the current default values. This
way you speed up the merge process.
• Type a smaller number of rows than the current default values. This
way you free memory resources but it may slow down the merge
process.
Tip
• Make sure you do not exceed your memory capacity as this may cause
the merge process to fail during the data transfer.
4. To see the effect of the new settings, continue with the merge process.
Related Topics
• Merging Data: An Overview, page 1725
• Selecting Source Data Using the Comparison List Common Tasks, page
1747
• Selecting Source Data Using the Comparison List: Overview, page 1746
Note
• You can reduce the amount of data to be merged by selecting fewer item
types, depending on the comparison information you require.
Related Topics
• Selecting Source Data Using the Comparison List Common Tasks, page
1747
• Selecting Source Data Using the Comparison List: Overview, page 1746
In the second row, the highlighted changes were made in the target table. In the
source table, these fields do not contain data.
In the third row, the target table does not contain an entry while the source table does.
That is why there are two rows. Sometimes the field is too short to display the entire
record, which causes the text to auto- scroll. Note that this can also make the field
appear as two rows. You can then stretch the column to make it longer.
To analyze the data, you need to print out the reports and mark changes you want to
make on the printouts. In the case of the supporting tables, this is a simple task since
these tables usually include two columns. All of the supporting tables are merged in
one process since they are required for the main item types. Therefore, you do not
need to worry about them so much.
Mark the reports (use color markers if possible), mainly for wiring changes.
Related Topics
• Selecting Source Data Using the Comparison List Common Tasks, page
1747
• Selecting Source Data Using the Comparison List: Overview, page 1746
Important
• Do not change the wiring selection options before starting the actual
merge process. The software processes the selected rows and carries
out the merge process in accordance with the settings.
• When selecting the With connections option in the Wiring Selections
tab folder, records that appear only in the target are marked as deleted
and are selected automatically by the Merger Utility. These selections,
in most cases, will be wrong and you will have to clear the Select the
check box in the appropriate comparison list dialog box, for example,
after clicking the 1 Side button in the Merger Comparison List
window.
• Exercise caution when using the Delete option in Merge Options
dialog box, Comparison Actions tab folder. This option instructs the
Merger Utility to actually carry out delete operations. It is possible
that the software will not delete items that are associated with other
items. Double check the selected records after merging. Delete data
directly in SmartPlant Instrumentation if results are not satisfactory.
In most cases, you do not need to select the Delete option.
• When selecting item types to be merged, especially Wiring and
Instrument Index data, it is important not to select different item types
within the same merge session. This is due to the fact that the Merger
Utility processes your selections differently when it comes to tag
numbers, cables, panels, and connections based on the pre-selected
settings.
• The final selection of tables and item types to be merged is determined
when you click Save to close the Merger Comparison List window.
You can browse the selected records of different item types. Click
Close to close the window without saving your changes.
Related Topics
• Selecting Source Data Using the Comparison List Common Tasks,
page 1747
You can select or deselect records as required. It is important to have all the jumpers
and cross wires existing in the Wiring module for further processing.
Note that when you select a panel using the With connections option, the Merger
Utility automatically selects the jumpers and cross wires.
Related Topics
• Selecting Source Data Using the Comparison List Common Tasks,
page 1747
• Selecting Source Data Using the Comparison List: Overview, page
1746
Caution
• If the source database uses the standard title block assignment method, and
the target uses the special title block assignment method, you are likely to
lose data after merging. In this case, your System Administrator must
change the Custom title block assignment method option in the source
domain from Standard to Special.
Related Topics
• Selecting Source Data Using the Comparison List Common Tasks,
page 1747
Related Topics
• Selecting Source Data Using the Comparison List Common Tasks,
page 1747
For a large quantity of data, it is recommended running the comparison lists again to
verify that all new items were inserted and there are no missing connections or cross
wires.
Index
.bmp files .xls files
adding to spec page, 476 font style of specs, 575
.dxf files global value display precision, 583
report insertion point, 191 Save as Excel overview, 575
saving reports, 191 saving specs, 571
.imp files saving specs in batch mode, 572
exporting links, 1399 setting macro security, 587
importing links, 1399 spec customization common tasks, 576
.ipd files spec customization guidelines, 578
exporting process data, 406 .xml files
importing process data, 404 prerequisites for working with DCS vendors, 1573
.isf files .zip files
importing data to instrument specs, 574 binder package documents, 1309
saving specs in .isf format, 570 binder packages, 1304
.pbl files revisions, 1304
creating libraries in InfoMaker, 615 spec revisions, 566
retrieving in PSR File Viewer, 642 ABB interface, 1571
retrieving reports, 642 associate fieldbus device types, 1595
.pdf files retrieving definitions, 1593
document binder package, 1308 access rights
driver, 601 browser views, 1266
printing documents, 188 maintenance event records, 722
printing specs into .pdf files, 601 accessing
.psr files Web Client, 1636
adding drop-down data windows, 624 active item library
adding select lists, 625 assigning to more than one plant, 1166
calibration form customization, 620 defining, 1166
correcting grid line divergence, 582 add_spec9 table, 466
correcting line discontinuity, 582 add-ins
creating invisible vertical line, 581 importing system interfaces, 1539
custom fields, 644 AdjustAutoCADBlocks.exe, 1201
customizing for Save as Excel, 579 ampersand character in specs, 483
dimensional data forms, 1321 amplifiers
form page customization common tasks, 621 adding amplifier channels, 1047
InfoMaker libraries, 616 adding connectors, 1046, 1050
opening as spec page, 462 creating, 1045
opening from .psr list, 642 analyzers
opening in InfoMaker, 623 analyzer stream specs, 526
opening in InfoMaker from libraries, 617 complex analyzer specs, 512
replacing double lines, 581 defining complex analyzers, 394
restoring for merger session, 1757 linking stream and line components, 395
retrieving custom spec pages, 469 overview, 391
revisions, 1304 API 2540 standard
saving spec pages, 465 liquid density calculation, 401
saving specs in .psr format, 570 apparatus
spec customization for Excel common tasks, 576 add an apparatus to a group, 809
spec revisions, 566 apparatus group, 808
specprn.psr, 595 common tasks, 805
value display precision for Excel, 583 configuring, 806
.wmf editing terminal properties, 810
saving spec pages, 465 fieldbus apparatus configuration, 982