Terms - SmartPlant Foundation - IM Update 46 - Help - Hexagon
SmartPlant Foundation Help
Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)
SmartPlant Foundation Help
Using the Dashboard
Log In
Add a new server configuration
Change user
Change preferences
Edit your server configuration
Message bar display
Module security access
Password expired
Sidebar menu
Select a module
Use SmartPlant Dashboard Help
SmartPlant Foundation Desktop Client
Using the SmartPlant Foundation Desktop Client
Getting started
Setting the active scope
Set your active scope
Set the active configuration by role
Set the active scope using the shortcut menu
Get to know the Desktop Client user interface
Fdn menu
Menu bar
Toolbar
Shortcut toolbar
Tree view
Sidebar menu
New Items window
Properties window
List view
Change what you see in the List view
Export the contents of the List view
List Edit window
Open the List Edit window
Change what you see in the List Edit window
Export list to Excel
Edit the properties of an object in the List Edit window
Set the date and time in the List Edit window
Create a new object in the List Edit window
Change your status code colors in the List Edit window
Resolve conflicts in the List Edit window
Save lists as documents
Status bar
Manage windows in the Desktop Client
Learn about the Desktop Client user profile
Dock a floating window
Create tab windows from multiple windows
Keyboard shortcuts
User Options
Set user options
Change your password
Change user
Display the number of related objects in the tree view and shortcut menu commands
View data for a specific date and time
Reset user profile
Change user preferences
Change general user preferences
Change user preferences for windows
Display objects in a separate window by configuration
Change user preferences for expansion
Change user preferences for APIs
Change user preferences for claim
Change default container IDs for new objects
Change user preferences for 3D viewing
Search for Objects
Searching for objects
Find an object
Query for an object
Save a query
Run a saved query
Update saved queries
Edit a previous query
Delete a saved query
Navigate query results
Query using light list view
Query for terminated objects
Extract all paged query results to Excel
Find an object using an FTR search
Find an object using an FTR preview
Graphical Navigation
View and mark up files
View items in SmartPlant Foundation Desktop Client
Cache 3D model files
Cache file types to the SmartPlant Foundation server
View and annotate files
View a 2D file
View a 3D model
3D Navigation Controls
View an item in a drawing
View an item in a model
Select a standard isometric or orthographic view
View a connected drawing
Use 3D model relationships
Place a published P&ID in a 3D model
Display 2D plant items that are shared with a 3D model
Print a 3D model
Lock a Markup file
Unlock a Markup file
View alternate files
View a thumbnail image
View with native application
Convert files for navigation
Clip volumes
Set a clipping volume
Turn off volume clipping
Smart Review with SmartPlant Foundation
Launch Smart Review from SmartPlant Foundation
View an item in Smart Review
View a model in Smart Review
Build display sets
Create and Modify Objects
Create a new object using the Create wizard
Create a new object using the Create dialog box
Copy an object
Update an object
Delete an object
Terminate an object
Revive a terminated object
Display details for an object
Display the history of an object
Change the owning group for an object
View a related web site or file for an object
Document Management
Document life cycle
Components of the document model
Document status icons
Create and manage documents in the Desktop Client
Create a new design document
Create a new vendor document
Reserve a vendor document
Activate a reserved vendor document
Copy a document
Copy the latest revision of a document
Delete a document
Generate PDF copies
Generate WebGL viewer files
Create batch renditions
Generate a thumbnail image
Save alternate renditions
Attach a file to a document
Copy attached files
Create a new template document
Check in and check out a document
Check out a document
Cancel a check out
Check out and edit a document in an authoring application
Check in a document
Sign off on a document
Sign off a document
Sign off a document with comments
Undo a document sign off
Cancel a document
Cancel a document
Undo cancel on a document
Revisions and versions
Revise a document
Revise multiple documents
Insert a historical revision
Show all revisions for a document
Show all versions for a document
Create a snapshot of a document version
Generate a document revision report for a document
Purge superseded versions for a document
Delete a document revision
Terminate a document revision
Comparing published documents
View and compare document versions
Compare document versions
Print the views in the Compare window
Select the layout for the Compare window
Change colors for comparison results
Change display indicators for comparison results
Change auto-focus options for comparison results
Find a change in the Comparison Results table
Find a selected change in compared drawings
Learn more about the View and Compare window
Print
Set view options
Zoom in
Zoom out
Zoom area
Fit
Pan
Select
View and Markup
Archive and purge
Archive files
Review the archive document and archive information files within Desktop Client
Reference files
Learn more about file types for reference files
Update Maintain Relations properties on reference files
Update reference relationships
Update Referred by relationships
Show nested reference files
View reference files for a document revision
Reference file behavior
Watermarks and labels
Create a new watermark
Attach a watermark to a document
Print a document with a watermark
Create a new label
Attach a label to a document
Print a document with a label
List documents
Create a new list document
Edit a list associated with a list document
Attach the list to an existing document
Create a list document snapshot
Create a line list document snapshot
Relationship Management
View relationships
Create relationships
Edit relationships
Terminate relationships
Use SmartPlant Foundation as an Authoring Tool
Register SmartPlant Foundation as a Tool
Register SmartPlant Foundation
Find registered tools
SmartPlant Registration Wizard
Data Sheets and Data Lists
Data sheet and data list basics
Edit Microsoft Excel security settings for data sheets and data lists
Data Sheets
Learn about instrument data sheet templates
Manage process cases
Create a process case
Associate process cases with instruments
Generate and edit an Instrument data sheet (IPD) online
Generate and edit a data sheet offline
Load offline data sheets and data lists
Generate datasheets for multiple instruments into a single worksheet
Publish a data sheet
Retrieve a data sheet in SmartPlant Foundation
Update the data sheet template for a partially mapped data sheet
Document-Managed Data Sheets
Create a data sheet document
Create a snapshot of a data sheet document
Compare data sheet snapshots
Publish a data sheet snapshot
Data Lists
Learn about data list definitions
Generate and edit an instrument data list online
Generate and edit an instrument data list offline
Generate a data list from a related object
Create and manage objects in a data list
Line Lists
Components of the Line List application
Line segment
Line list record
Line list pipeline
Line list
Line list document
Line list icons
Integrated line lists
Creating line lists from Smart P&ID data
Using line lists
Roll up and consolidate line lists
Retrieve data into the line list application
Roll up a line segment
Create a line list
Add records to a line list
Modify line list records
Create a line list pipeline
Create a line list record document
Create a line list document snapshot
Publish a line list document snapshot to the data warehouse
Reports
Adhoc reports
Create a new report
Save a configured report to run later
Save a report with filters
Save a report to run in the background
Run an existing report
Define filter criteria for an Adhoc report
Configure a report to run as a scheduled task
Terminate a report
Download physical files associated with objects in a report
Learn more about reporting output styles
Expose Adhoc reports in the Web Client
Graphic Reports
Create a new graphic report
Edit a graphic report definition
Modify the symbology of a graphic report
View an existing graphic report
Select a graphic report to run
Apply a graphic report to a model
Business Intelligence reports
Report snapshots
Creating and comparing report snapshots
Create a register definition
Create a register document
Create a snapshot of a report
Create a historic snapshot of a report
Create a snapshot comparison report
OpenXML Word reports
Create an OpenXML Word report for a design document
Exchange Data
Change Notifications
Manage object subscriptions
Add an object subscription
Update an object subscription
Remove an object subscription
Manage class subscriptions
Add a class subscription
Update a class subscription
Remove a class subscription
Workflows and the To Do List
Managing a document's workflow
Learn more about workflows
Workflow templates
Workflow status
Attach a workflow
Delete an attached workflow
Put an attached workflow on hold
Take an attached workflow off hold
Reject an attached workflow
Terminate an attached workflow
Update a workflow
Update the recipients of a current workflow step
Setting up your To Do List
Show or hide the To Do List
Show related items in a workflow across multiple plant configurations
Using the To Do List to manage workflow steps
View relationship objects
Claim a step in a workflow
Acknowledge an information step
Complete a step in a workflow
Update the checklist for a workflow step
Approve a step in a workflow
Reject a step in a workflow
Indicate a step cannot be completed
Reassign a step to another user or role
View a workflow
Add a recipient to a workflow step
Change the duration for a workflow step
Update the description for a workflow step
View a workflow details report for a document
View workflow details for a document
View workflow history for a document
View a report of overdue workflow steps
Transmittals
Transmittal icons
Transmittal life cycle
Transmittal project roles
Transmittal structure
Distribution matrices
Create and manage transmittals
Understanding default conditions for including documents in transmittals
Create an internal transmittal
Create an external transmittal
Create an internal transmittal for a set of documents
Create an external transmittal for a set of documents
Attach a document to a transmittal
Assign documents to an issue request
Export a transmittal
Export a transmittal (online)
Copy a transmittal
Create a transmittal from a template
Set the planned date for a transmittal
Update transmittal recipients
Set the controlling recipient for a transmittal
Cancel a transmittal
Terminate a transmittal or a section
View a transmittal structure
View a transmittal summary report
Save a transmittal as a template
View the transmittal history for a document
Manage transmittal responses for email and paper users
Schedulers and Queue Management
Scheduler
Stop or start a scheduler
Query for scheduled tasks
Retry a failed task
Load queue management
Publish documents
View documents in a queue
Find published documents
Query published documents
View a successfully published document
View published document information
Access load queues
Query for a published document by queue
Check published document status
Published document statuses
Manage the load queue
Retry failed document
Stop or start load queue
Printing in the Desktop Client
Print the contents of a List View window
Print a List View window
Print the contents of a dialog box
Batch print attached files
Print files to a local printer
Integration
Learn more about working in an integrated environment
Working with Microsoft Excel
Import data from Microsoft Excel
Import data from Microsoft Excel and compare
Export the contents of a List View to the default template
Export the contents of a List View to the selected template
Export the contents of a List View to Excel
Publish data from Microsoft Excel
Publish data from Microsoft Excel and compare
Configure export template
Create a template from Microsoft Excel
Create a template from the Desktop Client
Load the template file into the Desktop Client
Comparing published documents
Compare published items and work process considerations
Compare design basis objects to the design
Compare design basis documents to the design
Compare with design
Correlating items
Correlate items manually after publish
Correlate items automatically during publish
Correlate items from a new tool
Correlate items from PDS or AVEVA PDMS
View shared objects
Viewing status and history
View document history
View documents in a queue
View documents in load queues
Use load options
View authoring tools registered with the current plant
Revising documents
Learn more about revising documents
Revise a document
Revise a document in Smart 3D
Use minor revisions in Smart P&ID
Learn revision scheme behavior through scenarios
Publishing in an integrated environment
Learn more about publishing in an integrated environment
Reasons to publish
Publishing documents
Publishing files without data
Revisions and versions of publishing documents
Publish SmartPlant Foundation data
Query for a published document
View drawing items in a published document
Allow users to publish documents to a default workflow
Learn about publish workflows
Understand Load, Consolidated, and MergeDelta tasks
Publish the Plant Breakdown Structure
Register the Plant Breakdown Structure
Publish the Plant Breakdown Structure
Publishing large 3D models in SmartPlant Foundation
Learn more about publishing large 3D models to SmartPlant Foundation
Maintain versions of the composite document in SmartPlant Foundation
Publish the 3D model in Smart 3D
Publish the 3D model in PDS
Publish the 3D model to AVEVA PDMS
Query for a 3D composite document in SmartPlant Foundation
View the 3D model in SmartPlant Foundation
Create the 3D composite model manually
Add or remove relationships for composite 3D documents
Retrieving in an integrated environment
Learn more about retrieving documents in an integrated environment
Data handling after retrieval
Document types for retrieval
Design basis
Retrieve and restore
Retrieve in SmartPlant Foundation
Viewing inconsistencies
Viewing inconsistency reports in Microsoft Excel
Creating inconsistency reports in the background
Concurrent Engineering
Modifying an object in a project
Change user preferences for a claim
Claim an object
Claim optional objects
Update a claimed object
Claim an issued document
Merge a claimed object into the plant
Merge a complete configuration
Merge items by grouping object
Unclaim an object
Subscribe to claim notifications
Resolve conflicts and generate reports
Compare object to a higher configuration
Resolve conflicts
Generate a configuration report
Generate a future changes report
Generate a merge validation report
Generate a mergeable item summary
Create a mergeable items summary
Create a merge structure summary with validation
Viewing the mergeable items summary results
Exporting the report to Excel
Viewing the report in Excel
Generate a merge structure exception report
Use Merge Progress Notification
Merge with Merge Progress Notification enabled
Understand merge progress information
Review failed merge items
Progress
Calculate progress
Report progress
Progress example
Find an existing design workpack or design workpack template
Find an existing activity
Find an existing set of progress options
Freeze plan dates
Redistribute man hours
View progress data
View progress data graphically
Export progress data to Excel
Loader
Create a load file
Process a load file
View and edit XML load files
Load offline datasheets and data lists
XML format
XML instructions
XML load formats for documents
Attaching files (XML)
NLF format
NLF instructions
NLF load format for documents
Attaching files
Field types for NLF
Relations for NLF
Supporting relationship relations
Data lists in NLF format
Object mode in NLF format
NLF load file date examples
Transaction handling
Date time handling
CreateConfig setting
Modes for load files
ContainerID
SuppressENS
Load errors and reloading files
Viewing errors in the Loader
Reload files
Exception reports
View exception reports
View exception reports for individual load errors
Command line usage for the Loader
Loader Directory Poller
Run the Loader Directory Poller
Load file examples
Data creation
Perform instructions
Design document creation
Relationship examples
Attaching a file to an object
Attaching a document to a workflow
Configuring the SmartPlant Foundation Desktop Client
Setting up SmartPlant Foundation
Setting Up and Configuring SmartPlant Foundation
Stand-alone mode - SmartPlant Foundation authoring
Data warehouse mode
Combined mode
How to Set Up and Configure SmartPlant Foundation
Prerequisite knowledge for configuring SmartPlant Foundation
Design of what is required
Advantage of separate authoring and data warehouse servers
Domains
Domain groups
Extending the integration schema
Extending the existing stand-alone SmartPlant Foundation schema
Create a schema extension file
Add a new schema file to a configuration file
Create new objects and relationships in the schema
Modeling in the Schema Editor (class definitions and relationship definitions)
Configure a class definition
Configuring Relationships
Configure a relationship definition
Relationship properties
Max1 and Max2
Min1 and Min2
Delete12 and Delete21
Copy12 and Copy21
Owner12 and Owner21
ForceNullConfig
Claim12 and Claim21
FilterEdge12 and FilterEdge21
SPFCascade12
SPFCascade21
ExcludeFromMerge
Relationship examples
Optional relationship to a single existing object
Required relationship to a single existing object
Relationship with ownership
Composite objects
Configuration management and relationships
Configuration management and relationship ownership
Automatic claim of related objects
Optional claim of related objects
Configure an interface definition
Configure a property definition
Model complex documents
Load stand-alone schema changes into SmartPlant Foundation
Interactive modeling and administration
Stand-alone
Development - Production
Development - Prototype - Production
Plants and Projects
Sites
Plant breakdown structure
Create and configure a plant
Create a plant
Create a project
Create an area
Create a unit
Setting the active scope
Setting the active scope using the shortcut menu
Active Scope Status Configuration Syntax
Associate a vault
Configure role assignments
Include plants in a configuration
System administration user preferences
Display objects using internal names
Display internal names for GUI items
Manage object and relationship containers
Container ID naming convention
Setting container IDs
Set the container ID for new data
Set the container ID for existing data
Query by container
Exporting by container
Extend the administration model
Export data
Exporting data
Exporting link interfaces
Exporting by graph definition
Exporting by container ID
Exporting list views to Excel and text files
Loading the extended model
Compare XML
Summary of Delivered Configuration
Domains delivered
Databases delivered
Containers
Startup layer
Bootstrap layer
SchemaComponent layer
Core layer
Schema containers
Admin containers
Additional layers and containers
PlantAndProject container
PBS container
CertDocuments container
CertExSystemAndTags container
CertProgress container
CertTransmittals container
CertVendorDocs container
Security Configuration
Security Model Configuration Overview
Components of the security model
Security model configuration
How to Configure the Security Model
Configuring security
Log on security configuration
Password security
Access group configuration
Create access groups
Restrict access by configuration status
Configure method access
Copying method access groups
GUI item access configuration
Relationship access configuration
Restricting user and role access to database operations
Owning group configuration
Link vaults to owning groups
Create owning groups
Domain configuration for data segregation
Create domains
Relate class definitions to the domain
Role configuration
Create roles
Manage roles
User and role assignment configuration
Create login users
Create email users
Create paper users
Allow users to change other users' passwords
Change a user's password
Create and manage role assignments
Create, copy, and delete role assignments
Create a new configuration and assign users
Copy a configuration with role assignments
Data access configuration
Object owning group access control
Methods for setting ownership
Form sections for setting ownership
Interface owning group access control
Filtering objects by access group and owning group
Restricting objects at point of query
Workflow access control
View definition access configuration
Module security access configuration
Security rules configuration
Create a security rule
Applying security rules for complex objects
Security Model
Conditional data access
Example: Qfind method filter using an edge definition
Users
Roles, domains, and access groups
Object ownership
Role assignments
Shortcut menu method access
Menus and toolbar access
Relationship manipulation and navigation
Interface ownership
View definition access
Summary of Delivered Core Security Model
Domains
Owning groups
Roles
Roles and access groups
User Interface Configuration
GUI Model Configuration
Components of the GUI model
Methods
Right-click actions
Pull down menus
Toolbars
Drill down
Quick Find menu
Relationship management
Column sets
Manage related items
Forms
How to Configure the GUI Model
Container management
System administration user preferences
Configure methods
Add a new command to a menu
Create or update a method
Client Application Programming Interface (API)
Create a client API report
Common methods
Set the default double-click action
Configure paging queries
Configure light list view paging query
Configure extract all paged query results to Excel
Configuring queries for terminated objects
Configure conditions
Create or update a condition
Find a condition
Condition syntax
Functions
Condition constants
Environment variable support
Validate conditions
Correcting conditions
Expose shortcut menu actions
Shortcut toolbar
Expanding relationship toolbar shortcuts
Configuring relationship toolbar shortcuts
Managing access to relationship toolbar shortcuts
Relationship toolbar shortcut examples
Configure cascading shortcut menus
Create a cascading menu on a method
Create a cascading menu on a relationship definition
Create a cascading menu on an edge definition
Create a new menu
Create a new menu item
Manage menu items
Create a new sub menu
Create toolbars
Create a toolbar item
Create drill down tree items
Create a drill down tree item
Expand items by grouping
Quick Find menu items
Add a new item to the Quick Find menu
Configure launch URL client APIs
LaunchURL
LaunchURLWithDynamicArgs
Configure property definition URLs
Creating a property definition URL
Relationship management
Expand structure
Example of expanded structure for a class definition
Configure column sets
How column sets work
Tree view display column set
Column set resolution
Create column sets
Create a column set
Create column set items
Create column set items using the Library tab
Create column set items using the Schema Navigation tab
Associate a column set with an interface
Example configurations
Cumulative column sets on classified objects
Overriding cumulative column sets for Quick Find
Manage column items (Modified in an update)
Configuring automatic sorting using column sets (Modified in an update)
Manage column items for edit (Modified in an update)
Configure entry point default search filters
Configure column items by configuration (Modified in an update)
Manage related items
ManageRelatedItems API argument examples
Use the Manage Related Items form
Create and relate a new item
Find an existing item
Add an existing item
Update an existing item
Delete (terminate) a relationship
Delete an item
Edit relationships
View related items
Configure forms
Generate a form from a class definition
Form generation process
Default form generation
Generate form section for an interface
Form generation overrides
Create a form manually
Copy a form
Form builder
Create form sections
Dynamic sections
Dynamic section tabs
Picture mask types
Validate dates
Set date and time formats
Use regular expressions
Password mask on forms in the Web Client
Manage form sections
Create new section
Find an existing section
Add an existing section
Update an existing section
Delete a section from a form
Delete a section
Manage form section access control (Modified in an update)
Configure section access groups (Modified in an update)
Configure section owning groups (Modified in an update)
Setting precedence for form sections (Modified in an update)
Configure form title
Suppress the Apply button on forms in the Web Client
Create new display items
Display item types
List editing
List Management Console
Create a new list
Edit a list
Copy a list
Delete a list
Configure dependent related items for list editing
List Edit toolbar
Saving lists as documents
List Management Console advanced mode
Create a list in advanced mode
Edit, copy, or delete a list in advanced mode
Edit interfaces for a list
ISPFListEditControl interface
Edit access groups for a list
Configure column items for a list
Allow users to search for property values in the List Edit control
Edit lists of similar objects
Launch a list edit control from an object not included in a list
Display item display types
Manage display items (Modified in an update)
Relate a new display item to a section (Modified in an update)
Find an existing display item (Modified in an update)
Add an existing display item (Modified in an update)
Update an existing display item (Modified in an update)
Delete a display item from a section (Modified in an update)
Delete a display item (Modified in an update)
Restrict the Field length on a display item (Modified in an update)
Override enum behavior in a display item (Modified in an update)
Dependent related items
Dependent related items process
Configure dependent related items
Configure dependent and multiple dependent display items
Configure Relationship tabs on forms
Update form sections after schema modifications
Generate a new section from an interface
Configure UoM display sets
Default UoM
Create UoM sets
Desktop Client UoM support
Enumerated lists
Enumeration hierarchies
Making an enumerated list expandable
Disabling enumerated entries
Using EnumIsDisabled with forms
Properties window
Configure the Extended view
View definition access configuration
Graphical User Interface (GUI) Model
Item access control
Simplified model diagram
Toolbars
ISPFToolbar interface
ISPFGUIAccessControl interface
SPFGUIAccessControlMethod relationship definition
SPFGUIAccessControlDataAccessGroup relationship definition
ISPFGUIDisplay interface
ISPFDataAccessGroup interface
ISPFMethod interface
ISPFShortcutMethod interface
ISPFShortcutRelation interface
Quick Finds
ISPFQFindItem interface
ISPFGUIAccessControl interface
Drill down items
ISPFDrillDownItem interface
ISPFGUIAccessControl interface
Menus
SPFMenu class
ISPFMenu interface
SPFMenuParent relationship definition
SPFMenuItems relationship definition
ISPFMenuItem interface
ISPFGUIDisplay interface
Methods
ISPFClientAPI interface
ISPFMethod
SPFInterfaceDefMethod relationship definition
SPFMethodCondition relationship definition
SPFAccessGroupMethod relationship definition
ISPFAccessGroupMethod interface
SPFAccessGroupMethodCondition relationship definition
ISPFCondition interface
SPFClientAPIMethods relationship definition
SPFInterfaceDefValidClientAPIs relationship definition
ISPFGUIDisplay interface
Forms
ISPFForm interface
SPFClassDefForm relationship definition
SPFRelDefForm relationship definition
SPFObjClass interface
SPFObjClassForm relationship definition
SPFFormSection relationship definition
SPFFormSectionAccessGroup relationship definition
ISPFAccessGroup
ISPFSection interface
SPFSectionFormPurpose relationship definition
SPFSectionDisplayItem relationship definition
ISPFFormPurpose interface
ISPFDisplayItem interface
SPFFormSectionsPrecedence relationship definition
Display items
ISPFDisplayItem interface
SPFDisplayItemDependantItem relationship definition
SPFDisplayItemPropertyDef relationship definition
SPFDisplayItemEnumOverride relationship definition
SPFDisplayItemInterfaceDef relationship definition
SPFDisplayItemRelDef relationship definition
SPFDisplayItemEdgeDef relationship definition
ISPFDisplayItemRelDef interface
ISPFDisplayItemEdgeDef interface
IPropertyDef interface
IEnumListType interface
Dependent related items
ISPFDependentItem interface
Column sets
ISPFColumnSet interface
ISPFColumnItem interface
SPFColumnSetColumnItem relationship definition
ISPFColumnSetColumnItem interface
SPFInterfaceDefColumnSet relationship definition
SPFClassDefDisplayColumnSet relationship definition
SPFColumnSetObjClass relationship definition
Summary of Delivered Core GUI Model
Base form sections
Custom sections
Delivered form generation overrides
Infrastructure Configuration
Infrastructure Model Configuration
Components of the infrastructure model
Subscription
Notification
Scheduler
Printing
Print scheduler task
Alternate rendition scheduler task
SmartPlant Foundation Options
Email
Calendar
Organizations
Other support items
How to Configure the Infrastructure Model
Configure subscriptions
Subscription menu options
Configure object subscriptions
Manage object subscriptions (notification only)
Manage my object subscriptions
Create a new subscription for an object
Manage all subscriptions to object
Manage subscriptions for an object
Manage my object subscriptions
Manage object subscriptions across users
Manage class subscriptions
Manage my class subscriptions
Create a new subscription for a class
Manage notification subscriptions
Create external DLL subscriptions
Create logging subscriptions
Manage all class subscriptions
Manage class subscriptions for the current user
Manage class notification subscriptions across users
Manage class DLL subscriptions
Manage class log subscriptions
Configure notifications
Create the notification definition
Using a custom notification definition
Load Queue status notifications
Configure printing
File types and printing applications
Printer and file type relationships
Batch printing, local printing, and Office files
Configure batch printing
Configure the SPF Remote Services user
Configure Microsoft Office
Give users access to the SPF Remote Services temporary folder
Create printers
Create a printer group
Create an organization
Create printing relationships
Test the batch printing configuration
Configuring the scheduler
Single server scheduler setup
Multiple server scheduler setup
Configure the scheduler on an alternate server
Configure the scheduler polling intervals and running threads
Configure the system options
Configure the display of user names and login names in the Desktop Client
Set up Auto Retry
Configuring email notification definitions
Create or update an email definition
Configuring conditions
Add comments and messages to next step email
Add last interactive step comments to next step
Configure default email notifications
Learn more about email digests
Set user email digest duration
Configure and maintain calendars
Create a new calendar
Maintain your calendar
Implement a custom calendar
Configure archive purge
Configure companies and organizations
Create an external company
Create an internal department or office
Create an external department or office
Configure hosts
Create a new host
Relationships between hosts and organizations
Create a relationship between a host and an organization
Relationship between hosts and vaults
Infrastructure Model
Subscription model
Class subscription
Subscription
SPFDLLSubscriptionDef class
IDLLSubscriptionDef interface
SPFLogFileSubscriptionDef class
ILogFileSubscriptionDef interface
Scheduler model
Scheduler tasks
ISPFScheduler interface
SPFSchedulerSite relationship definition
SPFSchedulerTask relationship definition
ISPFSchedulerTask interface
SPFSchedulerTaskTasks relationship definition
ISPFAdminItem interface
Print scheduler task
ISPFPrintSchedulerTask interface
SPFPrintSchedulerTaskTaskItem relationship definition
ISPFPrintSchedulerTaskItem interface
FTR scheduler task
ISPFFTRSchedulerTask interface
Export and compress scheduler task
ISPFExportCompressSchedulerTask interface
Data loading scheduler task
ISPFDataLoadingTask interface
Send email digest scheduler task
ISPFSendEmailDigestTask interface
ISPFEmailUserSendEmailDigestTask relationship definition
ISPFEmailUser interface
Archive purge scheduler task
ISPFArchivePurgeSchedulerTask interface
SPFArchivePurgeSchedulerTaskTaskItem interface
Title block scheduler task
ISPFTitleBlockSchedulerTask interface
Alternate rendition scheduler task
ISPFAlternateRenditionsSchedulerTask interface
ISPFAltRendSchTaskTskItem relationship definition
Attach workflow scheduler task
ISPFAttachWorkflowSchedulerTask interface
ISPFWorkflowTemplate relationship definition
SmartPlant Foundation Options
ISPFOptions interface
SPFOptionsDefaultNotification relationship definition
ISPFConfigurationOptions interface
ISPFWorkflowOptions interface
ISPFNotificationDef interface
Email
Calendar
ISPFCalendar interface
SPFCalendarCalendarYear relationship definition
ISPFCalendarYear interface
Organizations
ISPFCompany interface
ISPFExternalOrg interface
ISPFDepartment interface
ISPFInternalOrg interface
ISPFOrganization interface
ISPFManufacturer interface
ISPFSupplier interface
ISPFExternalOrg interface
ISPFOrganization interface
Support items - Host
ISPFHost interface
SPFVaultHost relationship definition
SPFOrganizationFileServerHost relationship definition
ISPFVault interface
SPFVaultReplicatedTo relationship definition
ISPFOrganization interface
ISPFLoginUser interface
Support items - Local server
ISPFLocalServer interface
Folders model
ISPFFolder interface
SPFFolderSupportItem relationship definition
ISchemaObj interface
SPFFolderSchemaItem relationship definition
SPFFolderAdminItem relationship definition
ISPFDocument interface
ISPFPlantItem interface
SPFFolderPlantItem relationship definition
ISPFAuthPublishableItem interface
ISPFTEFPublishedItem interface
Other support items - Contract
ISPFContract interface
Other support items - Home collection
ISPFHomeCollection interface
SPFHomeCollectionObject relationship definition
SPFHomeCollectionUser relationship definition
Summary of Delivered Core Infrastructure Model
Notification definitions
Document Management
Document Management Configuration
Document life cycle
Components of the document model
How to Configure the Document Schema
Schema Editor
Revision schemes configuration
Create a new revision scheme
Configure different revision scheme strategies
One revision scheme for the whole system
Different revision schemes for plants and projects
Different revision schemes for a specific plant or project
Different revision schemes for different document classifications
Different revision schemes for different document classes
Vault configuration
Vault rules
Configure a default vault
Configure vaults by owning group
Configure vaults by configuration
Force a class of object to a vault
Configure alternative vaults for different object classes
Configure vaults by object properties
Configure vault subdirectories by document type
Configure subdirectories by a file limit
Create a new vault
Replicated vaults
File encryption in vaults
Configure title block updates for file types
Document GUI configuration
Configure markups
Configure markup security
Configure markup print and publish access
Configure markup labels and watermarks edit access
Configure watermarks and labels
Configure access to navigation
Configure access for displayed drawing layers
Configure the archive and purge functionality
Review archive document and archive information files
Change the default archive location
Enable purge after archive
Configure Full Text Retrieval (FTR)
Indexing
Configuring FTR Server
FTR Server Configuration Properties
Selective indexing
Setting a date and time for the scheduler task
Indexing Criteria section
Type of objects to be indexed
Regular indexing
Processing Deleted Objects
Indexing Status report
FTR filtering
Create and view batch renditions
Configure PDF generation
Manage alternate renditions
Configure WebGL viewer file generation
Generate WebGL viewer files from shortcut menu commands
Generate WebGL viewer files in batch
Automatically generate WebGL viewer files
Configure markup rendition file generation
Generate markup rendition files in batch
Automatically generate markup rendition files
Configure thumbnail generation
Configure export object structure
Change the default ExportObjectStructure target type and location
Use a seed (template) file to create a document
Create and classify a seed file
Enable seed files for a specific document class
Configuration controlled behavior of seed files
List document configuration
List document column set configuration
List Edit control
List document snapshot configuration
Template document for list snapshots
Documents with multiple sheets
Document Management Model
Complex document object
Non-revisable documents configuration
Non-revisable document model
ISPFDocument interface
ISPFDocumentObject interface
ISPFSubscribableItem interface
ISPFOwnedObj interface
ISPFFileComposition interface
ISPFClassifiedItem interface
SPFDesignDocClassAdminDocClassDef relationship definition
Non-revisable document forms
Exposing non-revisable documents in the GUI
Basic document configuration
Basic document master
ISPFVendorDocMaster interface
ISPFNonPublishedDocMaster interface
ISPFDocumentMaster interface
ISPFDocument interface
ISPFDocumentObject interface
ISPFSubscribableItem interface
Basic document revision
Complex document
ISPFVendorDocRevision interface
ISPFNonPublishedDocRevision interface
ISPFDocumentRevision interface
ISPFDocumentObject interface
ISPFSubscribableItem interface
ISPFOwnedObj interface
Basic document version
Complex document
ISPFVendorDocVersion interface
ISPFNonPublishedDocVersion interface
ISPFDocumentVersion interface
ISPFDocumentObject interface
ISPFSubscribableItem interface
ISPFOwnedObj interface
ISPFFileComposition interface
ISPFExportableItem interface
Basic document forms
Expose non-classified documents in the GUI
Design document master model
ISPFDesignDocumentMaster interface
ISPFTemplateMaster interface
ISPFNonPublishedDocMaster interface
ISPFDocumentMaster interface
SPFDocumentRevisions relationship definition
ISPFDocument interface
ISPFDocumentRevision interface
ISPFDocumentObject interface
ISPFClassifiedItem interface
ISPFSubscribableItem interface
Design document revision model
ISPFDesignDocRevision and ISPFTemplateRevision interfaces
ISPFNonPublishedDocRevision interface
ISPFDocumentRevision interface
ISPFDocRevisionScheme interface
SPFDocRevisionRevisionScheme relationship definition
SPFDocRevisionVersions relationship definition
SPFDesignBasis relationship definition
ISPFDocumentVersion interface
ISPFDocumentObject
ISPFPlantItem interface
SPFDocRevisionPlantItem relationship definition
ISPFMergableDocumentRevision interface
ISPFMergableItem interface
ISPFMergedItem interface
ISPFSubscribableItem
ISPFWorkflowItem interface
Revision scheme configuration
ISPFDocumentRevision interface
SPFDocRevisionRevisionScheme relationship definition
ISPFRevisionScheme interface
SPFInterfaceDefRevisionScheme relationship definition
ISPFObjClass interface
SPFRevisionSchemeObjClass relationship definition
ISPFConfiguration item interface
SPFRevisionSchemeConfigurationItem relationship definition
Design document version model
ISPFDesignDocVersion and ISPFTemplateVersion interface
ISPFNonPublishedDocVersion interface
ISPFDocumentVersion interface
ISPFDocumentObject interface
ISPFSubscribableItem interface
ISPFFTRItem interface
ISPFOwnedObj interface
ISPFFileComposition interface
Document reservation configuration
Document reservation model
ISPFDocMaster interface
ISPFReservableDocumentItem interface
ISPFReservableItem interface
Document reservation and forms
Expose the document reservation in the GUI
Snapshot document model
ISPFDatasheetRevSnapshot interface
ISPFListDocRevSnapshot interface
List document model
ISPFListEditControl interface
Publishable documents model
ISPFAuthPublishableDocumentRevision
ISPFAuthPublishableDocumentVersion
Data sheet document model
ISPFDatasheetDocRevision
Configuration controlled documents
Configuration controlled documents model
ISPFMergableDocumentRevision interface
ISPFMergableItem interface
ISPFMergedItem interface
Mergable documents and forms
Expose document merge GUI
Data sheet documents configuration
Data sheet documents compare configuration
Data sheet documents publish configuration
Full Text Retrieval
ISPFFTRConfig interface
ISPFFTRServerConfig interface
ISPFFRTStopProperty interface
Watermark and label model
ISPFDocument interface
ISPFDocumentMaster interface
ISPFDocumentRevision interface
ISPFDocumentObject interface
ISPFLabel interface
SPFDocMasterLabel relationship definition
SPFDocRevisionLabel relationship definition
SPFDocumentObjectLabel relationship definition
ISPFWatermark interface
SPFDocMasterWatermark relationship definition
SPFDocRevisionWatermark relationship definition
SPFDocumentObjectWatermark relationship definition
File interface model
ISPFTemplateFile interface
ISPFDesignFile interface
ISPFBusinessFile interface
SPFFileComposition relationship definition
ISPFFile interface
ISPFDBFile interface
ISPFOwnedObj
SPFFileFileType relationship definition
SPFFileVault relationship definition
ISPFAuthToolDataFile interface
ISPFAuthToolViewFile interface
ISPFFileInfo interface
File composition model
ISPFTemplateFile and ISPFDesignFile interfaces
ISPFNavigationFileComposition interface
SPFFileNavigationFile relationship definition
ISPFNavigationFile interface
ISPFAlternateRenditionComposition interface
SPFFileAlternateRenditionRelationship definition
ISPFAlternateRendition interface
ISPFMarkupComposition interface
SPFFileMarkup relationship definition
ISPFMarkupFile interface
ISPFFile interface
SPFFileRelation relationship definition
ISPFRefFile interface
ISPFRefFileComposition interface
SPFReferenceFile relationship definition
ISPFCopiedReferenceFile interface
SPFReferenceCopy relationship definition
ISPFReferenceControl interface
File types model
ISPFFileType interface
SPFFileTypeFileType relationship definition
ISPFTitleBlockPluginAddress interface
ISPFAlternateRenditionInfo interface
SPFFileFileType relationship definition
SPFPrinterFileTypes relationship definition
SPFFileTypeRefType relationship definition
SPFFileTypeObjClass relationship definition
ISPFFile interface
ISPFPrinter interface
ISPFRefType interface
Vault configuration model
ISPFFile interface
ISPOwnedObj interface
ISPFVault interface
ISPFVaultRule interface
ISPFDataAccessGroup interface
Design document classification model
Template document classification model
Alternate rendition model
ISPFAlternateRendition interface
SPFFileAlternateRendition relationship definition
ISPFAlternateRenditionComposition interface
ISPFDesignFile interface
ISPFAlternateRenditionInfo interface
ISPFAlternateRenditionSchedulerTask interface
ISPFFile interface
ISPFFileType interface
ISPFMergedRendition interface
SPFMergedRenditionComposition relationship definition
ISPFMergedRenditionsComposition interface
Summary of Delivered Core Document Model
Vaults
Alternate rendition file type path
Revision schemes
Form sections
Printing
Batch printing, local printing, and Office files
Enable print options on the Print Options dialog box
Print scheduler task
Configure batch printing
Configure the SPF Remote Services user
Configure Microsoft Office
Give users access to the SPF Remote Services temporary folder
Create printers
Create a printer group
Create an organization
Create printing relationships
Test the batch printing configuration
Objects and relationships for printing
Printer and file type relationships
File types and printing applications
Generating PDFs
Set up PDF generation
Configuring PDF generation with SmartPlant Markup Plus
Configure a file type to use SmartPlant Markup Plus for PDF generation
PDF generation with custom .INI settings
Additional settings and tips required for generating a PDF/CSF
Setting Launch and Active Permissions
Adding SPFRemoteServices to the Administrators group
Configure PDF generation and batch printing (retired)
Configure PDF generation
Create a SPFFileTypeFileType relationship definition
Configuring custom file extensions
Generate PDF files automatically
Generate PDF files in batch
Generate PDF files from shortcut menu commands
Generate merged PDF files from a shortcut menu command
Generate PDF files from a workflow step
Replace an original report with a non-editable PDF report as part of a workflow step
Manage alternate renditions
Configuring Watermarks and Labels
Configure watermarks
Create a watermark
Attach a watermark to a document
Configure labels
Create a label
Attach a label to a document
How to configure watermark and label viewing and printing strategies
How to configure default watermarks and labels
Reports Configuration
Report configuration
How to Configure the Reports Model
View definition configuration
Graph definition configuration
Report ownership configuration
Report styles configuration
New report template configuration
Excel Report template configuration
Report template configuration for transmittals
Getting the XML
Structure of the XML returned
Create the XSL file
Add a new template
Update an existing template
Extending the out of the box template
Extending the report to show a new property in the external transmittal report
Extending to show how to add a new relationship to the external transmittal report
Custom report configuration
Creating and extending reports
New report type creation
Report snapshot configuration
Comparison methods
Mergeable item summary
Generate OpenXML Word report for an object
Create custom OpenXML Word reports
Create a template (.docx) file
Create a control (.xml) file
Create a template document for OpenXML Word report
Create a method based on the OpenXMLWordReport client API
Filter template documents to generate OpenXML Word reports for classified objects
Configure the Exchange Data functionality
Exchanging published documents
Create a view definition and a graph definition
Create a new export details object
Create a new report configuration object
Manage view definition options
Manage class definitions for inverted CSVs
Manage relationship definitions for inverted CSVs
Create a user-defined method for exchanging data
Exchange data
Run a silent job
Run a job
How to Configure the Graphic Reports Model
View definition configuration for graphic reports
Graph definition configuration for graphic reports
Graphic report ownership configuration
Creating and extending graphic reports
Editing a graphic report definition
New graphic report type creation
Reports Model
Reports model overview
Graphic reports
Snapshot comparison class model
Model of the transmittal and related objects
Workflow Configuration
Workflow Model Configuration Overview
Components of the workflow model
Workflow model configuration
How to Configure the Workflow Model
Main workflow menus
Step types
Step class configuration
Create a step class
Process step types
Automatic sign off a document revision
Automatic sign off of steps
Setting an object or related object attribute
Propagating a value on an object or related object attribute
Validating an object or related object attribute
Validate main transmittal workflow recipient name
Create a checklist for the issue step
Running and attaching an OpenXML Word report
Running and attaching an OpenXML Word report asynchronously
Create and attach report
Export and compress
Copy recipients from previous revision
Voting
Archive and purge
Generate alternate rendition
Generate alternate rendition asynchronously
Sets the vendor document due date
Sets the vendor document planned return date
Update title block
Load published document
Load published document to a configuration
Remove the published document configuration
Correlates published objects
Set published document version to cancelled
Merge published Intergraph Smart 3D documents into composite document
Condition-based workflow branching
Propagate roles or users to a workflow process step
Propagate reason for rejection
Validate comments when a step is rejected
Attach a workflow to an object
Configure create object to attach workflow
Regenerate graphics map files in a target system
Configure a load job for exchanging documents and data automatically
Step class actions
Step definition configuration
Create a new step definition
Set precedences for the workflow steps
Step status creation
Create a step status
Set step status options
Step checklist configuration
Create and manage a new checklist
Create new checklist item
Edit a check list
Copy a check list
Email definition configuration
Create a reason for receipt
Workflow template configuration
Creating a new workflow template
Create or update a workflow template
Associate a workflow template with an interface
Lock down a workflow template
Workflow step definitions
Create workflow steps
Assign recipients to a workflow step
Viewing workflows
Workflow accept and reject steps
Set an accept workflow step
Set a reject workflow step
View auto signed off workflow steps
Set a voting workflow step
Configure attaching a workflow
Workflow access configuration
Restrict users from accessing objects attached to a workflow
Distribution matrix configuration
Configure a distribution matrix
Use a distribution matrix
System evaluation of recipients for a workflow step
Matrix management
Create a new matrix
Off-line matrices
Assign matrix recipients
Export recipients
Import recipients
Workflow processing
Workflow processing option
Attaching a default workflow
Workflow expiration processing
Configure workflow expiration options
Workflow overdue process
Perform expiration checks
Create Expiration Checks Scheduler Task
Set up the workflow overdue and expiration process options
Workflow rejection and revision process
Workflow options
Update workflow options
Transmittals
Transmittal icons
Transmittal project roles
Transmittal life cycle
Transmittal structure
Distribution matrices
Setting up transmittals
Create an external company
Create a supplier
Create a manufacturer
Create a contract
Create an internal department or office
Populate a distribution matrix
Create an external distribution matrix
Create an internal distribution matrix
Workflow Model
Step classification
Workflow templates
Instantiated workflow
Workflow recipients
Workflow checklists and recipients
Matrices
Workflow matrix recipients
Email options
Workflow options
Manage responses
Summary of Delivered Core Workflow Model
Default step definition classes
Default step statuses
Default workflow templates
Example document review matrix
Default workflow matrices
Default email definitions
Set Up Transmittals
Create a supplier
Create a manufacturer
Create a contract
Populate a distribution matrix
Create an external distribution matrix
Create an internal distribution matrix
Classified Object Configuration
Classified Objects Configuration
Classification tree example use case
How to Configure Classification Trees and Classified Objects
Configure the Engineering Numbering System (ENS)
Configure the ENS work process
Create a new ENS definition
Create a new ENS item
New ENS Item dialog box
ENS item types
Fill ENS gaps
Manage the Engineering Numbering System
Create a new ENS relationship
Configure alternative ENS definitions for a classification
Configure alternative ENS definitions for a configuration
Configure secondary ENS definitions
Configure the Hide ENS Multi Item Create option
Configure a new classification tree
Model the classification
Making the classification tree configuration controlled
Make the classification tree SmartPlant integration compatible
Creating the classification tree hierarchy
Automatic creation of a classification tree from a SmartPlant enum hierarchy
Running reports on the classification trees
Importing a classification tree from load files
Creating the classification tree interactively
Managing the classification tree – Enum mapping
Exposing the classification tree in the client
Configure homogeneous classifications
Add the classified item interface to the object ClassDef
Link the ClassDef to be created to the classification tree
Link the classified objects to the classification tree
Configure the methods
Set up the classified document forms
Restricting the classification tree node availability
Configure heterogeneous classifications
Model the classified objects in the schema
Required ClassDef schema model
Link the class definition to the classification tree
Link the classified objects to the classification tree
Configure the methods
Set up the classified document forms
Restricting the classification tree node availability
Configure alternative forms for a classification
Configure classified documents
Classified documents and forms
Expose classified objects and documents in the GUI
Document re-classification
Configure unique identifiers
Rename objects, UIDs, and unique keys
Classified Object Model
Core classification tree
ISPFObjClass interface
SPFObjClassEnumEnum relationship definition
SPFEnumEnumObjClass relationship definition
SPFClassDefForm and SPFClassDefENSDef relationship definitions
SPFClassMember relationship definition
IEnumEnum interface
IClassDef interface
Core classified object relationship model
Class items
Relate class tree to Enum tree
Core classified object
ISPFObjClass interface
ISPFClassifiedItem interface
SPFClassifiedLevel1-8 relDefs
Document classification
ISPFObjClass interface
ISPFDisplayOverride interface
Classified design document
SPFDesignDocMaster class
ISPFDesignDocMaster interface
SPFClassifiedItem interface
ISPFDocument interface
SPFDocument class
ISPFDesignDocClass interface
ISPFObjClass
SPFItemClassification relationship definition
IEnumEnum
SPFEnumEnumObjClass and SPFObjClassEnumEnum relationship definitions
Classified vendor document
Design document classification model
SPFDocument class
ISPFDocumentClass interface
ISPFDesignDocClass interface
ISPFObjClass
ISPFTemplateClass interface
SPFObjClassClassDef relationship definition
SPFDesignDocClassClassDef relationship definition
SPFTemplateClassClassDef relationship definition
Summary of Delivered Classification Trees
Classification tree models
Authoring and Data Warehouse Environment Configuration
Introduction
Authoring and Data Warehouse Overview
Architecture of SmartPlant Foundation Authoring
SmartPlant Foundation authoring client and server
Component schemas
Schema Component
SmartPlant Client
SmartPlant Foundation adapter
Architecture of SmartPlant data warehouse
SmartPlant Foundation data warehouse client and server
EFSchema
Shared domain
Publish domains
Authoring Process Overview
Registration
Configure an authoring tool to support publish from the plant or project level
Activate email notifications on scheduled publishes
Publish and retrieve
Data Warehouse process overview
Pre-loading data for approval
Creating a sub configuration
Log on to the configuration
Approving the data
Loading the data into the configuration
Viewing the data warehouse items
Quick find
Detail form
View Shared Data (Inconsistencies) form
Ad hoc report List View changes
Properties grid
History
Data flow through the domains
Data publish
Data load
Shared objects
Shared objects (multiple domains)
SameAs relationship
SmartPlant Foundation Authoring Adapter Details
SmartPlant Foundation adapter
ToolParameters
GetPublishableDocTypes
PublishDocument
PopulateMetaDataContainer
ExpandToSecondaryItems
PopulateDataContainerForPublish
GetSameAsUIDsForPublish
RetrieveDocument
Configuring SmartPlant Foundation to retrieve and view custom properties
Writing a tool map schema
Tool map file definition of the authoring schema
Tool map file mapping definitions for the authoring schema
Using Schema Editor to view and validate tool map files
Generate a tool map schema from a spreadsheet tool
Writing an adapter header file
ToolComponentSchema
ToolSchemaMapFile
DesignBasisComponentSchema
Publish section of the adapter header file
Publish
QueryForInterface
ExpandUsingGraph
DocCategory
DocType
DocSubtype
DocTitle
ComponentSchema or PublishToComponentSchema
DocumentToPublish
DocTypes/Document
Retrieve section of adapter header file
Retrieve
DocTypes/Document
OnRetrieve
OutputDebugFiles
ValidLineEndObjects
Compare section of the adapter header file
Compare
SmartPlant Schema Modification Rules
Schema modification rules
Rule enforcement
Creation rules
Deletion rule
Revision rule
Extending the Integration Schema
CMF file and physical pseudo files
Open the CMF file for editing
Pseudo files and ContainerID
Creating a new pseudo file in the Schema Editor
Merging a previously generated schema into a pseudo file
Converting an existing pseudo file into a physical pseudo file
Create new objects and relationships in the schema
Check in the updated CMF file
Extract the schema file to load
Prepare the pseudo file data to be loaded into SmartPlant Foundation
Load schema changes into the database
Load the pseudo file changes into the data warehouse database
Regenerate the component schema files
Creating an alternate plant breakdown structure (PBS)
Remove the existing PBS structure
Check out and launch the CMF file
Define a custom PBS hierarchy from a template
Define a custom PBS hierarchy
Check in the CMF and load schema changes
Generate component schema files
Generate authoring schema and load files
Load alternate PBS objects
Create a new plant and structure
Plant Naming Guidelines
Associate a vault with the new plant
Register and publish the PBS
Published Loader Operation
Overview
Supporting an object change of class definition
Workflow
Example of the UpdateClassInstruction
How to Configure Excel Publish
Steps to configure the Excel publish
Published schema definition
View definition creation
Excel template document creation
Datasheet definition creation
Map the view definition to the Excel template
Configure a publish method
How to Configure SmartPlant Foundation Authoring
Defining the data warehouse schema
Shared object configuration for data mining
Configuring the shared interface for the published equipment
Data warehouse publish schema creation
Configuration to support consolidation
Loading the publish schema into SmartPlant Foundation
Preparing the schema load file
Loading the schema file
Defining and mapping the authoring schema
Generating the authoring schema and mapping
Usage of standard SmartPlant Foundation interfaces
Additional schema considerations
Authoring schema to support the PBS hierarchy
Loading the authoring schema into SmartPlant Foundation
Creating the tool map schema
Configuring domains
Configuring the authoring environment
Configuration to create and manage the authored data
Additional schema to support equipment list authoring
Configuration of a list document
Configuration of a separate equipment list object and document
Configuration of roles for the equipment list
Additional configuration for managing equipment
Configuration of the equipment list document
List document without a separate list object
List document with separate list object
Configuration to generate the document snapshot
Configuration to load equipment from Excel
Configuring equipment list authoring
Adapter document configuration
Adapter mapping file configuration
Create the adapter mapping document in SmartPlant Foundation
Adapter header file configuration
Create the adapter mapping document in SmartPlant Foundation
Setting up publish and retrieve roles
Configuring publish for authored data
Register tool
Publish data sheet
Load published data
Configuring SkipFailedDocuments
Configuring the retrieve and compare process
Configuring retrieve for objects published by other tools
Mapping the retrieved SmartPlant schema to the authoring schema
Retrieve document
Domain
Adapter code
Configuring a design basis document
Configuring exposure of the published data
Special edge definitions
Configuring data warehouse inconsistency reports
Load XML files to run inconsistency reports
Retrieving data authored in SmartPlant Foundation into other tools
Configuring Excel load for the equipment list
Configuring Excel publish for the equipment list
Authoring Model
Registration object
SPFAuthRegistration class
ISPFAuthRegistration interface
SPFRegistrationConfig relationship definition
ISPFServer interface
SPFRegistrationServer relationship definition
ISPFLocalServer interface
Adapter document
ISPFAuthAdapterDocMaster interface
SPFAuthAdapterFile
SPFAuthAdapterClassClassDef relationship definition
ISPFAuthAdapterClass interface
Design basis
Design basis file
ISPFDesignBasisFile interface
Example process engineer class design basis classes
PRCDesignBasisDocMaster/Revision/Version
Interfaces used with authoring
Authoring interfaces
ISPFAuthPublishableItem interface
ISPFAuthPublishedItem interface
Data Warehouse Model
SmartPlant integration document object
SmartPlant integration published document
SPFTEFPublishedDocMaster class
SPFTEFPublishedDocRevision class
SPFTEFPublishedDocVersion class
ISPFTEFPublishedDocVersion interface
SPFTEFPublishedFile class
ISPFTEFXMLFile interface
ISPFTEFToolDataFile interface
ISPFTEFViewableFile interface
ISPFTEFInstructionFile interface
ISPFTEFDocumentMetaDataFile interface
SPFTEFSignature class
ISPFTEFSignature interface
ISPFTEFTool
SPFTEFRetrievedDesignBasis relationship definition
SPFTEFSchemaDocMaster class
SPFTEFSchemaDocRevision class
SPFTEFSchemaDocVersion class
ISPFTEFSchemaDocVersion interface
SPFTEFSchemaFile class
SPFTEFSchemaItem class
ISPFTEFSchemaItem interface
SPFTEFSchemaItemToSchemaVersion relationship definition
SPFTEFQueue class
ISPFTEFQueue interface
SPFTEFPublishedDocVersionInQueue relationship definition
SPFTEFConfigQueue relationship definition
SPFTEFDesignBasis relationship definition
SPFTEFRetrievedDesignBasis relationship definition
SPFTEFSignaturePublishedDocument relationship definition
SPFTEFSignatureToolParameter relationship definition
SPFTEFMovedSignatureConfigData relationship definition
SPFTEFRetrievedDataDesignBasis relationship definition
SPFTEFSignatureConfigurationItem relationship definition
SPFTEFDocVersionSchemaItem relationship definition
SmartPlant Integration published instructions
ISPFTEFPublishInstruction class definition
ISPFTEFPublishInstruction interface
IInstruction interface
Interface and relationship definitions used with central document allocation
ISPFTEFENSGenerated interface
SPFTEFPBSOwnedENSGenerated relationship definition
SPFTEFSignatureOwnedENSGenerated relationship definition
SPFTEFENSGeneratedPublishedDocument relationship definition
Summary of Core Delivered Authoring and Data Warehouse Models (OOTB)
Domains and their usage
Adapter documents
Roles and message access groups
Administration roles
Authoring roles
Data warehouse roles
Integration roles
Sample adapter document file
Consolidated Data Warehouse Environment Configuration
Consolidated Data Warehouse Overview
Summary of the shared object technology
The consolidated data warehouse object
Migration from shared object to CDW
Mapping authoring relationships to the CDW
Consolidation Implementation and Customization
Consolidation implementation basics
Authoring relationship processing
Classification handling
Map functions
CDW customization
Correlate by name
Auto-correlation rules
Correlating an object using auto-correlation rules
Managing auto-correlation rules
How to Configure the CDW
Extending the CDW model and mapping
Creating your own CDW schema
Using the demonstration CDW model as a starting point
Configuring SmartPlant Foundation to use the CDW
Configuration to expose consolidated data
Managing and using CDW precedence rules
CDW precedence rules
Creating and updating CDW precedence rules
Adding CDW precedence rules to a schema object
Consolidated Data Warehouse Model
Additional interfaces for published documents in a CDW environment
CDW object schema
Base CDW object schema
Source domain
CDW mapping schema
Base CDW mapping
Map function model
Additional map filtering
Authoring relationship model
CDW Demonstration Model
The model
Mapping
Exposing the CDW data
Enabling CDW consolidation
Data Sheet and Data List Configuration
Data Sheet Model Configuration
Components of the data sheet model
Data sheets and data lists model configuration
How to Configure the Data Sheet Model
Configuration process
Creating a data sheet
Create an Excel worksheet
Create a data sheet template and attach Excel worksheet
Create a data sheet definition
Launch data sheet definer to create mapping
Generate a new data sheet
Generate multiple data sheets into single worksheet
Update the data sheet template for a partially mapped data sheet
Map file for instrument data sheets
Creating a data list
Create an Excel worksheet
Create a data list template and attach Excel worksheet
Create a data list definition
Launch Data Sheet Definer to create mapping
Create the menu items
Data sheet documents
Configure data sheet documents
Configure the document to tag relationship
Making the data sheet document publishable
Configure the snapshot method for data sheets
Data Sheet Model
Data sheets and data lists
Data sheets and data lists
Incremental template
Line List Configuration
Line List Configuration Overview
Line list creation overview
Components of the line list application
Line list
Line list record
Line list pipeline
Line list document
Line segment
Equipment and equipment nozzles
In-line and off-line instruments
Off-page connectors
How to Configure Line Lists
Configuring line list record rollup and consolidation
Configuring valid line end objects
Configure valid line end objects for the line list adapter
Configuring ENS definitions for line list record naming
Configuring ENS definitions for line list pipeline naming
Configuring rollup of segments
Configuring consolidation
Controlling automatic consolidation on existing records
Line list edit methods
Line list document methods
Configuring alternative line list structures
Line List Authoring Model
Line list structure
Line list structure
Line list
ISPFLLALineList
ISPFLLALineListRecordComposition
SPFLLALineListLineListRecord
Line list record
ISPFLLALineListSegmentComposition
ISPFLLALineRecordHeader
ISPFLLALineListRecord
Line segment
ISPFLLALineSegment
ISPFLLALineSegmentItemCollection
ISPFLLALineSegmentHeader
ISPFLLALineSegmentData
ISPFLLALineSegmentNormalOperatingFluidData
ISPFLLALineSegmentStatus
ISPFLLALineSegmentCommissioning
Line segment connections
Line segment instrumentation connections
Line list document
ISPFListEditControl
ISPFLLALineListRecordDocumentRevisionSnapshot
ISPFListDocRevSnapshot
Line List Integration Schema Model
LLALineListDocument Class Definition
LLALineListRecord
ILineListRecord interface definition
Line list mapping information
Concurrent Engineering Configuration
Concurrent Engineering Overview
Configuration life cycle
Concurrent Engineering with Integration
Configuration hierarchy
Configuration-dependent data
Configurations
Data segregation
Claim items
Conflict resolution
Merge items
Merge items by grouping object
Reports
Summaries of mergeable items
Query across multiple configurations
Examples of relationship expansion behavior
How to Configure Concurrent Engineering
Working with configuration special behaviors
Configuring system and user preferences
Optimistic and pessimistic operations
Set system-wide options for claim
Force exclusive claim
Force explicit claim (before edit)
Change user preferences for a claim
Use concurrent engineering-specific object icons
Claimed document icons
Non-document claimed icons
Locking data
Configuring a configuration below a project
Configuring an alternate Work Breakdown Structure (WBS)
Making a class definition configuration-dependent
Dependent configuration
Making an item mergeable
Making a document mergeable
Merging related items
Configuring merge by grouping
Merge by grouping structure examples
Making an item claimable
Managing claims
Implicit claim
Explicit claim
History retention
Configuring revision schemes
Different revision schemes for plants and projects
Different revision schemes for a specific plant or project
Configuring relationship definitions
Relationship definition behavior rules
Creating configurations
Query configurations
Create configurations
Configuring the retrieval of data
Reporting
Reporting merge progress errors
Reviewing items that failed to merge
Reviewing merge by grouping object errors
Mergeable items summary
Configuring notifications
Configuring the Merge Progress Notification feature
Understanding the Merge Progress Notification information
Configuring concurrent engineering inconsistency reports
Concurrent Engineering Model
Configuration items
SPFConfigurationTop class
SPFConfigurationTree relationship definition
SPFConfigurationStatus class
SPFConfigurationConfigurationStatus relationship definition
Claimable items
Optional claimable items
Mergeable items
Additional properties
Document revise and merge life cycle
Initial creation
Revise in same configuration
Revise to sub configuration
Revise in the sub configuration
Revise in parent configuration/merge from another configuration
Resolve conflicts on the latest revision in the low configuration
Merge the latest revision
Schema extensions
Class definitions
Interface definitions
Relationship definitions
Concurrent engineering properties
Revision schemes
Merge Progress Notification schema components
Summary of Delivered Core Concurrent Engineering Model
Project life cycle
Standard form sections
Standard column sets
Progress Configuration
Configure the Progress Model
Components of the progress model
Progress and status accrual
Design progress accrual
Activity progress
Activity item review and return date calculation
Activity step durations
Activity workpack progress example
Progress model configuration
How to Configure the Progress Model
Create progress hierarchies
Add a new property to an existing hierarchy
Modify an existing hierarchy
Create a new alternative hierarchy
Prepare a new class definition for progress
Configure progress options
Configure progress options for a project
Administer Progress
Set progress hierarchies
Set the progress hierarchy
Define progress cut-off dates
Add progress cut-off dates
Create design workpacks
Create a new design workpack
Create a new design workpack based on a template
Create design workpack templates
Create new design workpack template
Create activity review periods
Create activity return periods
Create activity workpacks
Create a new activity workpack
Create activity workpack templates
Create new activity workpack template
Create activities
Create an activity
Create design documents
Create a design document
Register a deliverable with a workpack
Register a tag for progress
Update the progress of a deliverable
Activity progress status codes
Update activity item dates
Update progress for multiple deliverables
Unregister a deliverable from a workpack
Configure replan
Run a replan
Replan process
Change the replan dates
Accept the replan
Cancel the replan
View a replan
Configure rollups
Run rollup
Ad hoc progress
Progress Model
Progress reporting hierarchy
Progress reporting hierarchy model
Progress workpacks and templates
Activity workpack templates
Activity workpacks
Design workpack templates
Design workpacks
Progress deliverables
Design deliverables
Activity deliverables
Progress rollup
Progress rollup diagram
Progress replan
Progress options
Summary of Delivered Core Progress Model
Sample default hierarchies
Vendor documents ready to act as activity item
Performance Configuration
Configuration for Performance Overview
How to Analyze System Performance
Tools to analyze a system
Possible solutions
Situation appraisal
Record typical user actions in the system
Why is the shortcut menu slow?
Comparative tests
Look ahead option
Server tracing
Shortcut menu enhancements
Enable Interface definition access control option
Why is querying slow?
Query performance tests
Document queries
Impact of data segregation using domains
General infrastructure and database performance analysis
Scaling to use concurrency
Infrastructure analysis
General performance (single user logged in)
General performance (multiple concurrent users logged in)
Why is list editing slow?
Why is viewing files slow?
Testing replicated vaults
Why is data loading failing or slow?
Failure to load a large published document
Poor publish loader performance
Poor Desktop Client loader performance
How to Configure SmartPlant Foundation for Performance
Query and find
Column sets
Property comparisons
Quick find, query, and edge filtering
Filtering documents by owning group
Filtering objects by dates
Query form
Reconfigure document query
Quick find - design document
Interface query
Class definition criteria
Warning dialog number and Maximum query limit options
Query conditions
Using paging to improve query performance
Configure paging queries
Configure light list view paging query
Query performance on small data sets
Query performance using promoted properties
Query performance applying security rules
New domain group
New tables in the database
Example tables
Example indexes
Schema changes to support the new tables
Example schema changes
Graphs and reports
Graph definition properties
View property definitions
New graph definition
Shortcut menus
Edge definitions and relationships
Look Ahead on edges
Use relationships instead of edges
Performance improvement for relationships
Use max SQL instead of Look Ahead
Look Ahead displaying a large object count
Specify shortcut menu per role
Conditions
Forms
Classification page
Display related items on forms
List edit
Server
Scheduler
Modeling
Custom coding
Merging data
Data Capture
Getting Started with Data Capture
Getting Started with Data Capture
Data Capture users
Data Capture in a snapshot
File Systems
Document Discovery
Resolve Duplicates
Content Discovery
Extract Data from Domain
Resolve Relationships
Exploring Information
Terms and acronyms
Terms
Acronyms
Getting started
Set up a project with sample data
Set your active scope
Load the sample data for your site
Create a document discovery patterns group
Use the sample data to explore Data Capture
Start the Data Capture scheduler
Load documents into the Data Capture database
Create and run a document discovery task to load documents
Create and run a document discovery task to load drawings
Create and run a document discovery task to load files with the same name
Find loaded documents and drawings
Resolve duplicate documents
Specify a file location to store files with the Ignore status
Load a document index into Data Capture
Extract tags from the loaded files
Run a content discovery task to extract tag data from images
Run a content discovery task to extract tag data from documents
Run a content discovery task to extract tag data from drawings
Correct document classification
Extract data from PDF files using PDF Reader Pre-Processor
Create and manage PDF reader pre-processor templates
Configure Validation Rule
Configure TagConstant rule
Configure DocumentConstant rule
Configure SpecifiedArea rule
Configure ScatteredText rule
Configure Table rule
Configure Checkbox rule
Process the PDF files using the PDF Reader Pre-Processor module
PDF template keywords at a glance
Managed Data Task
Transfer data within the same site
Transfer documents within the same site
Export business objects within the same site using Data Validator
Export data from Data Capture to the approval domain in a different site
Prepare the data for export from Data Capture to the approval domain using Data Validator
Export data from Data Capture to the approval domain using Data Validator
Extract data from database using the data reader patterns
Create a data connection
Define properties to map to the data to be extracted
Create data reader patterns
Define the data reader pattern
Extract data from the database using the data reader patterns
Manage Data Capture data
Using Data Capture
File Index
Create a Data Capture file index
Load a Data Capture file index
Update the file index to include additional properties
Data Capture Task Manager
Load the data into the system
Create a new document discovery task
View document discovery tasks
Data Capture Document Status
Data Capture Document Status Icons
Document Creation with Title Block Information
Document Processing
Find duplicate documents
Master and Off Page documents
Create a document to document relationship
Document Index
Load a Data Capture document index
Edit the DocumentIndex.xlsx file
Data Capture Quality Control
Resolve Duplicates
View duplicate documents
Set the resolve status for the files
Move files to a new or existing document
Browse duplicates in thumbnail view
Compare duplicate files
Create documents from reference files
Send for approval
Pre-process the documents
Central Pre-Processor Settings
Drawing Reader Pre-Processor
Manage templates
Manage drawing reader pre-processor templates and template groups
Add rules
Configuring rules
Configure StaticText rule
Configure RelatedText rule
Configure Scale100 rule
Configure SymbolAttributes rule
Configure Pattern rule
Configure Concatenate rule
Configure ExtractDataFromText rule
Configure ScatteredText rule
Configure Variable rule
Preview rules
Process the files using the Drawing Reader Pre-Processor module
Office Reader Pre-Processor
Process the files using the Office Reader Pre-Processor module
PDF Reader Pre-Processor
Manage templates
Add a PDF reader pre-processor template groups
Manage PDF reader pre-processor templates
Manage rules
Configuring rules
Configure validation rule
Configure TagConstant rule
Configure DocumentConstant rule
Configure SpecifiedArea rule
Configure ScatteredText rule
Configure Table rule
Configure TableColumn rule
Configure CheckBox rule
Preview rules
Process the files using PDF Reader Pre-Processor module
Thumbnail Rendition Pre-Processor
Thumbnail rendition based on folder options
Thumbnail rendition based on document discovery pattern
3D Reader Pre-Processor
Manage 3D reader pre-processor templates
Add a template
Configure class definitions
Add a property
Process the files using the 3D Reader Pre-Processor module
Datasheet Reader Pre-Processor
Manage templates
Add a Datasheet Reader Pre-Processor template group
Add Datasheet Reader templates
Configure rules
Configure a validation rule
Configure a reference map rule
Configure a RowColMap rule
Configure a concatenate rule
Process the files using the Datasheet Reader Pre-Processor module
Extract content from the documents
View content discovery tasks
Create a new content discovery task
Run the content discovery task from the command line
Extract data from a database domain
View database domain discovery task
Create a new database domain discovery task
Data Capture Tags
Master and alias tags
Create and relate tags
Create a new tag
Find a tag
View an item in the 3D model
View related documents
Relationship Dashboard
View document thumbnails
Update relationships for selected thumbnails
Manage relationships for selected thumbnails
View the master file
Resolve Relationships
Search processed documents
Modify relationships for selected documents
Manage relationships for documents
View the master file
Approve relationships
Generate a quality control document report
Manage the tags
Search for orphan tags
Using the filter criteria
Classify tags
Generate the Tag Completeness report
Managed Data Tasks
Property and relationship mapping
Create a new work package
View managed data tasks
Create a managed data task
Check managed data task status
Use the Desktop Client to manage documents
Check in a document using content extraction
More Information
Start or stop the Data Capture scheduler
Preprocessed content XML file format
Resolve reference files
Search for documents
Identify the reference files
View reference files
Tag Pattern Extractor
Generate multiple tag patterns
Viewing tag and document properties
View master tag properties
View inconsistencies in master tag properties
View alias tag properties
View documents
Configuring Data Capture
Introduction to Data Capture Administration module in the Desktop Client
Users and roles
Security Model
Set active scope
Configure user access to Data Capture Task Manager sub-modules
Creating objects in Data Capture
Create a master tag
Create an asset
Create a manufacturer
Create a model
Create a supplier
Create a system
Configure Data Capture settings
Add languages and set the character ranges
Manage file types and prioritize them for content extraction
Configure alternate renditions
Learn more about defining the general settings
Manage reader and application relationship
Change the color settings for the file statuses
Change the color settings for relationship changes
Manage the separators and delimiters
Manage the UNC path
Manage the view definition groups
Document Naming System (DNS)
Using the Document Naming System module
View DNS items
Create a DNS item
Refresh the DNS item list
Edit a DNS item
Delete a DNS item
Document Discovery Pattern
View document discovery patterns
Create a new document discovery pattern
Manage file parts
Add a part
Delete a part
Split a part
Merge multiple parts
Edit the pattern for a file part
Select multiple file types
Edit document and attribute parts
Manage document name parts and attributes
Edit a document name pattern
Delete a document name part
Arrange document name parts
Edit document attributes
Delete document discovery patterns
Copy document discovery patterns
Edit document discovery patterns
Group document discovery patterns
Create a group document discovery pattern
Create a document pattern group using the Desktop Client
Data Reader Patterns
Manage data connections
View data reader patterns
Create data reader patterns
Create a data reader pattern
Create a data reader group pattern
Edit a data reader pattern
Define the data reader pattern
Map selected fields
Map selected fields to relationship definition
Map selected fields to file definition
Convert the property values
Join tables
Create a WHERE clause
Create custom properties
Create Data Validator job definitions
Edit a Data Validator job definition
Property Lists
Add a business object
Add a complex object
Create a column set
Add a property list
Add a property for a property list
Tag Classification
View tag types and related patterns
Create a tag classification
Edit a tag classification
Delete a tag classification
View tag patterns and related tags
Create a tag pattern
Edit a tag pattern
Delete tag patterns
Tag Naming System
Using the Tag Naming System Module
View TNS items
Create a TNS item
Refresh the TNS item list
Edit a TNS item
Delete a TNS item
Tag Discovery Pattern
View master tag patterns
Create a new master tag pattern
Manage tag parts
Add a part
Delete a part
Edit the pattern for a tag part
Merge multiple parts
Split a part
Understanding regular expressions
Edit a master tag pattern
Copy a master tag pattern
Tag attributes
Associate an alias tag pattern
Create an alias tag pattern
Add a part
Arrange the parts to build a tag pattern
Delete a part
Edit the pattern for a tag part
Merge multiple parts
Split a part
Edit an alias tag pattern
Copy an alias tag pattern
Delete alias tag patterns
Create a new group tag pattern
Edit a group tag pattern
Delete master tag patterns
Tag Type Relationships
Create document type to tag type relationships
View document types associated with a tag type
Associated tag types
Run the content discovery task from the command line
Learn more about content discovery
Document reader
PDF reader
Drawing reader
Image reader
3D reader
Text reader
Thumbnail generation
Configure Full Text Retrieval (FTR)
Indexing the Data Capture documents
FTR search
Manage document relationships
Manage users access to the Data Capture hosted on Intergraph Smart Cloud
Viewing reports
Open XML reports
Configure the Microsoft Word template document
Map view definitions to the Microsoft Word document
Store the Microsoft Word template in Data Capture
View an Open XML report in the Desktop Client
Save a report in the Desktop Client
Viewing business intelligence reports
Open the Business Intelligence module
Chart reports
Viewing ad hoc reports in the Desktop Client
Understanding the Data Capture Document Quality Control report
Run an ad-hoc report
View and manage Data Capture data using the Web Client
Extract data from a document
Extract data from multiple documents
Extract data from Data Capture documents attached to the workflow template
Load Data Capture documents to extract content
View Content Discovery Task Status
Quality Control using Data Capture
Resolve duplicate documents
Group files for a duplicate document
Compare files for a duplicate document
Sign off a resolved document
Use off-page connectors (OPCs) to view a continuation drawing
Update an off-page connector (OPC) to relate it to a different document
View and manage laser scans
Data Validator
Getting Started with Data Validator
Introduction to Data Validator
Data Validator Workflows
Data Validator in a snapshot
Import
Actions
Validation
Export
Export mapping actions
Target Systems
Job Definition
Terms and acronyms
Terms
Acronyms
Getting Started
Configure the target system
Configure the staging system
Tag Mapping
Create a target system
Create an import definition
Create column headers
Create export mapping
Create rule set and rules
Create a job definition
Create a job
View data in Desktop Client
Document Mapping
Object mapping to physical columns
Object mapping to computed columns
Property mapping
Relationship mapping
Validation rules
Export mapping
Job definition
Job
View documents and attached files in Desktop Client
Using Data Validator Job Management
Exploring Data Validator Job Management
Defining a Job in Data Validator Job Management
Set active scope
Create a job
Sort your jobs
Search for a job by creation date
Processing a job through Data Validator Job Management
Viewing job progress and statistics
Job summary import and export counts
Process the Import stage
Process the Validation stage
Download a validation report
Validation reports
Approve the validation report
Process the Implicit Delete stage
Download an implicit delete report
Approve the implicit delete report
Retry a failed implicit delete process
Process the Export stage
Export transfer
Export target system checks
Export checks list
Retry a failed export process
Viewing the job in the Desktop Client
Access permissions
Welcome to Data Validator Administration
Data Validator process architecture
Workflow
Scheduler
Customization
Data Validator work process
Using Data Validator Administration
Set Data Validator default options
Set illegal characters for import mapping
Copying behavior for export mappings
Define target systems
Create a new target system
Edit a target system
Define import mapping
Create an import definition
Edit an import definition
Copy an import definition
View mapping summary
Define column headers
Column types
Create a new column header
Connect to a target system
Search using a local search
Create a new object or property using free text
Create column header mappings
Object mapping by class definition
Property mapping by class definition
Relationship mapping by class definition
Relationship property mapping
Summary map
Edit column headers
Manage column header order
Define a raw attribute map
Edit a raw attribute map
Generate raw attribute property mappings for export
Define export mapping
Create an export mapping
Edit an export mapping
Copy an export mapping
Define stage object to target object mappings
Create a stage object to target object mapping
Edit a stage object to target object mapping
Define stage properties and relationships to target object mappings
Stage property to target property mappings
Stage relationship to target property mapping
Stage relationship to target relationship mappings
Stage relationship property to target relationship property mappings
Unique keys and query definitions
Target system unique keys
Target system query definitions
Define validation rules and rule sets
Create a new validation rule set
Edit a validation rule set
Copy a validation rule set
Create a validation rule
Edit a validation rule
Manage validation rules
Configure the automatic generation of validation rules
Rule auto-generation model
Naming convention for rule auto-generation
Data Validator rule severity levels
Create a validation rule relationship
Define implicit delete rules
Create an implicit delete rule
Edit an implicit delete rule
Define job definitions
Create a job definition
Edit a job definition
Delete a job definition
Use function column type mappings
Use the Computed column
Use the Prompted API column
Triggering a job external to the Job Management module
Using silent workflows and job scheduler
Understanding the control file format
Trigger the job
Converting a SmartPlant Foundation object to a Data Validator job
Create a new job details item object
Create a new job details object
Create a new load job
Attach the Loader workflow automatically
Monitor the load job
View the job
Exchange Load Job Import Validate Export workflow
Functions
Computed column functions
Prompted API column functions
Document functions
Target system computed columns
Non-target system computed columns
Document function examples
Date and time functions
ConvertToHash function
Computed column .NET methods
Regular expression for evaluating multiple value columns in a CSV file
Computed columns for returning the latest revision of a document
Validation rules and actions
Validation rule description
Actions
Export mapping actions
Relationship cardinality rules
Rename action in Data Validator
Understand implicit delete functionality
Environment variables
Environment variable examples
Document mappings
Import mapping examples
Documents with concurrent engineering
Exporting multiple revisions
Reservation and activation of document masters
Mappings for published documents
Tool signature mappings
CSV file example
Object mappings example
Property mappings example
UID Definitions mappings example
Relationship mappings example
Published document mappings using publish instructions
CSV file example
Object mappings example
Property mappings example
UID definitions mapping example
Relationship mappings example
Export mappings example
Export mappings example
SPO/E document and tag mappings
Document mappings
CSV file example
Object mapping to physical columns
Object mapping to computed columns
Property mapping
Relationship mapping
Tag mappings
CSV file example
Object mapping to physical columns
Object mapping to computed columns
Property mapping
Relationship mapping
Validation rules
Export mapping
Export file mappings
CSV mapping example
Files with custom target systems
Creating new versions and copying files from the previous version
Mappings for supported files
CSV file example
Data Validator mapping export
Delete job definitions using the Desktop Client
Supported CSV file formats
CSV files not in invariant format
Clash detection
Export objects configured with ENS in the target system
Case-insensitive support for Oracle databases
Job reports
EPC database registration after project completion
Exporting Data Validator configurations
SmartPlant Access Control Analysis
Getting started in SmartPlant Access Control Analysis
Build an access control query
Explore the access control query results
Group the access control query results
Open the results in the Desktop Client
View the access control diagram
Build an access group query
Explore the access group query results
View the access group object types
Edit the target access group
Search for all access group object types
Filtering, Sorting and Saving Results
Additional Query Filters
Access Control Query Examples
Access Control Diagram Examples
SmartPlant Attribute Manager
Get started in SmartPlant Attribute Manager
Build an attribute query
Explore the query results grid view
Modify attributes
Apply actions
Sort the attribute grid
Modify attribute relationship behavior
Add existing attributes
Create new attributes
Create new classifications
Modify the attribute sequence
Save the changes
Display dynamic section contents in the Desktop Client
Modifying legend colors
Attribution Manager Wizard Examples
Query for attributes by class definition
Query for attributes by classification
Create property definition attribute
Create relationship definition attribute
Create classification
SmartPlant Business Intelligence
Using Business Intelligence
Open Business Intelligence
Run a chart report
Change report style
Sort grouping column order
Drill down into a chart report
Hide zero count groups
Refresh chart report
Reset chart to original state
Print chart report
Export to Excel
Export to image
Switch application modules
Configuring Business Intelligence
Generate chart reports
Select the setup for the chart report
Select a view definition
Define access control
Define criteria and prompts
Define additional filter criteria on properties that store a date and time
Define additional filter criteria on properties for blank and non blank values
Specify grouping
Specify series grouping
Edit a chart report
Expose summary reports in Web Client feature sets
Modify the display of summary reports in a feature set
Load integration reports
Delete a chart report
Integration Business Intelligence Reports
Business Intelligence Model
SmartPlant Report Administration
Object types for reports
Other considerations when using the SmartPlant Report Administration module
Using the SmartPlant Report Administration Module
Create a report definition
Edit a report definition
Add properties to or remove properties from a report definition
Modify report definition properties and access rights
Delete a report definition
Export a report definition to an .xml file
Third-Party Connectors
Can I connect to third-party software?
SPO/E Core
Using SPO/E Core
Getting Started
Exploring SPO/E Core
Get to know the SPO/E Core
Familiarize Yourself with SPO/E Core
Learn about SPO/E Core objects
Search for SPO/E Core objects
Create and Modify SPO/E Core objects
Documents
Create a reserved document
Activate a reserved document
NLF load format for documents
Cancel a document
Relate objects to documents
Update a document securely
Check out a document securely
Cancel a check out
Check in a document securely
Dossiers
Create a dossier chapter
Reorder dossier chapters
Copy dossier
Relate objects to dossier, dossier documents, and dossier chapters
Generate a PDF of a dossier
Add a watermark to the PDF of a dossier
Configure bookmarks in the PDF of a dossier
Export dossier structure
Tags
Create a tag
Manage tags
Relate tags to documents, work packages, and other tags
Export tags
Export tags to Smart P&ID
Export tags to Smart Instrumentation
Retrieve tags in the SPO/E authoring domain
Create a property to publish and retrieve tags during integration
Add a property to SPO/E authoring domain
Add a property to CDW Schema
Map properties with Smart Engineering tools
Work Packages
Create a work package
Create a work package type
Publish SPO/E Core work packages
Publish a work package
Publish a work package using Schedule Publish
Publish a work package using Auto Publish
Publish motor and generator tags
Check work package status
Configure notification email
Set the work package limit
Organization/Support objects
Create an organization/support object
Create originator and discipline codes
Manage originator and discipline codes
Models and assets
Create a manufacturer
Create an asset
Create a new model
Create a supplier
Collaboration objects
Create collaboration objects
Relate collaboration objects to documents
Transmittals
Create an incoming transmittal
Create an outgoing transmittal
Create SPO/E Core objects using Microsoft Excel spreadsheets
Create objects using Microsoft Excel spreadsheets
Documents
Dossiers
Tags
Originators and disciplines
Models, assets, suppliers, and manufacturers
Work packages
Generate the SPO/E Core load files (.xmldrs)
Load the SPO/E Core files (.xmldrs)
Document and Tag Management in SPO/E Core
Document management in SPO/E Core
Tag management in SPO/E Core
Office Integration
Open a Microsoft Office file from the SmartPlant Foundation Desktop Client
Save a Microsoft Office file to the SmartPlant Desktop Client
Drag Microsoft Office files to the SmartPlant Foundation Desktop Client
Workflows
Risk reducing measure workflow
Create a Risk Reducing Measure (RRM)
Attach workflow to RRM (for Originators)
Evaluate RRM (for RRM Coordinator)
Review RRM (for RRM Reviewer)
Consolidate review comments (for RRM Coordinator)
Recommend RRM (for Engineering Manager)
Approve RRM (for Project Manager)
Confirm RRM implementation (for RRM Coordinator)
Action Item and Issue Tracking workflow
Create a task (for Originators)
Perform the task (for Assignee)
Verify the task (for Verifier)
Reports
Ad-hoc reports
Create a new report
View an existing report
Run an existing report
Define filter criteria for a report
Terminate a report
SPX Propagate Properties
SPX Propagate Recipients
Business Intelligence Reports
Open Business Intelligence
Chart reports
View and Manage SPO/E Core Data Using the SmartPlant Foundation Web Client
Configuring SPO/E Core
Configuring SPO/E in a CDW Environment
Mapping relations used in CDW
ClassDefToClassDef
InterfaceDefToInterfaceDef
PropertyDefToPropertyDef
RelDefToRelDef
SPFAuthoringRelDefToCDWRelDef
WPTagPublish method and Rels to go into CDW
SPFMapFunctionDef and MappingToSPFMapFunction
PrimarySPFMethodDef, SecondarySPFMethodDef, Performs, and SecondaryMethodDefs
Domains Architecture
Integration Environment – CDW View
SPX CDW Delivered Files
Implementing CTA for New Tag Types and Tag Properties
Prerequisites for Extending CTA Implementation
Extend CTA Implementation
Implement CTA for new tag types
Modify the TAG information
Analyze existing tag types
Add new tag types with default EnumEnum value
Define new tag types in the EF Schema
Generate the SPO/E Core load files (.xmldrs)
Load the SPO/E Core load files (.xmlldrs)
Merge the extended schema with the SmartPlant schema
Generate tool metadata and component schema files
Implement CTA for new tag properties
Modify the TAG information
Add a new tag property
Modify the CDW schema definitions
Create the SPXAuthoring-SPOPublish mappings
Generate the SPO/E Core load files
Load the SPO/E Core load files
Merge the extended schema with the SmartPlant schema
Load the modified map file
Generate tool metdata and component schema files
Move Existing SPO Customers to a CDW Environment
Domain Architecture
Implementation
Implementing SPO/E Core for a New Plant
Prerequisites for Implementing a New Plant
Creating and Configuring a New Plant
Create a plant
Modify the Core information
Modify the PBS information
Modify the WBS information
Modify the DMS information
Modify the TAG information
Modify the MAM information
Modify the CDW information
Generate SPO/E Core load files (.xmlldr)
Load the SPO/E Core files (.xmlldr)
SmartPlant Foundation Architecture
SmartPlant Foundation components
Application technology
Single schema object model
Schema editing
Typical server installation setup
Primary and secondary server sites
Cache service
Multiple worker processes
Configuration service
OAuth authorization
Scheduler
Single server Scheduler setup
Multiple server Scheduler setup
Remote sites
License service
Authoring and data warehouse
Domains
Consolidated Data Warehouse
Database structure
Storage of files and long fields in the database
Configuration management
Change history
SmartPlant Foundation application server
Standard assembly
Installed feature components
Server-side communication
Server-side functional items
Full Text Retrieval (FTR)
Data Access Layer (DAL)
Direct file transfer communication
Uploading files
Viewing and downloading files
Replicating files
Server tracing mechanism
SmartPlant Foundation client components
Dashboard
Client application modules
Desktop Client
Desktop Client server communication
Not configured for communicating with SmartPlant Client
Configured for authoring with publish and retrieve capabilities
Desktop Client component communication
Web Client
Web Client server communication
Web Client Interoperability
Extensibility
Embedded mode
Integration Architecture
Authoring tool components
SmartPlant adapters
Common user interface
SmartPlant Client
SmartPlant Schema Component
SmartPlant Foundation components
Authoring tool integration commands
Register
Publish
Retrieve
Find Documents to Publish
Licensing for SmartPlant Foundation
SmartPlant License Manager for SmartPlant Foundation
License session expiration and token release overview
Web Client license expiration and release
Desktop Client license expiration and release
SmartPlant Foundation licensing reports
Exporting the license report
Active License Report
Historical Report
Administrator Panel
E-mail Page
Troubleshooting SmartPlant Foundation
Log Files
SmartPlant Foundation Security
Unable to log on to SmartPlant Foundation
Cannot log on after several failed attempts
Unable to log on to SmartPlant Foundation site with Windows Authentication
Cannot log on with FIPS enabled
SmartPlant Foundation Installation
Unable to publish documents after hot fix installation
Error during uninstall of SmartPlant Foundation after removing Schema Component
Error occurs when browsing File Service after installing SmartPlant Foundation Update 25
Canceling uninstallation leaves an entry in Programs and Features list
Unable to load SPFDatasheetDefiner.vsto because a compatible version of .NET Framework is not installed
Unable to view Data Validator staging schema in site settings property
After applying an Update you receive runtime errors using the Web Client
Database Connections
Unable to connect to Oracle database after setting up new Windows Server
Unable to connect to the database server from the Desktop Client
Unable to connect to an Oracle database
Unable to load file or assembly Oracle.DataAccess
Timeout errors on SQL server
Oracle error 1502 occurs connecting to the database
Oracle error 942 during database dump file import
Oracle error 3114 occurs when connecting to a site
Unable to update site after upgrade as path access denied
Multi-byte character set data exceeds field size limit
Configuration Service and Cache Service
Configuration service
The communication object System.ServiceModel.Channels.ServiceChannel cannot be used
DefaultSPFServerURL
Behavior protocols
Cache service
Could not load type System.ServiceModel.Activation.HttpModule
System.ServiceModel.FaultException
Rejected credentials
Error changing scope due to cache synchronization failure
Integration
Problems viewing composite 3D documents
Merge fails with SPF File Service error
Border file will not display
License still in use after integration operation
Light green text labels display when viewing a Smart P&ID file
Unable to upload files using Excel Import
Missing manage integration options when setting integration defaults
Tool signature is empty when publishing PBS
Unable to change default publish and retrieve settings
Unable to expand a plant in tree view or publish custom PBS after upgrade
Unable to publish or retrieve documents
Unable to publish or retrieve after a domain name change
Unable to publish Plant Breakdown Structure (PBS) document
Unable to select a listed document for retrieve
Workflow is not valid (no relation to ISPFTEFPublishedDocVersion)
Unable to load published data into a project
Consolidation failed as process was unable to lock the object(s)
Unable to publish large data sets
Process is slow when retrieving a large number of documents (COM)
Any process fails and the error message refers to invalid data or a missing property
Smart 3D fails to publish when publishing from a remote server
Creating an Inconsistency Report in the background fails
SmartPlant Foundation Clients
Client connection
Log on is temporarily blocked
Unable to connect to the Desktop Client
Unable to connect to a server after domain name change
Unable to run Desktop Client using HTTPS
HTTP 404 error message after installation
Buffering error with IWA
Display
Desktop Client dialog boxes appear strangely
Client APIs and Methods
Activating and using some new commands results in an error message
Get workflow items no longer works after upgrade
Documents
Incorrect revision scheme appears when updating a document
Problem when trying to view files with many references
Using Excel with SmartPlant Foundation
Excel Process Not Dismissed
Cannot export report to Excel
Creating Objects in SmartPlant Foundation
Unable to Create a New Custom Object
Creating Data Lists in SmartPlant Foundation
Data List Contains Grey Columns
Creating Data Sheets in SmartPlant Foundation
Unable to Open a Data Sheet File
Failed to activate the data sheet after upgrade
Batch Printing
No printers available
Printing properties are not honored
PDF files will not print locally using the default printing application
Unable to print file types associated with the default printing application
Conversion and batch printing errors
Check CSF Writer settings for conversion
Alternate rendition error when printing Microsoft Office files locally
Batch printing and rendition generation fails after initial configuration
PDF Generation
Unable to generate PDF documents
Alternate rendition does not include views
Alternate rendition includes markup layers unspecified by the edge definition
Loading Published Documents
Show Failure Option on a Document in the Queue Does Not Work
Unable to load a file to a vault
Load of a large published document takes excessive time
Queries
Queries Run from Classification Tree Cannot be Saved
Queries do not return any results from newly created documents
Vaults and File Services
Operation fails with vault name that begins with numeric character
Unable to load a file to a vault
Merging Objects
Merge operation fails with a file not found error
Workflow
Method definition has been deprecated
SmartPlant Markup Plus
Problems viewing composite 3D documents
PDS model items are not highlighted properly
Batch printing fails with SmartPlant Markup Plus
PDF file conversion does not generate the expected output
Cannot generate PDF files
Error Problem: mdlPrintFilesInIGC
Unable to perform operation successfully
Notification error: The underlying connection was closed
Unable to view models or merge to composite document due to failed file compression
Full Text Retrieval (FTR)
FTR RT installation does not honor port numbers entered
Unable to run FTR attribute and content searches
Content indexing and searching fails
FTR search displays a warning on large data sets
FTR Indexing fails with an access violation error
FTR search fails when using generic keywords
SmartPlant Foundation Email
Unable to send email using JMail
Improving SmartPlant Foundation Performance
Look Ahead displaying time to retrieve relationships
Performance benchmark tests
Configuration mismatch error
Monitoring performance
Create performance counters on the server
Enable the use of performance counters
Add performance counters to Performance Monitor
Resetting performance counter values
Performing diagnostic tests for maintenance and troubleshooting
Hexagon tools
Oracle tools
SQL Server tools
API Services
Generating an OAuth access token for an external application using IWA authentication (retired)
Object is not appearing in the metadata
User gets an Invalid Grant error trying to generate a token
Configuration mismatch error
Setting Up SmartPlant Foundation Logging
SmartPlant Foundation server logging
Application block logging
Trace logging for server, cache service, remote services, file service, and configuration service
License server logging
Server Manager trace logging
Setting logging levels
Switches
Trace Listeners and formatters
Maintaining log output files
Logging the time required to populate a combo box
File server and remote services logging method
Setting logging levels
Enable logging on a server
Maintaining log output files
File server error log example
Setting up SmartPlant Foundation client logging
Configuring Elasticsearch to analyze logging data
Set up Elasticsearch and Kibana on the server
Configure an Elasticsearch index pattern for Kibana
Configure Elasticsearch analytics for a site
Troubleshooting Printing
Batch printing fails with SmartPlant Markup Plus
PrintUtility has encountered an unexpected error
Cannot generate PDF files
No printers available
Operation fails with vault name that begins with numeric character
Printing properties are not honored
Printer not Activated Error code -41
Set up a batch print log file
Unable to generate PDF documents
Unable to print file types associated with the default printing application
Conversion and batch printing errors
Alternate rendition error when printing Microsoft Office files locally
Batch printing or CSF generation of a PDF file format fails
Troubleshooting Data Capture
Using the Diagnostic Utility
Troubleshooting Data Capture
Unable to extract tags in content discovery task
Unable to load sample data in a newly configured plant
Error occurs while editing data reader patterns and running database domain discovery tasks
Error occurs while saving tag discovery patterns for drawing files
Unable to load sample data from SDAPBS.xlsm file when scope is not set in the Desktop Client
Error occurs while running a content discovery task for a Microsoft Office or PDF file
Draft has stopped working
Long domain name causes Qfind search exception
Tag information in Smart 3D model does not match with 3D model processed using Data Capture
Access denied when retrieving the COM class factory for component with CLSID
Server Execution failed when retrieving the COM class factory for component with CLSID
Timeout expired. The timeout period elapsed prior to obtaining a connection from the pool.
Multiple columnsets related to a business object
Object cannot be created. The UID is not unique in this config
Content extraction using the Web Client does not work for .zvf and .mdb2 files
Error occurs when 3D Reader Pre-Processor uses default OleDB provider to process the 3D models
Error occurs when extracting content from Microsoft Excel file using Data Capture Data Sheet Reader Pre-Processor
Data Capture document master properties are not displayed in the report generated for Data Capture documents
SmartPlant Markup Plus for Data Capture
Testing the CSF/PDF file conversion
SmartPlant Markup Plus server status is unknown or down
Troubleshooting SmartConverter
SmartSketch is not registered as the default symbol editor
SmartSketch Symbol is not in the Registry
Authentication level must be set to NONE
Enable full control of registry keys for the SmartSketch symbol identity user account
Local Service account does not have permissions
DAT MIME types is not found
Tags are not extracted for non- English characters
Troubleshooting Data Validator
Timeout Messages
Thread processing a large job was aborted
Socket connection aborted
FileService timeout
File transfer from the client to file service exceeds timeout
Unable to connect to file service
Database timeout for Oracle or SQL Server
Timeout period elapsed for SQL Server
Scheduled tasks timeout
Cannot upload a large file near 2GB limit
Handling session timeout
Validation
Invalid value for enum level on property
More than one value for a property
Export
Export stuck at stage 2
Export stuck at stage 3
Export fails at stage 3
Error when file object is exported before the object to which it is attached
Job Processing
Processing state after server failure
Summary shows a different number of implicit deleted objects
Job fails if Windows authentication is enabled
Unable to create a job
Object weights have not been configured correctly
Data Validator modules are not displayed when the dashboard is launched
Stored Procedures
Import fails because the system failed to execute stored procedures
Failed to execute stored procedure
Stored Procedure Diagnostics
Troubleshooting SPO/E Core
Server Manager
Unable to connect to the database: ORA-1017: invalid username/password; logon denied
Unable to connect to database: ORA-12154: TNS: could not resolve the connect identifier specified
HTTP 401 error (unauthorized access error)
Invalid License URL
Document Creation
The object with UID [UID] on End1 of the [SPFDocumentRevisions] relationship is missing - cannot be found in the container or dbase
Publishing
The object with UID [UID] on End1/END2 of the [CDW RelDef] relationship is missing - cannot be found in the container or dbase
Modify the browser security settings for Windows authentication
Windows authentication pop-up while publishing work packages
More Information
Find sample data on Smart Community
Working with Client APIs
Client APIs
Activate client API
AddOptionalIfaces client API
AddRecipient client API
AdminEntryPoints client API
AllOverdueStepsReport client API
AllowMarkupLabelsEdit client API
AllowMarkupPrint client API
AllowMarkupPublish client API
AllowMarkupWatermarksEdit client API
AllowNavigation client API
AllowViewDrawingLayers client API
ApplySchemaChanges client API
ArchivePurge client API
AttachWorkflow client API
BatchPrint client API
CancelDocument client API
ChangeOwnerOwningGroup client API
ChangeOwningGroup client API
ChangeStatus client API
ChangeUserPassword client API
CheckIn client API
CheckInFiles client API
CheckOut client API
ClaimObj client API
ClearTree client API
CompareAgainstPreviousVersion client API
CompareDBasis client API
CompareDocuments client API
CompareFiles client API
CompareLatestRetrievedData client API
CompareObjsToHigherConfig client API
CompareVersions client API
ConfigRoleAssignment client API
ConfigurationReport client API
ConfigureDatalist client API
ConflictResolution client API
ConvertForNavigation client API
CopyConfigObj client API
CopyDistributionMatrix client API
CopyNamedObject client API
CopyObj client API
CopyToLocalFile client API
CorrelateListEditContextMenu client API
CreateAdhocQuery client API
CreateBIReport client API
CreateClassObj client API
CreateClassObjAndLoad client API
CreateClassObjAndRel client API
CreateClassObjAndRelFromMarkup client API
CreateClassObjAndRelWithPropertyOverrides client API
CreateClassObjFromClass client API
CreateClassObjFromClassWithPropertyOverrides client API
CreateClassObjWithPropertyOverrides client API
CreateEntryPointFromQFind client API
CreateGraphicReport client API
CreateHistoricSnapshot client API
CreateListDocumentSnapShot client API
CreateMarkup client API
CreateNextSheet client API
CreateObj client API
CreateObjAndRel client API
CreateObjAndRelFromMarkup client API
CreateObjectFromSelectedObjects client API
CreateRegisterDocumentObj client API
CreateRenditionsInBatch client API
CreateSnapshot client API
CreateSnapshotReport client API
CreateWebGLSchedulerTask client API
CreateWizardClassObj client API
DataSheetDefinerAPIs client API
DeleteConfigHistory client API
DeleteConnectedGeoTag client API
DeleteMarkup client API
DeleteObj client API
DeleteOrphanedGeoTag client API
DeleteSavedQuery client API
DeleteWorkflow client API
DEVNavigateSchema client API
DocumentExecuteGraphicReport client API
DocVersionCompare client API
DocVersionGraphicCompare client API
DrilldownByGrouping client API
EditAdhocQuery client API
EditAllRels client API
EditBIReport client API
EditFiles client API
EditGraphicReport client API
EditObj client API
EditObjWithClassification client API
EditSavedQuery client API
EditSavedQueryFromListView client API
EditWizardObj client API
ExcelImporter client API
ExecuteAdhocQuery client API
ExecuteGraphicReport client API
ExecuteSavedReport client API
ExecuteSavedReportFromObject client API
ExecuteSavedUsrQuery client API
ExpandDocNestedStructure client API
ExpandFileNestedStructure client API
ExpandStructure client API
Export client API
ExportObjectStructure client API
ExportObjectStructureLocal client API
ExportVaultForBulkPublish client API
ExtractToExcel client API
ExtractToExcelTemplate client API
ExtractToExcelUserSelect client API
ExtractToText client API
FormBuilder client API
FormGenerate client API
FrameworkCorrelateRHM client API
FrameworkManageCases client API
FrameworkPublish client API
FrameworkPublishRHM client API
FrameworkRegisterInt client API
FrameworkRetrieve client API
FTRBulkIndex client API
FTRConfig client API
FTRPreview client API
FTRReport client API
FTRRHMConfig client API
FTRSearch client API
FutureChangesReport client API
GenDatasheet client API
GenerateAlternateRendition client API
GenerateClassTree client API
GenerateDatalist client API
GenerateMapFile Client API
GenerateMergedRendition client API
GenerateMergedRenditionForFiles client API
GenerateThumbnail client API
GenMultiDatasheets client API
GetDesignBasisData client API
GetItemsPublishedWithDocVersion client API
GetRetrievableDocs client API
GetSavedAdhocQueries client API
GetSavedUsrQueries client API
HelpAssistance client API
History client API
HotfixReport client API
InconsistencyReport client API
InconsistencyReportByQuery client API
InconsistencyReportWithStartingObject client API
InsertHistRev client API
InvalidMergableItemsReport client API
LaunchURL client API
LaunchURLFromFeatureSet client API
LaunchURLWithDynamicArgs client API
LimitViewMarkup client API
ListEditContextMenu client API
ListEditRelatedItems client API
ListEditRelatedItemsWithFilter client API
ListEditToolbar client API
ListEditUncontrolledItems client API
ListManagementConsole client API
Loader client API
LoadObject client API
LockMarkup client API
LScanSynchronizeSiteData client API
LScanViewScan client API
LScanViewSite client API
LScanViewTagInScan client API
MaintainCalendar client API
MaintainMatrixRecips client API
ManageAllClassSubscriptions client API
ManageAllClassSubscriptionsForCurrentUser client API
ManageAllObjectSubscriptions client API
ManageAllObjectSubscriptionsForCurrentUser client API
ManageClassSubscriptions client API
ManageClassSubscriptionsForCurrentUser client API
ManageFiles client API
ManageObjectSubscriptions client API
ManageObjectSubscriptionsForCurrentUser client API
ManagePrecedenceRulesAPI client API
ManageRelatedItems client API
MergeableItemSummary client API
MergeConfig client API
MergeIntoCompositeDoc client API
MergeObj client API
MergeStructure client API
MergeStructureSummary client API
ModuleAccess client API
MultiStepReAssign client API
Navigate client API
NotificationList client API
OpenXMLWordReport client API
OverdueStepsReport client API
Performance client API
PrgAcceptReplan client API
PrgCancelReplan client API
PrgEditCutOffDates client API
PrgHierarchy client API
PrgInitiateReplan client API
PrgManageActivityItemDates client API
PrgRegisterForProgress client API
PrgRunRollup client API
PrgUnregisterForProgress client API
PrgUpdateProgress client API
PrgViewDeliverable client API
PrgViewProgress client API
PrgViewProgressSCurve client API
PrgViewReplan client API
PrgWorkpackCreate client API
PrgWorkpackCreateFromTemplate client API
PrgWorkpackFreezeUnfreeze client API
PrgWorkpackQueryByHierarchy client API
PrgWorkpackRedistributeManHours client API
PrgWorkpackSetProgressUpdated client API
PrgWorkpackUpdate client API
PrgWorkpackView client API
Print client API
PrintContents client API
PrintFile client API
PurgeSupersededVersions client API
PutWorkflowOnHold client API
QFindObject client API
QueryByContainer client API
QueryClassObj client API
QueryClassObjFromClass client API
QueryForDocsByQueue client API
QueryObject client API
QueryObjectWithHistory client API
QueueManagement client API
ReclassifyObject client API
RegenerateAPIMetadata client API
RegenerateMetadata client API
RegenerateSchemaFiles client API
ReGenerateSharedObjs client API
RegisterAndCheckIn client API
RegisterAuthoringTool client API
RejectWorkflow client API
RelationshipManagement client API
RemoveDocInLoadQueue client API
ReplaceFiles client API
ResetProfile client API
ResponseManagement client API
RestartSchedulerPolling client API
RetryTask client API
Revise client API
RollupWithConfigOption client API
SchemaImport client API
SDAApproveSDVJob client API
SDADeleteSDVJob client API
SDARelationshipBuilder client API
SDASDVDownloadValidationReport client API
SDAShowMySDVJobs client API
SDAViewSDVJobSummary client API
SectionGenerate client API
SetActiveScope client API
SetAsCurrentConfiguration client API
SetContainer client API
SetDesignBasisCriteria client API
SetObjStatus client API
SetUserConfig client API
ShareUrl client API
ShowInbox client API
ShowInboxForObject client API
ShowObj client API
ShowTaskFailure client API
ShowWorkflow client API
SignOff client API
SignOffWithForm client API
SmartPlantReview client API
SPFCopyConfigAccess client API
SPFExchangeData client API
SPFNCDTCreationFromSelectedDocuments client API
SPFNCheckInWithContentExtraction client API
SPFNContentExtraction client API
SPFNCreateMasterRevision client API
SPFNCreateRelationshipsForSelectedDocuments client API
SPFNSetAsMasterFile client API
SPFNTagClassification client API
SPFNViewFilesRelatedToTag client API
StartScheduler client API
StepAcceptAction client API
StepClaim client API
StepReAssign client API
StepRejectAction client API
StepUpdateDates client API
StepUpdateDesc client API
StepUpdateRecip client API
StopScheduler client API
SummaryViewData client API
TakeWorkflowOffHold client API
TaskReassignmentConfiguration client API
TEFConsolidateDocument client API
TEFLaunchExternalSchemaApp client API
TEFLaunchSchemaEditor client API
TEFLoadPublishData client API
TEFMergeDelta client API
TEFPublishDatasheet client API
TEFReApplySameAsObjs client API
TEFSelectCorrelations client API
TEFShowFailure client API
TerminateObj client API
TerminateWorkflow client API
ToolVersionGraphicCompare client API
UnCancelDocument client API
UnClaimObj client API
UndoCheckOut client API
UndoEditFiles client API
UndoSignOff client API
UnlockMarkup client API
UnlockUserAccount client API
UpdateGraphicsMapFiles client API
UpdateMarkup client API
ViewConsolidatedDataForObject client API
UpdateReferences client API
UpdateReferredBy client API
UpgradeDataCaptureTagDocRels client API
UploadDocument client API
UserPreference client API
ValidateConditions client API
ValidateSPFSite client API
ViewAdhocQuery client API
ViewBatchRenditionLog client API
ViewFileWrapper client API
ViewForm client API
ViewInDrawing client API
ViewInSmartPlantReview client API
ViewItemIn3DModel client API
ViewLookAhead client API
ViewOPC client API
ViewRelatedItems client API
ViewRelationshipObjects client API
ViewSharedData client API
VTLDeleteJob client API
VTLViewAllJobs client API
WebClientExtensibility client API
WFDoExpirationChecks client API
WorkflowDetailsReport client API
WorkflowEdit client API
WorkflowHistory client API
XmlDiff client API
XmtlCancel client API
XmtlMakeTemplate client API
XmtlSetPlannedDate client API
XmtlSetPropToRecip client API
XmtlUndoCancel client API
XmtlUpdateRecip client API
Dialog Boxes and Commands
Accept Replan command
Add Step dialog box
Activate dialog box
Assign Recipients dialog box
Assign Recipients dialog box
Attach and Edit Workflow dialog box
Attach Files dialog box
Batch Print Files dialog box
Batch Print Options dialog box
Cancel Replan command
Change Owning Group dialog box
Change Password dialog box
Change User dialog box
Change User Preferences dialog box
Change User Preferences General tab
User Preferences Windows tab
Change User Preferences Expansion tab
Change User Preferences APIs tab
Change User Preferences Claim tab
Change User Preferences Default ContainerIDs tab
Change User Preferences 3D Viewing tab
Check In dialog box
Check Out dialog box
Claim dialog box
CMF File Manager dialog box
Common Views dialog box
Compare window
Compare XML Files dialog box
Copy dialog box
Configuration Role Assignment dialog box
Administration tab
Role Assignments tab
Append dialog box
Overwrite dialog box
Criteria Definition dialog box
Create or Update Workflow Template dialog box
Create Workpack command
CSV Report Settings dialog box
Current Definitions Window
Custom Sort dialog box
Data Sheet Definer dialog box
Data Sheet Definer tab
Date Entry dialog box
Define Symbology dialog box
2D tab of the Define Symbology dialog box
3D tab of the Define Symbology dialog box
Details dialog box
Displaying Workflow for [Object Name] dialog box
Displaying Workflow Template dialog box
Edit Graphic Report Definition dialog box
Edit Progress Cut-Off Dates command
Edit Project Cut-Off Dates dialog box
Edit Relationships dialog box
Edit Relationships dialog box (List Edit)
Edit Report Definition dialog box
Effective Date dialog box
ENS Definition command
Excel Import and Publish
Excel Import Wizard
Excel Import Wizard Summary dialog box
Excel Import Wizard View dialog box
Excel Publish Wizard
Export by Container dialog box
Export (Select Template) dialog box
External Matrix command
Filter dialog box
Find dialog box
Find Documents to Publish Dialog
Find Documents to Publish dialog - Document Types
Full Text Search dialog box
Generate Class Tree Wizard dialog box
Generate Data Sheet dialog box
History dialog box
Inconsistency Report Options dialog box
Initiate Replan command
Initiate Replan dialog box
Internal Matrix command
List Edit Options dialog box
List Edit UOM dialog box
List Edit window
List Edit window (with SaveAs)
List Management Console dialog box
Live and Terminated Objects dialog box
Loader dialog box
Lock Layers dialog box
Lock or Unlock Markup dialog box
Logon Information dialog box
Maintain Attributes dialog box
Maintain Calendar dialog box
Maintain Relationships dialog box
Manage [Object] dialog box
Manage Activity Item Dates command
Manage Activity Item Dates dialog box
Manage Cases dialog box
Manage Engineering Numbering System command
Manage Engineering Numbering System dialog box
Manage Subscription dialog box
Matrix Assignments command
Merge dialog box
Multiple Deliverable Progress Update dialog box
New [Object] dialog box
New Activity Workpack dialog box
Workpack Details tab
Steps tab
Plan Details tab
New Activity Workpack Template dialog box
New Datalist Definition dialog box
New Design Workpack dialog box
Time Strings tab
New Design Workpack Template dialog box
New ENS Definition dialog box
New Graphic Report dialog box
New Host command
New Host dialog box
New Label dialog box
New Relationship dialog box
New Relationship dialog box
New Report dialog box
New Server/Edit Server dialog box
New Watermark dialog box
New Workpack or Workpack Template dialog box
Object Compare dialog box
[Object] Subscriptions for [Users] dialog box
Out of Date Object dialog box
Progress Rollup S-Curve dialog box
Properties to Display dialog box
Published Documents dialog box
Query dialog box
Query by Container dialog box
Reason for Receipt and Format dialog box
Reassign dialog box
Register for Progress command
Register for Progress dialog box
Details tab (Register for Progress dialog box)
Steps tab (Register for Progress dialog box)
Resolve Conflicts dialog box
Resolve Conflicts dialog box
Response Manager dialog box
Return Codes dialog box
Revise dialog box
Revision Details dialog box
Run Graphic Report dialog box
Run Editor dialog box
Run Rollup command
Save Alternate Renditions dialog box
Save Graphic Report dialog box
Save Query dialog box
Save Report dialog box
Save Target As dialog box
Schema Import Wizard dialog box
Schema Import Wizard Comparison Results dialog box
Schema Import Wizard Review Changes dialog box
Select Accept Steps dialog box
Select attributes to display dialog box
Select Display Parameters dialog box
Layout tab (Select Display Parameters dialog box)
Display tab (Select Display Parameters dialog box)
Auto-focus tab (Select Display Parameters dialog box)
Select Reject Steps dialog box
Set Active Scope dialog box
Set Container dialog box
Set Date and Time dialog box
Set Progress Hierarchy command
Set Progress Hierarchy dialog box
Show Nested Reference Files dialog box
Sign Off dialog box
Sign Off with Form dialog box
SmartPlant Foundation Options dialog box
SmartPlant Registration Wizard - SmartPlant Foundation Plant
SmartPlant Registration Wizard - SmartPlant Foundation URL
Step Events dialog box
[Step Type] Task dialog box
Subscription Filter Options dialog box
Timestring dialog box
To Do List dialog box
To Do List window
Unclaim dialog box
Undo Check Out dialog box
Unregister for Progress command
Update dialog box
Update Progress command
Update Progress dialog box
Update Reference Relationships dialog box
Update Step Description dialog box
Update Step Duration and Dates dialog box
Update Step Recipients dialog box
Update Step Recipients dialog box
User Properties window
View and Compare window
View and Markup window for 2D files
View and Markup window for 3D files
View in Smart Review
View Progress dialog box
View Replan command
View Replan dialog box
XML Comparison dialog box
SmartPlant Master Tag Registry
Welcome to SmartPlant Master Tag Registry
A typical SmartPlant Master Tag Registry workflow
Overview of the tag creation and handover register generation work process
Create a unit
Pre-allocate tags
Generate a data sheet with equipment type tags
Define tag data
Import tag data into the authoring domain
Edit tags using List Edit
Create an authored register document and associate tags
Create a snapshot of the EquipmentAuthDoc authored document
Publish tags
Create a register document
Generate an equipment tag register
Managing Authored Tags
Create an instrument loop
Create a tag
Create a system
Create an authored document proxy and associate tags
Create tags with a data sheet
Query for authored tags
Edit tags in the authoring domain
Update authored tags
Renumber authored tags
Delete authored tags
Terminate authored tag relationships
Terminate the relationship between a class definition and an ENS definition
Managing Authored Documents
Register SmartPlant Master Tag Registry as an authoring tool
Create an authored document and associate tags
Find authored tags from the document
Create a snapshot of an authored document
Publish tags
Loading Tags Work Process
Generate and edit a data sheet offline
Generate a data sheet template
Create tags in a data sheet
Import tags into the authoring domain
Create an authored document and associate tags
Create a snapshot of an authored document
Publish tags
Loading Pipeline Tags Work Process
Generate and edit a pipeline datasheet
Generate a pipeline datasheet template
Create pipeline tags in a data sheet
Import pipeline tags into the authoring domain
Create a pipeline
Create a line list and associate line list records
Create a snapshot of a line list record document
Publish pipeline tags
Managing Published Tags
Set tag status for tags in the CDW domain
Query for published tags
Find published tags from the document
Terminate published tag relationships
Delete published tags
Using Register Documents
Create a register document
Update a register document
Copy a register document
Query for register documents
Using Tag Registers
Generate a tag register
View the status of scheduled register generation tasks
View the register generated by the scheduled task
View tag registers
Export tag registers
Business Intelligence Reports
Additional tag information to provide in a data sheet
SmartPlant Master Tag Register
Access Groups and Roles
Create and manage role assignments
Manage Access Groups and Roles
Report Definitions
Create a report definition
Set the owning group for a report
Edit a report definition
Add a custom register template
Register Definitions
Create a register definition
Update a register definition
Configure Change Statuses for Registers
Querying
Query for register documents
Query for authored tags
Query for registry tags
Setting up SmartPlant Foundation Options for auto-correlation
Set SmartPlant Foundation Options
Customizing the SmartPlant Master Tag Registry schema
Define a new property in the publish schema
Open the CMF file for editing
Define a new enumerated list
Define a custom interface to expose the new property definition in the publish schema
Define a new custom property definition in the publish schema
Apply the changes to the database
Copy the integration customizations out to be referenced by a configuration file
Define a new property in the authoring schema
Create a new configuration file and extension file for the authoring schema
Create a new interface to expose the custom property definition in the authoring schema
Define a new custom property definition in the authoring schema
Define a new property definition in the CDW schema
Define a new custom interface to expose the property in the CDW schema
Define the new custom property in the CDW schema
Map a CDW relationship between the publish and CDW interfaces
Map a CDW relationship between the publish and CDW properties
Add the custom property to the applicable view definitions
Add the customizations to the SmartPlant Master Tag Registry tool map file
Open the tool map file for editing
Define a new map class representing the new authoring interface definition
Define a new map property representing the new authoring property
Create a publish mapping relationship between the new map property definition and the new publish property definition
Load non-integration schema customizations into the database
PipeLine and PipeRun Consolidation
PipeLine and Line List Records Consolidation
Support, Copyright, and Legal Information
Hexagon Policy Against Software Piracy
Copyright Notice
Customer Support and Technical User Forum
Glossary
3D reader
access control
access token
action pins
actions
active scope
adapter
alias tag
API
API Services
as-built
asset
attribute
authoring tools
authorization token
auto-generate
batch printing
brownfield
business administrator
business intelligence (BI)
business objects
by method
by schema
by user profile
cache
cardinality
cases
change notification
chart report
check in
check out
checklist
claim
class definition
class view map
classification tree
classified objects
client API
column headers
column set
common assignee
common UI
communication objects
compare
component
component schema
condition
configuration
configuration tree
consolidated data warehouse (CDW)
container
content discovery task
contract
correlation
CORS
create scope
criteria
CSV file
current document
cut-off date
dashboard
data files
data list
data sheet
data sheet template
Data Validator
database
database domain discovery task
database reader
database reader pattern
dataflow
default mapping file
delimiter
deliverable milestone
deputy
design basis
design file
digest
display item
distribution matrix
document
document attribute
document discovery
document discovery pattern
document discovery task
document index
document master
document name pattern
document naming system
document reader
document renditions
document return code
document revision
domain
domain tag
downstream forecasting
drawing reader
drill down
dump file
duplicate document
edge definition
effective date
email digest
entry point
enumerated entry
enumerated list
export mapping
export process
exposes
feature sets
file index
file name parts
file name pattern
file properties or attributes
file server
file type
FIPS
folder
form
FTR
function code
function tab
GET
governing case
graph definition
graphic report
graphic report definition
greenfield
grouping
Handover
handover configuration
hierarchy
host
hotspot
hotspotting
identity token
IdPs
image reader
implicit delete
implies
import definition
import process
Info Map
integration
interface definition
interoperability
inverted CSV file
issue
issue purpose
issue request
IWA
job
job definition
JSON
JWt
JWT
JWT ID
laser scan reader
map file
mapped
mapping
markup layer
master document register (MDR)
master file
master tag register (MTR)
master tag register submittal
master tags
MEF
merge
message bar
meta schema
method
model
module
notifications
OAuth
object weighting
OData
OpenID
orphan tags
owning group
pane
picklist
pinboard
pins
plant
Plant Breakdown Structure (PBS)
POST
print server
process cases
profile
progress
project
prompt
property
property definition
property group
property list
publish
punchlist
QA review
query
query definition
query scope
raw attribute format
realizes
Reason For Issue (RFI)
Reason For Receipt (RFR)
reference file
register
register for interest
register interest
regular expression
relationship
Relationship Builder
relationship definition
REST
RESTful APIs
resurrected object
retrieve
revision
revision scheme
role
rollup
rules
rulesets
schema
Schema Component
scope
scoped by
section
security codes
security rules
separator
server
setup
shared object definition
sharing
SI
sign off
site
SmartPlant Enterprise
source
SSL
staging
status
step
submittal
subscribe
superseded
symbology
tag
tag discovery pattern
tag document register (TDR)
tag naming system
target system
technical query
TEF
terminate
text reader
thumbnail
thumbnail rendition
timestring
title block
To Do List
token
tombstone
tool
tool adapter
tool schema
tool signature
transmittal
transpose
UID
unique key
unit
unit of measure list
UoM
URL
user
user profile
validation process
vault
version
View and Markup
view definition
virtual directory
weighting
wildcard
Work Breakdown Structure (WBS)
work package
work process diagram
workflow
working document
XML