Schem SPI Enhanced Report Utility Users Guide
Schem SPI Enhanced Report Utility Users Guide
Schem SPI Enhanced Report Utility Users Guide
Version 2013
March 2013
DSPI2-PE-200014B
Copyright
Copyright © 2000-2013 Intergraph® Corporation. All Rights Reserved. Intergraph is part of Hexagon.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement;
contains confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade
secret law, and international treaty, and may not be provided or otherwise made available without proper authorization from
Intergraph Corporation.
U.S. Government Restricted Rights Legend
Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was
developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with
subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal
Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of
the United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS
252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.
Unpublished - rights reserved under the copyright laws of the United States.
Intergraph Corporation
P.O. Box 240000
Huntsville, AL 35813
Terms of Use
Use of this software product is subject to the End User License Agreement ("EULA") delivered with this software product unless
the licensee has a valid signed license for this software product with Intergraph Corporation. If the licensee has a valid signed
license for this software product with Intergraph Corporation, the valid signed license shall take precedence and govern the use
of this software product. Subject to the terms contained within the applicable license agreement, Intergraph Corporation gives
licensee permission to print a reasonable number of copies of the documentation as defined in the applicable license agreement
and delivered with the software product for licensee's internal, non-commercial use. The documentation may not be printed for
resale or redistribution.
Warranties and Liabilities
All warranties given by Intergraph Corporation about equipment or software are set forth in the EULA provided with the software
or applicable license for the software product signed by Intergraph Corporation, 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.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.
Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, SmartMarine, FrameWorks, I-Convert, I-Export, I-Sketch, IntelliShip, INtools,
ISOGEN, MARIAN, SmartSketch, SPOOLGEN, SupportManager, and SupportModeler are trademarks or registered trademarks
of Intergraph Corporation or its subsidiaries in the United States and other countries. Microsoft and Windows are registered
trademarks of Microsoft Corporation. MicroStation is a registered trademark of Bentley Systems, Inc. Other brands and product
names are trademarks of their respective owners.
Contents
Enhanced Report Utility .............................................................................................................................. 9
General Workflow When Working with the Enhanced Report Utility .................................................... 10
Features of the Enhanced Report Utility ............................................................................................... 11
Serial Fire and Gas Loops .................................................................................................................... 13
Using Enhanced Report Utility Help...................................................................................................... 13
You associate items with the layout that you define using the Enhanced Report Layouts
dialog box.
You can save bitmaps and redlining items other than straight lines, circles, and rectangles if
you make them part of a symbol.
Modifications such as saving to the database, redlining, macros, and SmartText are not
available for multi-strip reports.
For details of layout settings and so forth, refer to SmartPlant Instrumentation Online Help.
Create a Template
Templates are files that specify the sheet size and orientation of your reports. Several standard
drawing templates are supplied when you install the Enhanced Report Utility. You can use one
of these templates or customize your own.
For more information about customizing templates and choosing title blocks, see Create a
Custom Template (on page 16).
Define a Layout
Each report that you generate must be associated with an enhanced report layout. In a layout,
you choose the template and title block, report logo and other parameters that affect the
appearance of general report elements.
For more information, see Using Enhanced Report Layouts (on page 27).
disconnect switch
knife
fuse
Also, you can define your own terminal types and associate with
them symbols that you specify.
Display terminals by terminal The terminal sequence is fixed in accordance with the actual
sequence physical arrangement. Switching cable entries to a box changes
the cable alignment.
Display multiple drawing Where a drawing contains a large number of items, the software
sheets can generate several drawing sheets. You can move among the
sheets by means of the tabs or navigation arrows at the foot of the
drawing.
Wrap signals between Signals belonging to drawing items that extend over several lines
multiple 'lines' or sheets wrap over those lines. Off-sheet connectors indicate signals that
wrap over two sheets.
Display Plug and Socket The software uses a separate graphical representation for plug and
devices socket devices as opposed to standard connection devices.
Display CS tag / cabinet The software can display a dynamic matrix of attributes for Control
attributes System (CS) tags or cabinets. Editing the matrix is identical to
editing title block items. On the SmartPlant Instrumentation
Preferences dialog box, you specify whether to enable the matrix.
Indicate unwired instruments The software enables you to indicate on Enhanced SmartLoop
reports that the displayed loop includes unwired instruments. The
instruments appear separately in a dynamic matrix that is similar to
the CS tag matrix. On the SmartPlant Instrumentation
Preferences dialog box, you specify whether to enable the matrix.
Using Templates
Templates are files that determine the sheet size and orientation for enhanced reports. These
files have an .sma extension. The Enhanced Report Utility comes shipped with several
standard templates. These templates are located by default in the path: <SmartPlant
Instrumentation home folder>\RAD\Template.
The standard templates are:
The software automatically configures the page layout and orientation for your printer
according to the template you select.
Working with a larger template means that the drawing includes more details. The items
have fixed sizes that do not change relative to the sheet size.
This file contains the background sheet templates used for drawing generation.
Other Normal .sma files reside in the \Strip, \Telecom, \Fieldbus, \DCS, and \Cable
folders.
2. Click View > Working Sheets.
3. Click File > Sheet Setup.
4. Click the Size and Scale tab, if it is not already active.
5. Under Sheet size, do one of the following:
Click Standard, and then select a standard sheet size from the list.
Click Custom, and then type the required width and height of the sheet.
Do not change any of the settings on the Background tab.
6. Click View > Background Sheets.
7. Click Insert > New Sheet.
8. Click File > Sheet Setup.
9. Click the Size and Scale tab, if it is not already active.
10. Under Sheet size, select the same sheet size as you chose for the working sheet.
11. Click the Name tab.
12. In the Sheet name box, type a sheet name.
It is recommended that you type a sheet name that enables you to identify the sheet
size and orientation easily; for example, A4 Wide.
13. Click View > Fit.
14. Select a drawing sheet with a title block size similar to the background sheet that you intend
to create.
15. Click once anywhere on the background sheet and do one of the following:
Click CTRL + A.
Click Edit > Select All.
16. Do one of the following:
Click CTRL + C.
Click Edit > Copy.
17. Select the drawing sheet with the name that you have just inserted.
18. Click once anywhere on the background sheet and do one of the following:
Click CTRL + V.
Click Edit > Paste.
19. Click View > Fit.
20. On the main toolbar, right-click and ensure that on the shortcut menu, a check mark appears
beside Change. If no check mark appears, click Change.
21. Click once anywhere on the background sheet and do one of the following:
Click CTRL + A.
8. Place the cursor on the lower left corner of the title block and click.
9. On the Save As dialog box, type the desired title block name, and click Save.
Make sure that the title block name distinguishes the title block from other title blocks in
the selected folder, for example, A4wide, A4tall.
General
Name Description
plant_name or plnt_name Plant name
plant_UDF_C01 (up to C20) Plant UDF
area_name Area name
area_UDF_C01 (up to C20) Area UDF
sub_area_name Sub-area name
unit_name Unit name
unit_num Unit number
unit_note Note added for unit
unit_UDF_C01 (up to C20) Unit UDF
city City where plant is located
location Location of plant
Name Description
owner (owner_name) Owner name
domain_name (proj_name) Domain name
domain_desc (proj_desc) Domain description
eng_proj_name or proj_name Project name
(engineer_name)
eng_proj_desc or proj_desc Project description
(engineer_desc)
date Date of drawing generation
time Time of drawing generation
Up to 20 macros of each type can be used in a title block by adding the suffix _C01,
_C02, _C03, and so forth.
Only the Plant UDF macro can be used in the Hook-Up and Drawing title blocks, the
Area and Unit UDF macros do not function in Hook-Up and Drawing title blocks.
Loop
Name Value Description
loop_name Loop name
loop_serv Loop service
loop_note Loop note
ref_name 1..5 Loop drawing reference name (for
revisions 1 to 5)
ref_desc 1..5 Loop drawing reference description (for
revisions 1 to 5)
Telecom Line
Name Description
line_name (tc_line_number_name) Telecom line name
Telecom Class
Name Description
class_name (tc_net_cls_name) Telecom class name
Telecom Speaker
Name Description
cmpnt_name Telecom speaker name
cmpnt_note Telecom speaker note
Cable
Name Description
cable_name (cable_num) Cable name
cable_note Cable note
Cable Harness
Name Description
harness_name (cable_harness_name) Cable harness name
Location
Name Description
location_name (panel_loc_name) Panel location
Rack
Name Description
rack_name (cabinet_rack_name) Cabinet rack name
Hook-Up
Name Description
hu_name Hook-Up name
gen_output_file Hook-Up output file name
hu_udf_co1 (up to C20) Hook-Up user defined fields
Name Description
hu_type_desc Hook-Up description
plant_UDF_C01 (up to C20) Plant UDF
Drawing
Name Value Description
dwg_name Drawing name
dwg_desc Drawing description
dwg_num Drawing number
plant_UDF_C01 (up to C20) Plant UDF
cl_ck_by or cl_chk_by Client checked by
cl_ck_date or cl_chk_date Client checked date
cl_engr_by Client engineered by
cl_engr_date Client engineered date
cl_appr_by Client approved by
cl_appr_date Client approved date
ven_appr_by Vendor approved by
ven_appr_date Vendor approved date
ven_chk_by or ven_ck_by Vendor checked by
ven_ck_date or ven_chk_date Vendor checked date
ven_drwn_by Vendor drawn by
ven_drwn_date Vendor drawn date
ven_dsgn_by Vendor design by
ven_dsgn_date Vendor design date
ven_prop_by Vendor proposed by
ven_prop_date Vendor proposed date
loop_func (loop_func_name) Loop function
dwg_udf_c01... - Drawing user- defined
...dwg_udf_c102 character fields
loop_udf_c01... - Loop user-defined
...loop_udf_c50 character fields
curr_rev_name (current 1 Current revision name
revision number)
pid_name P&ID drawing name
Revisions
These macros have the structure [Macro_name.x.f1] where x is the revision number (max.value
=5), and f1 is the abbreviation for a user-defined function (optional).
7. Click on the drawing sheet in the desired location to add the label.
8. To further edit the appearance of the label, click the Select Tool .
9. Right-click the label and on the shortcut menu, click Properties.
10. On the Text Box Properties dialog box, modify other label properties as desired, for
example, the text color.
You can double-click the label to view the .xml code used to specify the property.
Displaying Logos
You can add a user-defined logo for enhanced reports. Adding a logo involves several
operations. First, in the Enhanced Report Utility, you create a file with a .sym extension for use
as a logo. Next, in SmartPlant Instrumentation, on the Preferences dialog box, you define the
default layout settings and specify the file path and name of the logo .sym file. Then, in the
Enhanced Report Utility, you open the default title block and position the logo as you require.
The software links the logo to the designated position when you generate enhanced reports for
items that belong to the default layout.
See Also
Place a Logo on an Enhanced Report (on page 26)
You can define the report type template either in the report layout or on the SmartPlant
Instrumentation Preferences dialog box, under Enhanced Reports > File Paths for the
particular report type.
If your template contains a default title block, the title block displays the default
logo. Before placing a user-defined logo, select the default logo and press the Delete
key.
3. Place an empty text box in place of the deleted logo.
The top-left x and y coordinates of the text box are also the top-left coordinates of your
logo.
4. Select and then right-click the text box.
5. On the shortcut menu, click Properties.
6. Click User.
7. In the Name box, type Logo.
8. Click Add and then click Save.
9. Specify the logo file path on the SmartPlant Instrumentation Preferences dialog box.
Delete a Logo
1. On the Windows Taskbar, click Start > Programs > Intergraph SmartPlant
Instrumentation > Enhanced Report Utility.
2. Do one of the following:
Click File > Open and navigate to the title block .sym file.
In the Windows Explorer, double-click the title block .sym file.
3. In the title block, select the text box you have defined for linking the logo when generating a
drawing.
For the standard logo supplied with the title block, select the logo bitmap.
4. Press the Delete key.
See Also
Place a Logo on an Enhanced Report (on page 26)
You can assign an enhanced report layout to more than one item; however, each item can
be assigned to only one layout.
If you do not define any layouts, the software automatically assigns the default layout
settings to all the selected items. You can modify the default layout settings on the
Preferences dialog box per report type.
You can edit, duplicate, or delete existing user-defined enhanced report layouts, other than
default layouts.
If you duplicate an enhanced report layout, the software duplicates in the target layout any
attributes that apply at the layout level such as macros and redlining defined per layout.
You can also create custom layouts that contain custom symbols. For more information, see
Creating a Custom Layout with Custom Symbols (see "Creating a Custom Layout with User
Defined (customized) Symbols" on page 70).
For more information on items that are saved at the Layout level, see Enhanced Report
Utility (on page 9) .
Do not drag items from the Domain Explorer or Reference Explorer of SmartPlant
instrumentation to an Enhanced Report Utility drawing.
The Enhanced Report Utility does not support the duplication of items in the Reference
Explorer or Domain Explorer, or the dragging of items from the Reference Explorer to the
Domain Explorer.
The Domain Explorer or Reference Explorer referenced in the Enhanced Report Utility
documentation refers only to the Enhanced Report Utility explorers (unless otherwise stated
in the documentation).
For a visual comparison of these options, see Setting the Wiring Representation (on
page 36).
8. Beside the Template file name and path field, click Browse and navigate to the desired
layout template file and path.
9. Beside the Title block file name and path field, click Browse and navigate to the desired
title block file and path.
10. Click the View tab and select the desired options.
11. Click OK to return to the Enhanced Report Layouts dialog box.
The alignment options apply only when you use a symbol file (.sym) for the title
block. They do not apply when you use the normal.sma template, which already
includes a title block.
The alignment specifies the location of the title block origin. Shipped title blocks
have their origin at the bottom left corner, and it is recommended that you specify
this position for the origin of any custom title blocks that you create.
The alignment of the title block has no effect on its orientation. The design of the
title block symbol is what determines its orientation.
6. In the Drawing area relative to title block list, select an option to specify where the
drawing area should be located in relation to the title block.
Click Reset to specify the default settings (all four margins set to 20 twips).
When you set the working area margins, the defined area includes the title block. The
software generates the drawing starting from the top left corner at the position relative to the
title block that you specified on the Title Block tab.
If any drawing elements extend beyond the right and bottom limits of the working area,
those elements are displayed on a new sheet.
The working area margins define the initial page margins during drawing generation
only. Once you have generated a report, you can modify it anywhere on the sheet,
including the region defined beyond the working area.
Diagonal Representation
Orthogonal Representation
Click Yes to open the print preview of the generated report. Choose this option if you
want to modify or annotate the report.
Click No to start printing the report without displaying its print preview.
On the General page of the Preferences dialog box, you can set the software to display a
print preview always, never or with your approval.
The Enhanced Report Utility prints PDFs using SmartPlant PDF Converter 4.51 and
publishes them to the output folder specified in File > Preferences > Enhanced Reports >
<Report Type> >Viewer Output Folder field for the specific report type. If no path is
present then SmartPlant PDF Converter 4.51 publishes the PDF to the Temp folder as
specified in File > Preferences > General.
Click No to start printing the report without displaying its print preview.
On the General page of the Preferences dialog box, you can set the software to display a
print preview always, never or with your approval.
SmartPlant PDF Converter 4.51 publishes PDFs to the output folder specified in File >
Preferences > Enhanced Reports > <Report Type>> Viewer Output Folder field for the
specific report type. If no path is present then SmartPlant PDF Converter 4.51 publishes
the PDF to the Temp folder as specified in File > Preferences >General. For Specification
Sheets, set the path in the Print Specs to PDF Files dialog box. For Document Binder
packages, set the path in the Print to file dialog box.
If, in the Enhanced Report Utility, you save custom changes for this report, the software
does not save changed positions of items on the drawing sheet.
On the General page of the Preferences dialog box, you can set the software to display a
print preview always, never or with your approval.
SmartPlant PDF Converter 4.51 publishes PDFs to the output folder specified in File >
Preferences > Enhanced Reports > <Report Type>> Viewer Output Folder field for the
specific report type. If no path is present then SmartPlant PDF Converter 4.51 publishes
the PDF to the Temp folder as specified in File > Preferences >General. For Specification
Sheets, set the path in the Print Specs to PDF Files dialog box. For Document Binder
packages, set the path in the Print to file dialog box.
3. On the Panel-Strip Selection dialog box, type values in the fields under Search
parameters if you need to find panels that meet a specific set of criteria.
4. Click Find to display the strips.
5. Highlight one or more strips (hold down CTRL for multiple selections).
The software requires a large amount of memory to display graphical items in
enhanced report previews. For this reason, we recommend that you do not select a large
number of strips at once for previewing reports.
6. Click Print, and at the preview prompt, do one of the following:
Click Yes to open the print preview of the generated report. Choose this option if you
want to modify or annotate the report.
Click No to start printing the report without displaying its print preview.
On the General page of the Preferences dialog box, you can set the software to display a
print preview always, never or with your approval.
If you select not to preview a report, and you are using Acrobat Distiller as your default
printer, make sure that Distiller is configured to enable report generation without prompting
for the output file location. To do this, open the Distiller Preferences dialog box and under
Output Options, clear the check boxes Ask for PDF file destination and Ask to replace
existing PDF file.
On the General page of the Preferences dialog box, you can set the software to display a
print preview always, never or with your approval.
SmartPlant PDF Converter 4.51 publishes PDFs to the output folder specified in File >
Preferences > Enhanced Reports > <Report Type>> Viewer Output Folder field for the
specific report type. If no path is present then SmartPlant PDF Converter 4.51 publishes
the PDF to the Temp folder as specified in File > Preferences >General. For Specification
Sheets, set the path in the Print Specs to PDF Files dialog box. For Document Binder
packages, set the path in the Print to file dialog box.
See Also
Generate an Enhanced Panel-Strip Report (on page 41)
On the General page of the Preferences dialog box, you can set the software to display a
print preview always, never or with your approval.
If you select not to preview a report, and you are using Acrobat Distiller as your default
printer, make sure that Distiller is configured to enable report generation without prompting
for the output file location. To do this, open the Distiller Preferences dialog box and under
Output Options, clear the check boxes Ask for PDF file destination and Ask to replace
existing PDF file.
On the General page of the Preferences dialog box, you can set the software to display a
print preview always, never or with your approval.
If you select not to preview a report, and you are using Acrobat Distiller as your default
printer, make sure that Distiller is configured to enable report generation without prompting
for the output file location. To do this, open the Distiller Preferences dialog box and under
Output Options, clear the check boxes Ask for PDF file destination and Ask to replace
existing PDF file.
On the General page of the Preferences dialog box, you can set the software to display a
print preview always, never or with your approval.
If you select not to preview a report, and you are using Acrobat Distiller as your default
printer, make sure that Distiller is configured to enable report generation without prompting
for the output file location. To do this, open the Distiller Preferences dialog box and under
Output Options, clear the check boxes Ask for PDF file destination and Ask to replace
existing PDF file.
Click No to start printing the report without displaying its print preview.
On the General page of the Preferences dialog box, you can set the software to display a
print preview always, never or with your approval.
If you select not to preview a report, and you are using Acrobat Distiller as your default
printer, make sure that Distiller is configured to enable report generation without prompting
for the output file location. To do this, open the Distiller Preferences dialog box and under
Output Options, clear the check boxes Ask for PDF file destination and Ask to replace
existing PDF file.
If, in the Enhanced Report Utility, you save custom changes for this report, the software
does not save changed positions of items on the drawing sheet.
On the General page of the Preferences dialog box, you can set the software to display a
print preview always, never or with your approval.
If you select not to preview a report, and you are using Acrobat Distiller as your default
printer, make sure that Distiller is configured to enable report generation without prompting
for the output file location. To do this, open the Distiller Preferences dialog box and under
Output Options, clear the check boxes Ask for PDF file destination and Ask to replace
existing PDF file.
On the General page of the Preferences dialog box, you can set the software to display a
print preview always, never or with your approval.
If you select not to preview a report, and you are using Acrobat Distiller as your default
printer, make sure that Distiller is configured to enable report generation without prompting
for the output file location. To do this, open the Distiller Preferences dialog box and under
Output Options, clear the check boxes Ask for PDF file destination and Ask to replace
existing PDF file.
Using Filters
In an Enhanced SmartLoop report, you can create one or more filters for filtering macros and
redlining for an item, according to selected properties of the item.
To create a new filter, click beside the Filter list to open the Item Filters dialog
box, where you can define a set of filters for the selected item For details, see Create
Filters for Items (on page 47).
5. Click Edit to enable access to the command buttons on the right.
When clicked, the Edit button changes to Apply.
6. Click Add to append a new data row.
7. From the Property column, select one of the item properties.
If the property that you are looking for does not appear in the list, select Display
browser list, and in the Browser list that appears in the data window, select another
browser.
In addition to the standard browsers, you can add a PowerSoft browser and configure it
for use with enhanced reports. For details, see SmartPlant Instrumentation Online
Help > Browser Views and Browser Manager > Adding New Browsers > Adding New
Browsers Common Tasks > Add a PowerSoft Browser.
8. To define an appropriate conditional expression for the filter, click the Operator data field
and select a suitable operator to determine how the selected field will relate to the
expression in the Value field.
9. In the Value field, do one of the following:
Select a value from the list of values registered in SmartPlant Instrumentation for the
selected field.
Type a text field value.
10. Depending on whether you want to add another filtering condition, in the Logic data field, do
one of the following:
Leave the Logic field empty if you have defined only one filtering condition.
Click the Logic field and select either And or Or if you have defined several filter
conditions. Selecting And includes the next expression in the filtering
condition. Selecting Or accepts either the previous or the next expression in the
filtering condition.
11. Click Verify to check the validity of the current filtering condition.
Using SmartText
In the Enhanced Report Utility, you can add SmartText to a drawing sheet. Each time you
generate an enhanced report for a particular item, the text is retained on the drawing.
You can define SmartText properties, such as font, size, underlining, alignment in the text box,
and rotation. Also, you can create a watermark using SmartText and display a SmartText item
on any specific drawing sheet, or on all the drawing sheets in a report.
Add SmartText
1. Click Actions > SmartText > New.
You can also access this command by clicking New SmartText on the Actions
toolbar.
2. Click the General tab.
3. Type text in the Caption box, if required.
You can type an unlimited number of lines with up to 28 characters in each line.
4. Select Set as watermark if you want to define the text as a watermark that appears in a
layer below other drawing items.
5. Under Textbox display, do one of the following:
Click Current sheet to display the SmartText item on the current drawing sheet only.
Click All sheets to display the SmartText item on all the sheets of the drawing.
If you choose All sheets, you only need to edit the SmartText properties on one of the
sheets, and the software applies the changes to all the other sheets.
6. Click the Text tab to define the text properties such as font, font size, rotation, and
orientation.
7. Click a blank area on the drawing sheet to position the text box.
8. Click File > Save Custom Changes.
Edit SmartText
1. Select a text box.
2. Click Actions > SmartText > Properties.
You can also access this command by clicking SmartText Properties on the
Actions toolbar.
3. Click the General tab.
4. Edit the text in the Caption box as required.
You can type an unlimited number of lines with up to 28 characters in each line.
5. Click the Text tab.
6. Click Font to open a dialog box where you can specify the text font, font style, size, color,
and other properties.
The default font, font style, and size are determined in the Preferences dialog box in
SmartPlant Instrumentation per enhanced report type; the default font color is
Black. Note that if you select a default font other than a TrueType font (indicated by a
TT symbol), the Enhanced Report Utility displays all SmartText with a yellow-green font,
regardless of any subsequent change you try to make to the font color in the Enhanced
Report Utility.
The Strikeout effect does not work with SmartText.
7. In the Horizontal and Vertical lists, select options to align text within the text box
boundaries.
8. Select Show Border if you want to display the text box border.
9. In the Rotation box, do one of the following:
Enter a positive value in degrees to rotate the text counter-clockwise (CCW).
Enter a negative value in degrees to rotate the text clockwise (CW).
You can enter values that include decimals, such as 22.5°.
10. In the Orientation list, select a text box orientation.
In the vertical orientation, the software rotates the letters 45° CCW.
11. Click File > Save Custom Changes.
You can also click Save Custom Changes on the Main toolbar.
Delete SmartText
1. Select a SmartText item.
You can only select and delete one SmartText item at a time. The font and border
color of the item change when you select the SmartText.
2. Click Actions > Delete SmartText.
You can also access this command by clicking Delete SmartText on the Actions
toolbar.
You should always use this method, and not the Delete key, to delete all the
occurrences of a SmartText item that appears on several sheets of a multiple sheet
report.
3. Click File > Save Custom Changes.
You can also access this command by clicking Save Custom Changes on the
Main toolbar.
When you delete a SmartText item, it is not pasted to the Clipboard and cannot be
reinserted. However, you can restore a SmartText item by immediately using Undo.
Using Macros
You can add macros to standard items in enhanced reports. Standard items are drawing items
that automatically appear on a generated enhanced report, such as panels, strips, terminals,
cables, cable sets, wires, ports, and pins. You can select a standard item and define a macro
for all occurrences of such an item on the sheet. Alternatively, you can select a macro filter to
assign a macro only to the selected item.
Also, you can attach a label to the left of a macro on a sheet. The software associates the
attached label in the database with this particular macro and attaches the label to all
occurrences of the macro on the sheet.
Adding a macro involves the following:
Selecting a standard macro type.
Selecting a macro name associated with this macro type.
Applying a filter to the macro, if needed.
Defining the macro text properties such as font, size, alignment in the text box, and rotation.
Attaching a label to the macro, if needed.
Defining the label text properties.
When you modify or move a macro for an item, it affects all occurrences of that item on the
sheet, unless a filter is used, in which case only those items to which the filter applies are
affected.
For items that have left and right sides, such as apparatus terminals and wires, when you
modify or move a macro for such an item, the action applies only to the corresponding side
for all the items that are defined by the specific macro or filter.
If, for a default macro such as a panel name, you define a filter that hides a particular macro,
a dot appears in place of the macro. The dot is needed to allow editing of the macro filter,
adding new macros to the item associated with the hidden macro, or editing of the item. If
you want to hide the dots, for example when printing the report or saving it in a different
format, you need to define the parameter HideEntities = Y in the Smartloop.ini file.
See Also
Add a Macro or a Macro Label to a Drawing Sheet (on page 54)
The macro position is fixed relative to the corresponding item so that if you move the
item, the macro moves with it; however, you can move the macro independently by using
the Move Macro command.
11. Click File > Save Custom Changes.
You can also access this command by clicking Save Custom Changes on the Main
toolbar.
See Also
Add a Macro or a Macro Label to a Drawing Sheet (on page 54)
Name Description
calib_range_max Maximum calibration range
calib_range_min Minimum calibration range
calib_range_uflg_max Absolute / Gage flag for
maximum calibration range
calib_range_uflg_min Absolute / Gage flag for
minimum calibration range
calib_range_uom_max Units of measure for maximum
range
calib_range_uom_min Units of measure for minimum
range
capacitance Capacitance
capacitance_uom Units of measure for capacitance
chg_date Change date
chg_status Change status
cmpnt_drawing_seq Tag drawing sequence
cmpnt_find_rem Tag note / remarks indication
cmpnt_mfr_name Tag manufacturer name
cmpnt_mod_name Tag model name
cmpnt_name Tag name (for example:
101-FT-100)
cmpnt_num Tag number (for example: 100)
cmpnt_quality_flg Tag quality
cmpnt_seq Tag sequence
cmpnt_serv Tag service
cmpnt_suff Tag number suffix
cmpnt_type_id Component type
dcs_range_max Maximum DCS range
dcs_range_min Minimum DCS range
dcs_range_uflg Absolute / Gage flag for DCS
range
dcs_range_uom Units of measure for DCS range
Name Description
inst_range_max Maximum instrument range
inst_range_min Minimum instrument range
inst_range_uflg_max Absolute / Gage flag for
maximum instrument range
inst_range_uflg_min Absolute / Gage flag for
minimum instrument range
inst_range_uom_max Units of measure for max.
instrument range
inst_range_uom_min Units of measure for min.
instrument range
item_price Item price
load_watt Load value
loop_name Loop name (for example:
101-F-100)
loop_num Loop number (for example: 100)
loop_serv Loop service
loop_trans_name Loop internal name
old_cmpnt_name Old tag number
pipe_class Pipe class
prefix Prefix
req_no Requisition number
spec_cmpnt_mounting Mounting
spec_cmpnt_po_item_no Purchase order item number
spec_cmpnt_po_no Purchase order number
spec_cmpnt_power_supply Power supply
spec_cmpnt_price Price
spec_cmpnt_sn Tag serial number
tag_trans_name Tag internal number
tc_fire_area Typical tag fire area
tc_location_layout Typical tag location
type_gen Drawing generation method
user_name User name
udf_c01... - ...c135 Character custom fields 1- 135
udf_n01... - ...n10 Number custom fields 1-10
Name Description
udf_d01... - ...d05 Date custom fields 1-5
udt_support_id1 Custom table 1
udt_support_id2 Custom table 2
udt_support_id3 Custom table 3
udt_support_id4 Custom table 4
To enable generation of Location Layout, Panel Layout, and Rack Layout reports, you must
specify on the Preferences dialog box the correct path on the File Locations page for the
particular report under Symbol folder.
To enable generation of Enhanced SmartLoop and Fieldbus Loop reports using the Custom
by Loop or Custom by Signal generation methods, you must specify on the Preferences
dialog box the correct path on the File Locations page for the particular report under
Custom symbol folder.
A shipped title block (.sym file) is available for each Layout report. You can modify these
title blocks according to your needs. For details, see Customize a Title Block (on page 19).
SmartPlant Instrumentation and the SmartPlant Enhanced Report Utility, store symbols used by
the application in two folders, the Symbols folder and the Custom folder. After installing the
application these folders can be found in the SmartPlant home folder > Instrumentation >
Rad > Symbols (> Custom).
The Symbols folder contains all the symbols supplied with the application that are used for the
generation of regular mode reports. The Custom folder (found in the Symbols folder) holds all
those symbols supplied with the application that are used for the generation of custom mode
reports. These custom symbols, are called custom symbols because they are for use with
custom generation mode reports and not because they were created or edited (customized) by
the user. Custom mode reports include the following;
Custom mode Loop Drawings
Custom mode Fieldbus Loop reports
Location Layout reports
Panel Layout reports
Rack Layout reports
Profibus reports
Hook-Up reports
Cable-Block Diagram reports
Generally, when saving a symbol that is required for use in a regular mode generated report,
store the symbol in the Symbols folder, for a symbol required for use in a custom mode
generated report, store the symbol in the Custom folder.
The paths for these folders are set by the user in the SmartPlant Instrument preferences under
Enhanced Reports > Enhanced SmartLoop > File Locations. These paths are saved as
relative paths with the symbols. For example, if the preferences is set to
C://Programfiles/SmartPlant/Instrumentation/RAD/Symbols and the symbol has the path
C://Programfiles/SmartPlant/Instrumentation/RAD/Symbols/MyTerminal.sym, then
MyTerminal.sym becomes the relative path, if the symbol was in the Custom folder, for
example
C://Programfiles/SmartPlant/Instrumentation/RAD/Symbols/Custom/MyTerminal.sym, the
relative path would be Custom/ MyTerminal.sym.
This rule also applies to symbols you create or edit using the Symbol Editor. If you use an
existing symbol to create a user defined symbol (customized) then save it to the Symbols folder
if you want to use the user defined symbol in regular mode, or to the Custom folder for use with
the custom mode generation method. If you create a new symbol in Symbol Editor for use with
regular mode drawings and reports then save the symbol in the Symbols folder, for use with
custom mode drawings and reports then save the symbol in the Custom folder. If you want to
use the symbol in both regular mode and custom mode, then save the symbol in both folders.
Software tags and Off Page Connectors (OPC) drawing-to drawing symbols, act slightly
different than regular or user defined symbols. These symbols are normally saved according to
the saved drawing generation method. For example, a regular mode generated loop drawing,
that has Software tags or OPC symbols dragged from the Symbol Explorer and associated on
the drawing, after saving the loop the symbols are saved to the (regular mode) Symbols folder.
Regenerating the loop retrieves the Software tags and OPC symbols from the Symbols folder.
If the generation method is custom then the Software and OPC symbols are saved, with a path
relative to, and retrieved from the Custom (mode) symbols folder. If for some reason the
symbols are moved from their folder, the software cannot retrieve them and display them on
your drawing.
When dragging items, from the Domain Explorer, that have Software or OPC tags associated
with the item, the application sets the symbols relative path according to the generation method.
If the generation method is regular the application sets the symbol path to the Symbols folder. If
the generation method is custom the application sets the symbol path to the Custom folder.
After saving and regeneration of the drawing, the application looks for the Software and OPC
symbols in the Custom (mode) symbols folder, unless the symbol was saved with its full path.
When saving Software or OPC symbols with a regular mode generated drawing, the
application changes the relative path of the symbols to the full path, so that on regeneration
of the drawing the symbols can be found
If the software tags are associated with Software tag symbols through their properties, and
the Software tag symbols reside in the Symbols folder and not in the Custom symbols
folder, then the symbols will not appear after regeneration, regardless of the generation
mode.
In order to always see the Software or OPC tag symbols on your drawing, you can place a
copy in the Symbols and Custom folder, this way the application always finds the symbol
irrespective of the generation method.
It is recommended that the Symbols folder contain symbols for the following types of reports:
Panel-Strip
Wiring Connections
Strip Signals
Multi Strips
Panel Signals
Harness
Symbols that are associated with component function types (Set in the Instrument Index
module > Instrument Types > Instrument Type Profile > Enhanced SmartLoop symbol)
should be stored in the Symbols folder.
Special panel symbols for Device panels (regular and plug and socket), Field device (regular
and plug and socket), Multi-Input and Multi-Input plug and socket, should be stored in the
Symbols folder.
User defined terminal type symbols should be stored in the Symbols folder:
The following symbols are stored in the Symbols folder:
Loop drawing reference symbols:
LoopDwgRefDetail.sym
LoopDwgRefHeader.sym
The DCS detail symbol (DcsDetail.sym) and the DCS header symbols (primary
DcsHeader.sym and secondary SecDcsHeader.sym).
Redlining symbols (regardless of generation method) and Cloud symbols for the Drawing
Comparison command (Cloud.sym, and CloudText.sym).
It is recommended that the Custom folder contain symbols for the following types of reports:
Rack Layout
Panel layout
Location Layout
Profibus
Custom mode Loop Drawings
Custom mode Fieldbus Loop reports
Profibus reports
Hook-Up reports (except for the following Hook-Up tag and list symbols;
HookUpItemListDetail.sym, HookUpItemListHeader.sym, HookUpTagListDetail.sym,
HookUpTagListHeader.sym, and LeftListPosition.sym.)
Cable-Block Diagram
The default symbols used for custom Enhanced SmartLoop reports should be stored in the
Custom folder. These are, FirstPin.sym, FirstTerminal.sym, Pin.sym, and Terminal.sym.
Symbols associated with the Associate Symbol command in the Enhanced Report drawings
are saved in the Custom folder. For example, Software tag symbols, OPC symbols, and
symbols associated with dynamic panels, dynamic strips, and dynamic connectors.
Symbols associated with Enhanced reports through the properties of an item (Associate
Symbols tab) should reside under the Custom folder.
The Origin point symbol (Origin.sym) is stored in the Custom folder.
You can associate each item with one symbol only per available report type.
You can associate the same symbol with more than one item if you desire.
When using custom terminal symbols in enhanced reports, there are two ways of displaying
the terminals on the drawing sheet:
Associating a symbol with a panel, where the symbol exactly represents the
panel-strip-terminal configuration, and dragging the panel onto the drawing sheet. With
this method, the software displays the entire panel.
Associating a symbol with each individual terminal and dragging the desired terminals
onto the drawing sheet. With this method, the software displays the selected terminals
with their associated strips and panels, together with the appropriate macros.
For more information on items that are saved at the Layout level, see Enhanced Report
Utility (on page 9).
Do not drag items from the Domain Explorer or Reference Explorer of SmartPlant
instrumentation to an Enhanced Report Utility drawing.
The Enhanced Report Utility does not support the duplication of items in the Reference
Explorer or Domain Explorer, or the dragging of items from the Reference Explorer to the
Domain Explorer.
The Domain Explorer or Reference Explorer referenced in the Enhanced Report Utility
documentation refers only to the Enhanced Report Utility explorers (unless otherwise stated
in the documentation).
The print preview prompt appears according to the settings in the Preferences dialog
box, on the General page.
The software automatically displays each rack belonging to the panel in a position
specified by the value of the rack's Sequence property.
6. If you have moved any symbols that were already on the drawing, click File > Save Custom
Changes.
You can apply this procedure in a similar way to create a Rack Layout report showing racks
with associated cards.
Do not drag items from the Domain Explorer or Reference Explorer of SmartPlant
instrumentation to an Enhanced Report Utility drawing.
The Enhanced Report Utility does not support the duplication of items in the Reference
Explorer or Domain Explorer, or the dragging of items from the Reference Explorer to the
Domain Explorer.
The Domain Explorer or Reference Explorer referenced in the Enhanced Report Utility
documentation refers only to the Enhanced Report Utility explorers (unless otherwise stated
in the documentation).
When using custom terminal symbols in enhanced reports, there are two ways of displaying
the terminals on the drawing sheet:
a. Associating a symbol with a panel, where the symbol exactly represents the panel-
strip-terminal configuration, and dragging the panel onto the drawing sheet. With this
method, the software displays the entire panel.
b. Associating a symbol with each individual terminal and dragging the desired terminals
onto the drawing sheet. With this method, the software displays the selected terminals
with their associated strips and panels, together with the appropriate macros.
If you choose to display a wiring item that includes standard terminals and no suitable
custom symbol is associated with that item, the software uses the symbol FirstTerm.sym as
the default symbol for the first terminal in a group of terminals, and the symbol Term.sym for
all subsequent terminals - provided that these symbols already exist in the custom symbol
folder specified in the SmartPlant Instrumentation Preferences dialog box for the Enhanced
SmartLoop report. FirstTerm.sym includes macros for the panel, strip, and terminal;
Term.sym includes macros for the terminal only.
Do not drag items from the Domain Explorer or Reference Explorer of SmartPlant
instrumentation to an Enhanced Report Utility drawing.
The Enhanced Report Utility does not support the duplication of items in the Reference
Explorer or Domain Explorer, or the dragging of items from the Reference Explorer to the
Domain Explorer.
The Domain Explorer or Reference Explorer referenced in the Enhanced Report Utility
documentation refers only to the Enhanced Report Utility explorers (unless otherwise stated
in the documentation).
See Also
Creating Enhanced Reports with User Defined (customized) Symbols (on page 61)
The preference Save custom symbol with layout must be selected. This preference is
found in SmartPlant Instrumentation under File > Preferences > Enhanced Reports >
Enhanced SmartLoop (or Fieldbus Loop) > View.
The sequence of items in subsequent drawings must be the same as the original drawing on
which the layout is based. For example, if the original drawing contained a junction box, 2
marshalling racks, and a DCS cabinet in this order, the new drawing must have the same
number of items for the user defined (customized) symbols to appear in their correct
positions.
1. Assign the loop to the layout that contains the user defined (customized) symbols. For more
information, see Assign a Layout to Enhanced Report Items (on page 32).
2. Generate the loop drawing. The drawing opens using the positions and symbols saved in
the assigned layout.
If the loop drawing has already been saved at the drawing level, the symbols displayed will
be those saved with the loop drawing and not the user defined (customized) symbols saved
with the custom layout.
If the loop drawing already contains user defined (customized) symbols, these user defined
(customized) symbols will be displayed and not those saved with the layout.
The generated loop must be of type Custom by Loop or Custom by Signal
2. Drag and drop the required symbol onto the drawing (the position on the drawing is not
important) and then associate the symbol with the required item in the Domain Explorer.
3. Use the Symbol Position command to set the Row and Column attributes, in our example
Row 2, Column 3.
4. Close and then reopen the Symbol Position dialog box, the dialog box now displays the
position of the symbol.
5. Use the Save Custom Changes command to save the drawings settings.
6. Open any drawing assigned to this layout that has an item assigned to Row 2, Column
3. The item is displayed in the exact position of the symbol in step 2.
Do not drag items from the Domain Explorer or Reference Explorer of SmartPlant
instrumentation to an Enhanced Report Utility drawing.
The Enhanced Report Utility does not support the duplication of items in the Reference
Explorer or Domain Explorer, or the dragging of items from the Reference Explorer to the
Domain Explorer.
The Domain Explorer or Reference Explorer referenced in the Enhanced Report Utility
documentation refers only to the Enhanced Report Utility explorers (unless otherwise stated
in the documentation).
The connection point of the terminal becomes highlighted as you move the mouse
pointer over it.
The Side 1 wire end is connected to the first terminal that you select.
6. Click the second terminal connection point to which you want to connect the wire.
After you have made the wire connections, the newly-connected wire is displayed.
Do not drag items from the Domain Explorer or Reference Explorer of SmartPlant
instrumentation to an Enhanced Report Utility drawing.
The Enhanced Report Utility does not support the duplication of items in the Reference
Explorer or Domain Explorer, or the dragging of items from the Reference Explorer to the
Domain Explorer.
The Domain Explorer or Reference Explorer referenced in the Enhanced Report Utility
documentation refers only to the Enhanced Report Utility explorers (unless otherwise stated
in the documentation).
Update an Assembly
An assembly is a symbol created by combining a number of symbols to form one symbol. After
making changes to a symbol that is a component of an assembly symbol, the changes are not
automatically displayed in the assembly symbol. You must run the Update Assembly
Command for the changes made to the component symbol to become part of the assembly
symbol.
This procedure cannot be reversed! It is advisable to make a backup of your symbols before
proceeding with updating the assembly.
The Update Assembly Command checks the assembly's component symbols for changes
in their original source folder. If you have copied the component symbols to another folder or
drive, for example from you C: drive to a network drive so that other users have access to
the symbols, and made changes to the copied component symbols, then the changes are
not updated in the assembly. You must delete the original symbols from their source folder
for the Update Assembly Command to update the copied symbols, or make your changes
to the original symbols.
1. Make the required changes to the component symbols, not to the assembly, and save them.
2. Click Tools > Customize.
3. On the Customize dialog box, click the Toolbars tab.
4. In the Categories pane, select Custom Commands.
5. Do one of the following:
From the Custom Commands pane, select the UpdateAssemblyCmnd90.dll.
Click Browse to locate the RAD folder installed in the SmartPlant Instrumentation
installation folder, click OK and then select the UpdateAssemblyCmnd90.dll.
6. Drag the UpdateAssemblyCmnd90.dll.to the toolbar.
7. On the Custom Button dialog box select a button to assign to the
UpdateAssemblyCmnd90.dll.
8. Click Assign.
9. Click Close on the Customize dialog box.
10. Click the Update Assembly Command button
11. On the Update Assembly dialog box, navigate to the folder where you saved the
component symbol.
12. Do one of the following:
From the Select file pane, select the symbols you want to update.
Click Select all to select all the symbol files.
13. Click OK.
You must close and re-open the drawing to view the changes made to the assembly.
You can add the Update Assembly Command to your toolbar by clicking Tools >
Customize and from the Customize dialog box selecting the UpdateAssemblyCmnd90.
Associate an Item with a User Defined Symbol on a Drawing Sheet (on page 65)
7. Do one of the following:
Click .
Click Actions > Generate Item Reports.
8. In the Generate Item Reports dialog box select Loop or Fieldbus Loop.
9. Click OK, the loop drawing associated with the OPC is generated in the Enhanced Report
Utility.
After adding and associating an OPC to your drawing, the drawing is automatically saved at
the drawing level. Any changes made after associating the OPC should be saved using the
Save Custom Changes command.
A loop that has an OPC associated with it and has been saved at the layout level, looses the
OPC association if the loop is assigned to another layout. Even if the loop is then reassigned
to the original layout, clicking the OPC just results in a blank drawing being generated.
When working in As-Built/project, you cannot associate an OPC between a drawing in the
As-Built and a drawing in a project.
See also
Remove a Custom Symbol from a Drawing Sheet (see "Remove a User Defined Symbol from a
Drawing Sheet" on page 66)
9. Click OK, the loop drawing associated with the OPC is generated in the Enhanced Report
Utility.
After adding and associating an OPC to your drawing, the drawing is automatically saved at
the drawing level. Any changes made after associating the OPC should be saved using the
Save Custom Changes command.
A loop that has an OPC associated with it and has been saved at the layout level, looses the
OPC association if the loop is assigned to another layout. Even if the loop is then reassigned
to the original layout, clicking the OPC just results in a blank drawing being generated.
When working in As-Built/project, you cannot associate an OPC between a drawing in the
As-Built and a drawing in a project.
See also
Remove a Custom Symbol from a Drawing Sheet (see "Remove a User Defined Symbol from a
Drawing Sheet" on page 66)
Naming OPCs
A unique name, consisting of the OPCs target loop drawing name, is given automatically to an
OPC when the following criteria are met:
In the Symbol Editor when creating your OPC symbol, you selected OPC text box on the
General tab of the SmartText Properties dialog box.
The OPC has been associated with a loop drawing.
You can edit the OPC name by doing the following:
1. Open the loop drawing that contains the OPC you want to add text to.
2. Select the OPC and do one of the following.
Click .
Click Actions > Off Page Connectors > OPC Label Text.
3. On the General tab of the OPC Label Text dialog box, in the OPC name field, type the text
you want to appear in the OPC name.
You can delete the automatically generated name, or add your text after the generated
name.
The OPC name field can hold up to 50 characters.
4. Click OK, the OPC name now appears when you pair the OPC in the Select Pair
OPC dialog box.
Click .
Click Actions > Off Page Connectors > OPC Label Text.
3. On the General tab of the OPC Label Text dialog box, under Text, type the text you want to
appear in the OPC Label.
4. Click OK.
Pair OPCs
The Pair button on the Select Pair OPC dialog box is a dynamic button that
changes automatically to Unpair if the source OPC is already paired with another OPC. If the
OPC is already paired, the paired OPC is highlighted in the Target OPC selection box.
1. On your open loop drawing, select the source OPC to be paired.
2. Do one of the following:
Click
Click Actions > Off Page Connector > Pair OPC.
3. On the Select Pair OPC dialog box, select the target OPC from the list of OPCs.
Only those OPCs where you selected the OPC text box on the General tab of
the SmartText Properties dialog box, are displayed in the list of OPCs.
4. Click Pair, to create the pairing and close the dialog box.
If the selected OPC has already been paired, selecting a new target OPC and clicking Pair,
unpairs the selected OPC from the current target and then pairs with the new target.
Click .
Click Actions > Off Page Connector > Pair OPC.
On the Select Pair OPC dialog box, click Unpair to unpair the highlighted OPC from the
selected OPC and close the dialog box.
You can also select a new target OPC and click Pair, the highlighted OPC is unpaired from
the selected OPC and the highlighted OPC is then paired with the selected OPC instead.
Delete Redlining
When you no longer need redlining items, you can delete them from individual reports or from a
group of reports associated with a particular layout.
For more information, see Delete Redlining (on page 87).
Delete Redlining
1. Select a redlining item.
To select several items, hold CTRL and click each item. The font and border color of
the items change when you select them.
2. Do one of the following:
Press the Delete key.
Click Actions > Delete Redlining.
You can also access this command by clicking Delete Redlining on the Actions
toolbar.
3. Click File > Save Custom Changes.
You cannot restore deleted redlining items. If you have saved the redlining per layout,
the software dissociates the redlining from the layout. In this case, you can no longer use this
redlining in other drawings you generate for the items assigned to the layout.
Inserting Sheets
You can insert additional sheets in enhanced reports. This option is useful if you want to add
extensive graphical or textual notes to a report. Sheets that you insert are based on the same
template as any existing sheets, and the title block appears on inserted sheets in the same
position as for existing sheets.
You can add SmartText items to a sheet and display the textbox on all the sheets, including any
sheets that you inserted.
Move a Macro
You can move macros to alternative positions on a drawing sheet. If you apply a filter to a
macro, the software moves only those elements that are defined by the filter.
For more information, see Move a Macro (on page 91).
Move a Macro
1. Make sure that no macros are selected.
2. Click Actions > Macro > Move.
You can also access this command using on the Actions toolbar.
3. Select a macro text box and drag it to a new position.
The software repositions by the same displacement all other items that are specified by
the same macro.
You can move one item of a macro, instead of all items associated to the macro, by
pressing CTRL on the keyboard, clicking Move Macro , and then dragging the item
to its new position. This results in the item being disassociated from the main macro
and then only this item is moved, instead of the software moving all the other items that
are specified by the same macro (this affects the current drawing only). You can only
reverse this action by using the Undo command in the Edit menu or by regenerating the
drawing without clicking Save Custom Changes.
4. Click File > Save Custom Changes.
See Also
Add a Macro or a Macro Label to a Drawing Sheet (on page 54)
Hold down the CTRL key while selecting each object individually.
The first graphical element that you select is the one with which all the other selected
graphical elements are aligned.
2. Click Actions > Alignment > By Objects.
You can also access this command by clicking Align Objects on the Actions
toolbar.
3. On the Alignment ribbon, click one of the following icons according to the alignment you
require:
The alignment commands use the first object selected as the base to align the other objects.
The Space Evenly commands require at least 3 objects to be selected. The spacing is then
based on the first two objects selected.
Swapping Objects
This procedure explains how to use the Swap Objects command to swap the position of two
objects on an Enhanced Report, for example two terminal strips. This command only functions
on the drawing display to create a customized visual display for your monitor or for printing. It
has no effect on the sequencing, connections, and so forth.
This procedure is for custom mode reports only.
If the objects you want to swap are part of a group of objects, for example terminals
on a terminal strip, then you must first use the Ungroup command on the terminal strip so that
you can then select the individual terminals.
1. On the report drawing select the two objects whose positions you want to swap.
You can only swap position between two objects.
2. Do one of the following:
Click .
Select Actions > Alignment > Swap Objects.
3. Select File > Save Custom Changes.
For this procedure to work, there must be enough connection points on both sides of the
terminal so that all the connectors from one side can be switched with the opposite side. For
example, a terminal with 3 connectors on one side cannot be switched to the opposite side
of the terminal if the opposite side has only 2 connectors. If though the opposite side has 2
connectors and a third, free connection point, the command is carried out successfully.
This procedure works in Custom Mode only.
1. In SmartPlant Instrumentation, select File > Preferences > Enhanced Reports >
Enhanced SmartLoop (or Fieldbus Loop) > View and select the Switch terminal
connector side (drawing only) check box.
This allows the switch to be displayed on your drawing after refreshing the display.
2. Generate the loop drawing or fieldbus loop and select Yes to display the print preview.
3. On the drawing select the terminal strip.
4. On the Change toolbar, click the Ungroup icon .
5. Select the terminal whose sides you want to modify.
6. Do one of the following:
Click .
Select Actions > Alignment > Switch Connector Side.
7. Select File > Save Custom Changes.
8. On the Save Custom Changes dialog box, click OK.
You can only split a terminal strip whose symbol is not constructed from a number of other
symbols (symbol assembly).
This procedure can only be carried out in a Custom mode loop drawing.
1. Generate a custom loop in the Enhanced Report Utility.
2. Select the terminal strip you want to split.
3. From the Change toolbar, click Ungroup.
Only click on Ungroup once, clicking more than once will cause the
system to fail to save the item (panel, strip, terminal etc.) symbol position.
4. Select the terminal(s) you want to reposition and drag them to their new positions
5. Click File > Save Custom Changes.
6. On the Save Custom Changes dialog box, from the Save at position group box, select the
level at which you want to save your drawing.
After saving the custom changes, it is impossible to regroup the terminal symbols into
a terminal strip unless you use the File > Clear Position command at both the Layout and
Drawing level. This returns the loop drawing to its default layout before any changes were
applied.
7. Click OK.
SmartSketch versions lower than version 4 are incompatible with files saved in the native
.sma format; however, SmartSketch is compatible with files saved in .dxf, .dgn, or .dwg
formats.
You can open an enhanced report that you have saved under any file format (.dxf, .dwg, and
so forth), in AutoCAD, provided that you update the Write Version parameter in the Itacad.ini
file for the appropriate AutoCAD version as follows:
'Write Version=14' (for AutoCAD 14)
'Write Version=2000' (for AutoCAD 2000)
When saving a report in a format for use with an external CAD program, such as .cgm, .dgn,
.dwg, or .dxf, the embedded or linked images are saved as a separate .tiff file and are
placed in the same directory as the saved CAD file. This graphics file is linked, not
embedded, to the drawing.
If you move a strip that is split between sheets from the edge of a sheet to the middle and
then regenerate the drawing after saving the position of the graphical elements, that strip
appears on one sheet only.
If you remove all elements on a particular sheet, that sheet is deleted the next time you
generate the drawing.
You can save the position at the layout level for custom layouts only, not for the default
layout.
The new connector positions appear on a drawing after you refresh the screen or
regenerate a drawing for the same SmartPlant Instrumentation item.
This is a useful procedure for presetting the position of the strips on a group of enhanced
reports.
You can save the position at the layout level for custom layouts only, not for the default
layout.
For more information on items that are saved at the Layout level, see Enhanced Report
Utility (on page 9).
To specify whether a redlining item is saved to the database per report or per layout, when
you attach the redlining item to an item, you select the option that you require in the Attach
Redlining dialog box (on page 145).
You can save other redlining items and bitmaps if you make them part of a symbol.
The software cannot save changes to the properties of drawing elements to the database;
for example, if you change the color, thickness, or line style of a connector.
For a symbol that is associated to a hook-up item, Save Custom Changes can only apply
to a symbol that is saved as a .sym file on the default layer of the drawing, with the top left
corner of the symbol positioned on the drawing where you want the symbol to appear the
next time the drawing is generated.
When using the Save Custom Changes command, after regenerating the drawing, the
macro setting Display Null may not be saved correctly.
After generating a loop, and saving it using Save Custom Changes, you cannot change the
generation method of the loop to Custom by signal or Custom by loop. Changing the
generation method causes the generation of the drawing to contain inaccuracies. To change
the generation method, you must first clear the custom changes using the Clear Position
command.
For more information on items that are saved at the Layout level, see Enhanced Report
Utility (on page 9).
For a symbol that is associated to a hook-up item, Save Custom Changes can only apply
to a symbol that is saved as a .sym file on the default layer of the drawing, with the top left
corner of the symbol positioned on the drawing where you want the symbol to appear the
next time the drawing is generated.
When using the Save Custom Changes command, after regenerating the drawing, the
macro setting Display Null may not be saved correctly.
After generating a loop, and saving it using Save Custom Changes, you cannot change the
generation method of the loop to Custom by signal or Custom by loop. Changing the
generation method causes the generation of the drawing to contain inaccuracies. To change
the generation method, you must first clear the custom changes using the Clear Position
command.
Updating Revisions
Overview
You can add or update revisions for any enhanced report by accessing the Revisions dialog
box. After you refresh the report, the revision data appears in the title block or wherever the
report includes revision macros.
Update a Revision
1. Click Actions > Revisions.
You can also access this command by clicking Revisions on the Actions toolbar.
2. On the Revisions dialog box, add a revision or modify existing revision data as you require.
3. Click Actions > Refresh to view data changes that appear on the report.
Comparison of enhanced reports is only available if the Domain Administrator has selected
one of the options for saving revisions of the specified report in the Report Management
dialog box in the SmartPlant Instrumentation Administration module.
You must perform the revisions in the Enhanced Report Utility. For details, see Update a
Revision (on page 99). If you perform a revision from SmartPlant Instrumentation, the
software does not create an archive.
If the report can be archived as an enhanced report or as a standard (PowerSoft) report,
both report types will be available for comparison. If you compare reports generated by
both methods, you will obtain an incorrect comparison result. You must therefore ensure
that you select only reports that were archived as enhanced reports.
Report comparison does not work in By custom symbol mode.
Report comparison does not include any graphical modifications such as changing strip
positions or changing the width of a symbol.
Compare Reports
1. Click Actions > Compare Reports.
You can also access this command by clicking Compare Reports on the Actions
toolbar.
2. On the Report Comparison Actions dialog box, click Compare the current report with
an archived report.
3. On the Report Revision Archive dialog box, select the revision corresponding to the
archived report that you require.
If there is a long list of revisions in the data window, type the required revision number
in the Revision filter box and select Activate.
4. Click OK to open a comparison report in SmartPlant Instrumentation displaying a list of
differences between enhanced reports, and a view of both reports in Enhanced Report
Utility with a graphical indication of the differences on each report.
If the archived and the currently previewed reports are different, the software indicates the
differences graphically by means of cloud symbols.
If the report can be archived as an enhanced report or as a standard (PowerSoft) report,
both report types will be available for comparison. If you compare reports generated by
both methods, you will obtain an incorrect comparison result. You must therefore ensure
that you select only reports that were archived as enhanced reports.
Report comparison does not include any graphical modifications such as changing strip
positions or changing the width of a symbol.
If the archived and the currently previewed reports are different, the software indicates the
differences graphically by means of cloud symbols.
If the report can be archived as an enhanced report or as a standard (PowerSoft) report,
both report types will be available for comparison. If you compare reports generated by
both methods, you will obtain an incorrect comparison result. You must therefore ensure
that you select only reports that were archived as enhanced reports.
Report comparison does not include any graphical modifications such as changing strip
positions or changing the width of a symbol.
Editing Items
When you generate an enhanced report, you can edit SmartPlant Instrumentation data for
generated items directly from the report. You can edit data for the following items:
Tag numbers
Cables
Cable sets
Wires
Panels
Strips
Terminals
Also, you can generate the following tag documents for the tag numbers in a drawing:
Specification
Process Data
Calculation
Tag Signal Diagram
Loop Signal Diagram
SmartLoop (standard)
I/O Tag Assignment Report
CAD (to view the associated loop drawing using a CAD application)
Segment Map
Other (to view an external document created in another application)
Edit an Item
1. Select the name of a wiring item such as a tag number, cable, cable set, wire, panel, strip,
or terminal.
2. Click Actions > Item > Properties.
You can also access this command by clicking Item Properties on the Actions
toolbar.
3. Change the properties of the item as you require on the dialog box that opens.
To remove a folder from a custom view, right-click a folder and then on the shortcut menu,
click Remove from Custom View.
When a custom view is displayed, any changes made in the Domain Explorer in
SmartPlant Instrumentation are not reflected in the custom view until you exit and then
reopen the custom view.
If you preview the report in the Enhanced Report Utility, the paper size for printing is
taken from the report template as selected in the File Locations (Preferences).
The following paper sizes are not supported by this function:
A0 Tall
A0 Wide
A1 Tall
A1 Wide
A2 Tall
A2 Wide
p_chg_date revision.chg_date
p_user_name revision.user_name
p_rev_no revision.rev_no
p_rev_create_by revision.rev_create_by
p_rev_date revision.rev_date
p_rev_desc revision.rev_desc
p_rev_chk_by revision.rev_chk_by
p_rev_appr_by revision.rev_appr_by
p_rev_sign revision.rev_sign
p_rev_udf_c01 revision.rev_udf_c01
p_rev_udf_c02 revision.rev_udf_c02
p_rev_udf_c03 revision.rev_udf_c03
p_rev_udf_c04 revision.rev_udf_c04
p_rev_udf_c05 revision.rev_udf_c05
p_rev_udf_c06 revision.rev_udf_c06
p_rev_udf_c07 revision.rev_udf_c07
p_rev_udf_c08 revision.rev_udf_c08
p_rev_udf_c09 revision.rev_udf_c09
p_rev_udf_c10 revision.rev_udf_c10
p_rev_udf_c11 revision.rev_udf_c11
p_rev_udf_c12 revision.rev_udf_c12
p_rev_udf_c13 revision.rev_udf_c13
p_rev_udf_c14 revision.rev_udf_c14
p_rev_udf_c15 revision.rev_udf_c15
p_rev_udf_c16 revision.rev_udf_c16
p_rev_udf_c17 revision.rev_udf_c17
p_rev_udf_c18 revision.rev_udf_c18
p_rev_udf_c19 revision.rev_udf_c19
p_rev_udf_c20 revision.rev_udf_c20
pkg_name package.pkg_name
pkg_desc package.pkg_desc
p_dwg_name drawing.dwg_name
3. In SmartPlant Instrumentation click File > Preferences > Enhanced Reports > [Report
type for example, Panel Strip] > File Locations.
4. Click Browse next to the Title block for default layout field and select the new title block
as your default title block.
5. Click OK.
Symbol Editor
Using the Symbol Editor, you can customize symbols to fit your own design conventions
specifically for Layout reports and for Enhanced SmartLoop drawings that use the Custom by
Loop or Custom by Signal generation methods.
The Symbol Editor is not intended for customizing symbols for other types of enhanced
reports.
When you create a symbol, you define the symbol type (panel, strip, rack, card, terminal, and so
forth), and you can then assign to the symbol itself macros appropriate for that symbol
type. You can also add connection points to a terminal's symbol and specify the properties of
the connection points such as the left or right side of the terminal and the angle at which the
connection appears on the report.
The software provides you with the flexibility to create multi-level symbols, for example, you can
create a symbol for a terminal and then use this symbol as a component of a strip symbol
according to the number of terminals in the strip. The terminal symbols are added as
sub-symbols of each strip symbol. Similarly, you can create various panel symbols that contain
one or more strip symbols.
In this way, you can build up a library of symbols which you then associate with appropriate
items in SmartPlant Instrumentation.
For a catalog of the symbols that come shipped with the software, view the
SymbolsDescription.xls file. This file is located in the folder: <SmartPlant Instrumentation
home folder>/RAD/Help/.
Placing Symbols
The main use of the Symbol Explorer is to drag symbols from a directory to the current
document. The Symbol Explorer acts much like the Windows Explorer. To view symbols, you
can type the name of the directory in the Address Box at the top of the Symbol Explorer; or
you can click the Explore Elsewhere button and set the directory path that the Symbol
Explorer looks in.
If you click Home at the top of the Symbol Explorer, it displays the home page for the symbols
that are associated with the template on which the active document is based. You can override
this property by setting a new address with Properties on the File menu. On the Properties
dialog box, you click the Browser tab to set the option.
After the Symbol Explorer displays the symbols, you can drag a symbol from the Symbol
Explorer to the current document.
Window Options
Back - Takes you backward to the previous location of the Symbol Explorer, either a web
page or a directory path.
Forward - Takes you forward to the previous location of the Symbol Explorer, either a web
page or a directory path.
Home - Takes the Symbol Explorer back to the home page that you set with Properties on
the File menu. If you do not set the home page with this command, the Symbol Explorer opens
the symbols directory associated with the template that the active document is based on.
Address - Sets the current location for the Symbol Explorer. You can type in a directory or a
World Wide Web address and then press Enter. Some examples of what you can type in are as
follows:
http://www.intergraph.com
C:\PROGRAM FILES\DRAWINGS\
If you want to view an HTML page on your hard drive, you must enter the entire path and
filename in the address box.
If you set the path of the Symbol Explorer to a directory, you can see a tree view and a
shell view. If you set the path to an HTML page, you can see the symbols of that page in the
style of Microsoft Internet Explorer 4.01 or earlier, if that version is installed. If Microsoft
Internet Explorer is not installed, the software prompts you to install it.
See Also
Close the Symbol Explorer (on page 114)
Move the Symbol Explorer (on page 113)
Open Documents from the Symbol Explorer (on page 113)
You can filter the view of documents in the Symbol Explorer. If you want to view just one
type of document, such as symbols, pause the pointer in the Symbol Explorer window and
right-click. On the shortcut menu, click View, and then File Type.
If you double-click a document in the Symbol Explorer, the software that created the
document opens and displays the document. For example, if you double-click the
SYMBOL.sym document, the software opens and displays the SYMBOL.sym document.
Or, if you double-click a document with an .htm extension, the Microsoft Internet Explorer
opens.
If you open or create a document while the Symbol Explorer is open, you must click Home
to display the symbols directory associated with the current document.
You can filter the view in the Symbol Explorer window to display only certain types of
documents, such as MicroStation, AutoCAD, or other types. You can click View File Type
on the shortcut menu in the Symbol Explorer window.
For example, to display only AutoCAD documents, select the AutoCAD option for .dwg
documents. When you set this option, the Symbol Explorer window displays only .dwg
documents.
If you set the path of the Symbol Explorer to a directory, you can see a tree view and a
shell view., a shell view, and the Attribute Viewer. If you set the path to an HTML page, you
can see the symbols of that page in the style of Microsoft Internet Explorer 4.01 or earlier, if
that version is installed. If Microsoft Internet Explorer is not installed, the software prompts
you to install it.
You can use many of the same tools to view web pages that are available in the Windows
Internet Explorer. For example, if you click Back at the top of the Symbol Explorer, the
Symbol Explorer returns to the previous page.
If you open or create a document while Symbol Explorer is open, you must click Home to
display the symbols directory associated with the current document.
You can drag any document that supports OLE 2.0 from the Symbol Explorer to the
drawing sheet.
If you set the path of the Symbol Explorer to a directory, you can see a tree view, a shell
view, and the Attribute Viewer. If you set the path to an HTML page, you can see the
symbols of that page in the style of the Microsoft Internet Explorer 4.01 or earlier, if that
version is installed. If Microsoft Internet Explorer is not installed, then the software prompts
you to install it.
If the Symbol Explorer is displayed as a separate window from the main window,
double-click the bar at the top to make it part of the main window again. You can dock the
Symbol Explorer at any place in the window.
If you resize the Symbol Explorer and then double-click it to make it part of the main
window, the Symbol Explorer size remains the same.
Before creating symbols, make sure that you have first specified a path for the Symbol
Editor where your symbols will be located by default. For details, see Specify a Path for the
Symbol Editor (on page 115).
You must start Symbol Editor from within SmartPlant Instrumentation in order to establish a
connection to the database.
1. On the SmartPlant Instrumentation main menu, click Tools > Symbol Editor.
2. Draw your symbol as you require using the drawing tools.
3. Select all the drawing elements on the sheet.
When creating a symbol using different elements, press CTRL while choosing
elements with the Select tool.
4. Click Symbols to display the symbol ribbon bar.
5. On the symbol ribbon bar, click Create Symbol . The mouse pointer changes to a
cross-hair icon.
6. Click a point on the drawing sheet to define the origin of the symbol.
The Save As dialog box automatically appears at this point. You do not need to use
Save As on the File menu to open this dialog box.
7. On the Save As dialog box, select the folder where you want to save the symbol.
8. Type the name that you want for the symbol.
The software saves the symbol at this point and reopens it as a separate sheet in the
Symbol Editor.
9. On the Actions toolbar, click Assign Item Type .
10. On the Assign Item Type dialog box, select the desired item type to assign to the symbol.
After you have selected an item type, only macros appropriate for that item type are
available for the symbol.
For an I/O card, select Wiring Equipment as the item type.
For an OPC, select Document as the item type.
11. Add macros, text labels, and connection points to the symbol as needed. For details, see:
Add a Macro to a Symbol File (on page 121).
Add Connection Points to a Symbol File (on page 122).
Before creating these symbols, make sure that you have first specified a path for the Symbol
Editor where your symbols will be located by default. For details, see Specify a Path for the
Symbol Editor (on page 115).
You must start Symbol Editor from within SmartPlant Instrumentation in order to establish a
connection to the database.
1. Start the Symbol Editor from the SmartPlant Instrumentation program.
2. Open a new drawing sheet and draw an outline for the location, which can be a site,
building, floor plan, or room as you require.
3. Select the outline that you have drawn.
4. Click Symbols to display the symbol ribbon bar.
5. On the symbol ribbon bar, click Create Symbol . The mouse pointer changes to a
cross-hair icon.
6. Click a suitable point on the drawing sheet to define the origin of the symbol.
You must specify accurately the position of the symbol's origin so that the symbol is
placed correctly relative to the page origin; usually, this is the lower left corner of the
drawing sheet.
The Save As dialog box automatically appears at this point. You do not need to use
Save As on the File menu to open this dialog box.
7. On the Save As dialog box, select the folder where you want to save the symbol.
8. Type the name that you want for the symbol.
9. Draw the panels as desired using the location outline as a guide and save each panel
drawing as a separate symbol.
Use rectangles to represent common sizes of panels such as 80 x 80 cm enclosures,
and so forth.
10. Return to the location symbol and click Actions > Assign Item Type.
11. In the Assign Item Type dialog box, from the Item type list, select Location.
12. Add macros as needed and save the symbol.
13. For each panel symbol, assign item type Panel.
14. Add macros as needed on each panel symbol and save the symbols.
15. In SmartPlant Instrumentation, associate the room symbol with the desired location item and
associate each cabinet symbol with the desired panel, selecting Location Layout report as
the name of the report type. For details, see Associate a Symbol with an Item (on page 64)
in the Enhanced Report Utility User's Guide.
Before creating these symbols, make sure that you have first specified a path for the Symbol
Editor where your symbols will be located by default. For details, see Specify a Path for the
Symbol Editor (on page 115).
You must start Symbol Editor from within SmartPlant Instrumentation in order to establish a
connection to the database.
1. Start the Symbol Editor from the SmartPlant Instrumentation program.
2. Open a new drawing sheet and draw an outline for a panel with appropriate rack columns.
3. Select all the components of the panel that you have drawn.
4. Click Symbols to display the symbol ribbon bar.
5. On the symbol ribbon bar, click Create Symbol . The mouse pointer changes to a
cross-hair icon.
6. Click a suitable point on the drawing sheet to define the origin of the symbol.
You must specify accurately the position of the symbol's origin so that the
symbol is placed correctly relative to the page origin; usually, this is the lower left corner of
the drawing sheet.
The Save As dialog box automatically appears at this point. You do not need to use
Save As on the File menu to open this dialog box.
7. On the Save As dialog box, select the folder where you want to save the symbol.
8. Type the name that you want for the symbol.
9. Draw a rack using the panel outline as a guide and save the rack drawing as a separate
symbol.
You must specify the position of the symbol's origin at the starting point where each rack
is to be added to the panel, for example, the top left corner.
Make a note of the dimensions of the rack so that you can use it to specify the correct
Symbol displacement value when specifying the start points on the panel.
10. Return to the panel symbol and click Actions > Assign Item Type.
11. In the Assign Item Type dialog box, from the Item type list, select Panel.
12. Add macros as needed.
13. On the Actions toolbar, click Place Starting Points .
14. On the Starting Points ribbon bar, from the Placement order list, select one of the
following options:
Left to Right
Right to Left
Top to Bottom
Bottom to Top
15. Enter values for the Symbol displacement and Symbols per row / column properties.
As an example, suppose that you want to add the racks in stacks of up to 8 racks in
vertical columns, starting from the top of the panel. In this case, you select from Placement
order the option Top to Bottom, then for Symbols per row / column, type 8. For the
Symbol displacement property, type a value of 1.00 to specify a height allowance of 1 inch
for each rack.
16. Click the mouse pointer at each point where you want to add a starting point. Note that the
Row / Column number value increments by one each time you add a new start point.
17. Save the panel symbol.
18. Open the rack symbol and assign to it item type Rack.
19. Add macros as needed.
20. Save the rack symbol.
21. In SmartPlant Instrumentation, associate the panel symbol with a panel that has one or
more racks, selecting Panel Layout report as the name of the report type. For details, see
Associate a Symbol with an Item (on page 64) in the Enhanced Report Utility User's Guide.
22. Associate each rack in the selected panel with the rack symbol that you created, selecting
Panel Layout report as the name of the report type.
The order in which the software places the racks is determined by the rack Sequence
property.
Although this procedure refers to strips and terminals, you can apply it to any situation
where you create a symbol with sub-symbols. For general details of how to create
individual custom symbols, see Create a User Defined (customized) Symbol (on page 115).
You must start Symbol Editor from within SmartPlant Instrumentation in order to establish a
connection to the database.
1. On the SmartPlant Instrumentation main menu, click Tools > Symbol Editor.
2. Create a new terminal symbol.
The symbol's origin point is important in this case because the software places the
sub-symbols relative to one another within the main symbol.
The Save As dialog box automatically appears at this point. You do not need to use
Save As on the File menu to open this dialog box.
8. On the Save As dialog box, select the folder where you want to save the symbol.
9. Type the name that you want for the symbol.
10. Assign item type Terminal Strip for the symbol.
11. Add macros as needed on the strip symbol.
12. Open the Symbol Browser and drag two or more terminal symbols into the strip outline.
When dragging the terminal symbols, the software assigns the symbol order of
each terminal in sequence. For this reason, it is essential that you place the terminals in the
order that you want their numbering to be assigned.
13. Save the strip symbol.
14. Open a new drawing sheet and draw an outline for your panel.
15. Create a panel symbol from the drawing.
16. Assign item type Panel for the symbol.
17. Add macros as needed on the panel symbol.
18. Drag two or more strip symbols into the panel outline in the desired order.
19. Save the panel symbol.
20. In SmartPlant Instrumentation, associate the panel symbol with the desired panel. For
details, see Associate a Symbol with an Item (on page 64) in the Enhanced Report Utility
User's Guide.
If you generate an Enhanced SmartLoop report using the Custom by Loop or Custom
by Signal generation methods, and no suitable custom symbol is associated with a particular
wiring item that includes standard terminals, the software uses the symbol FirstTerm.sym as the
default symbol for the first terminal in a group of terminals, and the symbol Term.sym for all
subsequent terminals - provided that these symbols already exist in the custom symbol folder
specified in the SmartPlant Instrumentation Preferences dialog box for the Enhanced
SmartLoop report. FirstTerm.sym includes macros for the panel, strip, and terminal; Term.sym
includes macros for the terminal only.
e. Drag the Origin Point symbol to where you want the origin point to be on your symbol,
and click to place.
f. In the Save dialog box, type the name of your symbol and click Save.
g. Click and in the Assign Item Type dialog box select the item type for the symbol.
In this case Connector.
h. Click and then click on the symbol where you want your connection points to be
located.
For further information, see Add Connection Points to a Symbol File (on page 122).
When the symbol is of type Connector, the Connection Point ribbon is inactive as
there is no left or right terminal side.
i. Click to add macros. For more information, see Add a Macro to a Symbol File (on
page 121).
j. Click and close the symbol.
2. Now do the following to create a terminal strip symbol and combine it with the connector
symbol:
a. Repeat steps a to f of part one of this procedure.
b. Click and in the Assign Item Type dialog box select the item type for the symbol.
In this case Terminal Strip.
c. Click to add macros.
d. On the Symbol Explorer, locate the connector symbol that you created.
e. Drag and drop the connector symbol on to your terminal strip symbol.
f. Click and close the symbol.
3. Finally do the following to create a wiring equipment symbol and combine it with the terminal
strip symbol:
a. Repeat steps a to f of part one of this procedure.
b. Click and in the Assign Item Type dialog box select the item type for the symbol.
In this case Wiring Equipment.
c. Click to add macros.
d. On the Symbol Explorer, locate the terminal strip symbol that you created.
e. Drag and drop the terminal strip symbol on to the wiring equipment symbol you created.
f. Click and close the symbol.
Select the Show all macros for assembled symbols from the Enhanced SmartLoop .>
View preferences in SmartPlant Instrumentation, if you want to display all macros associated
with assembled symbols on a report. Do not select this preference if you want to display only
those macros associated to an assembly that are connected to a signal.
Hold down the CTRL key while selecting each object individually.
The first graphical element that you select is the one with which all the other selected
graphical elements are aligned.
The alignment commands use the first object selected as the base to align the other objects.
The Space Evenly commands require at least 3 objects to be selected. The spacing is then
based on the first two objects selected.
6. If you are adding a macro for an item that is part of a hierarchy, such as a channel or
terminal strip that can be associated with more than one parent item type, select the relation
for the item from the Relation list.
You must specify the correct relation for the software to retrieve the data for the
specified macro.
7. Define a filter, if needed.
If you do not use a filter, the software adds the macro to all items of the same type.
8. In the Caption box, type a label name if you want to associate a label with the new macro.
The label appears to the left of the macro on the symbol.
9. Click the Macro Text tab to define the macro text properties.
10. Click the Caption Text tab to define the label text properties.
11. On the symbol, click where you want the macro to appear.
12. Click File > Save.
Symbols created before Version 2007, that contain macros with labels, display the label
even if the value is null. To correct this you must create new macros on each symbol. Symbols
created from Version 2007 do not need to be fixed.
You can add more than one connection point on each terminal side if needed. If you do
so, it is recommended that you place the points alongside one another or specify a
different connection angle for each point.
Graphical symbol elements are defined on the Default layer and these elements
determine the symbol boundaries. Connection points are defined on the Connection
layer, which means that placing connection points beyond the symbol boundaries does
not affect the calculation of spacing between symbols in drawings.
5. Click the mouse pointer to place the second connection point in a similar way.
6. If you require, add wire macros to each connection point. For details, see Add Wire Macros
to Connection Points (on page 123).
7. On the toolbar, click Finish.
8. Click File > Save.
Graphical symbol elements are defined on the Default layer and these elements
determine the symbol boundaries. Macros are defined on the Macro layer, which
means that placing macros beyond the symbol boundaries does not affect the
calculation of spacing between symbols in drawings.
For terminals that have connections on both sides, if you want the cable macro names
to appear between the connection points, it is recommended that you place cable macro
names on one side of the symbol only to avoid duplication for each terminal to which the
cable is connected.
10. Click File > Save.
The software only displays wire macros for connection points that actually have
connections.
If you delete a connection point, the software automatically deletes from the symbol all
macros belonging to that connection point.
Customize a Symbol
1. Do one of the following:
On the SmartPlant Instrumentation main menu, click Tools > Symbol Editor.
On the Windows Taskbar, click Start > Programs > Intergraph SmartPlant
Instrumentation > Symbol Editor.
In any file browser, double-click the .sym file you want to open. (For this option to work,
the file type must be registered to open with the Symbol Editor.)
If you use the last two methods of opening a file, you will not be able to perform
certain actions that require connectivity to the SmartPlant Instrumentation database, for
example changing the item type. For this reason, it is generally recommended that when
customizing a symbol, you open the Symbol Editor from within SmartPlant Instrumentation.
2. Customize the symbol as you require. You can make any of the following changes:
Edit graphical elements.
Change the item type.
Add, modify, or delete SmartText.
Add, modify, or delete macros.
Add, modify, or delete connection points (for terminals).
Add, modify, or delete starting points (for panels with racks).
3. Click File > Save.
If you change a symbol's item type, the software automatically deletes from the symbol all
macros belonging to the original item type.
See Also
Add a Macro to a Symbol File (on page 121)
You can also add or edit text in the OPC Label from the Enhanced Report Utility.
Click the Text tab, if you want to adjust the formatting of the label text.
6. Click OK, the cursor changes to cross-hairs.
7. Click on the OPC symbol where you want the label to appear.
8. Save and close the OPC symbol.
Text
Caption —Type the text that you want to appear on the OPC Label text box.
You can leave this blank and add text later in your loop drawing.
Options
Set various options for how the SmartText is displayed.
Set as watermark (not available with OPC Label) — Select the box if you want to use the text
as a watermark, which means that it appears behind other drawing items.
Set as Off Page Connector (OPC) (Only available in the Symbol Editor) — Select the check
box to add an OPC Label text box to the OPC symbol.
Off Page Connector Name (Only available when Set as Off Page Connector (OPC) has been
selected, and the OPC has been associated with a drawing.) — Displays the target loop name
of an associated OPC, as the name of the OPC, creating a unique name for the OPC. You can
add text to this field if required. This field holds up to 50 characters.
Textbox display
These options are only available when you add SmartText for the first time.
Current sheet (not available with OPC Label) — Click to display the SmartText item on the
current drawing sheet only.
All sheets (not available with OPC Label) — Click to display the SmartText item on all the
drawing sheets.
Update an Assembly
An assembly is a symbol created by combining a number of symbols to form one symbol. After
making changes to a symbol that is a component of an assembly symbol, the changes are not
automatically displayed in the assembly symbol. You must run the Update Assembly
Command for the changes made to the component symbol to become part of the assembly
symbol.
This procedure cannot be reversed! It is advisable to make a backup of your symbols before
proceeding with updating the assembly.
The Update Assembly Command checks the assembly's component symbols for changes
in their original source folder. If you have copied the component symbols to another folder or
drive, for example from you C: drive to a network drive so that other users have access to
the symbols, and made changes to the copied component symbols, then the changes are
not updated in the assembly. You must delete the original symbols from their source folder
for the Update Assembly Command to update the copied symbols, or make your changes
to the original symbols.
1. Make the required changes to the component symbols, not to the assembly, and save them.
2. Click Tools > Macro.
3. On the Custom Command dialog box, in the Look in field, navigate to the Smart Plant
Instrumentation installation folder and click SmartPlant > Instrumentation >RAD.
4. Select the .dll UpdateAssemblyCmnd90.
5. Click Open.
6. On the Update Assembly dialog box, navigate to the folder where you saved the
component symbol.
7. Do one of the following:
From the Select file pane, select the symbols you want to update.
Click Select all to select all the symbol files.
8. Click OK.
You must close and re-open the drawing to view the changes made to the assembly.
You can add the Update Assembly Command to your toolbar by clicking Tools >
Customize and from the Customize dialog box selecting the UpdateAssemblyCmnd90.
Symbol Ribbon
Create Symbol - Allows you to create a symbol. You must first select graphics on the
drawing sheet before this button is available. Click this button to display an origin cursor ,
which you use to set the symbol origin and to open the Save As dialog box.
To find out the name of an option on the ribbon, pause the pointer over an option and read
the ToolTip. Ribbon Options.
Default Style — Places a symbol in the style you select when you drop the symbol in the active
document. Setting Style as drawn displays the symbol graphics as drawn in the original symbol
document. Setting Active style gives the symbol the line style currently set in the active
document.
Angle — Specifies the angle that the symbol is rotated when you drop it into the active
document. The default angle is 0 and is horizontal to the bottom of the screen. You can
specify a new angle. The number of degrees increases in the counter-clockwise direction, for
example, 90 degrees is at the top of the screen. You can also type positive or negative values:
a positive value is counter-clockwise from the x axis, and a negative value is clockwise from the
x axis.
Scale factor — Specifies the scale factor that symbols use when you drag and drop them into
the active document. The scale factor used is relative to the symbol's model units, for example,
if you set the scale factor to 2 and the symbol has 1 cm square in model units, it appears 2 cm
square when you drag and drop it into the active document.
Menu Commands
In This Section
File Menu Commands.................................................................... 129
View Menu Commands.................................................................. 130
Actions Menu Commands.............................................................. 131
Insert Menu Commands ................................................................ 139
Tools Menu Commands................................................................. 140
Window Menu Commands............................................................. 141
Help Menu Commands .................................................................. 142
Freeform Command (Draw Toolbar) ............................................. 143
Opens the Save Custom Changes dialog box with options for saving to the SmartPlant
Instrumentation database custom changes that you make for the following graphical elements:
Redlining, macros, and SmartText.
For Enhanced SmartLoop reports, the position of panel strips and connectors that you have
moved.
Hook-Up drawings, including Hook-up symbol, general blocks, Tag list, Item list, and other
drawing elements.
You can save these elements per drawing or per layout. The next time you generate a report
for the same item, the elements appear on the sheet in the specified positions and with the
characteristics that you defined for them. If you save the graphical elements per layout, they
appear in the same position on any report to which the same layout is assigned.
For more information on items that are saved at the Layout level, see Enhanced Report
Utility (on page 9).
The software cannot save changes to the properties of drawing elements to the database;
for example, if you change the color, thickness, or line style of a connector.
For a symbol that is associated to a hook-up item, Save Custom Changes can only apply
to a symbol that is saved as a .sym file on the default layer of the drawing, with the top left
corner of the symbol positioned on the drawing where you want the symbol to appear the
next time the drawing is generated.
When using the Save Custom Changes command, after regenerating the drawing, the
macro setting Display Null may not be saved correctly.
After generating a loop, and saving it using Save Custom Changes, you cannot change the
generation method of the loop to Custom by signal or Custom by loop. Changing the
generation method causes the generation of the drawing to contain inaccuracies. To change
the generation method, you must first clear the custom changes using the Clear Position
command.
Clears the settings you make after manually positioning drawing elements on a sheet and
saving using the Save Custom Changes command. After clearing the position, the next time
you generate the report for the same item, the elements appear on the sheet in the default
positions that the software defines.
Item
Topics
Item > Associate Command (Actions Menu) ................................. 131
Item > Dissociate Command (Actions Menu) ................................ 131
Item > Properties Command (Actions Menu) ................................ 132
Item > Define Filter Command (Actions Menu) ............................. 132
Allows you to associate the selected item with a specific symbol type. This option applies for
the Custom Symbol generation method only.
Before you can choose this command, you must select an item.
Dissociates the selected item from the symbol type with which it is associated.
Before you can choose this command, you must select an item.
Opens the appropriate dialog box in SmartPlant Instrumentation for editing the selected item, for
example, tag number, panel, terminal, cable, and so forth.
Before you can choose this command, you must select an item.
To view data changes that appear on the report, click View > Refresh.
Opens the Define Filter for Item dialog box in SmartPlant Instrumentation to allow you to define
or modify a filter. The filter determines whether or not the software displays macro values for a
particular item.
Opens the Documents window in SmartPlant Instrumentation where you can view and edit
documents related to the tag such as specification sheet, process data sheet, signal diagrams,
and so forth.
Before you can choose this command, you must select a tag number.
Connection
Topics
Connection > Connection Window Command (Actions Menu) ..... 132
Connection > Activate Connection Mode Command (Actions Menu)
....................................................................................................... 133
Connection > Associate Wiring Item Command (Actions Menu)... 133
Connection > Dissociate Wiring Item Command (Actions Menu).. 133
Opens the Connection window in the SmartPlant Instrumentation Wiring module to allow you to
edit the wiring connections of the selected item.
Before you can choose this command, you must select a strip or a terminal.
To view data changes that appear on the report, click View > Refresh.
Allows you to add connectors or jumpers between connection points on a custom symbol.
Before you can choose this command, you must select a strip or a terminal.
Allows you to associate a connector symbol (line) on a drawing sheet with a particular cable,
set, or wire. This option applies for the Custom Symbol generation method only.
Before you can choose this command, you must select a strip or a terminal.
Optimization
Topics
Optimization > Redraw All Connections Command (Actions Menu)
....................................................................................................... 133
Optimization > By-Pass Strips Command (Actions Menu) ............ 134
Optimization > Optimize Overlapping Connectors Command (Actions
Menu) ............................................................................................. 134
Optimization > Gap Connectors Command (Actions Menu) ......... 134
Redraws all the connectors on the sheet to minimize the number of connector overlaps and
intersections.
Moves each connector (cable) that intersects a strip so that the connector by-passes the strip.
Alignment
Topics
Alignment > By Objects Command (Actions Menu) ...................... 134
Alignment > By Connection Command (Actions Menu) ................ 135
Alignment > Swap Objects Command (Actions Menu) ................. 135
Alignment > Switch Connector Side Command (Actions Menu) ... 135
Displays the Alignment ribbon for setting the alignment of two or more graphical
elements. You can align items by their left, right, top, or bottom edges and also by centering the
objects. Other options available on the Alignment ribbon are tangent (side by side) alignment
where the objects are moved next to each other on the horizontal or vertical plane, and the
space evenly option where the space between the objects is adjusted to be the same.
Hold down the CTRL key while selecting each object individually.
It is not possible to align macros and redlining items that are attached relative to items on
the drawing sheet.
Displays the Alignment ribbon for setting the alignment of two or more connected graphical
elements based on the position of the connector between them. You can align items by the left
or right connector position (for vertically aligned connectors), or by the top or bottom connector
position (for horizontally aligned connectors).
It is not possible to align macros and redlining items that are attached relative to items on
the drawing sheet.
This command is used to swap the positions of two objects on your report.
This command only affects the report display and has no effect on the sequencing,
connections, and so forth.
Switches the connectors and their wires from one side of a terminal to the opposite side of
the terminal.
This command only functions on the drawing display to create a customized visual display
for your monitor or for printing. It has no effect on the sequencing, connections, and so
forth.
You must select from the SmartPlant Instrumentation preferences, the preference Switch
terminal connector side (drawing only) under Enhanced Reports > Enhanced
SmartLoop or Fieldbus Loop > View to allow the report drawing to display the modification
after performing Refresh.
Redlining
Topics
Redlining > Attach Command (Actions Menu) .............................. 136
Redlining > Move Command (Actions Menu) ................................ 136
Redlining > Delete Command (Actions Menu) .............................. 136
Attaches a redlining item (line, circle, rectangle, or drawing symbol) to the current drawing sheet
or layout, as you specify.
Before you can choose this command, you must select a redlining item.
You can also select an item and then select a redlining item to attach to all the items that are
of the same type as the selected item.
To retain redlining items when you regenerate the report, click File > Save Custom
Changes.
Allows you to move redlining items (lines, circles, rectangles, or drawing symbols) that are
attached relative to items on the current drawing sheet or layout.
You must choose this command before you can select a redlining item to move.
To retain the new positions of the redlining items when you regenerate the report, click File
> Save Custom Changes.
Before you can choose this command, you must select a redlining item.
If you delete a redlining item that you attached to an item type or to a layout, the software
deletes all instances of the redlining item that appear with the item type or on the drawing
sheets that belong to the layout.
SmartText
Topics
SmartText > New Command (Actions Menu) ................................ 137
SmartText > Properties Command (Actions Menu) ....................... 137
SmartText > Delete Command (Actions Menu) ............................. 137
You can specify whether the SmartText appears on the current drawing sheet or all the
sheets in the case of a multiple sheet drawing.
To retain the SmartText when you regenerate the report, click File > Save Custom
Changes.
Allows you to view and edit the text and font properties of a SmartText item.
Before you can choose this command, you must select an existing SmartText item.
Before you can choose this command, you must select a SmartText item. Only one
SmartText item at a time can be selected and deleted.
You should use this command, rather than the Delete key, if you want to delete all
occurrences of a SmartText item that appear on all the sheets of a multiple sheet drawing.
Macro
Topics
Macro > New Command (Actions Menu) ....................................... 137
Macro > Properties Command (Actions Menu) ............................. 138
Macro > Move Command (Actions Menu) ..................................... 138
Macro > Delete Command (Actions Menu) ................................... 138
Allows you to move macros for generated items (panels, strips, terminals, cables, cable sets,
wires, ports, pins, and so forth) on the current drawing sheet or layout.
You must choose this command before you can select a macro to move.
To retain the new positions of the macros when you regenerate the report, click File > Save
Custom Changes.
With an item selected on the current report, opens a dialog box from which you can select any
other report type that is available for the item for generating a report.
Opens the Report Comparison Actions dialog box in SmartPlant Instrumentation to allow you
to compare the current enhanced report with an archived report or to compare two archived
reports. The software displays the comparison as a standard SmartPlant Instrumentation data
report and also by indicating graphical differences on both of the reports by means of cloud
symbols.
Report comparison is only available if the SmartPlant Instrumentation Domain
Administrator has selected one of the options for saving revisions of the specified report in the
Report Management dialog box in the Administration module.
Opens the Revisions dialog box in the SmartPlant Instrumentation Loop Drawings module to
allow you to add or update revisions for the selected item. Revision data appears in the report
title block.
To view data changes that appear on the report, click View > Refresh.
Displays the Domain Explorer, from which you can associate items with symbols, or drag items
with symbol associations onto the drawing sheet. You can also use F7 to display the Domain
Explorer.
Do not drag items from the Domain Explorer or Reference Explorer of SmartPlant
instrumentation to an Enhanced Report Utility drawing.
The Enhanced Report Utility does not support the duplication of items in the Reference
Explorer or Domain Explorer, or the dragging of items from the Reference Explorer to the
Domain Explorer.
The Domain Explorer or Reference Explorer referenced in the Enhanced Report Utility
documentation refers only to the Enhanced Report Utility explorers (unless otherwise stated
in the documentation).
Displays the Reference Explorer, from which you can associate items with symbols, or drag
items with symbol associations onto the drawing sheet. You can also use F8 to display the
Reference Explorer.
Do not drag items from the Domain Explorer or Reference Explorer of SmartPlant
instrumentation to an Enhanced Report Utility drawing.
The Enhanced Report Utility does not support the duplication of items in the Reference
Explorer or Domain Explorer, or the dragging of items from the Reference Explorer to the
Domain Explorer.
The Domain Explorer or Reference Explorer referenced in the Enhanced Report Utility
documentation refers only to the Enhanced Report Utility explorers (unless otherwise stated
in the documentation).
You can use Tools > Customize to place the New Window button on a toolbar.
See Also
Cascade Command (on page 141)
Cascade Command
Overlaps windows diagonally across the screen.
You can use Tools > Customize to place the Cascade Windows button on a toolbar.
See Also
New Window Command (on page 141)
Save
For this drawing only — Click to save the selected redlining item with the item it is attached to
on all the drawings that you generate for that item.
For all drawings assigned to the current layout — Click to save the selected redlining item
with the item it is attached to on all drawings that belong to the same layout as the current
drawing.
Position
These options are only available when you select an item with the redlining item.
Fixed — Click to fix the position of the selected redlining item on the sheet and attach the
redlining item to the selected item only.
Relative to <item name> — Click to attach the redlining item relative to the position of the
selected item and for all the occurrences of that item per drawing or per layout. For this option,
when you move an item, the attached redlining item moves with the item.
Filter
When you attach a redlining item to an item, you attach it to all the items of the same type; for
example, to all panels. Using a filter allows you to attach redlining to specific items belonging to
the item type selected on the drawing; for example, only to those panels that are junction
boxes. You define filters in SmartPlant Instrumentation.
Filter — Select a filter from the list of definitions.
Description — Type a meaningful description for the filter.
Use filter — Select this check box if you want to use the filter when setting the redlining position
as relative to an item. If you clear the check box, the software applies the macro to all
occurrences of the specified item type, such as panels, on the drawing.
Defines the color, margin settings, and background sheet display information.
Background sheet — Specifies the background sheet that you want to use for the working
sheet. If you have not created a background sheet, this box does not display any options. You
must first create a background sheet before you can select it from the list.
All graphics on the background sheet display on the working sheet. Changing the background
sheet updates the size and margin settings of the working sheet to the values defined by the
selected background sheet.
Show background — Displays the background sheet graphics on the selected working sheet.
Preview — Displays the range of the graphic to print on the printer paper.
Macro definition
Macro type —Select the type that describes the selected item most accurately; for example,
select Instrument, Panel, or another type. Macros are categorized according to the type of
items that they influence.
Macro — Select a macro such as Panel Name, Manufacturer, or Model. The available
macros depend on the macro type that you selected.
Relation — For cases where the selected macro represents the property of an item that can
relate to the current item in several possible ways, you must select the particular relation that
you want to apply. For example, you can have a loop with a strip belonging to wiring equipment
in a rack, and another loop with a strip that is located directly in a rack. To resolve the rack data
correctly, you must define a macro with a different relation for each loop. When creating a
layout, the macro relation path must reflect the actual relationship between the items. For this
reason, you can only use that layout for loops where the relationship between the items is
identical.
Macro function
You can add a function to a macro that is carried out on the macro, when the macro is used on a
drawing. For example, to remove spaces between sections of displayed tag numbers, you would
select the RemSpace function. You define the properties of the macro function in the
User-Defined Macro Function Properties dialog box in SmartPlant Instrumentation > Loop
module > Tables > User-Defined Macro Functions > Properties.
Function —Select the function you want performed on the Macro.
Description - Displays a description of the selected function.
Filter
When you add a macro to an item, you add it to all the items of the same type; for example, to
all panels. Using a filter allows you to add a macro to specific items belonging to the item type
selected on the drawing; for example, only to those panels that are junction boxes. You define
filters in SmartPlant Instrumentation.
Filter —Select a filter from the list of definitions.
Description - Type a meaningful description for the filter.
Use filter — Select this check box if you want to use the filter when adding the macro. If you
clear the check box, the software applies the macro to all occurrences of the specified item type,
such as panels, on the drawing.
Label
Caption — Type the text that you want to appear as the label caption. Press the Enter key to
start a new line.
Display caption only — Select to display only the macro caption without the data value of the
item. This option only displays the caption if the selected property has a data value or if the
Display 'Null' when no data is available check box is selected.
Display 'Null' when no data is available — Select to display the string 'Null' in the case where
no value for the property exists in the database.
See Also
Add a Macro or a Macro Label to a Drawing Sheet (on page 54)
Text
Caption —Type the text that you want to appear on the OPC Label text box.
You can leave this blank and add text later in your loop drawing.
Options
Set various options for how the SmartText is displayed.
Set as watermark (not available with OPC Label) — Select the box if you want to use the text
as a watermark, which means that it appears behind other drawing items.
Set as Off Page Connector (OPC) (Only available in the Symbol Editor) — Select the check
box to add an OPC Label text box to the OPC symbol.
Off Page Connector Name (Only available when Set as Off Page Connector (OPC) has been
selected and the OPC has been associated with a drawing.) — Displays the target loop name of
an associated OPC, as the name of the OPC, creating a unique name for the OPC. You can add
text to this field if required. This field holds up to 50 characters.
Textbox display
These options are only available when you add SmartText for the first time.
Current sheet (not available with OPC Label) — Click to display the SmartText item on the
current drawing sheet only.
All sheets (not available with OPC Label) — Click to display the SmartText item on all the
drawing sheets.
Text
Caption —Type the text that you want to appear on the Enhanced SmartLoop drawing.
Watermark
Set as watermark — Select the box if you want to use the text as a watermark, which means
that it appears behind other drawing items. This option is only available when you add
SmartText for the first time.
Set as Off Page Connector (OPC) (Only available in the Symbol Editor) — Select the check
box to add an OPC Label text box to the OPC symbol.
Off Page Connector Name (Only available when Set as Off Page Connector (OPC) has been
selected and the OPC has been associated with a drawing.) — Displays the target loop name of
an associated OPC, as the name of the OPC, creating a unique name for the OPC. You can add
text to this field if required. This field holds up to 50 characters.
Textbox display
These options are only available when you add SmartText for the first time.
Current sheet — Click to display the SmartText item on the current drawing sheet only.
All sheets — Click to display the SmartText item on the all the drawing sheets.
Style
The preview window displays the appearance of the selected font.
Font —Click to open the standard Windows Font dialog box to define the font, font style, size,
color, and other properties. Note that the default font, font style, and size are determined in the
Preferences dialog box in SmartPlant Instrumentation per enhanced report type; the default font
color is Black. If you select a default font other than a TrueType font (indicated by a TT
symbol), the Enhanced Report Utility displays the text with a yellow-green font, regardless of
any subsequent change you try to make to the font color in the Enhanced Report Utility.
Border
Show border — Select this option to display a border around the text.
Alignment
Horizontal — Select the horizontal alignment of the text: left, center, or right.
Vertical — Select the vertical alignment of the text: top, center, bottom, or justified.
Placement
Rotation — Type the rotation angle of the text in degrees. You can enter positive values from 0
to 360 degrees, or negative values to 180 degrees. The text rotates clockwise when you type a
negative value.
Orientation — Select horizontal or vertical orientation of the text inside the text box.
See Also
Add a Macro or a Macro Label to a Drawing Sheet (on page 54)
Defines the name of a drawing sheet. You can also change the name of a drawing sheet.
Sheet name — Specifies a name for the drawing sheet. You can also use this box to rename a
drawing sheet by selecting the sheet in the document before clicking Sheet Setup on the File
menu.
To change the default setting of the Sheet Tab name permanently you must
change the name in the SmartPlantEN.dll. For more information, consult the SmartPlant
Instrumentation Administration module help.
Save position at
When you select the Save position check box, the following options become available:
Drawing level —- Select to retain the position of the drawing elements for the current
drawing only.
Layout level —- Select to retain the position of the drawing elements for all reports that
belong to the same layout as the current drawing. Note that this option applies for custom
layouts only, not for the default layout.
Layout level for soft tags only — Select to retain the position of soft tags for all reports
that belong to the same layout as the current drawing. When you select this option, all other
drawing elements are saved at the level of the drawing.
After generating a loop, and saving it using Save Custom Changes, you cannot change
the generation method of the loop to Custom by signal or Custom by loop. Changing the
generation method causes the generation of the drawing to contain inaccuracies. To change the
generation method, you must first clear the custom changes using the Clear Position
command.
Select Scale — Sets the drawing scale to a standard ratio. The specified ratio defines the size
of the drawing in relation to the size of the real-world object. For a 2:1 ratio, the 2 represents the
size of the drawing and the 1 represents the size of the real-world object.
Custom — Defines a custom or scale ratio. The first value defines the distance on the drawing
sheet and the second value defines what this distance is equal to in the real world.
Paper units — Sets the paper units for the drawing sheet.
Units — Controls the display of numeric values in dialog boxes that define the size of
non-scaled objects. Some examples of non-scaled object values are text height and line width.
This setting does not affect dimension units.
Only value boxes use this option. For example, if you are working in feet and inches, you can
specify that you want to read and enter values for text height in fractional inches. (1/8" instead of
0.00'-0.125")
When printing or plotting a drawing sheet, the non-scaled items appear on the printed
document with the exact size that you specify.
Precision — Sets the number of significant figures to display, or the accuracy of the unit
readout value. The precision setting does not change the numbers that you can type in the
fields, only the display of the numbers in the field. Values ending in 5 are rounded up to the next
whole number.
For example, if you set this control to .001 and you draw a line that is 2.1056 inches, then the
line length value is rounded. The length value appears as 2.106 inches. If you set this control to
0.01 and you type a line length value of 3.5 mm, the length value appears as 3.50 mm.
Style
The preview window displays the appearance of the selected font.
Font —Click to open the standard Windows Font dialog box to define the font, font style, size,
color, and other properties. You determine the default font, font style, and size in the
SmartPlant Instrumentation Preferences dialog box enhanced report type; the default font color
is Black. If you select a default font other than a TrueType font (indicated by a TT symbol), the
Enhanced Report Utility displays the text with a yellow-green font, regardless of any subsequent
change you try to make to the font color in the Enhanced Report Utility.
The text effect Strikeout does not function with SmartText.
Border
Show border — Select this option to display a border around the text.
Alignment
Horizontal — Select the horizontal alignment of the text: left, center, or right.
Vertical — Select the vertical alignment of the text: top, center, bottom, or justified.
Placement
Rotation — Type the rotation angle of the text in degrees. You can enter positive values from 0
to 360 degrees, or negative values to 180 degrees. The text rotates counter-clockwise when
you type a positive value.
Orientation — Select the orientation of the text inside the text box: horizontal or vertical.
A C
Actions Menu Commands • 131 Cascade Command • 141
Add a Label to an OPC • 125 Change the Symbols for a Terminal Type •
Add a Loop to a Custom Layout with User 105
Defined (customized) Symbols • 71 Clear Position Command • 130
Add a Macro or a Macro Label to a Drawing Clear Position Dialog Box • 146
Sheet • 54 Close the Symbol Explorer • 114
Add a Macro to a Control System Tag or Compare Archived Reports • 101
Non-Wiring Tag Symbol File • 56 Compare Reports • 100
Add a Macro to a Symbol File • 121 Compare Reports Command (Actions
Add a Symbol as a Redlining Item • 84 Menu) • 138
Add an OPC Between Drawings to a Loop Comparing Enhanced Reports • 99
Drawing • 77 Connect Individual Wires in a Custom Loop
Add and Format a Redlining Item • 84 or Custom Signal Report • 75
Add Connection Points to a Symbol File • Connecting Individual Wires in an Custom
122 Loop or Custom Signal Report • 74
Add SmartText • 51 Connection • 132
Add SmartText to a Symbol File • 121 Connection > Activate Connection Mode
Add Starting Points to a Symbol File • 124 Command (Actions Menu) • 133
Add Text to an OPC Label • 80 Connection > Associate Wiring Item
Add User Defined (customized) Symbols to Command (Actions Menu) • 133
an Enhanced Report • 69 Connection > Connection Window
Add Wire Macros to Connection Points • Command (Actions Menu) • 132
123 Connection > Dissociate Wiring Item
Align Drawing Objects • 91, 120 Command (Actions Menu) • 133
Alignment • 134 Control System Tag Macro List • 57
Alignment > By Connection Command Create a Custom Layout with User Defined
(Actions Menu) • 135 (customized) Symbols • 71
Alignment > By Objects Command (Actions Create a Custom Template • 16
Menu) • 134 Create a Location Layout Report • 66
Alignment > Swap Objects Command Create a Logo Symbol • 26
(Actions Menu) • 135 Create a Panel Layout Report • 67
Alignment > Switch Connector Side Create a Template Using a Background
Command (Actions Menu) • 135 Sheet • 17
Annotating Enhanced Reports • 83 Create a Title Block File • 19
Assign a Layout to Enhanced Report Items Create a User Defined (customized)
• 32 Symbol • 115
Associate a Symbol with an Instrument Create Filters for Items • 47
Type • 105 Create Symbols for a Location Layout
Associate a Symbol with an Item • 64 Report • 116
Associate an Item with a User Defined Create Symbols for a Panel Layout Report •
Symbol on a Drawing Sheet • 65 117
Attach a Macro or a Macro Label to an Item Create Symbols for an Enhanced
• 54 SmartLoop Report • 118
Attach Redlining Dialog Box • 145 Creating a Custom Layout with User
Attach Redlining Symbols with Macros to Defined (customized) Symbols • 70
Drawing Items • 86 Creating a Wiring Equipment Symbol
Attach Redlining to Drawing Items • 85 Assembly • 119
Item > Properties Command (Actions Place Property Labels on a Drawing Sheet •
Menu) • 132 24
Position a Symbol Using the Symbol
M Position Command • 70
Printable Guides Command (Help Menu) •
Macro • 137 142
Macro > Delete Command (Actions Menu) •
138
Macro > Move Command (Actions Menu) • R
138 Redlining • 135
Macro > New Command (Actions Menu) • Redlining > Attach Command (Actions
137 Menu) • 136
Macro > Properties Command (Actions Redlining > Delete Command (Actions
Menu) • 138 Menu) • 136
Macro Text Tab (Macro Properties Dialog Redlining > Move Command (Actions
Box) • 149 Menu) • 136
Menu Commands • 129 Reduce Generation Time for Enhanced
Modify Terminal Type Symbols • 104 Reports • 36
Move a Macro • 91 Reducing Generation Time for Enhanced
Move a Redlining Item • 91 Reports • 36
Move the Symbol Explorer • 113 Reference Explorer Command (Tools
Menu) • 140
N Refresh Command (View Menu) • 130
Remove a User Defined Symbol from a
Naming OPCs • 79 Drawing Sheet • 66
New Sheet Command • 140 Revising and Comparing Saved Enhanced
New Window Command • 141 Reports • 99
Non-Wiring Tag Macro List • 58 Revisions Command (Actions Menu) • 139
O S
Off Page Connector • 139 Save a Report in a Different Format • 95
Off Page Connectors • 77, 78 Save Custom Changes Command • 129
OPC Label Text Command • 139 Save Custom Changes Dialog Box • 150
Open Documents from the Symbol Explorer Save Custom Changes to an Enhanced
• 113 Report • 97
Open Target Loop Drawing From Paired Save Panel Strip and Connector Positions •
OPC • 80 96
Optimization • 133 Saving Custom Changes to Enhanced
Optimization > By-Pass Strips Command Reports • 97
(Actions Menu) • 134 Saving Enhanced Reports • 95
Optimization > Gap Connectors Command Saving Panel Strip and Connector Positions
(Actions Menu) • 134 • 96
Optimization > Optimize Overlapping Scale a Report to Fit Printer Paper Size •
Connectors Command (Actions Menu) • 106
134 Select OPC Pair Command • 139, 150
Optimization > Redraw All Connections Serial Fire and Gas Loops • 13
Command (Actions Menu) • 133 Set Filter Conditions for Item Properties • 48
Set the Tag Priorities Within a Loop • 35
P Set the Title Block Position • 30
Pair OPCs • 80 Set the Working Area Margins • 31
Performing Miscellaneous Activities in Setting Enhanced Report Utility Parameters
Enhanced Reports • 103 • 35
Place a Logo on an Enhanced Report • 26 Setting the Wiring Representation • 36
T
Tag Documents Command (Actions Menu)
• 132
Text Tab (SmartText Properties Dialog Box)
• 151
The Symbol Explorer • 109
Tile Horizontally Command • 142
Tile Vertically Command • 142
Title Block Macro List • 20
Tools Menu Commands • 140
U
Unpair a Paired OPC • 81
Update a Revision • 99
Update an Assembly • 76, 126
Updating Revisions • 99
Using Enhanced Report Layouts • 27
Using Enhanced Report Utility Help • 13
Using Filters • 47
Using Macros • 53
Using Redlining Common Tasks • 83
Using SmartText • 51
Using Templates • 14
Using Templates Common Tasks • 15
Using the Symbol Position Command
Workflow • 72
V
View a Web Page with the Symbol Explorer
• 112
View Documents with the Symbol Explorer •
112
View Menu Commands • 130