SmartPlant Format Manager Users Guide

SmartPlant Format Manager
User’s Guide
Version 4.4 July 2005 DPID2-PE-200011G

Copyright
Copyright © 1999-2005 Intergraph Corporation. All Rights Reserved.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license
agreement; contains confidential and proprietary information of Intergraph and/or third parties which is protected by
copyright law, trade secret law, and international treaty, and may not be provided or otherwise made available
without proper authorization.
Restricted Rights Legend

Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c) of the
Contractor Rights in Technical Data clause at DFARS 252.227-7013, subparagraph (b) of the Rights in Computer
Software or Computer Software Documentation clause at DFARS 252.227-7014, subparagraphs (b)(1) and (2) of
the License clause at DFARS 252.227-7015, or subparagraphs (c) (1) and (2) of Commercial Computer Software---
Restricted Rights at 48 CFR 52.227-19, as applicable.
Unpublished---rights reserved under the copyright laws of the United States.
Intergraph Corporation
Huntsville, Alabama 35894-0001
Warranties and Liabilities

All warranties given by Intergraph Corporation about equipment or software are set forth in your purchase contract,
and nothing stated in, or implied by, this document or its contents shall be considered or deemed a modification or
amendment of such warranties. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to
applicable technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in
this document.
The software discussed in this document is furnished under a license and may be used or copied only in accordance
with the terms of this license.
No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not supplied by
Intergraph or its affiliated companies. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Trademarks
Intergraph, the Intergraph logo, SmartSketch, FrameWorks, SmartPlant, INtools, PDS, and MARIAN are registered
trademarks of Intergraph Corporation. Microsoft and Windows are registered trademarks of Microsoft Corporation.
Other brands and product names are trademarks of their respective owners.
Table of Contents
Table of Contents
Preface.................................................................................................................................5
Using Format Manager: An Overview ............................................................................7
Navigating in Format Manager: An Overview ...............................................................9

Open Database Command ............................................................................................9
Open Plant Structure Dialog Box ..................................................................................... 10
Open Site Server Dialog Box............................................................................................ 11
Connect to a Database....................................................................................................... 12
Save Command...........................................................................................................13
Most Recently Used Sites Command .........................................................................13
Exit Command ............................................................................................................13
Close the Format Manager Software ................................................................................ 13
Editing Format Properties: An Overview .....................................................................15

Add Format Command ...............................................................................................15
Add Format Dialog Box.................................................................................................... 16
Add a Format .................................................................................................................... 17
Define a Text Format ........................................................................................................ 18
Properties Command ..................................................................................................18
Edit Format Properties Dialog Box................................................................................... 19
Edit a Format Name .......................................................................................................... 21
Edit Format Properties ...................................................................................................... 21
Delete Command ........................................................................................................22
Delete a Format................................................................................................................. 22
Editing Field Properties: An Overview ......................................................................23
Field Properties Dialog Box.............................................................................................. 23
Insert a Field ..................................................................................................................... 25
Change Field Properties.................................................................................................... 26
Editing Text Properties: An Overview .......................................................................27
Text Properties Dialog Box .............................................................................................. 27
Insert Text ......................................................................................................................... 28
Using Help: An Overview................................................................................................29

Format Manager Help Command ...............................................................................30
About Format Manager Command.............................................................................30
Printable Guides Command........................................................................................30
Glossary ............................................................................................................................31
Index..................................................................................................................................43
SmartPlant Format Manager User’s Guide 3

Table of Contents
4 SmartPlant Format Manager User’s Guide

Preface
Preface
This document is a user's guide for SmartPlant Format Manager. The content is the
same as the online Help delivered as part of the software.
Intergraph gives you permission to print as many copies of this document as you need
for non-commercial use at your company. You cannot print this document for resale
or redistribution outside your company.
Send documentation comments or suggestions to PPMdoc@ingr.com.

Preface

Using Format Manager: An Overview

SmartPlant® Format Manager defines the characteristics and format for labels, report
data, and formatted properties. Format Manager is a stand-alone manager for the
plant administrator to create and edit formats. Only a plant administrator can use
Format Manager.
The interface for Format Manager lets the plant administrator add or edit text
properties on drawings and reports for all types of data:
• Letters of the alphabet,

• Numbers, or
• Special characters, such as punctuation marks and symbols like !, @, #, %.
Important
• The double-quote, ", is a special character and should not be used in
format names.
Related Topics
• Add a Format, page 17
• Close the Format Manager Software, page 13
• Define a Text Format, page 18
• Insert a Field, page 25


Navigating in Format Manager: An Overview

You can create a new format or edit an existing format for an entire plant structure
using Format Manager.
Data types are displayed at the base level on the Tree view as folders. Formats are
displayed subordinate to the related data type. When you review the Tree view,
notice the symbols to the left of the listed formats. A plus sign indicates that formats
are stored under that data type. When you click the plus sign, the display expands to
show all available formats. Conversely, in an expanded view, a minus sign appears to
the left of the data type. When you click the minus sign, the display minimizes to
show only the data type.
Right-clicking in the main window opens a shortcut menu where you can quickly
access common commands.
The Tree view displays all of the available data types and formats. You can rename,
edit or add a format, but you cannot add or remove a data type. Data types are pre-
defined in the software. A data type is formatted data that represents text with strings;
numbers with integers, fractions, decimals, and so forth; and measurements with
inches, BTUs, ergs, ohms, and so forth. All data types contain formats that the design
software can use.
Related Topics
• Close the Format Manager Software, page 13
• Edit a Format Name, page 21
Open Database Command

File > Open Database
Opens the Open Plant Structure dialog box, and allows you to connect to the site
and server that you want to work with in the software by choosing the appropriate
SmartPlant initialization file (.ini file). You can also view the plants to which you
connected recently. In order to use this command, your computer must be able to
connect to the network where the server is located.

Open Plant Structure Dialog Box

Sets options for connecting to a site and plant structure and passes user access
information to the application.
Available plant structure - Lists those plant structures found on the network. You
can select only one item from this List view at a time.
Application type - Allows you to specify the application that you want to associate
with this plant structure.
Open - Connects you to the selected database. When you click this button, the
application also checks to make sure you have the correct access privileges for the
selected plant structure and passes your access information back to Format Manager.
Site Server - Opens the Open Site Server dialog box, allowing you to select a
SmartPlant initialization file from local and network directories. Plant structures that
correspond to the initialization file that you choose are subsequently displayed in the
list of available plant structures.

Open Site Server Dialog Box

Allows you to specify the initialization file associated with the plant structure you
want to work with in Format Manager.
Look in - Lists the available folders and files. To see how the current folder fits in the
hierarchy on your computer, click the down arrow. Click a folder to see its contents.
In the displayed list, you can double-click a folder or file to open it. To open the
folder one level higher, click the Up One Level button.
Up One Level - Navigates one level higher in the directory.
Create New Folder - Adds a new folder in the current directory.
View Menu - Allows you to select the format in which the files are displayed in the
main window of the dialog box. Options include Large Icons, Small Icons, List,
Details, and Thumbnails.
File name - Provides space for you to type the name of the file.
Note
• You can use * as a wildcard. For example, you can type *.* to see a list of
all files. Alternately, you can type the full path of a file, such as
c:\rules\smartplantv4.ini.
Files of type - Lists the category of files that you want to be displayed. This option is
useful for narrowing the displayed list of files to only those files of interest.
Open - Opens the file with the name, file type, and location that you specified.
Open as read-only - Opens the file in a read-only display. The software does not
save any of your changes.
Related Topics
• Connect to a Database, page 12
• Open Database Command, page 9
• Open Plant Structure Dialog Box, page 10

Connect to a Database
1. Click File > Open Database.
Tip
• If the plant structure that you want appears in the Available plant
structures list, you can select it in the List view on this dialog box
and go to step 4.
2. On the Open Plant Structure dialog box, click Site Server.
3. On the Open Site Server dialog box, select the correct SmartPlant initialization
file (.ini file) and click OK.
4. Click Open.
Tip
• The Open command checks to make sure that you have the correct
access privileges for the selected plant structure and passes your access
information back to the software.
Related Topics
• Navigating in Format Manager: An Overview, page 9
• Open Site Server Dialog Box, page 11
• Using Format Manager: An Overview, page 7

Save Command
File > Save
Records any changes that you completed during an editing session with Format
Manager.
Related Topics
• Edit Format Properties, page 21
Most Recently Used Sites Command

Displays a list on the File menu of the last sites to which you were connected. Select
a site from this list to quickly re-open that site.
Related Topics
• Connect to a Database, page 12
Exit Command
File > Exit
Closes the Format Manager application. The software prompts you to save your
changes.
Close the Format Manager Software

Click File > Exit.
Tip
• Format Manager prompts you to save your changes.
Related Topics
• Navigating in Format Manager: An Overview, page 9


Editing Format Properties: An Overview

You use the Format Properties dialog box to create a new format or the Edit
Format Properties dialog box to edit an existing format.
Format Manager supports compound formats. A compound format is a combination

of format fields that make up a text format, such as 10 ft - 4 in.
Related Topics
• Change Field Properties, page 26
• Delete a Format, page 22
Add Format Command

Edit > Add Format
Opens the Format Properties dialog box that allows the plant administrator to add a
new format.
Note
• You must select a data type, or folder, in the Tree view to make the Add
Format command available.
Related Topics

Add Format Dialog Box

Appears when you click Add Format on the toolbar and allows the plant
administrator to create a format for the entire plant. After the plant administrator
creates the format, the Format Manager display is updated. Formats appear
subordinate to the selected data type, or format folder, in the Tree view.
Name - Specifies the name of the format as it appears in the Tree view in the main
window. This name must be unique and can be any combination of characters.
Data Type - Specifies the category of the format and determines where the format
appears in the Tree view in the main window. The data type is specified by the folder
you select in the main window.
Delete - Removes the format definition. The software prompts you to confirm the
deletion of a format.
Edit - Displays the Field Properties dialog box or Text Properties dialog box. You
can use these dialog boxes to specify the properties for the selected field.
Format - Displays the format item that is currently active, lists all the format fields
included for the selected text format, and contains the Edit, Insert Text, Insert
Field, and Delete buttons needed to change format properties.
Item - Displays the numeric value that indicates the text format field that is currently
active in Text Properties. You can use this list to select the portion of the format you
want to edit. The scroll-up button increases the number in the Item list. The
scroll-down button decreases the number in the Item list.
Note
• The Item list reflects the total number of formats and updates
automatically when you add or delete text or fields.

Text Properties - Displays the format fields included in the selected text format.
Note
• You can create compound formats, which use a combination of fields to
create a complete format. An example of a compound format is 10 ft. 4 in.
This example includes format fields for 10 ft., which defines the
measurement in feet; and 4 in., which defines the measurement in inches.
Insert Text - Displays the Text Properties dialog box to add text to a format. This
dialog box lets you append text to the text format string that is currently selected.
Note
• To ensure that unit-conversion is performed successfully, make sure extra
text resides to the right of the units field. You can do so by inserting fields
into new formats before text is inserted, or by using SmartText in Catalog
Manager to embed text into label formats. To further ensure that the units
of measure convert correctly, formats with embedded text should be used
for labels, not for properties that appear in the Properties window.
Insert Field - Displays the Field Properties dialog box to create a field. You can
append a format field to the format that is currently selected.
Add a Format
1. In the Format Manager main window, select the data type that needs the new
format.
2. Click Edit > Add Format.
Tip
• You must select a format folder in the Tree view to enable the Add
Format command.
3. On the Format Properties dialog box, type a description in the Name box.
4. Define a new field or new text for the format. For more information, refer to the
Insert a Field, page 25 or Insert Text, page 28 procedures.
Note
• To ensure that unit-conversion is performed successfully, make sure
extra text resides to the right of the units field. You can do so by
inserting fields into new formats before text is inserted or by using
SmartText in Catalog Manager to embed text into label formats. To
further ensure that the units of measure convert correctly, formats with
embedded text should be used for labels, not for properties that appear
in the Properties window.

Define a Text Format

1. Select a folder and click Edit > Add Format.
2. On the Format Properties dialog box, type a name in the Name field.
3. On the Text Properties dialog box, type your text in the User text box.
Note
• If you also need to add field properties to this format definition, click
Insert Field on the Format Properties dialog box. For more information,
see Insert a Field, page 25.
Important
• To ensure that unit-conversion is performed successfully, make sure that
extra text resides to the right of the units field. You can do so by inserting
fields into new formats before text is inserted or by using SmartText in
Catalog Manager to embed text into label formats. To further ensure that
the units of measure convert correctly, formats with embedded text should
be used for labels, not for properties that appear in the Properties
window.
Related Topics
• Editing Text Properties: An Overview, page 27
Properties Command
Edit > Properties
Displays the Edit Format Properties dialog box that allows you to change the
selected format. You must select a format before the Properties command is
available.
Related Topics
• Editing Field Properties: An Overview, page 23
• Editing Format Properties: An Overview, page 15

Edit Format Properties Dialog Box

Appears when you click Properties on the toolbar and allows the plant
administrator to change an existing format for the entire plant. After the plant
administrator edits a format, the Format Manager display is updated. Formats appear
subordinate to the selected data type, or format folder, in the Tree view.
Name - Specifies the name of the format as it appears in the Tree view in the main
window. This name must be unique and can be any combination of characters.
Data Type - Specifies the category of the format and determines where the format
appears in the Tree view in the main window. The data type is specified by the folder
you select in the main window.
Delete - Removes the format definition. The software prompts you to confirm the
deletion of a format.
Format - Displays the format item that is currently active, lists all the format fields
included for the selected text format, and contains the Edit, Insert Text, Insert
Field, and Delete buttons needed to change Text Properties.
Item - Displays the numeric value that indicates the text format field that is currently
active in Text Properties. You can use this list to select the portion of the format you
want to edit. The scroll-up button increases the number in the Item list. The
scroll-down button decreases the number in the Item list.
Note
• The Item list reflects the total number of formats and updates
automatically when you add or delete text or fields.

Text Properties - Displays the format fields included in the selected text format.
Note
Edit - Displays the Field Properties dialog box or the Text Properties dialog box.
You can use these dialog boxes to specify the properties for the selected field.
Insert Text - Displays the Text Properties dialog box to add text to a format. This
dialog box lets you append text to the text format string that is currently selected.
Note
• To ensure that unit-conversion is performed successfully, make sure extra
text resides to the right of the units field. You can do so by inserting fields
into new formats before text is inserted, or by using SmartText in Catalog
Manager to embed text into label formats. To further ensure that the units
of measure convert correctly, formats with embedded text should be used
for labels, not for properties that appear in the Properties window.
Insert Field - Displays the Field Properties dialog box to create a field. You can
append a format field to the format that is currently selected.
Related Topics
• Properties Command, page 18

Edit a Format Name

1. In the main window, select the format with the name that you want to edit.
2. Click Edit > Properties.
3. On the Edit Format Properties dialog box, type the changes in the Name box.
Important
• The double-quote (") is a special character and should not be used in
format names.
Caution
• Renaming a format will break any labels that already use that format. The
software prompts you to be sure that you want to rename a format.
Related Topics
Edit Format Properties

1. In the main window, select the format that you want to edit.
2. Click Edit > Properties.
3. On the Edit Format Properties dialog box, change the displayed information as
necessary.
Related Topics
• Insert Text, page 28

Delete Command
Edit > Delete
Removes the highlighted format from the system. A message box asks you to confirm
the deletion before the software deletes a category or format. You cannot delete a data
type.
Related Topics
Delete a Format
1. Highlight the format to delete.
2. Click Edit > Delete.
3. Click OK on the message box to delete the format.
Related Topics

Editing Field Properties: An Overview

On the Format Properties dialog box or the Edit Format Properties dialog box,
click Edit. For formats that have fields defined, the Field Properties dialog box
appears and displays the characteristics of each field in the format. To change or add
information, a field must be available.
Related Topics
Field Properties Dialog Box

Appears when you click Edit on the Format Properties dialog box or the Edit
Format Properties dialog box if you have selected a field in a format, as opposed to
text. This dialog box also opens when you click Insert Field on either of the above
dialog boxes.
Data type - Defines the overall category, such as Energy or Length, of the
information associated with the format. Data types are delivered with Format
Manager and correspond to folders in the main window. You cannot add or remove a
data type.
Readout - Lists the types of characters appropriate for the format. The format
changes for integers, upper case or lower case, numeric, fraction, decimal, and so
forth. Choose the appropriate readout type from the list.

Precision - Lists the degrees of accuracy available that the text format uses when
reporting numeric values. Choose the appropriate level of accuracy.
Alignment - Specifies the text alignment of the field. Selections are left, right, and
center.
Minimum length - Quantifies the minimum number of characters that this field can
contain. The Padding Character options are available if you specify a minimum
length.
Fixed-length string - Defines the field as fixed in length. The Padding Character
options are available if you specify a fixed length.
Display units - Indicates whether the unit of measure are displayed. Checking this
checkbox removes the format from the Property Grid in the SmartPlant P&ID
modeling environment, necessitating the modification of all labels using this new
label. For example, if you want 50.00 psi to appear as 50.00 in your label, you must
create a Pressure format to display 50.00 psi in the Property Grid and then create
another Pressure format to display 50.00 in the label. The only difference between
these two formats is that the Display units checkbox is checked for the former and
not checked for the latter.
Units Of Measure - Displays the primary, secondary, and tertiary units that define
the text format.
Primary - Defines the first unit of measurement that the software uses in the format.
Secondary - Defines the second unit of measurement that the software uses in the
format.
Tertiary - Defines the third unit of measurement that the software uses in the format.
Padding Character - Sets a filler character that constructs the remaining character in
a fixed-length or minimum length string. Select the Zero, Space, or User-defined
option to determine the padding character. This option is available only if you
complete the Fixed-length string or Minimum length box.
Note
Related Topics

Insert a Field
1. Select a format and click Edit > Properties.
2. On the Edit Format Properties dialog box, click Insert Field.
Tips
• If you are creating a new format, click Insert Field on the Format
Properties dialog box.
• A new format field is appended to the active format.
3. To change the readout, define the character type or select the appropriate text
format.
4. To change the precision, select the degree of accuracy necessary for reporting
numeric values.
5. For any data type except string, to change the minimum length, type the minimum
number of characters in the Minimum Length box. To change the fixed-length
string format for the string data type, type the change in the Fixed-length string
box.
6. To change the alignment, select left, right, or center.
Tip
• You can access the Alignment box only after you type a value in the
Minimum Length field or select Fixed-length string.
7. To change the units of measure, select the units necessary to define the text
format. You can select the first unit of measurement in Primary, the second unit
of measurement in Secondary, and the third unit of measurement in Tertiary.
8. To select or change the padding character, select the Zero, Space, or User-
defined option. For the User-defined option, type a filler character in the box to
the right of the option.
Related Topics

Change Field Properties

1. Select a format, and click Edit > Properties.
2. On the Edit Format Properties dialog box, click Edit.
3. To change the readout, define the character type or select the appropriate text
format.
Tip
• Examples of appropriate types for readout for a text string are
Standard, Uppercase, and Lowercase. Examples of types for readout
for numbers are Decimal and Fraction.
4. To change the precision, select the degree of accuracy necessary for reporting
numeric values.
5. To change the minimum length for any data type except string, type the minimum
number of characters in the Minimum Length box. To change the fixed-length
string format for the data type of string, type the change in the Fixed-length
string box.
Tip
• You can access the Alignment box only after you type a value in the
Minimum Length box.
6. To change the alignment, select left, right, or center.
7. To change the units of measure, type or select the units necessary to define the
text format.
8. To change the padding character, select the Zero, Space, or User-defined option.
For the User-defined option, type a filler character in the text box to the right of
the option.
Note
• A compound format uses a combination of format fields to create a text
format. An example of a compound format is 10 ft. 4 in. The example
includes format fields for 10 ft., which defines the measurement in feet;
and 4 in., which defines the measurement in inches.
Related Topics

Editing Text Properties: An Overview

You can add or append text to a format that you select in the main window. You can
edit text properties only when you add or edit a text field.
Related Topics
Text Properties Dialog Box

When you click Insert Text on the Format Properties dialog box or the Edit
Format Properties dialog box, the Text Properties dialog box appears. If a text
format is selected, this dialog box allows you to append text to the text string. If a
string format is not active, the Text Properties dialog box allows you to append a
text string. You can also use this dialog box when you are adding or editing a
compound text format.
User Text - Allows you to type the text that you want to append to the format.
Related Topics

Insert Text
1. Select a format, and click Edit > Properties.
2. On the Edit Format Properties dialog box, click Insert Text.
Tip
• For more information about creating a new text format, refer to Define
a Text Format, page 18.
3. On the Text Properties dialog box, append text to the text that currently appears
by adding to user text.
Tips
• To ensure that unit-conversion is performed successfully, make sure
extra text resides to the right of the units field. You can do so by
inserting fields into new formats before text is inserted, or by using
SmartText in Catalog Manager to embed text into label formats.
• To further ensure that the units of measure convert correctly, formats
with embedded text should be used for labels, not for properties that
appear in the Properties window. In fact, if you embed text in the
middle of a format, those formats are not available in lists of formats
that appear in the Properties window.
Related Topics

Using Help: An Overview

Online user assistance makes command information available as you perform tasks.
You can access different kinds of information any time that you are running the
software. This information includes reference topics, narrative descriptions, or
instructional material.
The software offers the following important user-assistance features:
Online Help
A structured table of contents, an index, and full-text search capabilities provide easy
access to Help topics. Press F1 any time you need online Help during a session. You
can access the table of contents by clicking Help > Format Manager Help, or by
clicking the Help command on the toolbar.
Learning Tools
You can click Help > About Format Manager to see your software version and
license information.
User Interface Features

ToolTips help you find toolbar command names. When you point to a command
button on the toolbar and pause over it, a label displays the name of the command.
Printable Guides
You can click Help > Printable Guides and choose to display Format Manager Help
in portable document format. Then you can print the file if necessary.

Format Manager Help Command

Help > Format Manager Help
Opens the Help viewer where you can read topics about commands, procedures,
dialog boxes, and so forth. Format Manager Help also contains topics that describe
how to get the most out of the Help viewer.
About Format Manager Command

Help > About Format Manager
Displays information about your copy of the software, including the version number
and the copyright, legal, and licensing notices.
Printable Guides Command

Help > Printable Guides
Opens a page in your default browser that includes links to the user's guides in
portable document format. Click a link, and the guide is opened in the appropriate
application. From this format you can print any or all of the document. The user's
guides contain the same information that is in the online Help.

Glossary
Glossary
A
absolute path name
Sequence of directories, beginning with the node name, that locates a file - for
example, \\MyPC\C:\temp\MyFile.txt.
application software
Software designed to meet specific user needs, unlike system software, which runs
other software.
approval status
A property value that controls revisions to drawings.
archive
To copy a file to a specified storage location and then delete the file from the current
location.
associative
Having a relationship to another item.
attribute
1. A property or characteristic of a component.
2. A characteristic that all members of a class possess. Each property has an
associated value that defines its current state. Most databases represent an
attribute by a column in a table.
B
backup
To copy a file to a specified storage location while retaining the file in the current
location.
batch
A group of jobs to process on a computer at one time with the same program without
user intervention.
batch processing
A method of processing data that collects a series of operations into a group and runs
the group in a continuous stream without user intervention.

Glossary
C
client
In network operations, a node that accesses data or performs a function on the remote
resource, usually a server. All network operations among two or more nodes establish
a client/server relationship.
client/server database
A database system in which the database engine and database applications reside on
separate, intelligent computers that communicate with each other through a network.
In this system, the processing power is split between the two CPUs. The workstation
for the user is the client, and the database runs on the server.
collaboration
Working jointly. In Workshare, satellite sites work together with the host site to share
the creation and maintenance duties for P&ID drawings and related data.
column
An attribute of a database table. A group of columns defines a table in the database.
company
Organization that owns the plant.
concatenate
To connect in a series; to link or append.
configuration
Relative arrangement of parts or items.
context-sensitive help
Display of help topics that are associated with a dialog box or command. For
example, you can press F1 to learn about a dialog box.
D
data dictionary
The underlying data model of a plant, consisting of database entries and select lists.
SmartPlant Data Dictionary Manager maintains this information.
data model
Application items that populate a project. Typical items in a data model are
components, lines, and labels.
database
Collection of files of comprehensive information that have predefined structure and
organization; a specific program can communicate, interpret, or process these files.

Glossary
database administrator
The technical support person who assigns user IDs and data access permissions,
creates new databases, removes databases no longer in use, and monitors disk storage
usage of the database and performance.
database link
A network object stored in the local database that identifies a remote database, a
communication path to that database, and optionally, a user name and password.
Once defined, the database link is used to access the remote database, for example, to
provide the satellite a view into the plant schema at the host site.
database table
Part of the database consisting of rows and columns and containing information about
the project and design elements.
DBLink
Database link.
default
Predetermined value of a parameter that the system or a program automatically
supplies whenever the user does not specify a value.
delimiter
A separating mark or space; a character or sequence of contiguous characters that
mark the end of a string of characters.
design database
Database that contains the non-graphical data for the equipment and piping models.
design file
File containing graphics and text data, also called a drawing file.
design session
Elapsed time from when you open a design file until you close the design file.
design-wide break
A region of the drawing within which a single property value is defined for all the
included components. Indicating the region, a closed shape exists, along with an
accompanying label that shows the property value.
directory
File or folder that stores the names of other files.
document
Item used to define an output group, such as files, drawings, or other documents.

Glossary
domain
Set of acceptable values for a value within a component.
download
To transfer data, such as design files, from a larger device, such as a server where
master copies reside, to a smaller device, such as a workstation.
drawing file
File in which you place items; also called a design file.
drawing, P&ID
Graphics file that contains data about one unit. Each drawing has a unique drawing
number within the unit to which the drawing belongs.
F
file
Collection of logical records stored as a unit.
file name
Name that a user defines for an interactively created file. For easier identification, the
name should relate to the contents of the file.
full path name

Name of the entire path or directory hierarchy to a file, including the filename. See
also relative path name.
G
global name
The full name of the database that uniquely identifies it from any other database. The
global database name is of the form database_name.database_domain, for example,
sales.us.acme.com.
H
Help files
Online documentation that provides description in text, graphics, and AVIs to help
you discover how to use the software. Help is available in the form of Overview,
Command, Dialog Box, and Command Reference topics. You can access the entire
Help file from the Help menu. You can access context-sensitive Help on a dialog box
by clicking the Help button or pressing F1.
hierarchical
An ordered relationship from greatest to least; refers to the relationships among
groups, components, and labels.

Glossary
hierarchy
A classified structure with superiors, or roots, and subordinates, or dependents, for
grouping files or commands.
host
A computer that acts as the controlling source of information. In Workshare, a site
that controls satellites.
I
instance
A single allocation of an item class.
instrument loops
A group of one or more instruments or control functions arranged so that signals can
pass from one function to the next for the purpose of measuring and controlling a
process variable. In SmartPlant P&ID, you can create instrument loops containing
any combination of inline and offline instruments.
item
Unit of storage within a larger unit, such as a file in a catalog; a single member in the
P&ID.
item type
Distinct objects that users can manipulate in SmartPlant P&ID, such as equipment,
events, and safety classes.
K
keyword
A word that the software recognizes to provide access to a certain function.
L
loop
Software structure that allows a specified sequence of instructions to run repeatedly,
if the stated conditions remain constant.
M
model
A representation of graphics or a schema; collection of all items and their
relationships to create a coherent description of a process plant.
model file
A design file or database file that defines the 2-D or 3-D geometry and connectivity
of a structure.

Glossary
N
Net8
An Oracle networking solution that enables a network session from client application
to an Oracle database server. Once a network session is established, Net8 acts as a
data courier for the client application and the database server. It is responsible for
establishing and maintaining the connection between the client application and
database server, as well as exchanging messages between them. Net8 is able to
perform these jobs because it is located on each computer in the network.
network
Interconnection of host computers and workstations that allows them to share data
and control. The term has a dual meaning: network can refer to the devices that
connect the system, or network can refer to the connected system.
nodes
A collection of folders that make up a catalog file system. You can navigate through
the catalog and view folder contents by opening and closing different nodes.
node address
Hard-wired Ethernet address assigned to each node at manufacture. Each node must
identify and communicate with another node in the network.
node name
Name, or alias, that you can assign to the node address of a device on a network.
O
occurrence
A row within a relational database table.
offline
Term that refers to those instrument components that are not inserted in a pipe run.
online Help
Online documentation that provides description in text, graphics, and AVIs to help
you discover how to use the software. Help is available in the form of Overview,
Command, Dialog Box, and Command Reference topics. You can access the entire
Help file from the Help menu. You can access context-sensitive Help on a dialog box
by clicking the Help button or pressing F1.
Oracle
A relational database management system.
P
P&ID
See Piping and Instrumentation Diagram.

Glossary
parameter
A property with a value that determines the characteristics or behavior of an item.
path
The route to a file on a disk. In communications, the route between any two nodes.
Same as line, channel, link or circuit. See absolute path name or UNC.
path name
Sequence of directories leading to a file. See also absolute path name and relative
path name.
Piping and Instrumentation Diagram (P&ID)

Primary drawing for maintaining a plant. The P&ID includes three primary groups of
items: equipment, piping, and instrumentation. The drawing relates critical process-
related information, such as process conditions for temperatures and pressures, and
identifies physical components in the plant. The P&ID is the basis for both the
construction of the physical plant and further specification of instrumentation
components.
plant
A group of facilities and equipment that performs one or more material processing
functions within a given geographical area. One company can have several plants
located at different geographical locations.
plant group items

The building blocks, such as site, plant, unit, area, and level, used to create plant
breakdown structures or plant structure hierarchies.
plant structure
Represents the business structure or physical hierarchy of a plant.
port
A pathway into and out of the computer or a network device.
project
1. A directory file created in an application environment that contains design files
and subprojects. A project is not necessarily specific to an application; the project
may contain design files from multiple applications.
2. Term used for convenient grouping of either all or part of the items that constitute
a plant. Several projects can be under design at one time, probably in separate
geographical locations and having limited communication among them.
property
A unique characteristic of an object, item, symbol, or document.

Glossary
The properties of an item can include display properties and properties stored with the
item. For example, the properties of a valve symbol can include display properties
such as color, line style, and width. Other properties stored with the valve symbol can
include the manufacturer, cost, or material. Properties stored with the valve symbol
are displayed in the Properties window when the valve symbol is selected.
publish
To release a P&ID drawing for subscription or distribution.
publishing method
To publish a P&ID drawing using either the database link or the file sharing means of
transferring data.
R
RDL
Relational Database Language.
reference data
A collection of information containing facts relative to industry design codes, catalog
data of vendors, job specifications, commodity libraries, graphics symbology, label
descriptions, report formats, and other information of a similar theme.
reference file
A drawing file attached to another drawing file for reviewing reference; a graphic
representation attached to a drawing view.
Relational Database Management System (RDBMS)

A database management system that uses Structured Query Language (SQL) to
implement and query data in relational tables.
relative path name

Sequence of directories leading from the current directory to a particular file. See also
absolute path name and path name.
S
satellite
A server located remotely from the host server. In Workshare, a remote server
connected to a satellite slot at the host server.
satellite slot
The host's side of the Workshare connection. Satellites connect to the satellite slots
made available by the host at the host site.
schema
Description of the overall structure of the rulebase or database.

Glossary
schema file
File that outlines the overall logical structure of a rulebase or database.
server
In network operations, the node that maintains common data or performs a common
task that clients need. All network operations between two or more nodes establish a
client/server relationship.
site
A group of plants. A site can contain one or more plants.
site server
A text file containing the database type, connection alias, data dictionary, and schema
information for the site. Appears as the root directory for each site in SmartPlant
Engineering Manager.
SP_IDs
Unique identification numbers assigned by the SmartPlant software to all items
created in the database.
SQL
See Standard Query Language.
SQL file
An ASCII file containing valid SQL statements.
Standard Query Language (SQL)

Language developed by IBM for creating, modifying, and querying relational
databases.
static Oracle port

Network configuration that forces an Oracle database link to always connect via a
fixed path to a fixed port number.
subnet
A division of a network into an interconnected, but independent, segment, or domain,
in order to improve performance and security.
subnet mask
The technique used by the IP protocol to filter messages into a particular network
segment. The subnet mask is a binary pattern that is stored in the client machine,
server, or router and is matched up with the incoming IP address to determine
whether to accept or reject the packet.

Glossary
subscribe
To sign up for a service. In Workshare, connecting a satellite site with a satellite slot
at the host.
subscribe access
Read-only access to published P&ID drawings.
symbology
1. Display style of an item, including color, pattern, style, and width.
2. In Options Manager, symbology provides graphical clarity to a drawing by
differentiating among various items by their appearance. Symbology refers to the
color, line weight, and style associated with items in a particular filter.
T
table
Collection of data for quick reference, either stored in sequential locations in memory
or printed as an array of rows and columns of data items of the same type.
table, relational database

An item with information stored in a relational database, organized in rows and
columns.
template
A document or file having a preset format, used as a starting point or blueprint for a
particular application so that the format does not have to be recreated each time it is
used. In SmartPlant P&ID, a file used to create a drawing with a set of default
parameters; a template serves as an outline or blueprint for you to create a new
drawing. In SmartPlant Engineering Manager, a file used to create roles, data
dictionaries or other database schemas.
transaction
Nongraphic record of any additions, deletions, and changes that you request during
job posting activities.
U
UNC path
Universal Naming Convention. The full name of a resource on a network. It conforms
to the \\servername\sharename syntax, where servername is the name of the server
and sharename is the name of the shared resource. UNC names of directories or files
can also include the directory path under the share name, with the following syntax:
\\servername\sharename\directory\filename.

Glossary
unit
Group of parts of the schematic and individual worlds of a plant that together perform
a given process function. The identifying number of the unit is unique within the
project and within the plant. Most companies, but not all, use the concept of unit.
user name
Name that provides access to an account on the system. Same as username.
utility
Program that provides a commonly used service.
V
values
Data stored in a property; either you can enter this data or the software determines the
value.
variable
Quantity that can assume any one of a set of values.
view
Defined area of vision on a screen or window. The visual contents of a window
displaying an aspect of the application model.
W
workflow
Method of selecting processes and performing tasks.
working directory
Directory from which you are opening and viewing or changing files.

Glossary

Index
Index
about Format Manager, 30 exiting,Format Manager, 13
access control, 10, 11 fields
adding editing, 23
fields, 25 inserting, 17, 25
formats, 9, 17 modifying, 25
text, 16, 19, 27, 28 properties, 16, 19
alignment, 18, 23, 25, 26 filler characters, 25
appending,text, 27, 28 fixed-length strings, 25
changing Format Manager command, 29
fields, 23, 25 Format Manager Help command, 30
format names, 21 format name,modifying, 21
formats, 9, 13, 15, 16, 19, 23, 26 formats
properties, 18, 23, 26 compound, 15, 27
characters,reserved, 7 creating, 15, 17
closing,Format Manager, 13 deleting, 22
commands editing, 16, 19, 21
About Format Manager, 30 fields, 23
Delete, 22 modifying, 15, 16, 19
Exit, 13 properties, 15, 16, 19
Format Manager Help, 29, 30 text, 18
New, 15, 17 Help, 29, 30
Open Database, 9 accessing, 30
Printable Guides, 30 inserting
Properties, 18, 26 fields, 16, 17, 19, 25
Save, 13 text, 16, 17, 19, 27, 28
comments on documentation, 5 legal information, 30
connecting lengths
to databases, 9, 10, 11, 12 fixed, 18, 25
to plant structures, 11 minimum, 25
to sites, 13 licenses, 30
consulting services, 5 minimum length, 18, 25, 26
copyrights, 30 modifying
creating,formats, 9, 15, 17 fields, 23, 25
customer support, 5 format names, 21
data types, 9, 15, 16, 19, 23 formats, 9, 13, 15, 16, 19, 21, 23, 26
databases,opening, 9, 10, 11, 12 properties, 18, 23, 26
defining,text formats, 18 text properties, 27
Delete command, 22 Most Recently Used Sites command, 13
deleting names,modifying, 21
formats, 16, 19, 22 naming,formats, 7, 16, 19, 21
text, 16, 19 navigating the tree view, 9
displaying New command, 15, 17
Help, 30 new formats, 15, 17
properties, 18 online Help, 29, 30
documentation comments, 5 Open Database command, 9
editing opening
fields, 23, 25 databases, 9, 10, 11, 12
format names, 21 Help, 30
formats, 9, 13, 15, 16, 19, 21, 23, 26 plant structures, 11
properties, 18, 21, 23, 26 sites, 13
text, 27 user's guides, 30
embedded text, 17 overviews, 7, 9, 15
Exit command, 13 plant structures,opening, 11

Index
precision, 18, 23, 25 sites, 9, 10, 11, 12

printable guides, 30 opening, 13
Printable Guides command, 30 special characters, 7
properties, 18 strings, 18, 25
fields, 16, 19, 23 support, 29, 30
formats, 15, 16, 18, 19 technical support, 5
modifying, 18 text
text, 16, 19, 27 adding, 28
Properties command, 18, 26 appending, 17, 27
quitting,Format Manager, 13 editing, 27
readout, 18, 23, 25, 26 formats, 18
removing,formats, 16, 19, 22 inserting, 16, 17, 19
renaming,formats, 9, 21 properties, 16, 19, 27
reserved characters, 7 units of measure, 17, 18, 23, 25
Save command, 13 user access, 10, 11
saving, 13 user's guides, 30
servers, 9, 10, 11, 12 version numbers, 30

SmartPlant Format Manager Users Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

SmartPlant Format Manager Users Guide

Uploaded by

Copyright:

Available Formats

SmartPlant Format Manager

Version 4.4 July 2005 DPID2-PE-200011G

Restricted Rights Legend

Warranties and Liabilities

Using Format Manager: An Overview ............................................................................7

Navigating in Format Manager: An Overview ...............................................................9

Editing Format Properties: An Overview .....................................................................15

Using Help: An Overview................................................................................................29

SmartPlant Format Manager User’s Guide 3

4 SmartPlant Format Manager User’s Guide

Send documentation comments or suggestions to PPMdoc@ingr.com.

SmartPlant Format Manager User’s Guide 5

6 SmartPlant Format Manager User’s Guide

Using Format Manager: An Overview

• Letters of the alphabet,

SmartPlant Format Manager User’s Guide 7

8 SmartPlant Format Manager User’s Guide

Navigating in Format Manager: An Overview

Open Database Command

SmartPlant Format Manager User’s Guide 9

Open Plant Structure Dialog Box

10 SmartPlant Format Manager User’s Guide

Open Site Server Dialog Box

Up One Level - Navigates one level higher in the directory.

Create New Folder - Adds a new folder in the current directory.

SmartPlant Format Manager User’s Guide 11

12 SmartPlant Format Manager User’s Guide

Most Recently Used Sites Command

Close the Format Manager Software

SmartPlant Format Manager User’s Guide 13

14 SmartPlant Format Manager User’s Guide

Editing Format Properties: An Overview

Format Manager supports compound formats. A compound format is a combination

Add Format Command

SmartPlant Format Manager User’s Guide 15

Add Format Dialog Box

16 SmartPlant Format Manager User’s Guide

SmartPlant Format Manager User’s Guide 17

Define a Text Format

18 SmartPlant Format Manager User’s Guide

Edit Format Properties Dialog Box

SmartPlant Format Manager User’s Guide 19

20 SmartPlant Format Manager User’s Guide

Edit a Format Name

Edit Format Properties

SmartPlant Format Manager User’s Guide 21

22 SmartPlant Format Manager User’s Guide

Editing Field Properties: An Overview

Field Properties Dialog Box

SmartPlant Format Manager User’s Guide 23

24 SmartPlant Format Manager User’s Guide

SmartPlant Format Manager User’s Guide 25

Change Field Properties

26 SmartPlant Format Manager User’s Guide

Editing Text Properties: An Overview

Text Properties Dialog Box

SmartPlant Format Manager User’s Guide 27

28 SmartPlant Format Manager User’s Guide

Using Help: An Overview

The software offers the following important user-assistance features:

User Interface Features

SmartPlant Format Manager User’s Guide 29

Format Manager Help Command

About Format Manager Command