Administration and Configuration of HxGN SDx - HxGN SDx - Update 71 - Administration & Configuration

Language: English
Product: HxGN SDx
Search by Category: Administration & Configuration

Introduction to administration and configuration
How do I get started creating my digital twin in SDx?
Create a base configuration of your digital twin
Plant breakdown structure (PBS)
Differences between the two provided PBS hierarchies
Create the PBS
Create the Hexagon default PBS interactively
Create the PBS using the Load Manager
Plant Naming Guidelines
Create a new host
Create a new vault
Configure companies and organizations
Create an organization
Prepare your digital twin
Site setup overview
Plant setup overview
Project setup overview
Prepare the SDx site
Load data into your system
Configure data validation
Configure job details
Configure prompted attributes on load jobs
Run a load job
Edit template documents
Create a new revision scheme
Additional site configuration options
Prepare the SDx plant
Manage the plant configuration details
Configure user access
Create a new user
Update a user
Manage user role assignments
Assign security codes to a user
Assign roles to a user in a configuration
Manage the organization for users
Get an overview of users assigned to a role
Role management
Copy user access
Copy role assignments to another user
Copy user access between configurations
Unlock a temporarily locked user
Configuring disciplines for a user
Create a discipline
View and update disciplines
Configure security
Security model overview
Access group configuration
Create access groups
Manage the access groups for a role
Manage roles for an access group
Manage methods for an access group
Restrict access to methods in an access group
Further ways to restrict access to methods
Manage relationship definitions for an access group
Manage access groups for an API Entry Point
Managing roles
Create a role
Manage the access groups for a role
Role assignments
Configure owning groups
Create an owning group
Restrict access to methods using owning groups
Relate vaults to an owning group
Configure security rules
Create a security rule
View and update security rules
Configure security codes
Create a security code
View and update security codes
Log on security configuration
Password security
Set up the projects
Create a project
Manage the project configuration details
Complete a project
Cancel a project
Configure a document review matrix
Create a contract
Results of setting a default for the response days property
Configure roles and users for SDx Projects
Categorize roles
How do I extend my system?
Configuration rules
Roles, access groups, and security configuration rules
User interface configuration rules
Workflow process remodeling rules
Data model configuration rules
Common Schema evolution rules
Class definitions
Interface definitions
Property definitions
Enumerated lists
Enumerated entries
ENS definitions
Unit of measure lists
Unit of measure
Relationship and edge definitions
Configure the schema
Extend the existing stand-alone SDx schema
Extend the administration model
Export data
Customer modifications and relationships
Configure the user interface
Configure the interface
Configure feature sets
Create a feature set
Modify a feature set
Relate a method to a feature set
Manage feature sets
Group function tiles in a feature set
Control the display of functions
Modify how functions display
Manage method access groups
Configure the form used on create methods
Configure the default method action for object types
Suppress the display of methods
Configure file attachments as mandatory on creating documents
View files default action
Configure API Entry Points
Create an API Entry Point from a class or interface definition
Create an API Entry Point from a Quick Find method
Update an API Entry Point
Create an API Entry Point group
Configure API Entry Point relationships
Relating a column set to an API Entry Point
Edit property comparison criteria
Configure API Entry Points to display as functions in a feature set
Modify the display of API Entry Point functions in a feature set
Manage access groups for an API Entry Point
Use the Info Map to configure an API Entry Point
Select the role to view navigations
Show all navigations
View visible navigations
Resolve which column set to use to display items
Configure methods
Create a method
Configure Revise method to inherit existing document relationships to the new document revision
Update a method
Manage the access groups for a method
Manage the interface definitions for a method
Restrict access to methods in an access group
Further ways to restrict access to methods
Configure conditions
Create a condition
Update a condition
Condition syntax
Common syntax
Function condition expressions
Condition constants
Environment variable support
Condition validation
Common condition errors
Configure search menu items
Configure peek search request value
Disable peek search
Configure the default search bar criteria
Change the default search operator
Edit the display name of a search menu item
Configure the default search filter column set items
Exclude search filter column set items
Advanced search menu items
Configure the results grid sort order
Configure Actions menu items
Display a method icon on the Actions menu
Configure shortcut ribbon hover debounce value
Configure object icons for use in the Web Client
Configure objects for use in List Edit
Configure the Delete command in List Edit
Configure forms
Form generation process
Form generation rules
Configuring forms
Create a form
Update a form
Copy a form
Control ENS display in create forms
Alternative forms
Suppress the Apply button on forms
Forms for complex objects
Hide the ENS Multi Item Create option
Configure sections
Create a section
Form purpose options
Update a section
Manage sections in a form
Manage section access groups
Hide sections
Defining dynamic sections
Create a dynamic section
Configure column items in dynamic form sections
Configure column items by configuration
Configuration control of sections
Dependent pick lists
Configure display items
Create a display item
Update a display item
Manage display items in a section
Configuration control of display items
Configure display item relationship tabs on forms
Configure display items for related objects in create and update forms
Picture mask types
Set date and time format
Validate dates
Use password masks on forms
Use regular expressions
Configure template documents
Create a template document
Configure a method to display the templates
Configure documents with multiple sheets
Configure a property value to be set on merged objects
Configure viewing page titles
Configure linking to connected tags on hotspot bubbles
Configure content extraction on the Replace Files and Check in methods
Configure the audit functionality on methods
Configure column sets
Create a column set
Create a column item
Associate a column set with an interface
Managing column items
Manage column items for Edit
Configure automatic sorting of column items
Configure column width
Example configurations
Manage related items
Use the manage related items dialog
Search for an item to relate
Relate an item
Remove a related item
Edit an existing related item or property
Change the display order of related items
View related items in the object's details form
Configure the related items for a specific object type
Manage access groups
Manage the access groups for a role
Manage roles for an access group
Manage methods for an access group
Restrict access to methods in an access group
Manage relationship definitions for an access group
Manage access groups for an API Entry Point
Manage the relationship definitions for an entry point
Manage column items
Manage column items for a column set
Manage column items for edit for dynamic forms
Configure automatic sorting of column items
Configure column width
Manage column items by configuration
Manage reports
Manage reports for an object
Manage summary reports for an object
Configure an InsightView dashboard
Create an authorization server
Create a Web API
Create a request header
Example request headers
Create a dashboard
Create a widget
Complete the URL using a wizard
Make a widget dependent on another widget
Supported URL parameters
Check the status of a widget
Update a dashboard
View the widget logs
InsightView dashboards worked examples
InsightView dashboard example
Create a Web API to connect to your local SDx system
Create the dashboard and make it available to selected users
Configure the widgets
View your dashboard
Home screen dashboard example
Create the home screen dashboard
Configure the home screen widgets
View your home screen
Configure launch URLs
Launch URL examples
Configure file types
Configure Save Target As action to filter file types
Configure object actions to restrict file types
Configure Edit Files action to filter nested reference files
Configure Revise method to inherit existing document relationships to the new document revision
Configure the display of missing and duplicate reference files
Configure PDF generation with custom rendition options
Configure viewable files
Configure locking and unlocking of markup layers
Configure the Graphic View Control (GVC) and the Visualization Data Service (VDS)
Install and configure the VDS
Configure VDS for a HxGN SDx for PAB site
Create a VDS connection
Enable the Graphic View Control (GVC)
Verify your VDS settings
Configure WebGL renditions
Localize the Graphic View Control (GVC)
Generate localization resource files for the GVC
Troubleshooting the VDS
Troubleshooting the GVC
An error occurred during display
Force Refresh to update graphics in a Smart 3D model
GVC fails with "Uncaught ReferenceError: WebAssembly is not defined at libMCD.js:634:17" error
Unable to interact with the GVC on an iPad
Configure markup renditions
Configure the view and markup control
Make sure your settings are enabled
Enable Wasm threading
Grant permission to print and download
Localize the view and markup control
Generate localization resource files
Define MIME types
Configure stamps and symbols
Updating the stamps.json file
Adding stamps or symbols from the library
Removing stamps or symbols from the library
Specifying stamps and symbols locations
Converting XSP stamps to SVG
Moving the stamp and symbol SVG files
Creating custom stamps, symbols, and action pins
Configuring stamps, symbols, and action pins for enhanced performance
Troubleshooting the view and markup control
Unable to retrieve the markup rendition
Configure reports
Configure object naming
Configure the Engineering Numbering System (ENS)
Create an ENS Definition
Update an ENS definition
ENS item property types
ENS Start Sequence
ENS Fill Gaps
Creating multiple objects using ENS
Hide the ENS Multi Item Create option
Configure email definitions
Create a new email definition
Configure the system options
Configure and maintain the system calendar
Manage workflows
Manage workflow templates
Create a workflow template
Create a workflow step
Step definition
Create a workflow step definition
Create a workflow step checklist
Update a workflow template
Copy a workflow template
Delete completed workflows
Create a merge workflow process step type
Merge completed workflow steps
Configure workflow step re-authentication
Configure workflow parallel reject steps
Using the Workflow Comparer
Comparing workflow templates
Resolving conflicts
Synchronize the workflow template
View the results
Accept all master workflow template changes
Configure roles for workflows
Configure workflow access
Configure roles to appear during reassignment
Configure roles to appear when adding users as workflow recipients
Configure To Do List filtering by roles
Update role assignments for new users
Transfer ownership of items from one user to another
Reassign tasks owned by one user to another user
Control the reassignment pagination
Configure methods to automatically attach objects to a workflow
Configure workflows in SDx Operations
Change request workflow
Temporary change request workflow
Temporary change request review workflow
Work package planning workflow
Internal change action workflow
Configure workflows for SDx Projects
Incoming Submittal workflow
Internal Actions workflow
Internal Draft workflow
Internal Review workflow
Outgoing Actions workflow
QA Actions workflow
QA Actions Cancelled workflow
QA Review workflow
Contract transfer workflow
Signature Request workflow
Authenticate and Manage DocuSign
Handover Request workflow
Technical Query workflow
Internal Technical Query workflow
Outgoing Technical Query workflow
Incoming Technical Query workflow
Configure notifications and emails for project workflows
Modify email definitions
Configure dynamic assignment of recipients
Configure transmittals workflows
Outgoing Transmittal workflow
Incoming Transmittal Workflow
Internal Transmittal Workflow
Cancelled Transmittal Workflow
Configuring schedulers
Create a scheduler
Start or stop a scheduler
Restart a scheduler
Update a scheduler
Terminate a scheduler
Query for scheduled tasks
Retry a failed task
Update a task
Terminate a task
Delete a task
Configure data books
Build a data book classification query
Create new classifications for data books
Configure bookmarks for the PDF generated from the data books
Configure SDx to work with j5
Display other j5 applications within SDx
Configure watermarks
Create a watermark
Preview a watermark
Set up additional SDx Project features
Configure issue purposes
Create an issue purpose
View and update issue purposes
Configure menu items for SDx
Configure submittals
Types of submittals
Validation rules for MDR submittals
Configure management properties on contractor documents
Configure review plans
Configure review plan top level classification
Overnight scheduler task to generate review plan items
Configure document reviews
Configure methods for document reviews
Configure client APIs for document reviews
Document review required
Create review assignment rules
View review assignment rules
Configure display of security codes when registering interest in review plan items
Register for interest scheduler
Planned issue dates for revisions
Document review start date
Configure workflows for projects
Configure a work package
Project reports
Configure an external document management system (DMS) to store files
How a DMS works with HxGN SDx
DMS services logic
SDx application server logic
Setup the SDx application server site to use a DMS
File operation process flows
Download
Checkin
Revise
Staging directory file cleanup
Web Client localization
Create localization resource files
Update localization resource files
How do I configure data loading and data exchange?
What is the difference in Data Validator in HxGN SDx and SmartPlant Foundation?
Data Validator Basics
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
Configure Data Validator mappings
Copy Data Validator master mappings
Configure Data Validator mappings in the Web Client
Pre-defined (submittal/loader) mappings in SDx
System setup mappings
PBS mappings
Reference data mappings
Tags and Assets mappings
Document mappings
Submittal mappings
MDR planning create mappings
MDR planning delete mappings
MDR deliverable create mappings
MDR deliverable delete mappings
MTR create mappings
MTR delete mappings
Tag properties mappings (inverted CSV)
TDR create mappings
TDR delete mappings
Using Data Validator Administration
Set Data Validator default options
Set illegal characters for import mapping
Copying behavior for export mappings
Upgrade CFIHOS mappings to the latest version
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
Object mapping by interface definition
Property mapping by class definition
Property mapping by interface definition
Relationship mapping by class definition
Relationship mapping by interface 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
Define 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
Copy a job definition
Delete a job definition
Use function column type mappings
Use the Computed column
Use the Computed column for interface definition based mapping
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 an HxGN SDx 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
Computed column functions for interface definition based import mappings
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
Interface definition based functions
Validation rules and actions
Validation rule description
Actions
Export mapping actions
Relationship cardinality rules
Rename action in Data Validator
Understand implicit delete functionality
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
Exporting Data Validator configurations
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
Configure the Exchange Data functionality
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
Configure the Web API Reader functionality
Create an authorization server
Create a Web API
Load XML file for Web API Reader classification
Create a Web API import definition
Create a dependent variable
Create a Web API job definition
Create an environment variable
Create a job details item
Create a job details object
Create a load job method
Run a load job
Trigger a Web API load job using a HTTP client
How do I configure data capture?
Getting Started with Data Capture
Introduction to Data Capture
Data Capture users
Data Capture in a snapshot
File Systems
Document Discovery
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
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
Configure and administer Data Capture
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 user access to Data Capture Task Manager sub-modules
Users and roles
Security Model
Set active scope
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 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
Drawing reader
Image reader
3D reader
Text reader
PDF reader
Thumbnail generation
Manage users access to the Data Capture hosted on Intergraph Smart Cloud
Manage document relationships
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
Using Data Capture
File Index
Load a file index
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
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
GraphicsMapFile format for different file types
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
View and manage Data Capture data using the Web Client
Tag Naming Systems
Export tag discovery patterns to the target site
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
Process the data
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
Extract data from documents using a scheduler task
View Content Discovery Task Status
Can I connect to third-party software?
Troubleshooting
Accessing Web Client
After applying an Update you receive runtime errors using the Web Client
Cannot log on as account is temporarily blocked
CORS error when trying to log in to the Web Client
Cannot log on as application server software pre-requisite is missing
Cannot log on with FIPS enabled
Client application is not known or access is not authorized
Client application made an invalid request error
Error when configuring Smart API Manager using the saved configuration file
Logging on with Integrated Windows Authentication results in prompt for domain credentials
Log on failure
Prompted to log on with IWA enabled when using Chrome
Web Client access error when SAM is hosted on a different server
Concurrent engineering
Merge operation fails with large amounts of data
Configuring methods
Open action in a separate browser tab creates multiple related objects
Configuring a site
Problems generating WebGL viewer files
"Thread was being aborted" error when generating WebGL viewer files in batch
WebGL file conversion fails
Copy master workflow template exception
Creating a Web Client site
Server URL validation error
Document Review Matrix is not assigning recipients
Exception diagnosis
Extract content issues
Access denied when retrieving the COM class factory for component with CLSID
Content extraction using the Web Client does not work for .zvf and .mdb2 files
Failed to create FDWTagArea relationship as area's plant code changed
Memory related issues when processing large 3D models
Server Execution failed when retrieving the COM class factory for component with CLSID
File download issues
Cannot download a single file from a document that contains multiple files
Cannot download file after clicking Export All to Excel in a Citrix environment
Cannot download files from a proxy server
Cannot download multiple files when a single large file is detected
Cannot export data to Excel due to an internal server error
Content error using Export All To Excel
HTTP Status 500 error when downloading a file
Unable to locate files downloaded using Internet Explorer
File upload issues
Cannot upload a file with a modified name
Cannot upload files when Web Client is hosted on a different server
System runs out of disk space due failed or abandoned files
Upload of a large file to the server fails
File viewing problems
3D model does not load into the browser
Browser displays an "out of memory" error message
Cannot search for tags using View and Markup
Cannot view a file using View Native
Cannot view Microsoft Visio files that have a .vsdx file extension
Cannot view object properties when viewing the file using Smart Review
Chrome displays error message "could not initialize WebGL"
Data cannot be found for selected object
Excel to PDF File Conversion Fails
Files do not open
Hexagon drawing or model will not open because of an incorrect input URL
Hyperlink objects not found
Item is not viewable with this command
Localized characters do not display correctly
Markup rendition is not generated for large files
Merged rendition is not generated for large numbers of files or file sizes
Missing border and/or title block information in PID file
Missing or corrupted fonts when viewing a Hexagon drawing in a browser
Multiple sites configured to use X-Frame Options headers
PDF file containing 3D content appears blank
PDF generation fails
Text in alternate renditions of PID files does not appear properly
Text in markup renditions is larger than expected
Slow performance when loading Hexagon 3D models
Thread is aborted in remote services when generating alternate rendition for large files
Touch commands do not work in Chrome
Unsupported file format
Fix the "Project is not set" warning issue for SOPSTempChngReqWorkflow step in the temporary change request workflow
Fix the update HEX QA Review Verification Workflow template exception
Full Text Retrieval (FTR) search issues
FTR search does not display in the Web Client
FTR search is currently disabled
FTR results in Web Client do not match Desktop Client results
Inconsistency report issues
InsightView dashboard issues
Issues when configuring an InsightView dashboard
My tablet keyboard is preventing me from creating a widget
The dashboard is currently unavailable
Issues when displaying an InsightView dashboard
Cannot embed a website in an iframe
Site is shown as Not Secure
The Actions menu isn't available for items in a grid or count widget
The dashboard is slow to load on my iPad
Widget content is not displayed
When viewing a widget, the error "No route found" is returned
When viewing a widget, the error "Resource not found for the segment <Name>" is returned
Load Manager issues
SDx and Office 365 integration troubleshooting
Edit online option not available
Unable to edit a document online
Unable to upload a file
Submittals processing errors
Export
Failure during loading data into the project
Common causes of data export failure
Failure during loading files into the project
Common causes of file processing failure after export
Attempting to update the latest revision of the existing MDR with the same file
Import
Common causes of import errors
Pre-processing errors
File formatting errors preventing processing
Validation
Validation error processing stalled with no errors
Validation errors waiting for approval to load
Other common validation errors
Unable to enter text using Android tablet in landscape mode
Using Mozilla FireFox can increase license consumption
Web browser issues
Feature set images display as a question mark
Saved bookmarks no longer work
Slow performance using the search bar
Web Client continually tries to authenticate
Workflow step password re-authentication errors
Learn more about configuring SDx
Find sample data on Smart Community
Working with Client APIs
Client APIs
AddRecipient client API
AdminEntryPoints client API
AssignRecipients client API
AttachWorkflow client API
CancelDocument client API
ChangeConfigStatus client API
CheckInFiles client API
ClaimObj client API
CompareDocuments client API
CompareWorkflowTemplates client API
CompleteESign client API
ConfigRoleAssignment client API
ConfigureEnumTypes client API
ConflictResolution client API
CopyDistributionMatrix client API
CopyObj client API
CopyToLocalFile client API
CreateClassObj client API
CreateClassObjAndLoad client API
CreateClassObjAndRel client API
CreateENSDefinition client API
CreateEntryPointFromQFind client API
CreateMethod client API
CreateNextSheet client API
CreateObj client API
CreateObjAndRel client API
CreateObjectFromSelectedObjects client API
CreateObjModal client API
CreateRenditionsInBatch client API
CreateSignObjectFromSelectedObjects client API
CreateSignWizardClassObj client API
CreateWatermark client API
CreateWebGLSchedulerTask client API
CreateWizardClassObj client API
Dashboard client API
DashboardCreatePage client API
DashboardUpdatePage client API
DecryptPropertyValue client API
DeleteObj client API
DeleteUnClaimedWorkFlowSteps client API
DeleteWorkflow client API
EditFiles client API
EditFilesOnline client API
EditObj client API
EditObjModal client API
EditObjWithClassification client API
EditSignWizardObj client API
EditWizardObj client API
ExecuteSavedReportFromObject client API
ExpandDocNestedStructure client API
ExpandFileNestedStructure client API
FinishEditOnline client API
FTRSearch client API
Fusion3DContentExtractor client API
GenerateAlternateRendition client API
GenerateMergedRendition client API
GenerateMergedRenditionForFiles client API
GenerateThumbnail client API
GenerateValidationErrorReport client API
GoToOneDrive client API
HistoryViewModal client API
HistoryViewRoute client API
HomeDashboard client API
InconsistencyReport client API
InconsistencyReportByQuery client API
InconsistencyReportWithStartingObject client API
InsertHistRev client API
LaunchURLFromFeatureSet client API
LaunchURLWithDynamicArgs client API
ListEditContextMenu client API
ListEditUncontrolledItems client API
LScanSynchronizeSiteData client API
LScanViewSite client API
LScanViewTagInScan client API
LoadDocumentIndex client API
MaintainCalendar client API
ManageDocumentDiscoveryTask client API
ManageFiles client API
ManageSignedFiles client API
MergeConfig client API
MergeObj client API
MergeStructure client API
MultiStepReAssign client API
Navigate client API
OpenXMLReport client API
PrintFile client API
ProjectHandover client API
QueryClassObj client API
QueryObject client API
RegenerateMetadata client API
RelationshipManagement client API
ReplaceEditableCopyWithMasterCopy client API
ReplaceFiles client API
RequestForESign client API
RestartSchedulerPolling client API
RetryTask client API
Revise client API
RunDocumentDiscoveryTask client API
SCLBCommunicationManagement client API
SCLBCommunicationManagementDetails client API
SCLBManageQualityAssuranceReviewPlan client API
SCLBQualityAssuranceRegister client API
SCLBQualityAssuranceReview client API
SCLBQualityAssuranceReviewDetails client API
SDAApproveSDVJob client API
SDACreateClassObjAndRelFromMarkup client API
SDADeleteSDVJob client API
SDAImpactAnalysis client API
SDAManageDataTree client API
SDAManageMarkupLayersForRendition client API
SDARelationshipBuilder client API
SDASDVDownloadValidationReport client API
SDAShowMySDVJobs client API
SDAViewSDVJobSummary client API
SDAWorkflowStepUserAssignment
SDxCopyWorkflowTemplate client API
SDxCreateClassObjAndLoad client API
SDxCreateWorkflowStepChecklist client API
SDxCreateWorkflowStepDef client API
SDxCreateWorkflowTemplate client API
SDxDeleteCompletedWorkflows client API
SDXManageRelatedItems client API
SDxShowMySDVJobs client API
SDxUpdateWorkflowStepChecklist client API
SDxUpdateWorkflowStepDef client API
SDxWorkflowTemplateEditor client API
SetObjectCollectionValues client API
SetObjectValues client API
ShareUrl client API
ShowInbox client API
ShowInboxForObject client API
ShowObjModal client API
ShowWorkflow client API
SignOff client API
SignOffWithForm client API
SmartPlantReview client API
SOPSCommunicationManagement client API
SOPSCommunicationManagementDetails client API
SOPSManageMarkupLayersForRendition client API
SPFCopyConfigAccess client API
SPFCreateEmailDef client API
SPFNContentExtraction client API
SPFUpdateEmailDef client API
StepAcceptAction client API
StepClaim client API
StepRejectAction client API
TaskReassignmentConfiguration client API
TerminateObj client API
TerminateWorkflow client API
UnCancelDocument client API
UnClaimObj client API
UndoCheckOut client API
UndoEditFiles client API
UndoEditOnline client API
UndoSignOff client API
UnlockUserAccount client API
UpdateGraphicsMapFileWithFDWTag client API
UpdateMethod client API
UpdateReferences client API
UpdateReferredBy client API
UpdateRoleAssignments client API
UpdateWatermark client API
UpdateWidget client API
UploadDocument client API
ViewBatchRenditionLog client API
ViewInDocument client API
ViewItemInRelatedDocument client API
ViewRelatedFiles client API
ViewTagFiles client API
WebClientExtensibility client API
WebClientExtensibilityMultiple client API
WorkflowDetailsReport client API
XmtlCancel client API
XmtlUndoCancel client API
Environment variables
Workflow process step types
Are items mergeable
Attach workflow to an object
Claim your change request to project scope
Change contract and revise related documents
Create a consolidated PDF rendition object
Create document PDF renditions
Create document review objects
Create document review objects based on appended recipients
Delete latest revision(s)
Delete relationships between markups and a change request
Delete workflow markups
Expand a definition and instantiate the relationship
Export and compress the files related to the source object
Generate document reviews for the latest issue purposes
Identify the reviewers in the document review process
Merge a workflow item
Merge to as-built
Merge workflow process steps
Propagate milestone property
Propagate reason for rejection
Propagate roles or users to a workflow process step
Relate the latest issue purposes to the document
Revise a SDx Projects workflow object
Revise document attached to an action
Schedule a task to start a review temporary change workflow
Set the target date on the review step
Sign off latest revision
Skip document reviews
Terminate a relationship between the objects
Validate a common relationship between a workflow object and its child objects
Validate a condition against the workflow object
Validate comments when a step is rejected
Validate if a document with a given issue purpose has been reviewed
Validate if a document with a given issue purpose has any reviewers
Validate the user email address
Keywords
Configure SDx for performance
Actions menu
Lookahead count
Manage the expansion of nodes
Archive and purge
Archive files
Conditions
Entry Points
Change the default query criteria
Forms
Classification page
Display related items on forms
List edit
Merging data
Modeling
New domain group
New tables in the database
Example tables
Example indexes
Schema changes to support the new tables
Example schema changes
Property comparisons
Search, query, and edge filtering
Filtering by property that has no value
Filtering documents by owning group
Filtering objects by dates
Query and find
Column sets
Query form
Reconfigure document query
Interface query
Using paging to improve query performance
Query performance on small data sets
Query performance using promoted properties
Query performance applying security rules
Reassign task page size
Scheduler
Server
Visualization
Configure Graphic View Control for performance
Review required software
Review hardware recommendations
Optimize Smart Interop Publisher .binz data translation
Disable Continuous Highlight and enable Optimize Performance for faster navigation
Disable Anti-alias, Ambient Occlusion, and Transparency effects for better load and navigation performance
Increase the network speed to 1000 BaseT
Increase the browser disk cache
Enable server-side compression
Use HTTP/2
Do not use Incognito Mode
Manage File Service Settings node properties
Optimize Rendering Settings
Update LOD and maximize GPU memory for model loading
Increase the number of worker and download threads
Workflows
Run system health check reports
Column Set Cost Report
Complex Conditions Cost Report
API Entry Point Cost Report
Forms Cost Report
Dynamic Forms Cost Report
Advanced configuration in the Desktop Client
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
Using the 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
Active Scope Status Configuration Syntax
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
User Options
View data for a specific date and time
Reset user profile
Change user preferences
Change general user preferences
Display objects using internal names
Display internal names for GUI items
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 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
Extract all paged query results to Excel
Find an object using an FTR search
Find an object using an FTR preview
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
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
Relationship Management
View relationships
Create relationships
Edit relationships
Terminate relationships
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
Configure formatted Word reports
Business Intelligence reports
Configure visual intelligence reports
Create a visual intelligence report
Extend a visual intelligence report
Exchange Data
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
Loader
Create a load file
Process a load file
View and edit XML load files
XML format
XML instructions
XML load formats for documents
Attaching files (XML)
Transaction handling
Date time handling
CreateConfig setting
Modes for load files
ContainerID
SuppressENS
Load errors and reloading files
Viewing errors in the Loader
Exception reports
View exception reports
View exception reports for individual load errors
Command line usage for the Loader
Load file examples
Data creation
Perform instructions
Relationship examples
Configuring SDx
How to Setup and Configure the SDx Schema
Loading the extended model
Load stand-alone schema changes into HxGN SDx
Import data from Microsoft Excel
Import data from Microsoft Excel and compare
Compare XML
How to Configure the Security Model
Configuring security
Relationship access configuration
Restricting user and role access to database operations
Domain configuration for data segregation
Create domains
Relate class definitions to the domain
Data access configuration
Object owning group access control
Methods for setting ownership
Form sections for setting ownership
Interface owning group access control
View definition access configuration
Workflow access control
Create a security rule
Applying security rules for complex objects
Security Model
Conditional data access
Users
Roles, domains, and access groups
Object ownership
Role assignments
Shortcut menu method access
Relationship manipulation and navigation
Interface ownership
View definition access
How to Configure the GUI Model
Configure conditions
Create or update a condition
Find a condition
Condition syntax
Functions
Condition constants
Environment variable support
Validate conditions
Correcting conditions
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
Configure property definition URLs
Creating a property definition URL
Relationship management
Configure forms
Generate a form from a class definition
Form generation process
Default form generation
Generate form section for an interface
Form generation overrides
Password mask on forms in the Web Client
Create a form manually
Copy a form
Form builder
Configure form title
Suppress the Apply button on forms in the Web Client
Manage form sections
Create form sections
Dynamic sections
Dynamic section tabs
Picture mask types
Validate dates
Set date and time formats
Use regular expressions
Create new section
Find an existing section
Add an existing section
Update an existing section
Delete a section from a form
Delete a section
Create new display items
Display item types
Display item display types
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
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
Configure UoM display sets
Default UoM
Create UoM sets
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
How to Configure the Infrastructure Model
Configure subscriptions
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
Configuring email notification definitions
Learn more about email digests
Set user email digest duration
How to Configure 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 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
Set the View Rendition Auto Convert option
Additional settings and tips required for generating a PDF/CSF
Setting Launch and Active Permissions
Adding SPFRemoteServices to the Administrators group
Configure PDF/CSF generation and batch printing
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
Configuring watermarks
Attach a watermark to a document
Configuring labels
Create a label
Attach a label to a document
How to Configure the Document Schema
Revision schemes configuration
Create a new revision scheme
One revision scheme for the whole system
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 subdirectories by a file limit
Replicated vaults
File encryption in vaults
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 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 thumbnail generation
Configure export object structure
Change the default ExportObjectStructure target type and location
Configure classified documents
Classified documents and forms
Expose classified objects and documents in the GUI
Document re-classification
Document Management Model
Non-revisable documents configuration
Non-revisable document model
ISPFDocument interface
ISPFDocumentObject interface
ISPFSubscribableItem interface
ISPFOwnedObj interface
ISPFFileComposition interface
ISPFClassifiedItem interface
Basic document configuration
Basic document master
ISPFNonPublishedDocMaster interface
ISPFDocumentMaster interface
ISPFDocument interface
ISPFDocumentObject interface
ISPFSubscribableItem interface
Basic document revision
Complex document
ISPFNonPublishedDocRevision interface
ISPFDocumentRevision interface
ISPFDocumentObject interface
ISPFSubscribableItem interface
ISPFOwnedObj interface
Basic document version
Complex document
ISPFNonPublishedDocVersion interface
ISPFDocumentVersion interface
ISPFDocumentObject interface
ISPFSubscribableItem interface
ISPFOwnedObj interface
ISPFFileComposition interface
ISPFExportableItem interface
Revision scheme configuration
SPFDocRevisionRevisionScheme relationship definition
ISPFRevisionScheme interface
SPFInterfaceDefRevisionScheme relationship definition
ISPFObjClass interface
SPFRevisionSchemeObjClass relationship definition
ISPFConfiguration item interface
SPFRevisionSchemeConfigurationItem relationship definition
Configuration controlled documents
Configuration controlled documents model
ISPFMergableDocumentRevision interface
ISPFMergableItem interface
ISPFMergedItem interface
Mergable documents and forms
Full Text Retrieval
ISPFFTRConfig interface
ISPFFTRServerConfig interface
ISPFFTRStopProperty interface
Watermark and label model
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
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
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
ISPFVault interface
ISPOwnedObj interface
ISPFVaultRule interface
ISPFDataAccessGroup interface
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
How to Configure the Workflow Model
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
Condition-based workflow branching
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
Set precedences for the workflow steps
Step status creation
Create a step status
Set step status options
Create a reason for receipt
View auto signed off workflow steps
Set a voting workflow step
Lock down a workflow template
Configure attaching a workflow
Workflow access configuration
Restrict users from accessing objects attached to a workflow
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
How to Configure the Reports Model
Report configuration
Report ownership configuration
Report styles configuration
New report template configuration
Excel Report template configuration
Create a template from Microsoft Excel
Create a template from the Desktop Client
Load the template file into the Desktop Client
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
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
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 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
Making a class definition configuration-dependent
Dependent configuration
Making an item mergeable
Making an item claimable
Managing claims
Explicit claim
History retention
Configuring revision schemes
Different revision schemes for plants and projects
Different revision schemes for a specific plant or project
Relationship definition behavior rules
Query configurations
Configuring the retrieval of data
Reporting
Reporting merge progress errors
Reviewing items that failed to merge
Reviewing merge by grouping object errors
Configuring notifications
Configuring the Merge Progress Notification feature
Understanding the Merge Progress Notification information
How to Analyze System Performance in SDx
Tools to analyze a system
Possible solutions
Situation appraisal
Record typical user actions in the system
Why is the shortcut menu slow?
Comparative tests
Server tracing
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?
Poor Desktop Client loader performance
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
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
Advanced troubleshooting in the Desktop Client
HxGN SDx Security
Unable to log on to HxGN SDx
Unable to log on to HxGN SDx site with Windows Authentication
Post logout redirect authentication loop
HxGN SDx Installation
Error occurs when browsing File Service after installing HxGN SDx Update 25
Canceling uninstallation leaves an entry in Programs and Features list
After applying an Update you receive runtime errors using the Web Client
Unable to launch Server Manager after upgrading HxGN SDx to Update 42
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
Configuration Service and Cache Service
Configuration service
The communication object System.ServiceModel.Channels.ServiceChannel cannot be used
DefaultSPFServerURL
Behavior protocols
Cache service
Rejected credentials
Error changing scope due to cache synchronization failure
HxGN SDx 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
Display
Desktop Client dialog boxes appear strangely
Client APIs and Methods
Activating and using some new commands results in an error message
Documents
Incorrect revision scheme appears when updating a document
Problem when trying to view files with many references
PDF Generation
Unable to generate PDF documents
Alternate rendition does not include views
Alternate rendition includes markup layers unspecified by the edge definition
Vaults and File Services
Operation fails with vault name that begins with numeric character
Unable to load a file to a vault
Full Text Retrieval (FTR)
FTR RT installation does not honor port numbers entered
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
HxGN SDx Email
Unable to send email using JMail
Improving HxGN SDx Performance
Configuration mismatch error
Configuring API request logging
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
Oracle tools
SQL Server tools
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
Import
Import fails when the port number is not updated in the target system URL
Import fails because the system failed to execute stored procedures
Validation
Invalid value for enum level on property
More than one value for a property
Export
Export stuck at stage 2
Export fails 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
Export fails with error: No queue has been found
Export fails with error: File composition is not found to find the vault
Unable to export CSV files correctly using Exchange Data feature
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 Data Capture
Data Capture Pre-Processor issues
Draft has stopped working
Tag information in Smart 3D model does not match with 3D model processed using Data Capture
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
Sample data loading issues
Unable to load sample data in a newly configured plant
Unable to load sample data from SDAPBS.xlsm file when scope is not set in the Desktop Client
Data Capture Content discovery task issues
Content discovery task processing is stuck when extracting data from multiple file types with large drawing files
Unable to extract tags in content discovery task
Error occurs while running a content discovery task for a Microsoft Office or PDF file
Object cannot be created. The UID is not unique in this config
Performance issues
Long domain name causes Qfind search exception
Timeout expired. The timeout period elapsed prior to obtaining a connection from the pool.
Error occurs while editing data reader patterns and running database domain discovery tasks
Error occurs while saving tag discovery patterns for drawing files
Multiple columnsets related to a business object
Data Capture document master properties are not displayed in the report generated for Data Capture documents
Setting up the client debug log
Setting up HxGN SDx 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
Support, Copyright, and Legal Information
Copyright Notice
Customer Support
Hexagon Policy Against Software Piracy
Glossary
3D reader
access token
action pins
actions
active scope
alias tag
API
API Services
as-built
asset
attribute
authorization token
auto-generate
brownfield
business administrator
business objects
cache
cardinality
check in
client API
column headers
common assignee
condition
configuration
configuration tree
content discovery task
contract
contractor
CORS
create scope
CSV
current document
data files
Data Validator
database
database domain discovery task
database reader
database reader pattern
delimiter
deliverable milestone
deputy
design file
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 renditions
document review
document revision
domain
domain tag
drawing reader
duplicate document
edge definition
entry point
enumerated entry
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
function
function code
GET
Graphic Data Service (GDS)
graphic report
Graphic View Control (GVC)
greenfield
hierarchy
host
hotspotting
identity token
image reader
implicit delete
implies
import definition
import process
Info Map
integration
interface definition
inverted CSV file
issue purpose
IWA
job
job definition
JSON
laser scan reader
mapping
markup layer
master document register (MDR)
master file
master tag register (MTR)
master tags
merge
method
model
notifications
OAuth
object weighting
OData
orphan tags
owning group
picklist
pinboard
pins
plant
POST
progress
project
property
property definition
property group
property list
publish
QA review
query
query definition
query scope
raw attribute format
realizes
Reason For Issue (RFI)
Reason For Receipt (RFR)
register interest
regular expression
Relationship Builder
relationship definition
relationship property
rendition
responder
response
REST
RESTful APIs
retrieve
review assignment
review plan
review plan item
revision
revision scheme
role
rules
rulesets
schema
scope
scoped by
section
security codes
security rules
separator
server
sign off
site
SSL
staging
status
step
submittal
sub-review
subscribe
superseded
tag
tag discovery pattern
tag document register (TDR)
tag naming system
target system
technical query
terminate
text reader
thumbnail
title block
To Do List
transmittal
transpose
UID
unique key
unit
UoM
URL
user
user profile
validation process
validation rule
vault
vendor
version
View and Markup
virtual directory
Visualization Data Service (VDS)
wildcard
work breakdown structure
work package
work process diagram
workflow
working document
XML

Back to home page