SPPIDDataModel (1)
SPPIDDataModel (1)
Utilities Guide
March 2015
DPID2-PE-200028H
Copyright
Copyright © 1999-2015 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.
Documentation
Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides,
Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a
particular software product.
Other Documentation
Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support,
SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph
as guidance for using a software product.
Terms of Use
a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the
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 and Documentation. 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.
b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial. The Other Documentation may
not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and for any
reason by Intergraph Corporation by giving written notice to Licensee.
Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. 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, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. 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.
Export Controls
Intergraph Corporation’s software products and any third-party Software Products obtained from Intergraph Corporation, its
subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are
subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software
Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access)
under the following circumstances:
a. To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries.
b. To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce
Denied Persons, Entities, and Unverified Lists, http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S.
Department of Treasury Specially Designated Nationals List, http://www.treas.gov/offices/enforcement/ofac/, and the U.S.
Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.
c. To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design,
development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive
nuclear uses.
d. To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporation’s Export
Compliance Department, Huntsville, Alabama 35894, USA.
Trademarks
Intergraph, the Intergraph logo, Intergraph Smart, PDS, SmartPlant, SmartMarine, FrameWorks, I-Sketch, IntelliShip, ISOGEN,
Sapphire, 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.
Index ........................................................................................................................................................... 33
Suggested Solutions
1. Delete symbol from existing drawings. Open the symbol in Catalog Manager, delete
rectangles, and draw the graphics as lines instead of a rectangle. Place updated symbol on
drawing.
2. Delete symbol from existing drawings. Open symbol in Catalog Manager, place a select set
around the graphics, select Ungroup from the Change toolbar. Place symbol on drawing.
3. Delete symbol from existing drawings. Open symbol in Catalog Manager, delete connect
points and add connect points. Place symbol on drawing.
4. Delete symbol from existing drawings. Open symbol in Catalog Manager, delete symbol and
re-create symbol. Place symbol on drawing.
5. Delete symbol from existing drawings. From Catalog Manager, delete connect points and
add Auxiliary points. Place symbol on drawing.
alternative exists before using the Entire Database command to automatically delete the
problems from the database.
5. After any manual database clean up, click Entire Database to automatically delete the
problems from the database.
6. Click Model Items.
7. On the Delete Orphan Model Items dialog box, select each model item type from Item
Type Names list to see if any orphan items exist in the database.
8. In the List view, select the model orphan items to delete, and click Delete.
You can also click Delete All to select and delete all the items in the list view.
9. Click Close to return to the Clean Data dialog box.
10. On the Clean Data dialog box, click OPCs.
11. On the Repair OPCs dialog box, chose either repairable or non-repairable from the OPC
Type list. Repairable OPC pairs retain one link out of two between the mates.
Non-repairable OPC pairs retain neither link.
12. Choose the OPC pair you are interested in from the OPC list, and click Fix if it is a
repairable pair or Delete if it is non-repairable.
13. Click Close to return to the Clean Data dialog box.
14. On the Clean Data dialog box, click Gaps to find and repair gaps that do not have the
correct representation in the database.
We do not recommend using the Gaps command as part of your database
constraint cleanup. If you find it necessary to run Gaps, you must be careful not to select
Yes to a symbol that is not a gap. If you select Yes to any symbol other than a gap, you may
corrupt your data set.
15. On the Clean Data dialog box, click Close to return to the design software.
The Clean Data utility must be run from within the SmartPlant P&ID environment.
For easy access to this utility, you can create a custom menu in the SmartPlant P&ID
interface to run the Clean Data utility. For information about how to do this, see the Create a
New Menu topic in the SmartPlant P&ID User's Guide.
Log messages generated when orphaned records are deleted from the plant database are
written to the DBCleanup.txt file in the folder assigned to the TEMP environment variable.
Log messages are placed in SPDelOrpModItems.log file in the folder assigned to the TEMP
environment variable. The log file contains information about deleted items including the
item type and SP_ID number.
4. On the Apply Display Set dialog box, enter the name of the display set to which you want
the display tab filters written.
5. The new display set is added to the View > Apply Display Set > My Display Sets menu.
2. Click Connect to Active Plant. The name of the active plant displays.
To use these files, you must rename the ItemTag.dll file installed on your computer (for
example, rename the file to DeliveredItemTag.dll), then copy from one of the product CD
sub-folders (ActiveProjectAgainstAs-Built or ActiveProjectAgainstAs-BuiltAndProjects)
the ItemTag.dll flavor that you want to use. Place this copy in the same location as the installed
ItemTag.dll that you just renamed. When you are finished, remove the ItemTag.dll copy, then
rename the delivered copy back to its original name.
5. Select the Report option and click OK to evaluate relationship indicators and generate the
RnR-RelIndicators.log report in the Temp folder. Review the report to see any relationship
indicator errors existing in the drawing.
6. If any errors exist, select the Repair & Report option and click OK to repair relationship
indicators and to generate an activity report, RnR-RelIndicators.log, in the Temp folder.
Review the report to see how each relationship indicator error was resolved.
7. Close and reopen the drawing after running this utility and before making any further
modifications to the drawing.
This utility must be run on a per drawing basis. It cannot be run on an entire plant.
Updating Symbology
You can force the software to redraw the graphic representation of your data, the drawing, by
using the Update Symbology command in SmartPlant P&ID. This command refreshes the
graphic symbology (that is, line weight and color) of symbols in your drawing based on the
current settings in Options Manager. The ApplySettingsCmd macro (delivered to the
..\SmartPlant\P&ID Workstation\bin folder) also updates the line settings, Minimum Connector
Segment, and Routing Self-Avoidance.
The symbology and other settings defined in Options Manager usually take effect only in those
drawings created after those values are defined. Updating Options Manager settings enables
you to force changes in your symbology definitions to be reflected in the current drawing,
regardless of when it was created.
Any user can update drawings using these commands. However, check your permissions,
which are assigned in SmartPlant Engineering Manager, to find out if you can make changes
to the plant-wide symbology in Options Manager.
Once you load the current plant-wide symbology definitions into your drawing, you cannot
revert to previous definitions. However, you can always override plant-wide symbology
choices in your drawing by using drawing filters and choosing alternate symbology for items.
In Options Manager, two settings, Minimum Connector Segment and Routing
Self-Avoidance, control the behavior of pipe and signal runs when they are placed in a
drawing or when an inline component is placed on a run. You can change these settings in
Options Manager, but the new values affect only lines placed after the change. The
ApplySettingsCmd.dll macro applies the latest settings to all runs on the current drawing.
You must run this macro for every drawing individually.
To disable checking, set the value to 0; to check all the categories, set the value to 7
(1+2+4). For a combination of checks, set the value of AnalyzerOptions to the bit sum of
the individual categories, for example, to check unnamed linear patterns and bad
connectors, the value of AnalyzerOptions should be set to 5 (1+4), as shown in the
example.
On opening the drawing, if a problem was found under one or more selected categories, the
following message appears:
4. Click Yes to open the SmartpidAnalyzer.log file, which is located in the user’s Temp folder.
The log file is overwritten each time a drawing with an identified problem is opened.
To use the Piping Specification Utility with SmartPlant 3D, you must install the SmartPlant
3D Piping Specification Remote Access Client, which is available on the SmartPlant P&ID
product CD under Prerequisite Software.
All of the displayed text strings are maintained as Visual Basic resources in the
PipeSpec.dll file. These strings can be translated or modified as required using a resource
file editor.
When performing piping materials class validations, commodity code lookup, or validation of
nominal diameter for SmartPlant 3D or SmartPlant Reference Data, the Piping Specification
Utility assigns the highest revision number from the SmartPlant 3D or SmartPlant Reference
Data piping materials class to the Pipe Spec Revision property.
Error messages are placed in the PipeSpecError.log file in the folder assigned to the TEMP
environment variable. Error messages help you identify the cause of failure when the utility
does not complete the tasks as expected. For example, if minimum requirements are not
met for the look-up, the missing properties are listed in the log file.
The ServiceLimits.log file contains any errors encountered during the Service Limit
Validation process, which runs as part of the Piping Specification Utility.
4. Double-click each property to display the Modify Property dialog box (see example below).
5. Type the necessary information in the given fields as shown in the above table; then click
OK to save and close.
6. Repeat the steps 3 - 5 above to update each database table.
PDS3D — The Short Value column is populated with data from the second column
of the PDS3D_SP3D_ShortCode_Correlation.txt file (AABBCC code).
SmartPlant 3D or SmartPlant Reference Data — The Short Value column is
populated with data from the third column of the
PDS3D_SP3D_ShortCode_Correlation.txt file.
No — The data in the Short Value column is not updated and remains what it was
previously.
When changing the Use piping specification setting from No to PDS3D, SmartPlant
3D, or SmartPlant Reference Data, validation occurs only for items modified after the
change.
3. Do one of the following:
If connecting to a SmartPlant 3D database, fill in the database information in the
SmartPlant 3D Plant Name and SmartPlant 3D Server Name fields, and then skip the
rest of this procedure.
If connecting to a SmartPlant Reference Data database, fill in the database information
in the SmartPlant Reference Data Plant Name and SmartPlant Reference Data
Server Name fields, and then skip the rest of this procedure.
The SmartPlant Reference Data server name must be entered as a connection
string in the form of <Host Name>:<TCP/IP Port Number>/<Service Name>, for
example:
IN-SPMATDBSRV:1521/SDB2012
If connecting to a PDS 3D database, proceed with the remaining steps of this
procedure.
4. Select the database type from the PDS Database Type list. Supported database types are
MSSQL and Oracle.
5. Type the database name in the PDS Database Name field.
The database name is not required for Oracle databases. The default value of a blank
space, not a null, must be assigned for Oracle databases.
6. Type a value in the PDS Database Server/Alias field.
This entry defines the server name for a Microsoft SQL Server database or the Alias
name on the client machine for an Oracle database.
7. Type the user name and password of the ra schema of a PDS 3D project under PDS
Approved Reference Database Schema Name and PDS Approved Reference Database
Schema Password respectively.
8. Type the user name and password of the pd schema of a PDS 3D project under PDS
Project Control Database Schema Name and PDS Project Control Database Schema
Password respectively.
9. In the Max-Temperature Unit in PDS3D list, select the unit of measurement used in PDS
3D for the maximum temperature limit for piping components.
The units for the PDS 3D maximum temperature are those specified in Options Manager.
If continuous validation is turned on for the PipeSpec utility, then a pipe run with
temperature-pressure limits that do not agree with its PMC generates Error in PMC in the
commodity code for an inline component.
If any temperature values for the pipe run are unspecified, then for SmartPlant Reference
Data or PDS 3D, a value of zero Deg-K is assumed for each of the unspecified
temperatures. For SmartPlant 3D, an unspecified temperature is interpreted as 'undefined'.
SmartPlant 3D can validate commodity codes using the four case temperatures listed earlier
against Maximum Temperature ranges or Minimum Temperatures specified on piping
components in the SmartPlant 3D database.
SmartPlant Reference Data can validate commodity codes using the pipe run’s Design Max
Temp against Maximum Temperatures specified on piping components in the SmartPlant
Reference Data database. Other case maximum temperatures or minimum temperatures will
not be used in the validation.
If the temperature falls within the allowable limits, the software will return a commodity code;
otherwise, Not in Spec is returned.
SmartPlant Reference Data supports a single maximum temperature only for each option code.
SmartPlant Reference Data does not return a commodity code for reducers.
The Fabrication Category property of inline piping components is a select-listed property in
SmartPlant P&ID. A relationship between the fabrication category and the commodity name
can be defined in the PDS 3D database. The Commodity Name is a unique name for
every symbol. In PDS 3D, this unique name is the AABBCC Code property. In SmartPlant
P&ID, the commodity name corresponds to the Short Value entry of the Piping Component
Type select list for the symbol defined in Data Dictionary Manager and it is this value of the
commodity name that is used for the look-up. For a delivered SmartPlant symbol, the Short
Value entry is equivalent to the symbol's AABBCC Code, defined in Catalog Manager.
Similarly, the Option Code property is a select list of text values in SmartPlant P&ID, while it
is a set of code numbers or indices in SmartPlant 3D. Short Value for the Option Code
select list contains the SmartPlant 3D indices corresponding to the appropriate Option Code
text in SmartPlant P&ID. The Piping Specification Utility uses the entries in the Short Value
box of the Option Code list to obtain the Option Code used in the SmartPlant 3D database
tables.
3. Select the check boxes beside the drawings that you want to process.
Click Select All to select all the drawings of the active plant.
The Report command only reports problems. Problems are addressed by running the
Repair & Report command or opening the drawing and running the Repair Relationship
Indicators utility (RepairRelIndCmd.dll).
The Status column of the Service Pids dialog box shows the current status of each
drawing as follows:
The status indicates that the drawing is either open or in a recreate state.
5. Click View Logfile to view the results of the reporting or repair process. The log file can be
saved as a text file and printed.
6. Click Close to close the utility.
Log Files
The following table lists the most common log files generated by SmartPlant P&ID.
C S
Check Item Paths Utility • 7 Sample Check Symbol Log File • 9
Check Symbols in a Plant • 8 Service P&IDs Utility • 28
Check Symbols Utility • 7 Smart PID Analyzer • 19
Clean Data (Delete Orphan Model Items) • SmartPlant P&ID Utilities • 7
10
Clean Data Utility (DelOrpModItems.dll) • 10 U
Configure Piping Specification Settings • 23
Update Labels Utility • 16
Update Line Styles Using the
D ApplySettingsCmd Macro • 17
Display Tabs Conversion Utility • 12 Update Zero Length Pipe Run Connectors
Duplicate Item Tag Report Utility • 13 Utility • 26
Updating Symbology • 16
E Use the Update Symbology Command • 17
Enter Required ProgIDs • 22
F
Find Invalid Break Labels Utility • 27
Fix Orphaned Symbols During Drawing
Re-Creation • 18
Fix Orphaned Symbols Using the
OrphanGraphics Macro • 17
Fixing Orphaned Drawing Symbols • 17
I
Item Tag Validation Utilities • 14
L
Local Model Item Lookup Table Utility • 15
Log Files • 31
O
Open the Service P&IDs Utility • 28
P
Performing Commodity Code and
Fabrication Category Look Up • 25
Performing Service Limits Validation • 25
Piping Specification Utility • 21
R
Repair Relationship Indicators Utility • 15