Spi General

8/3/2019 Spi General

1/62

General Features

140 SmartPlant Instrumentation Users Guide

SmartPlant Instrumentation provides you with several options to find the tag and loopnumbers that you require to work with.

You can look for your tag and loop numbers in the SmartPlant InstrumentationExplorer or you can use the search facilities provided in the pertinent modules. Formore information, seeSearch for Items in SmartPlant Instrumentation Explorer, page242.

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 searchparameters that you specified. If you do not specify any search parameters, thesoftware finds all the existing tag or loop numbers in the current . In theProcess Data and Calibrations modules, you can search for tag numbers either in thecurrent , or in all the of the current . You can also look fortypical tags created in the current domain.

You search for tag numbers in the Find Tag dialog box. There are many cases wherethe software opens theFind Tag dialog box. You can look for tag numbers afterclicking 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, ordeleting 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 theFind Loop dialog box whenever you need to search for a loop number. There aremany cases where theFind Loop dialog box opens: cl icking Find in a dialog boxthat prompts you to enter a loop number opens the Find Loop dialog box. Forexample, you can click Find when you want to edit or duplicate one or more loopnumbers in the Instrument Index module.

Related TopicsSearch for Items in SmartPlant Instrumentation Explorer, page 242Searching for Tag and Loop Numbers Common Tasks, page 141


2/62

General Features

The following tasks are used frequently when searching for tag or loop numbers:

Search for All Tag Numbers

This topic explains how to find all the existing tag numbers in the current . Inthe Calibration and Process Data modules, you can search for tag numbers in all the of the current . In the Process Data module, you can find tagnumbers in all units when searching for tag numbers to generate instrument reports.For more information, seeSearch for All Tag Numbers, page 142.

Search for Typical Tags

This help topic explains how to find all the existing typical tag numbers in the currentdomain. For more information, seeSearch for Typical Tags, page 145.

Use Search Parameters to Find Tag Numbers

This help topic explains how to f ind tag numbers by entering search parameters.

Entering search parameters in theFind Tag dialog box enables you to narrow downyour search. You can narrow your search to the maximum by entering all the searchparameters. It is up to you what search parameters to specify. You can use wildcards

in the fields where you type values.

Leaving some of theSearch parameter fields empty widens the search. If you donot 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 yoursearch parameters in theSearch results data window.

For more information, seeUse Search Parameters to Find Tag Numbers, page 143.

Search for All Loop Numbers

This topic explains how to find all the existing loop numbers in the current .For more information, seeSearch for All Loop Numbers, page 146.

SmartPlant Instrumentation Users Guide 141


3/62

General Features


Use Search Parameters to Find Loop Numbers

This help topic explains how to find loop numbers by entering search parameters.

Entering search parameters in theFind Loop dialog box enables you to narrow downyour search. You can narrow your search to the maximum by entering all the searchparameters. Leaving some of theSearch parameter fields empty widens the search.It is up to you which search parameters to specify. If you do not specify any searchparameters, the software finds all the existing tag numbers in the current .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 aredisplayed in the Results data window.

For more information, seeUse Search Parameters to Find Loop Numbers, page 146.

Search for Typical Loops

This help topic explains how to find all the existing typical loops in the current unit.For more information, seeSearch for Typical Loops, page 148.

Related TopicsSearching for Tag and Loop Numbers: An Overview, page 140

1. In theFind Tag dialog box, do not enter any other values in the Search

parameter fields.

Tip

In the Calibration or Process Data module, select Look in the entirecurrent plant if you want to find tags in all the of the current.

2. Cl ick Find.

Tip

Select the Show more search results check box to hide the search

parameter f ields and enlarge the Search results data window todisplay more tag rows. Clear this check box to return to normal view.

3. Select the required tag numbers in theSearch results data window and click OK.

Related TopicsSearching for Tag and Loop Numbers Common Tasks, page 141Searching for Tag and Loop Numbers: An Overview, page 140


4/62

General Features


NoteTo specify search parameters in the Calibration module, you need toperform a separate procedure. For details, seeSearching for TagNumbers in the Calibration Module page 665.

1. In theFind Tag dialog box, from the Tag class l ist, select the desired tag class.

Tip

A conventional tag is an instrument that does not belong to theFieldbus, Telecom, Typical, or Electrical classes.

2. Use the following fields and lists in the Search parameters group box for search

parameters that narrow your search:SearchParameter

Explanation Example

TagNumber

Type the whole tag number you are looking for.Include any prefix, suffix, and separatorcharacters. You can use wildcards if needed.

101-FT 2225/1

Or use a wildcard:101-FT%

Processfunction

Select a process function to narrow your searchto tags belonging to the selected processfunction.. (This parameter is available in the

Instrument Index and Process Data modulesonly.)

FlowPressure

Instrumenttype

Select an instrument type to narrow your searchto tags belonging to the selected instrumenttype.

D/P Type FlowElement (FE), MassFlow Transmitter(FT)

Status Select a tag status to narrow your search to tagsassociated wi th the selected status.

An existing device,a new instrument, arelocated device

Location Select a tag location, for example, Field, to

narrow your search to tags for which you havedefined this location.

Equipment room,

junction box

I/O type Select a I/O type to narrow your search to tagsfor which you have defined this I/O type.

AO (analog output)DI (Digital input)

Prefix Type the tag number prefix to find all the tagnumbers that have this prefix in their names. Donot include the separator characters. The number segment in the tag number name isusually the tag number prefix. You can also usewildcards if needed.

101


5/62

General Features


Search

Parameter

Explanation Example

Number Type the numeric segment of a tag number tofind all the tag numbers that have this numericsegment. You can also use wildcards if needed.

2315

Suffix Type the suffix segment of the tag number tofind all the tags that contain this suff ix. Do nottype the slash ( / ) character. You can also usewildcards if needed.

1 ( the numberfollowing the slash (

/ ) in tag number101-FT 2225/1)

Equipment Select equipment to narrow your search to tagsfor which you have defined this equipment.

Line Select a line to narrow your search to tags wi th

which you have associated this line. (Thisparameter is not available in the Process Dataand Specifications modules.)

Formnumber

Select a specification form number to narrowyour search to tags for which you have definedthis form number. (This parameter is availablein the Specifications module only.)

Date range Type dates or use spinners to narrow yoursearch to a given date range. (This parameter isavailable in the Specifications module only.)

3. To broaden the search to include all of the in a given , selectLook in the entire .

Tip

This field is available in the Calibration module, and in the course ofvarious procedures in the Process Data and Specifications modules.

4. Cl ick Find.

Tip

Select the Show more search results check box to hide the search

parameter f ields and enlarge the Search results data window todisplay more tag rows. Clear this check box to return to normal view.


6/62

General Features


5. In theSearch results data window, do one of the following:

Select the desired tag number.

Press and hold down Ctrl to select multiple tag numbers.Multi-selection is available in the Calculation module when you selecttags for batch calculation, in the Process Data module for instrumentreport generation, and in the Specifications module. You can alsoselect the Select all check box to select all the displayed tag numbers.

6. Cl ick OK.


Note

It is possible to search for typical tags only in the Instrument Indexmodule.

1. When editing, deleting, dupli cating or moving tags in the Instrument Indexmodule, in theEnter Tag Number dialog box, click Find.

2. In theFind Tag dialog box, select Typical tag from theTag class list.

3. Do not enter any other values in theSearch parameter fields.

4. Cl ick Find.

Tip

Select the Show more search results check box to hide the searchparameter f ields and enlarge the Search results data window todisplay more tag rows. Clear this check box to return to normal view.

5. Select the desired tag numbers in theSearch results data window and click OK.

Related TopicsSearching for Tag and Loop Numbers Common Tasks, page 141

Searching for Tag and Loop Numbers: An Overview, page 140


7/62

General Features


1. In theFind Loop dialog box, do not enter any other values in the Search

parameter fields.

2. Cl ick Find.

Tip

Select the Display more results check box to enlarge the Searchresults data window and display more rows. Clear this check box toreturn to normal view.

3. Select the required loop numbers in theSearch results data window and clickOK.


1. Use the fields and lists in theSearch parameters group box to enter your search

parameters to narrow your search. The following search parameters are available:

Search

Parameter

Explanation Example

Loop name Type the whole loop number you are lookingfor. Include any prefix, suffix, and separatorcharacters. You can use wi ldcards if needed.The Search Results data window will displaythis loop number if it exists.

101F -2225\A

101F-%

Loopnumber

Type the numeric segment of the loop number tofind all the loop numbers that have this numericsegment. You can also use wildcards if needed.

2225

Loop prefix Type the loop number prefix to find all the loopnumbers that have this prefi x. Do not include

the separator characters. The numbersegment in the loop number name is usually the

loop number prefix. You can also use wildcards

if needed.

101

Loop suffix Type the suffix segment of the loop number tofind all the loops that have this suff ix. You canalso use wildcards if needed.

A

Measuredvariable

This search parameter is used to f ind all theexisting loop numbers that have the measuredvariable that you select from this list.

Density (D)

Pressure (DP)


8/62

General Features


Search

Parameter

Explanation Example

Loop type This search parameter is used to find all theexisting loop numbers that have the loop typethat you select from this list.

Electrical Loop(Electrical),

Open Loop (Open)

Loopfunction

This search parameter is used to f ind all theexisting loop numbers that have the loopfunction that you select from this list.

Indication andAlarm (IA),

Control (C)

Generationtype

This search parameter is used to f ind all theexisting loop numbers that used a specific typeof loop drawing generation.

CAD (a loopdrawing generatedby an external CAD

engine)

Manual (a loopdrawing generatedby using the manualmethod

2. If required, select theFieldbus check box to narrow your search to the loopnumbers that contain tags with a fieldbus I/O type.

3. Cl ick Find.

4. Select one or more loop numbers in theSearch results data window.

Tips

The Select all option is not available when duplicating an existingloop number.

Select the Show more search results check box to hide the searchparameter f ields and enlarge the Search results data window todisplay more loop rows. Clear this check box to return to normalview.

5. Cl ick OK.



9/62

General Features


You perform the search in the Instrument Index module.

Using the Typical Loop Management dialog box:

1. Cl ick Edit > Typical Loop Management.

2. In theFind typical loop field, type the name of the typical loop you want to f ind.As you type the software highlights the typical loop names in the data window.

Using the Batch Loop Creation dialog box:

1. Cl ick Edit > Batch Loop Creation.

2. Cl ick Find.

3. In theFind Typical Loop dialog box, do one of the following:

Enter the required search parameters, and click Find.

Click Find, and from the Search results data window, select therequired typical loop.



10/62

Supporting Tables

Supporting tables are dialog boxes that allow you to manage the contents of selectlists in SmartPlant Instrumentation. For example, when creating or editing apanel,the values that you select from the lists are held in the relevant supporting tables.

To access a supporting table, click next to the list arrow in the relevant dialog box,or when in theWiring Module or Instrument Index Module window, click Tablesand then the relevant menu command.

Note that in a multi-user installation, SmartPlant Instrumentation allows only one userat a time to edit a given supporting table record.

For a detailed list and description of all the supporting tables in the SmartPlantInstrumentation, seeSupporting Tables in SmartPlant Instrumentation, page 151.

For details about the various activities that you can perform with the supportingtables, seeSupporting Tables Common Tasks, page 150.



11/62

Supporting Tables


The following tasks are used frequently when managing supporting tables.

Add a New Value to a Select List

This option shows you how to add a new value to a select l ist. All values are storedin the supporting tables that you can access from various windows and dialog boxes.You can access a supporting table from a menu by selecting the appropriate item from

theTables menu or by clicking in a dialog box. For more information, seeAdd aNew Value to a Select List, page 159.

Manage a Custom Table

This option shows you how to usecustom tables, as defined by theDomainAdministrator, to contain supporting data for instruments. After you enter your datain aCustom Table dialog box, you can use this data as additional tag attributes whensetting a profile in the Instrument Type Profile dialog box, and when editing tagnumber properties in the Tag Number Properties dialog box. For more information,seeManage a Custom Table, page 160.

Customize Manufacturer-Specific Field Headers

Some field headers on the Distributed Control System (DCS) dialog box,Programmable Logic Controller (PLC) dialog box, I/O Card Properties dialogbox, and some appropriate reports use manufacturer-specific terminology. Therefore,

these dialog boxes display field headers according to the panel manufacturer youselect from theManufacturer l ist when editing panel properties. The procedureoutlines how to customize these field headers according to manufacturer-specificterminology. For more information, seeCustomize Manufacturer-Specific FieldHeaders, page 160.

Related TopicsSupporting Tables in SmartPlant Instrumentation, page 151Supporting Tables: An Overview, page 149


12/62

Supporting Tables

The following table lists all the available supporting tables and the description of theirfunctions. You can access these supporting tables by clicking next to a list arrowor by clicking an appropriate command on the Tables menu in the Instrument Indexand Wiring modules.

Supporting

Table

Description

Allows you to define a sub-category for the General processfunction in the Instrument Types dialog box.

General ProcessFunction Sub-Categories

Allows you to maintain the contents of the Status select list on

the Tag Number Properties dialog box.

Instrument

Statuses

Allows you to maintain the contents of theSystem I/O type liston theTag Number Properties dialog box.

I/O Types

InstrumentLocations

Allows you to specify general or specif ic instrument locationswithin the .

Equipment Allows you to categorize the equipment that your instruments areinstalled on. Equipment is also categorized according to differenttypes, for example, you can specify the equipment type as:pumps, compressors, burners, silos, and so forth.

Allows you to add new equipment types to the Equipment typeselect list in the Equipment dialog box. You can categorize theequipment that your instruments are installed on according todifferent types, such as pumps, compressors, burners, silos, andso forth.

Equipment Types

P&ID DrawingReferences

Allows you to store P&ID drawing references used for makingassociations with tag numbers in the Instrument Index and LoopDrawings modules.

Lines Allows you to categorize and modify line data in your .This dialog box also enables you to access the Line Propertiesdialog box where you can create a new line or edit the properties

of an existing line.Line Types Allows you to create, view, edit, and delete line types.

InstrumentCriticality

Allows you to customize instrument criticality data. Then, youcan define criticality for a particular tag in the AssociateCategories and Criticality dialog box that you access from anInstrument Index Standard Browser view.

InstrumentCertification

This supporting table holds certification information forinstruments that are certified for hazardous environment.



13/62

Supporting Tables

Supporting

Table

Description

InstrumentManufacturers

Allows you to control the content of the Manufacturer l ists inthe Tag Number Properties andFind Tag dialog boxes as wellas the Manufacturer column in an Instrument Index StandardBrowser view.

The URL feature on the Instrument Manufacturer dialog boxallows you to enter a desired URL that can be double-clicked toautomatically launch the Internet Explorer and go to the pertinentWeb site if you are connected to the Internet.

InstrumentModels

Allows you to store instrument model data in the current domain.All instrument models are categorized by instrument

manufacturer.Function Blocks Allows you to add new user-defined function blocks to your

instrument index, delete the redundant ones, or modify thedefinition of existing user-defined function blocks.

Intrinsically SafeCircuit Types

Allows you to create and manage intrinsically safe circuit typeswhich you can associate with tag numbers while editing tagnumber properties. The intrinsically safe circuit types that areheld in this supporting table then become available in the Wiringmodule where you can carry out the intrinsic safety calculation.

Loop Measured

Variables

Allows you to enter or modify the loop process variable identifier

which is used in the loop naming conventions. The loop processvariable identifier is the first letter in the loop name that comesafter the loop prefix.

Loop Types Allows you to maintain the contents of the Loop type select liston the Loop Number Properties, Typical Loop Properties, andFind Loop dialog boxes.

Loop Functions Allows you to enter or modify the loop function identifier whichis used in loop naming conventions. The loop function identifieris used to identify the succeeding letters that follow the loopmeasured variable identi fier in the loop name.

AssociatedElectricalEquipment

Allows you to view equipment tags that are associated withsignals that are defined in SmartPlant Electrical and theequipment type to which each signal belongs.

AssociatedElectricalEquipment Types

This supporting table holds all the available associated electricalequipment types to which SmartPlant Electrical signals canbelong.

Circuits This supporting table holds circuit values that appear in theCircuit l ist on theElectrical tab of the Tag Number Propertiesdialog box.



14/62

Supporting Tables

Supporting

Table

Description

Rated Voltage This supporting table holds rated voltage values that you can usein the Rated voltage list on thePower Supply tab of the TagNumber Properties dialog box.

Frequency This supporting table holds frequency values that you can use inthe Frequency l ist on the Power Supply tab of the Tag NumberProperties dialog box.

Number ofPhases

This supporting table holds number of phases values that you canuse in the Number of phases l ist on thePower Supply tab of theTag Number Properties dialog box.

Operating Modes This supporting table holds operating mode values that you can

use in the Operating mode list on thePower Supply tab of theTag Number Properties dialog box and the properties dialogboxes of panels that support power supply. SmartPlantInstrumentation provides you with pre-defined operating modes(Continuous, Intermittent, Spare, and Standby), which are theonly values that are recognized by SmartPlant Electrical. Youcannot delete or modify these values.

Signal Types This supporting table holds signal type values that are used todefine HART instrument properties. To fill this table, you need todownload DeltaV definitions.

Lineari ty Types This supporting table holds lineari ty type values that are used todefine HART instrument properties. To fill this table, you need todownload DeltaV definitions.

Allows you to maintain the contents of thePanel type list whenediting the properties of a panel.

Panel Types

Allows you to customize the options on the Manufacturer list onthe Properties dialog boxes listed below. The URL field on thePanel Manufacturer dialog box allows you to enter a desiredURL. You can then double-click this URL to automatically startthe Internet Explorer and go to the pertinent Web site if you areconnected to the Internet. This supporting table also allows you

to define field headers that use manufacturer-specificterminology.

PanelManufacturers

Allows you to manage the contents of the Model list whencreating or editing a panel. SmartPlant Instrumentation classifiespanel models according to manufacturer. You can find the dataused in the other columns in the manufacturer's catalog. Notethat selecting a different model does not change any other data.

Panel Models

Allows you to manage the data contained in the Areaclassification list on any of the panel properties dialog boxes.

Panel AreaClassifications



15/62

Supporting Tables

Supporting

Table

Description

Allows you to manage the data contained in the Type l ist on theTerminal Strip Properties dialog box. You can use this dialogbox to categorize a terminal strip where the terminal striprepresents a hardware device or a DCS/PLC I/O termination.

Terminal StripTypes

Allows you to manage the contents of the Manufacturer l ist onthe Terminal Strip Properties dialog box.

Terminal StripManufacturers

Allows you to manage the contents of the Model select list on theTerminal Strip Properties dialog box. SmartPlantInstrumentation classifies terminal strip models according tomanufacturer. You can classify a terminal strip model/MFG forcontrol si/s cards and hardware devices.

Terminal StripModels

Allows you to manage the contents of the Type select list on theTerminal Properties dialog box. Also, you can classify theterminals whenever their type needs to be defined. You canreplace the default graphic image of terminal sides that appear intheConnection window and the appropriate reports.

Terminal Types

Allows you to manage the contents of the Manufacturer selectlist on the Terminal Properties dialog box.

TerminalManufacturers

Allows you to manage the contents of the Model select list on theTerminal Properties dialog box. Terminal models are classifiedaccording to manufacturer.

Terminal Models

Allows you to manage the contents of the Color select list on theTerminal Properties dialog box. You can also select andcustomize the graphical representation of the color names definedin this supporting table. This sets the precise colors for the barconnecting terminals in theConnection and Cross-Wiringwindows.

Terminal Colors

Allows you to manage the contents of the Wiring equipmenttypes select list. Wiring equipment type is one of the propertiesused to define wiring equipment items, such as I/O cards, I/Oterminations, fieldbus bricks, safety barriers, relays, amplifiers,

and so forth.

WiringEquipment Types

Allows you to manage the contents of the Manufacturers selectlist. Wiring equipment manufacturer is one of the properties usedto define wiring equipment items, such as I/O cards, I/Oterminations, fieldbus bricks, safety barriers, relays, amplifiers,and so forth.

WiringEquipmentManufacturers

Allows you to manage the contents of the Models select l ist.Wiring equipment model is one of the properties used to definewiring equipment items, such as I/O cards, I/O terminations,fieldbus bricks, safety barriers, relays, amplifiers, and so forth.

WiringEquipmentModels



16/62

Supporting Tables

Supporting

Table

Description

WiringEquipmentCategory

This supporting table holds wiring equipment category values.The categories that exist in this supporting table are available forselection in the Categories select list of theNew WiringEquipment dialog box. You can add your own categories andthen set their properties as you require. However, you cannotmodify or delete the categories that are supplied to you with thesoftware.

Enables you to manage cable type data that appears on theCableProperties dialog box, Type select list. TheCable Types dialogbox holds all the data that pertains to the cable types in thecurrent . Users can view the data or delete it as needed.

This dialog box provides access to the Cable Type Propertiesdialog box, where you can create a new cable type or edit theproperties of an existing cable type.

Cable Types

Enables you to manage the data in the Cable Manufacturerssupporting table, which contains all the items of theManufacturer select list on the Cable Properties dialog box.

CableManufacturers

Cable Models Allows you to manage the data in the Cable Models supportingtable, which contains all the items of the Model select list on theCable Properties dialog box. SmartPlant Instrumentationclassifies cable models according to manufacturer.

Allows you to manage the contents of the Color select list on theCable Properties dialog box.

Cable Colors

Enables you to manage the data in the Cable Glands supportingtable, which contains all the items of the End 1 and End 2 selectlists in the Glands group box of the Cable Properties dialogbox. This way, you can assign cable glands to selected cabletypes. Once assigned to a cable type, the gland attributesautomatically propagate to all the cables of that type.

Cable Glands

Allows you to define and maintain the contents of the Cableharness select list on the Cable Properties dialog box.

Cable Harnesses

Conductor Cross-Sections

Enables you to manage the conductor cross-section data for thecables in the current . The values that appear in thisdialog box are available in the Cross-section select list on theCable Properties dialog box.

Allows you to manage the contents of the Type list on theWireProperties dialog box.

Wire Types

Allows you to manage the contents of the Color l ist on theWireProperties dialog box.

Wire Colors



17/62

Supporting Tables

Supporting

Table

Description

Connector Types A connector type defines pin configuration and other properties.When you define connectors for a cable, selecting a connectortype copies these properties for the cable connector. Thissupporting table allows you to create and manage the connectortypes required for your plug-and-socket boxes and for cables thatrequire connectors.

Allows you to manage the contents of the Manufacturer selectlist on the Connector Types dialog box.

ConnectorManufacturers

Allows you to manage the contents of the Model select list on theConnector Types dialog box. Connector models are classifiedaccording to the Manufacturer column. The information used inthe other columns can be found in the manufacturer's catalog.

ConnectorModels

Controllers The controller is the processing hardware that controls andsupervises I/O cards. This supporting table allows you to defineand manage your I/O card controllers. You can define newcontrollers, edit the properties of existing controllers, and deletecontrollers.

Allows you to manage the contents of the Channel Type selectlist on the Channels dialog box.

Channel Types

Segment-WideParameterProfiles

Allows you to define default settings that serve as design rules forthe various Fieldbus segments.

Standard Widths Each routing trunk that you define consists of positions. Insteadof defining new positions for each additional trunk, you select thepositions from the list of standard positions. Instead of definingthe width for each standard position that you can add to a trunk,you select it from the standard width list that you set in thissupporting table. You use the widths that you add in thissupporting table to define the positions in a routing trunk. Thewidth that you define here is a standard unit and therefore can beused several times to characterize different positions.

Standard RoutingPositions

Each routing section of type trunk that you define consists ofpositions. (Building sections do not have positions.) Instead ofdefining new positions for each additional trunk, you select thepositions from the list of standard positions that you define in thissupporting table.

MaximumNumber ofCables

The maximum number of cables limits the number of cables thata position can contain. After you have defined widths andcreated positions, you need to set the maximum number of cablesper defined-width position that you want to associate with arouting trunk.



18/62

Supporting Tables


Supporting

Table

Description

Routing Sections Defining routing sections is the last step in creating the cable routing before associating routing wi th cables. The cablerouting sections contain the positions that convey the cablesbetween the instruments. Using this supporting table, you canadd or edit a routing section and select positions to be included ina trunk section. The positions that you can select are those forwhich you have already defined the maximum number of cables.

Cable Drums Allows you to define and manage the cable drums in your. Note that cable drums are categorized according tocable type.

Pulling Areas Allows you to define thepulling areas in your . Thepulling area in the is the area allocated to cables and

the cable drums they are wound on. The purpose of allocating

pulling areas is both to organize the drums in

designated areas and to regularly use the cables from these

areas.

DCS Block Types Allows you to manage the block type data for control systemtags. The values that appear on this dialog box are available inthe Block Type select list on the Control System TagProperties dialog box.

DCS Function

Block I/OTermination

Enables you to manage the DCS function block I/O termination

data for control system tags. The values that appear on thisdialog box are available in the Function block I/O terminationselect list on the Control System Tag Properties dialog box.

Notes

For the various actions that you can perform with supporting tables,see Supporting Tables Common Tasks, page 150.

For the supporting tables used in Telecom, seeSupporting Tables forTelecom, page 158.

Related TopicsSupporting Tables: An Overview, page 149


19/62

Supporting Tables

The following table lists all the available Telecom supporting tables and thedescription of their functions. You can access these supporting tables by clickingnext to a list arrow or by clicking Tables > Telecom and then an appropriatecommand in the Instrument Index and Wiring modules.

Supporting

Table

Description

TelecomDevice Types

Allows you to create and manage telecom device types. You definethe required telecom device type profile for your telecom tag numbersso 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. Youcan add new telecom device types and modify the shipped ones asdesired. 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 youalready used to create a tag number.

Allows you to maintain the contents of theTelecom line list whencreating a telecom field device in thePlug-and-Socket Box wizardand the Line number list on the Tag Number Properties dialog box.

Telecom LineNumbers

TelecomFieldEquipment

Allows you to maintain the contents of the Field equipment select liston theTag Number Properties dialog box.

Allows you to maintain the contents of theSignal level select list onthe Tag Number Properties dialog box.

TelecomSignal Levels

Allows you to maintain the contents of theSub-system select list onthe Equipment Panel Properties dialog box.

Panel Sub-Systems

TelephoneNumbers

Allows you to define new telephone numbers that you can associatewith existing switch channels in PABX cabinets.

Allows you to manage the contents of theTelephone number statusselect list on the Telephone Number Properties dialog box.

TelephoneNumberStatuses

Allows you to manage the contents of theTelephone number usagesselect list on the Telephone Number Properties dialog box.

TelephoneNumberUsages

IntercomNumbers

Allows you to define new intercom numbers that you can laterassociate with amplifiers.

PA Zones Allows you to manage the PA zone definitions which are available forselection on the Category Properties tab of the Wiring EquipmentProperties (Amplifier) dialog box.



20/62

Supporting Tables


Supporting

Table

Description

Alarm Zones Allows you to manage the alarm zone definitions which are availablefor selection on the Category Properties tab of the WiringEquipment Properties (Amplifier) dialog box.

PABXCategories

Allows you to manage the contents of thePABX categories select liston thePABX Cabinet Properties dialog box.

Note

For the various actions that you can perform with supporting tables,see Supporting Tables Common Tasks, page 150.

Related TopicsSupporting Tables: An Overview, page 149

1. Open the appropriate supporting table by clicking in the appropriate dialog box

or by selecting the appropriate menu item on theTables menu.

2. In the appropriate supporting table dialog box, click New.

3. Type the required value in the fields provided, and pressTab to move to the nextfield.

4. Cl ick New to enter another new value, if desired.

5. Cl ick OK to accept the new values and close the dialog box.

Related Topics

Supporting Tables Common Tasks, page 150


21/62

Supporting Tables


1. Do one of the following to open thePanel Manufacturers dialog box:

In the Wiring module, click Tables > Panel > Manufacturers.

Click next to theManufacturer select list on the appropriate dialogbox: Distributed Control System (DCS) Properties, ProgrammableLogic Controller (PLC) Properties, or I/O Card Properties.

2. On the Panel Manufacturers dialog box, click Headers.

3. From theWiring item list, select the item type for which you want to customizethe field headers.

4. Under Custom Field Header, type the text you require next to the appropriatevalue that appears under Field Header in Data Dictionary.

5. Repeat steps 3 and 4 as many times as you require.

6. Cl ick OK.

Related Topics

Supporting Tables Common Tasks, page 150

1. In the Instrument Index Module menu, click Tables > Custom Tables, and then

select the custom table you want to open.

2. To add a new record, click New, and then type a unique name and an optionaldescription.

3. To edit an existing record, click a value that you want to edit, and modify asneeded.

4. To delete a record, select the row that you want to delete, and click Delete.

5. Cl ick OK.

Note

TheDomain Administratorhas rights to create the required custom

tables for each . If the Domain Administrator does not createany custom tables, theCustom Tables menu option is not available.

Related TopicsSupporting Tables Common Tasks, page 150Supporting Tables: An Overview, page 149


22/62

Interface Languages


You can replace the SmartPlant Instrumentation interface language. The SystemAdministratormust first add languages to the database. After adding a language tothe database, you can replace your current language wi th the added one.

The following languages are currently available as add-ins:

Engli sh (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:

Replace the existing interface language with the new interfacelanguage.

Translate interface text phrases.

Notes

Translated text appears in the main SmartPlant Instrumentationinterface, the Administration module, and in the Import and Mergerutilities. The text strings are stored in the In_catalog.db file.

Text in the following software components is not translated:

Initialization and Update interfaces

Rule Manager

Internal Setup

SAP Interface

Fluke Wizard

External Editor

Process Data Editor


23/62

Interface Languages


Text strings for other software components are located in the followingseparate resource files:

Resource File DescriptionMenuLibrary80.dll All user interface text strings for the Domain and Reference

Explorers and Preferences for the Enhanced Report Utility

SmartLoop8.drx Menu labels, ToolTips, and Microhelp for the Enhanced ReportUtility

SymbolEditor8.drx Menu labels, ToolTips, and Microhelp for the Symbol Editor

SmartPlantEN.dll Dialog box labels and error messages for the Enhanced ReportUtility and Symbol Editor

ESLAboutEN.dll Text in theAbout box for the Enhanced Report Utility

SEAboutEN.dll Text in theAbout box for the Symbol Editor

Related TopicsInterface Languages Common Tasks, page 163


24/62

Interface Languages


Replace the Interface Language with a Language from the Database

This procedure explains how to replace the current SmartPlant Instrumentationinterface wi th a language from the database. For more information, seeReplace theInterface Language with a Language from the Database, page 164.

Replace the Interface Language with a Language from an External File

This procedure explains how to replace the interface language wi th a language froman external file. In this mode, all the terms and phrases are retrieved from a languagefile instead of being retrieved from the database, which improves the performance.For more information, seeReplace the Interface Language with a Language from anExternal File, page 164.

Translate Interface Text Phrases

This procedure explains how to replace the phrases in the current interface text withyour customized text in the target language. After switching to the target language,all the phrases in the column representing that language replace the original phrasesof the interface language without overwriting them. Empty fields in the targetlanguage do not overwrite the original phrases. This way you can always revert to theoriginal phrases of the interface language. For more information, seeTranslateInterface Text Phrases, page 165.

Prefixes and Suffixes in the Interface Text

This topic contains a table with the information about the prefixes and suffixes thatyou can use when customizing new interface text phrases. For more information, seePrefixes and Suffixes in the Interface Text, page 167.

Related TopicsSmartPlant Instrumentation Interface Languages: An Overview, page161


25/62

Interface Languages


1. On the menu bar, click Tools > Select Language.2. On the Select Language dialog box, do one of the following:

From theLanguage list, select the language with which you want toreplace the current interface language.

Click Default to revert the language to the default language, which isEnglish.

3. Do one of the following:

Select the Optimize speed check box to speed up the translation

process. This allows the software to load the interface text to yourcomputer memory and retrieve it from there.

Clear the Optimize speed check box to retrieve the interface text fromthe database. This frees the memory resources but decreases theperformance.

4. Cl ick OK to close the dialog box and change the interface language.

Related TopicsInterface Languages Common Tasks, page 163SmartPlant Instrumentation Interface Languages: An Overview, page

161

Important

Use this procedure only if you experience memory problems whileworking on your local computer.

1. On the menu bar, click Tools > Select Language.

2. Select Optimize speed.


26/62

Interface Languages


3. Select Use file to retrieve the interface text from a pre-defined .psr file, and thendo one of the following:

In the data field, type the path and filename of the appropriatelanguage file.

Click Browse to navigate to the language file.

Caution

The software does not check whether the specified .psr file is suitablefor translation. If you select an unsuitable fi le, the software wil ldisplay the 'Expression not valid' message when you try to use variousoptions in SmartPlant Instrumentation.

4. To update your language file, do one of the following:

Select Overwrite existing file to update the contents of the externallanguage file after running an update for the application. This actionoverwrites all existing data in the language file with the data retrievedfrom the database.

Clear Overwrite existing file to leave the language file contentsunchanged.

5. Cl ick OK to close the dialog box and change the interface language.

Related Topics

Interface Languages Common Tasks, page 163SmartPlant Instrumentation Interface Languages: An Overview, page161

Important

The System Administratormust first add the specified target languageto the database.

1. On the menu bar, click Tools > Edit Translation Text.


Click Open to navigate to a language (.psr) file that contains theinterface text.

Click Retrieve to retrieve the interface text from the database.

Important

After you click Update, these commands become permanentlydisabled, and you will no longer be able to perform either of theseoperations to load the interface text again.


27/62

Interface Languages


3. In the desired language column, type the phrases you want.

Tips

The column headers that appear depend on the available languages, forexample: Custom Phrase, French Phrase, German Phrase, and soforth.

You can compare phrases more easily by moving two columns closertogether. Drag a column header and drop it in the desired location.

Important

If you leave any fields blank for the target language, text from theOriginal Phrase column (English) will appear in those fields in theinterface after switching languages. This is useful for terms that are

the same in your language as in English; otherwise, you should notleave fields blank in order to prevent the occurrence of phrasesbelonging to more than one language appearing in the interface.

Make sure that you add the same prefixes, suffixes and punctuationmarks that appear in the corresponding original phrases of thatinterface language, for example: ~, & . For details, seePrefixes andSuffixes in the Interface Text, page 167.


Click Update to save the changes to the database. (I f you want to savethe changes to an external language file and not to the database, do not

click Update.)

Click Save File to save the translated interface text to an externallanguage file with a .psr extension.

5. Cl ick Close to close theEdit Translation Text dialog box.

Important

You must exit and then restart the application for your text changes totake effect.

6. Select the language that you have translated by means of one of the followingoptions:

To select a language from the database, seeReplace the InterfaceLanguage with a Language from the Database, page 164.

To select a language from an external file, seeReplace the InterfaceLanguage with a Language from an External File, page 164.

Related TopicsInterface Languages Common Tasks, page 163SmartPlant Instrumentation Interface Languages: An Overview, page161


28/62

Interface Languages


The following table contains information about the prefixes and suffixes that you canuse when customizing new interface text phrases.

Prefix/Suffi

x

Function Syntax Example

& Specifies a menu item.Underlines the letterfollowing the '& ' symbol.

& &Action

&& Displays the '& ' symbol. && Operators &&Functions

~n Starts a new line. ~n

~nContinue?

~r Starts a new paragraph(functions like the Enterkey in Microsoft Word).It is usually used inconjunction with ~n.

~r

Warning~n~r

~t Adds a tab entry. ~t

&Action~tCtrl+A

Related Topics

Interface Languages Common Tasks, page 163SmartPlant Instrumentation Interface Languages: An Overview, page161


29/62

Document Revisions

When managing revisions, you can add revisions to documents in SmartPlantInstrumentation, update them as needed, archive and compare new and existingdocument revisions, and delete obsolete revisions. A document is a report or drawingthat has a document number. Also, you can add a document number when adding arevision to an item .

The software allows you to add a revision to a specific report, drawing, or item , forexample, 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 itemproperties. Also, you can create global revisions.

In the Administration module, in the Report Management dialog box, theDomainAdministratorhas rights to define revision management settings individually for eachreport that you can generate in SmartPlant Instrumentation.

In the database, each report is assigned to the report type, which can be a listor a non-listtype report. The report type determines how you can manage revisions createdfor a specific report, for an item , or a group of i tems. For list-type reports, theDomain Administrator can enable SmartPlant Instrumentation users to manage

revisions eitherper documentorper item .In accordance with the revision management setting, you can either create a revisionwhose document number and revision number become shared for a specific item andfor reports generated for that item (when the setting is per-item ), or create a uniquerevision for a particular report (when the setting is per-document).

Regardless of the revision management setting, any document numbers and revisionsthat you create in the software are shared with the document numbers and revisionscreated for the same items in the Enhanced Report Uti lity. For example, a drawingcreated in the Enhanced Report Utility automatically inheri ts the same documentnumber and revision that you assigned to an Enhanced SmartLoop report generated in

SmartPlant Instrumentation.

When working in an integrated environment, you can specify whether to useSmartPlant Instrumentation revisions or external revisions created when working inan integrated environment. For more information about using revisions in anintegrated environment, seeRevising Documents in an Integrated Environment: AnOverview, page 1675.



30/62

Document Revisions


To place issue data on ti tle blocks for enhanced reports, use the Place DrawingProperty Label command in the Enhanced Report Utility. For more information, seePlace Property Labels on a Drawing Sheet in theEnhanced Report Utility User'sGuide, under Working with Templates and Title Blocks.

Global revisions enable you to perform a revision activity in batch mode.

At the first stage of applying global revisions, you select a revision activity, anddefine the default revision settings, such as revision values, numbering method, andrevision details. At the second stage, you select the required items in a specificmodule, and apply the defined revision settings.

Revision activities include:

Add revision - select the required numbering method and add a newrevision.

Update revision - change the existing revision value without changingthe numbering method. For example, you can update a revision fromA1 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 DomainAdministrator selected thePer Documentrevision management setting in theReportManagement dialog box.

An exception is Enhanced Report Utility reports, which are always assigned to thePer Item revision management setting. The document number and global revisionthat you create in SmartPlant Instrumentation are shared with the document numberand revision created in the Enhanced Report Utility.

Note

Items that have archive options defined as Save to database, anyrevisions are only saved to the archive after closing the GlobalRevisions dialog box. Adding a revision and then deleting therevision, before closing the dialog box, results in the revision not beingarchived.


31/62

Document Revisions

The following tasks are used frequently when managing global and local revisions:

Add Global Revisions

This option enables you to add a global revision to items that belong to any of thefollowing modules: Specifications, Process Data, Calculation, Loop Drawings, Hook-Ups, Wiring, and Dimensional Data. For more information, seeAdd GlobalRevisions, page 172.

Define Settings for Upgrading Revisions

This option enables you to define default settings for upgrading revisions globally.

These settings include revision numbering method, and revision details. For moreinformation, seeDefine Settings for Upgrading Revisions, page 174.

Update Revisions Globally

You can update the existing revision values globally for the items used in thefollowing modules: Specifications, Process Data, Calculation, Loop Drawings, Hook-Ups, Wiring, and Dimensional Data. For more information, seeUpdate RevisionsGlobally, page 175.

Upgrade Revisions Globally

After defining the default settings for upgrading revisions, you use this option toapply these settings to the selected items in batch mode. For more information, seeUpgrade Revisions Globally, page 176.

Delete Global Revisions

You can perform batch deletion of revisions if you have the appropriate access rights.You have the option to delete all revisions for the selected items in the specifiedmodule, or delete only the last revisions. For more information, seeDelete GlobalRevisions, page 177.

Filter Items for Global Revisions

You can filter the items in the data window of theGlobal Revisions dialog box whenadding, updating, upgrading, or deleting revisions in batch mode. On theWiring tabof theGlobal Revisions dialog box, you can also filter the Wiring module items perreport. For more information, seeFilter Items for Global Revisions, page 171.



32/62

Document Revisions


Add Local Revisions

You can add revisions locally to a specific SmartPlant Instrumentation document or

item , depending on revision management settings defined by theDomainAdministrator. For all list-type reports, the revision management setting is alwaysPer Document. For certain non-list-type reports, the Domain Administrator hasrights to define the setting as either Per document or Per Item . For moreinformation, seeAdd Local Revisions, page 178.

Edit Local Revisions

Use this procedure to edit existing local revisions. For more information, seeEditLocal Revisions, page 179.

Delete Local Revisions

Use this procedure to delete existing local revisions. For more information, seeDelete Local Revisions, page 180.

Related TopicsGlobal Revisions: An Overview, page 169Revision Management: An Overview, page 168

1. In theGlobal Revisions dialog box, click one of the following tabs:

Specifications, Process Data, Calculations, Loops, Hook-Ups, Wiring, orDimensional Data.

Tips

If you accessed the Global Revisions dialog box from the mainSmartPlant Instrumentation window, tabs for multiple modules areavailable; 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 ofwhere you access this dialog box from, the following tabs are disabled:Specifications, Process Data, Loops, and Dimensional Data.

2. If you selected the Wiring tab, do the following:

Under Filter parameters, from theReport for list, select the item forwhich you want to apply revisions: Panels, Cables, or DCS/PLC.

From theReport type list, select a report type appropriate for the itemyou selected in the previous step.

Tip

To set new filter parameters, first click Clear.


33/62

Document Revisions


3. For all tabs, under Filter parameters, type values in one or more of the textboxes to specify the parameters that you want to use for f iltering the data.

4. Select theDisplay current data only check box to display the data in thecurrent . Clear this check box to display all data at the level of the current.

Tip

On the Hook-Ups tab, data is filtered at the level only.

5. Select Activate filter to apply the filter parameters on the items.

Tip

If you select the Activate filter check box first, the software filters thedata as you select or type the filter parameters.

6. Select Enable wildcard search to use a wildcard, if required, in your search.

Tips

The Enable wildcard search is enabled only when Activate filter hasbeen selected.

The % character is used as the wildcard symbol in your filter.

7. Cl ick Refresh to update the data window as needed.

8. Cl ick Apply.

Related Topics

Global Revisions: An Overview, page 169Revision Management Common Tasks, page 170Revision Management: An Overview, page 168

1. In the main window of any SmartPlant Instrumentation module, click Tools >

Global Revisions.

2. On the Settings tab of the Global Revisions dialog box, from theActivity list,select Add revision.

3. In theRevision field, enter the desired revision value.

4. Do the following to enter the revision details:

In the Revised by field, enter the initials of the person performing therevision. The default is the current user's initials, if previously definedby the System Administrator.

In the Date field, enter the date of revision, i f required.

Fill out the other fields as needed.


34/62

Document Revisions


5. Click one of the following tabs: Specifications, Process Data, Calculations,Loops, Hook-Ups, Wiring, or Dimensional Data.

Tips



6. In the data window, filter the items as needed. For details, seeFilter Items forGlobal Revisions, page 171.

7. In the data window, select the items for which you want to add a global revisiondefined on theSettings tab by doing one of the following:

Select the desired tag numbers (hold down Ctrl or Shift to makemultiple selections).

Select the Select all check box to select all the tag numbers in the datawindow.

8. Cl ick Apply to add a revision to each of the selected items.

9. If you want to add revisions for other modules, repeat the appropriate steps foreach module.

Note

Items that have archive options defined as Save to database, anyrevisions are only saved to the archive after closing the GlobalRevisions dialog box. Adding a revision and then deleting therevision, before closing the dialog box, results in the revision not beingarchived.

Related Topics

Global Revisions: An Overview, page 169Revision Management Common Tasks, page 170

Revision Management: An Overview, page 168


35/62

Document Revisions


1. With any main window open, click Tools > Global Revisions.

2. On the Settings tab, from theActivity list, select Upgrade revision.

3. To change the numbering method for items that do not currently have revisions,from theInitial revision numbering method list, select one of the followingnumbering methods you want to start with:

P0 for preliminary number sequence P0, P1, P2,...

0 for number sequence 0, 1, 2,...

A for number sequence A, B, C,...

Tip

The initial revision numbering method only affects items that do nothave revisions. For items that already have revisions, the softwareadds a new revision line using the existing revision numberingmethod.

4. To change the numbering method for items that currently use the preliminaryrevision numbering method (P0, P1, P2,...), select Switch to another numberingmethod, and from the Continue using numbering list, select one of thefollowing new revision numbering methods:


A for number sequence A, B, C,...5. Do the following to enter the revision details:




6. Click the appropriate module tab to apply the defined settings. For details, seeUpgrade Revisions Globally, page 176.

Tips




36/62

Document Revisions


1. With any main window open, click Tools > Global Revisions.

2. On the Settings tab, from theActivity list, select Update revision.

3. In theRevision field, enter the desired revision value.

4. Do the following to enter the revision details:





Tips


If you are working in an integrated environment, then regardless ofwhere 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, seeFilter Items for

Global Revisions, page 171.

7. In the data window, do one of the following to select the items whose revisionsyou want to update:



8. Cl ick Apply to apply the new revision value to all the selected items in batchmode.

9. If you want to update revisions for other modules, repeat the appropriate steps foreach module.

Related Topics

Global Revisions: An Overview, page 169Revision Management Common Tasks, page 170Revision Management: An Overview, page 168


37/62

Document Revisions


1. Define the settings for upgrading revisions globally. For details, seeDefine

Settings for Upgrading Revisions, page 174.

2. Select the desired module tab and fi lter the items as needed. For details, seeFilter Items for Global Revisions, page 171.

3. To change the numbering method for items that do not currently have revisions,from theInitial revision numbering method list, select one of the followingnumbering methods you want to start with:

P0 for preliminary number sequence P0, P1, P2,...


A for number sequence A, B, C,...4. In the data window, do one of the following to select the items for which you

want to upgrade revisions:



5. Cl ick Apply to apply the new revision value to all the selected items in batchmode.

6. If you want to upgrade revisions for other modules, repeat the appropriate steps

for each module.

Related TopicsGlobal Revisions: An Overview, page 169Revision Management Common Tasks, page 170Revision Management: An Overview, page 168Revision Upgrade Example, page 177


38/62

Document Revisions


This example is based on the following parameters:

Initial numbering method: P0

Switch to numbering method for preliminary revisions: A

With the above parameters, the following results are obtained for subsequentrevisions (on clicking Apply in the module sub folders of theGlobal Revisionsdialog box):

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 numberingmethod (A, B, and so forth.)

A B C D Incremented by one step each time from the previousrevision

B C D E Incremented by one step each time from the previousrevision

1 2 3 4 Incremented by one step each time from the previousrevision

2 3 4 5 Incremented by one step each time from the previousrevision

Related TopicsGlobal Revisions: An Overview, page 169Revision Management Common Tasks, page 170Revision Management: An Overview, page 168Upgrade Revisions Globally, page 176

1. In the main window of any SmartPlant Instrumentation module, click Tools >

Global Revisions.

2. On the Settings tab of the Global Revisions dialog box, from theActivity list,select one of the following:

Delete revisions select to delete all revisions for the selecteditems.

Delete last revision select to delete the last saved revision for eachselected item .


39/62

Document Revisions



Tips



4. In the data window, filter the items as needed. For details, seeFilter Items forGlobal Revisions, page 171.

5. In the data window, do one of the following to select the required items:



6. Cl ick Apply to delete the revisions for the selected items.

7. If you want to delete revisions for other modules, repeat the appropriate steps foreach module.

Related TopicsGlobal Revisions: An Overview, page 169Revision Management Common Tasks, page 170Revision Management: An Overview, page 168

1. In theRevisions dialog box, select one of the revision numbering methods from

theRevision method list (use P0, P1, P2... for preliminary revisions or 0, 1, 2 / A,B, C, and so forth for normal serial revisions).

TipIf you select a revision numbering method other than preliminaryrevisions (P0, P1, P2...), you will not be able to return to thepreliminary revision method and this option will be disabled.

2. If needed, in theDrawing number field, type the number of the documentassociated wi th the item for which you create the revision. In drawings andreports, this number appears in the title block.


40/62

Document Revisions


3. Cl ick New to add a new revision.

Tips

If you are working in an integrated environment in a module thatsupports publishing and retrieving of documents, clicking New opensthe Revise dialog box for the integrated environment instead of theSmartPlant Instrumentation Revisions dialog box.

The software automatically increments the revision number accordingto the selected revision method. You can overwri te SmartPlantInstrumentation revisions if desired.

4. Add or edit the revision data as needed.

Note

If the document for which you are making a revision contains acustom-title block, theUser-defined fields data window becomesavailable for you. In this data window, you can view the user-definedfields that you added to the custom title block that you created.

Related Topics

Global Revisions: An Overview, page 169Revision Management Common Tasks, page 170Revision Management: An Overview, page 168View an Archived Revision, page 180

1. In theRevisions dialog box, select the revision that you want to edit.

2. Make the desired changes according to the revision table:

Field Description

No The revision number. This is incremented automatically according tothe revision method selected, you can overwrite it if required.

By Type the initials of the person performing the revision. The default isthe current logged-in user initials, if previously defined by the System

Administrator.Date The default is today's date, you can modify it if required.

Description Description of the changes made or the purpose of the revision.

CheckedBy

Type the name of the person checking the revision, if required.

ApprovedBy

Type the name of the person approving the revision, if required.


41/62

Document Revisions


3. Make changes for other revisions as desired.

4. Cl ick OK to apply your changes.


1. On the Revisions dialog box, select the revision that you want to delete.

2. Cl ick Delete.


1. In the Administration module, select the desired archiving option. For details, see

Set Archiving Options for Report Comparison in theAdministration User'sGuide, underDomain and Project Administration,Report Management.

2. In SmartPlant Instrumentation application, save a revision for the desireddocument.

Important

For enhanced reports, you must perform revisions from the EnhancedReport Utility if you want them to be archived for performing reportcomparison or viewing a changes report.

The software archives revisions for browser view reports separatelyfor each view regardless of any existing filter or sort sequence.

3. On the Print Preview toolbar, click to open theDocument Revision Archivedialog box where you view the revision.

4. Double-click the desired revision or revisions to open the print preview.

Related TopicsRevision Management Common Tasks, page 170Revision Management: An Overview, page 168


42/62

Report Comparison


Report comparison is available if you have saved revisions for a particular report.For every saved report revision, there is an archived report, stored according to thearchiving option. The Domain Administrator defines an archiving option for eachreport.

When comparing reports, you can generate a comparison report to view the reportfields in which the values are different.

Notes

Report comparison is only available if the System Administrator hasselected Audit trail options in the Domain Definition window for thecurrent domain, and if the Domain Administrator has selected one ofthe options for saving revisions of the specified report in the ReportManagement dialog box in the Administration module.

For enhanced reports, you must perform revisions from the EnhancedReport Utility if you want them to be archived for performing reportcomparison.

You cannot perform report comparison for PowerSoft browsers.

Using report comparison, you can do the following:

Compare the currently previewed report with an archived report. Fordetails, seeComparing the Current Report with an Archived Report,page 184.

Compare two archived reports. For details, seeComparing ArchivedReports, page 183.

Related TopicsSetting Font and Color for Report Comparison, page 182Viewing Archived Reports, page 185


43/62

Report Comparison


This option enables you to set a comparison color and font style prior to comparingreports. The preset color and font style appear in a previewed report after comparingthis report with an existing archived report. You can also set the grayscale and fontstyle to appear in a printed report after report comparison. In a previewed report, thecomparison color and font style indicate the differences between the previewed reportand an archived report selected for comparison.

1. On the Tools menu of any SmartPlant Instrumentation module, click DataComparison Display Options.

2. Beside theHighlight color for display field, click .

3. In theColor dialog box, choose the color that you require.

4. Cl ick OK to return to the Data Comparison Display Options dialog box.

Tip

The highlight color you have set appears after report comparison inany report print preview to indicate the differences between the currentand the archived report.

5. Beside theGrayscale fi eld, click .

6. In theGrayscale dialog box, move the slider to the required position.

7. Cl ick OK to close the Grayscale dialog box.

Tip

The grayscale you have set appears after report comparison in aprinted report to indicate the differences between the current and thearchived report.

8. Under Font style, do the following if required:

a. Select Bold to mark the differences between the current and the archivedreport in bold.

b. Select Italic to mark the differences between the current and the archivedreport in italic.

Related Topics

Report Comparison: An Overview, page 181


44/62

Report Comparison


This option enables you to compare between two archived reports.

1. In thePrint Preview window, do one of the following:

On the Print Preview window toolbar, click

On the View menu, click Compare Reports.2. In theReport Comparison Options dialog box, click Compare two archivedreports.

3. Cl ick OK.

4. In theSelect Archived Revisions for Report Comparison dialog box, do thefollowing:

a. From theCompare data window, select the revision corresponding to thesource archived report.

b. From theWith data window, select the revision corresponding to the targetarchived report that you want to compare with the source report.

Tip

If there is a long list of revisions in either of the data windows, typethe desired revision number in the Revision filter box and selectActivate.

Note

If the archived and the currently previewed reports are different, in thepreviewed report the software marks the differences in color. Ifrequired, you can set your own comparison highlight color and fontstyle to indicate the differences for report display. You can also set a

grayscale and font style to indicate the differences in a printed report.For details, see Setting Font and Color for Report Comparison, page182

Related TopicsComparing the Current Report with an Archived Report, page 184Report Comparison: An Overview, page 181


45/62

Report Comparison


The option enables you to compare the currently previewed report wi th an archivedreport.


On the Print Preview window toolbar, click .

On the View menu, click Compare.

2. In theReport Comparison Options dialog box, click Compare the currentreport with an archived report.

3. Cl ick OK.

4. In theReport Revision Archive dialog box, select the revision corresponding tothe archived report that you require.

Tip

If there is a long list of revisions in the data window, type the requiredrevision number in theRevision filter box and select Activate.

5. Cl ick OK to reopen the Print Preview window.

Tip

If the archived and the currently previewed reports are different, in thepreviewed report the software marks the differences in color. Ifrequired, you can set your own comparison highlight color and fontstyle to indicate the differences for report display. You can also set agrayscale and font style to indicate the differences in a printed report.

For details, see Setting Font and Color for Report Comparison, page182

Related TopicsReport Comparison: An Overview, page 181


46/62

Report Comparison


This option enables you to open a report preview of any archived report. The softwareautomatically archives reports when saving report revisions for the currentlypreviewed report. TheDomain Administratordefines an archiving option for eachreport.


On the Print Preview window toolbar, click

On the View menu, click Report Revision Archive.

2. In theReport Revision Archive dialog box, select the revision whichcorresponds to the archived report you want to view.

Tip

If there is a long list of revisions in the data window, type the requiredrevision number in theRevision filter list, and select Apply.

3. Cl ick OK to open the archived report in the Print Preview window.

Related Topics

Report Comparison: An Overview, page 181


47/62

Report Comparison


This option enables you to display a list of documents for which data modificationshave been made. To use this option, theDomain Administratormust first select theSave Document Data option in theReport Management dialog box for each reportthat you want to include in the list. The software does not include in changes reportsany modifications that you make to title block macros or external symbols such asDCS data or non- wiring tag lists in enhanced reports.

The software does not display data changes in the following cases:

If you add a new i tem such as a panel or gland in list reports, becausethe 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 thatyou make in the Instrument Index Standard Browser are included inthe Browse - Instrument Index Report item, and not in theInstrument Index under the list of browser

1. On the Tools menu, click Changed Documents.2. In theChanged Documents dialog box, do one of the following:

Under Document types, highlight the desired document types. Formultiple selection, hold down Ctrl or Shift while making yourselection.

Select the Select All check box.

3. Under Filter by, select an option to specify the method of f iltering. The availableoptions are:

Documents changed since last revision - select to filter documents

for which data was changed since the last revision of the document. Ifthere is no revision, the software does not display that document.

Documents changed between specified dates - select to filterdocuments for which data was changed during the date range specifiedby the From date and To date fields.

4. Cl ick Find to retrieve the list of changed documents according to the documenttypes and filter options that you specified.

5. Cl ick Changes Report if you want to display a report of the changed documents.


48/62

Workflow Procedures


TheWorkflow option enables instrument engineers to control the data entry processfor instrument tags by specifying if and when process data should be entered for aparticular tag. Workflow defines an additional level of access rights for individualinstrument tags, determined by the Workf low status of the tags. In this way, aninstrument engineer, while working on instrument data for a particular tag, can lockout process engineers from making changes to process data unti l all the instrumentdata 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 ornot the tag requires process data. In the event that the instrument tag does requireprocess data, the process data fields of the tag become available to the processengineers for editing.

2. The process engineer, after fi rst accessing the instrument tag for editing ofprocess data, can lock the process data fi elds against any changes wherever theinstrument engineers have access rights.

3. On being released by the process engineer, the instrument engineer can now enterinstrument data as required. The instrument engineer can lock the tag against anychanges wherever the process engineers have access rights.

Related Topics

Create a Workflow Browser, page 189Implementing Workflow, page 190Process Data Statuses, page 192Workflow Prerequisites, page 188


49/62

Workflow Procedures


Before you can implement Workflow in a given , theSystem AdministratorandDomain Administratorneed to perform the following tasks:

The System Administrator enables Workflow in your domain. Formore information, see the Administration module Online Help, SystemAdministration > Domain Management > Enable Workflow.

The Domain Administrator defines two groups that will be responsiblefor working in the areas of process engineering and instrumentengineering. For more information, see Creating a New Group Profilein Online Help for the Administration module.

The Domain Administrator does one of the following:

Associates Windows groups with the SmartPlant Instrumentationprocess engineering and instrument engineering groups. For moreinformation, see the Administration module Online Help, Users,Departments, and Groups > Create a Group for Windows

Authentication Logon Method.

Assigns users individually to the process engineering and instrumentengineering groups. For more information, see the Administrationmodule Online Help, Users, Departments, and Groups > Assign Users

to Groups.

The Domain Administrator defines Workflow access rights for theprocess engineering and instrument engineering groups. For moreinformation, see the Administration module Online Help, Domain AndProject Administration > Access Rights > Workflow Access Rights.

Note

After initialization of a domain from a source or after a versionupgrade, i t i s essential to regenerate the library forms to enable theWorkflow options to be used in the Specifications Browser. Fordetails, seeRegenerate Library Forms, page 501.

Related TopicsCreate a Workflow Browser, page 189Implementing Workflow, page 190Workflow: An Overview, page 187


50/62

Workflow Procedures


ImportantWorkflow needs to be set up by an instrument engineer.

Make sure that the System Administratorand theDomainAdministratorhave prepared SmartPlant Instrumentation forWorkf low. For more information, seeWorkflow Prerequisites, page188.

1. Open the Browser Manager.

2. Under Browser groups, double-click Workflow to expand the hierarchy.

3. Select theInstrumentation/Process Data Browser and create a new view.

4. Double-click the view to expand the hierarchy.5. Click , and in theStyle settings section, click Edit.

6. Select the check boxes in theView column to specify the fields to be displayed inthe view.

Important

You must include the Process Data Status field among the fieldsselected for displaying in the view.

7. Cl ick Save.

8. Select the View level in the tree, and then c

Date post:	07-Apr-2018
Category:	Documents
Upload:	sriteja-josyula
View:	228 times
Download:	0 times