Administration and Configuration of HxGN SDx - HxGN SDx

PPMProduct: HxGN SDx
PPMCategory_custom: Administration & Configuration
SPFVersion_custom: 10

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
Run a load job
Edit template documents
Create a discipline
View and update disciplines
Create a new revision scheme
Prepare the SDx plant
Configure user access
Create a new user
Update a user
Unlock a temporarily locked user
Manage user role assignments
Assign security codes to a user
Assign roles to a user in a configuration
Get an overview of users assigned to a role
Copy user access
Copy role assignments to another user
Copy user access between configurations
Configuring disciplines for a user
Configure security
Configure security rules
Create a security rule
View and update security rules
Configure security codes
Create a security code
View and update security codes
Relate disciplines to your plant
Relate issue purposes to your plant
Set up the SDx projects
Create a project
Create a contract
Results of setting a default for the response days property
Configure roles and users for SDx Projects
Categorize roles
Additional site configuration options
How do I extend my SDx system?
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
Modify the display of method functions in a feature set
Manage method access groups
Suppress the display of methods in the Web Client
Create a method in the Desktop Client
Configure the default method action for object types
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
Configure API Entry Point relationships
Update an API Entry Point display
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 API Entry Point access groups
Configure search menu items
Edit the display name of a search menu item
Configure the default search filters
Edit property comparison criteria
Advanced search menu items
Configure the results grid sort order
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 Actions menu items
Display a method icon on the Actions menu
Configure object icons for use in the Web Client
Configure objects for use in List Edit
Configure a property value to be set on merged objects
Configure display items and forms
Configure column items in dynamic forms
Control the access to display item hyperlinks
Configure display items for related objects in create and update forms
Suppress the Apply button on forms
Control ENS display in create forms
Configure viewing page titles
Configure linking to connected tags on hotspot bubbles
Configure the audit functionality on methods
Configure launch URLs
Launch URL examples
Configure file types
Configure the import of SharePoint documents
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 view item commands after upgrade
Configure the display of missing and duplicate reference files
Configure viewing for Hexagon PPM file types
Set up the HxGN SDx File Server for WebGL viewer file display
Verify prerequisites on the HxGN SDx File Server
Activate MicroStation on the HxGN SDx File Server
Set the Load User Profile property and grant permissions
Set up the HxGN SDx Application Server for WebGL viewer file display
Enable automatic generation of WebGL viewer files for Hexagon PPM 2D and 3D files
Configure client computers to display WebGL viewer files
Test client computers support for WebGL
Set Chrome graphic rendering and acceleration options
Configure marking up of Hexagon PPM 2D file types
Generate markup rendition files in batch
Automatic generation of markup renditions for Hexagon PPM 2D files
Manually generate or regenerate WebGL viewer files for Hexagon PPM 2D and 3D files
Batch generate WebGL viewer files
Regenerate WebGL viewer files in batch
Check the status of a scheduled task
Configure locking and unlocking of markup layers
Configure stamps and symbols
Adding stamps or symbols from the library
Create stamp or symbol templates
Add stamp or symbol templates to the library
Removing stamps or symbols from the library
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
Build a URL with a variable
Supported URL parameters
Check the status of a widget
Update a dashboard
Configure reports
Configure the Reports feature set
Configure a saved ad hoc report to run in background mode
Configure summary reports
Configure formatted Word reports
Configure visual intelligence reports
Create a visual intelligence report
Extend a visual intelligence report
Configure the data model
Configure object naming
Configure data books for use with operations
Build a data book classification query
Create new classifications for data books
Configure SDx to work with j5
Display other j5 applications within SDx
Set up additional SDx Project features
Configure issue purposes
Create an issue purpose
View and update issue purposes
Relate issue purposes to your project
Relate disciplines to your project
Configure menu items for SDx Projects
Configure submittals
Types of submittals
Learn about the Incoming Submittal workflow
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 SDx document review matrix
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
Configure workflows for projects
Configure a work package
Project reports
Configure workflows
Configure roles to appear during reassignment
Configure roles to appear when adding users as workflow recipients
Configure methods to automatically attach objects to a workflow
Configure workflow access
Configure workflows in SDx Operations
Configure workflows for SDx Projects
Technical Query workflow
Exporting technical query workflow steps
Internal Technical Query workflow
Outgoing Technical Query workflow
Incoming Technical Query workflow
QA Review workflow
QA Actions workflow
Internal Review workflow
Internal Draft workflow
Correct rendition generation failures
Configure notifications and emails for project workflows
Modify email definitions
Configure dynamic assignment of recipients
Configure transmittals
Web Client localization
Generate localization resource files
How do I configure data loading and data exchange?
What is the difference in Data Validator in 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
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
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
Property mapping
Relationship mapping
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
Copy 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 an 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
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
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
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
How do I configure data capture?
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 Data Capture settings
Create a new document discovery pattern
Load the data into the system
Resolve Duplicates
Pre-process the documents
Create a new master tag pattern
Extract content from the documents
Resolve Relationships
Manage the tags
Create data reader patterns
Extract data from a database domain
Create a managed data task
View and manage Data Capture data using the Web Client
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
Document discovery tasks
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
Data Capture Pre-Processor Utilities
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
Content discovery tasks
View content discovery tasks
Create a new content discovery task
Run the content discovery task from the command line
Database domain discovery tasks
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
View relationships in the Document Workbench
Create Document Tag relationship
Tag Maintenance
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 new 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
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
Extract content using workflow template
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
Can I connect to third-party software?
HxGN SDx Connector for TruView
Users and roles for SDx Connector for TruView
Configuring and administering SDx Connector for Truview
Manage Laser Scan Servers
Create a laser scan server
Update a laser scan server
Terminate a laser scan server
Synchronize servers to import data
Show the details of relationships
Manage laser scan sites and scans
Terminate a laser scan site
Terminate a laser scan object
Create a geotag
Using SDx Connector for TruView
View and explore laser scan sites and scans
View details of a laser scan site
Search for a laser scan object
View a laser scan object
View laser scan geotags
View a geotag in a laser scan
Explore laser scans
Measurements
Neighbor laser scans
HxGN SDx Connector for Plant Maintenance
Synchronize tag to functional location
Create a destination
Create a detail
Create a view definition
Create an ad hoc report
Relate destination, transform, and report to detail
Synchronize Plant Breakdown Structure to SAP
Synchronize a tag to a functional location using the Web Client
Configure an automatic workflow to synchronize a tag to a functional location
Synchronize asset to equipment
Create a destination
Create a detail to synchronize asset to equipment
Update an ad hoc report
Relate destination, transform, and report to detail
Synchronize an asset to the equipment
Update an asset
Synchronize an asset to an equipment using the Web Client
View SAP Netweaver Portal from SDx
Configure asset information link and equipment installation or dismantle or replacement functionalities
Create the Web Client site
Finding APIs by Postman
Regenerate metadata
Configure SAP
Using XSLT
HxGN SDx Connector for OSISoft PI
Synchronize tag to AF element
Create a destination
Create a detail
Create a tag
Create a view definition
Create an ad hoc report
Relate destination, transform, and report to detail
Synchronize Plant Breakdown Structure to OSIPI
Synchronize a tag to an AF element using the Web Client
Using edge definitions
Using XSLT
HxGN SDx Connector for Maximo
Synchronize tag to location
Create a destination
Create a detail
Create a view definition
Create an ad hoc report
Relate destination, transform, and report to detail
Synchronize Plant Breakdown Structure to Maximo
Synchronize a tag to a location using the Web Client
Configure jump interface
Modify the Web Client site
Finding APIs by using Postman
Regenerate metadata
Using XSLT
HxGN SDx Connector for AspenTech
Synchronize a tag to an AspenEquipment
Prerequisites for synchronization of a tag to an aspenequipment
Interfaces
ISPXSAPSyncObject
ISDXAspenEquipment
ISDAAPIDestination
ISPXSAPSyncDetail
Aspen_TagTransform
Create a destination
Create a detail
Create a view definition
Create an ad hoc report
Modify the Aspen_TagTransform XSLT file
Relate destination, transform, and report to the detail
Configure an automatic workflow to synchronize a tag to an Aspen Equipment
Using XSLT
Troubleshooting
Exception diagnosis
Accessing Web Client
Log on failure
Cannot log on as account is temporarily blocked
Client application is not known or access is not authorized
Client application made an invalid request error
Logging on with Integrated Windows Authentication results in prompt for domain credentials
Prompted to log on with IWA enabled when using Chrome
After applying an Update you receive runtime errors using the Web Client
Concurrent engineering
Merge operation fails with large amounts of data
Configuring a site
Multiple sites configured to use X-Frame Options headers
Problems generating WebGL viewer files
"Thread was being aborted" error when generating WebGL viewer files in batch
Creating a Web Client site
Server URL validation error
File viewing problems
File viewing troubleshooting tips for non-Hexagon PPM formats
Non-Hexagon PPM files will not open and a Brava! Enterprise license error is logged
Non-Hexagon PPM files will not open because Apache Tomcat cannot access Brava! logs
Cannot view a file using View Native
Cannot view non-Hexagon PPM files using View and Markup
Starting Client message appears but file does not open
Cannot view large PDF files using View and Markup
Missing content in Microsoft Office file formats
Cannot view large Microsoft Office, HTML, or HTM files using View and Markup
Cannot view Microsoft Visio files that have a .vsdx file extension
Cannot view a PDF file with a BPN or MSG file attached
PDF generation fails
PDF file containing 3D content appears blank
PDF generation fails for documents attached to a workflow
PDF has extra pages when viewed in a Web Client
Missing border and/or title block information in PID file
Files do not open using View and Markup on a localized installation
Files do not open using View and Markup with a non-English server
Publish to PDF, TIF, or TIFF fails
Non-Hexagon PPM files are too blurry to read
Cannot search for tags using View and Markup
HTTP Status 500 error when publishing to PDF using View and Markup
Viewing error 500
Unable to load error
A file will not open in the browser because the BravaServer URL is not set
Intermittent problems viewing or printing non-Hexagon PPM Files in the browser
Unsupported file format
Detect missing fonts when viewing non-Hexagon PPM CAD files
Missing or corrupted fonts when viewing a 2D DWG file
Missing or corrupted fonts when viewing a Hexagon PPM drawing in a browser
Missing lines when viewing a DGN or 2D DWG file
Localized characters do not display correctly
Hexagon PPM drawing or model will not open because of an incorrect input URL
Data cannot be found for selected object
Hyperlink objects not found
Item is not viewable with this command
3D model does not load into the browser
Slow performance when loading 3D models
Chrome displays error message "could not initialize WebGL"
Touch commands do not work in Chrome
Browser displays an "out of memory" error message
Brava! Enterprise log file errors
License Server Down Error
Brava Server license expired error
The server setting for legal.ip.to.get.sessionid does not match the error
java.lang.RuntimeException: Could not generate DH keypair error
java.lang.NullPointerException: null error
Apache Tomcat service fails to start
Server is running out of memory
Server is consuming too much CPU
File download issues
HTTP Status 500 error when downloading a file
Cannot download files from a proxy server
Cannot export data to Excel due to an internal server error
Unable to locate files downloaded using Internet Explorer
Cannot download a single file from a document that contains multiple files
Cannot download multiple files when a single large file is detected
Content error using Export All To Excel
Cannot download file after clicking Export All to Excel in a Citrix environment
File upload issues
Cannot upload files when Web Client is hosted on a different server
Cannot upload a file with a modified name
System runs out of disk space due failed or abandoned files
Inconsistency report issues
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
Load Manager issues
SharePoint configuration issues
Access denied to a SharePoint site
Exceptions occur accessing a SharePoint Site
No data is returned querying a SharePoint site
Web browser issues
Feature set images display as a question mark
Saved bookmarks no longer work
Web Client navigates to home page on OAuth token refresh
Slow performance using the search bar
InsightView issues
Site is shown as Not Secure
Cannot embed a website in the Web Client
Widget content is not displayed
The Actions menu isn't available for items in a grid or count widget
Troubleshooting 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
Content extraction using the Web Client does not work for .zvf and .mdb2 files
Using Mozilla FireFox can increase license consumption
Submittals processing errors
Pre-processing errors
File formatting errors preventing processing
Import
Common causes of import errors
Validation
Validation errors waiting for approval to load
Other common validation errors
Validation error processing stalled with no 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
Copy master workflow template exception
Error when creating field observations
Fix the update HEX QA Review Verification Workflow template exception
Learn more about configuring SDx
Find sample data on Smart Support
Working with Client APIs
Client APIs
Activate client API and its delivered methods
AddOptionalIfaces client API and its delivered method
AddRecipient client API and its delivered methods
AdminEntryPoints client API and its delivered method
AllOverdueStepsReport client API and its delivered method
AllowMarkupLabelsEdit client API and its delivered method
AllowMarkupPrint client API and its delivered method
AllowMarkupPublish client API and its delivered method
AllowMarkupWatermarksEdit client API and its delivered method
AllowNavigation client API and its delivered method
AllowViewDrawingLayers client API and its delivered method
ArchivePurge client API and its delivered methods
AssignRecipients client API and its delivered methods
AttachWorkflow client API and its delivered methods
BatchPrint client API and its delivered methods
CancelDocument client API and its delivered method
ChangeOwnerOwningGroup client API and its delivered method
ChangeOwningGroup client API and its delivered methods
ChangeStatus client API and its delivered methods
ChangeUserPassword client API and its delivered method
CheckIn client API and its delivered methods
CheckInFiles client API and its delivered methods
CheckOut client API and its delivered methods
ClaimObj client API and its delivered method
ClearTree client API and its delivered method
ClearBravaCache client API and its delivered methods
CompareDocuments client API and its delivered methods
CompareFiles client API and its delivered methods
CompareObjsToHigherConfig client API and its delivered methods
ConfigRoleAssignment client API and its delivered method
ConfigurationReport client API and its delivered method
ConflictResolution client API and its delivered methods
ConvertForNavigation client API and its delivered methods
CopyConfigObj client API and its delivered methods
CopyDistributionMatrix client API and its delivered methods
CopyNamedObject client API and its delivered methods
CopyObj client API
CopyToLocalFile client API and its delivered methods
CreateAdhocQuery client API and its delivered method
CreateBIReport client API and its delivered method
CreateClassObj client API
CreateClassObjAndLoad client API and its delivered methods
CreateClassObjAndRel client API
CreateClassObjAndRelFromMarkup client API
CreateClassObjAndRelWithPropertyOverrides
CreateClassObjFromClass client API and its delivered methods
CreateClassObjFromClassWithPropertyOverrides client API
CreateClassObjWithPropertyOverrides client API
CreateEntryPointFromQFind client API and its delivered method
CreateMarkup client API and its delivered method
CreateNextSheet client API
CreateObj client API and its delivered methods
CreateObjAndRel client API and its delivered methods
CreateObjAndRelFromMarkup client API
CreateObjectFromSelectedObjects client API and its delivered methods
CreateRenditionsInBatch client API and its delivered methods
CreateWebGLSchedulerTask client API and its delivered method
CreateWizardClassObj client API
Dashboard client API and its delivered methods
DashboardCreatePage client API and its delivered methods
DashboardUpdatePage client API and its delivered methods
DeleteConfigHistory client API and its delivered method
DeleteConnectedGeoTag client API and its delivered methods
DeleteOrphanedGeoTag client API and its delivered methods
DeleteMarkup client API and its delivered method
DeleteObj client API and its delivered methods
DeleteSavedQuery client API and its delivered method
DeleteWorkflow client API and its delivered method
DocVersionCompare client API and its delivered method
DrilldownByGrouping client API and its delivered method
EditAdhocQuery client API and its delivered method
EditAllRels client API and its delivered methods
EditBIReport client API and its delivered method
EditFiles client API and its delivered methods
EditObj client API and its delivered methods
EditSavedQuery client API and its delivered method
EditSavedQueryFromListView and its delivered method
EditWizardObj client API
ExcelImporter client API and its delivered method
ExecuteAdhocQuery client API and its delivered method
ExecuteSavedReport client API and its delivered methods
ExecuteSavedReportFromObject client API and its delivered methods
ExecuteSavedUsrQuery client API and its delivered method
ExpandDocNestedStructure client API and its delivered method
ExpandFileNestedStructure client API and its delivered method
ExpandStructure client API details and its delivered methods
ExplorerConfiguration client API and its delivered methods
Export client API and its delivered methods
ExportObjectStructure client API and its delivered methods
ExportObjectStructureLocal client API and its delivered methods
ExtractToExcel client API and its delivered method
ExtractToExcelTemplate client API and its delivered method
ExtractToExcelUserSelect client API and its delivered method
ExtractToText client API and its delivered method
FormBuilder client API and its delivered method
FormGenerate client API and its delivered method
FTRBulkIndex client API and its delivered method
FTRConfig client API and Its delivered method
FTRPreview client API and its delivered method
FTRReport client API and its delivered method
FTRRHMConfig client API and its delivered methods
FTRSearch client API and its delivered methods
Fusion3DContentExtractor client API and its delivered method
FutureChangesReport client API and its delivered method
GenerateAlternateRendition client API and its delivered methods
GenerateClassTree client API and its delivered method
GenerateMergedRendition client API
GenerateThumbnail client API and its delivered methods
GenerateValidationErrorReport client API and its delivered method
GetSavedAdhocQueries and its delivered method
GetSavedUsrQueries client API and its delivered method
HelpAssistance client API and its delivered method
History client API and its delivered method
HotfixReport client API and its delivered method
InsertHistRev client API and its delivered method
InvalidMergableItemsReport client API and its delivered method
LaunchURL client API and its delivered methods
LaunchURLFromFeatureSet client API
LaunchURLWithDynamicArgs client API and its delivered methods
LimitViewMarkup client API and its delivered method
ListEditContextMenu client API and its delivered methods
ListEditRelatedItems and its delivered method
ListEditRelatedItemsWithFilter client API
ListEditToolbar and its delivered method
ListEditUncontrolledItems client API and its delivered methods
ListManagementConsole client API and its delivered methods
LoadDocumentIndex client API and its delivered method
Loader client API and its delivered method
LoadObject client API and its delivered methods
LockMarkup client API and its delivered methods
LScanSynchronizeSiteData client API and its delivered methods
LScanViewScan client API and its delivered methods
LScanViewSite client API and its delivered methods
LScanViewTagInScan client API and its delivered methods
MaintainCalendar client API and its delivered method
MaintainMatrixRecips client API and its delivered method
ManageAllClassSubscriptions client API and its delivered methods
ManageAllClassSubscriptionsForCurrentUser client API and its delivered method
ManageAllObjectSubscriptions client API and its delivered method
ManageAllObjectSubscriptionsForCurrentUser client API and its delivered method
ManageClassSubscriptions client API and its delivered methods
ManageClassSubscriptionsForCurrentUser client API and its delivered method
ManageDocumentDiscoveryTask client API and its delivered methods
ManageFiles client API and its delivered method
ManageObjectSubscriptions client API and its delivered method
ManageObjectSubscriptionsForCurrentUser client API and its delivered method
ManageRelatedItems API argument summary
MergeableItemSummary client API and its delivered method
MergeConfig client API and its delivered method
MergeObj client API and its delivered method
MergeStructure client API
MergeStructureSummary client API
ModuleAccess client API and its delivered methods
MultiStepReAssign client API and its delivered methods
Navigate client API and its delivered methods
NotificationList client API and its delivered method
OpenXMLReport client API and it delivered methods
OpenXMLWordReport client API and its delivered methods
OverdueStepsReport client API and its delivered methods
Performance client API and its delivered method
Print client API and its delivered method
PrintContents client API and its delivered method
PurgeSupersededVersions client API and its delivered method
PutWorkflowOnHold client API and its delivered method
QFindObject client API and its delivered methods
QueryByContainer client API and its delivered methods
QueryClassObj client API and its delivered methods
QueryClassObjFromClass client API and its delivered methods
QueryObject client API and its delivered methods
QueryObjectWithHistory client API
QueueManagement client API and its delivered methods
ReclassifyObject client API and its delivered method
RegenerateAPIMetadata client API and its delivered method
RegenerateMetadata client API and its delivered method
RegisterAndCheckIn client API and its delivered methods
RejectWorkflow client API and its delivered method
ReplaceFiles client API and its delivered methods
ReRunContentDiscoverytask client API and its methods
ResetProfile client API and its delivered method
ResponseManagement client API and its delivered methods
RestartSchedulerPolling client API and its delivered method
RetryTask client API and its delivered method
Revise client API and its delivered methods
RunDocumentDiscoveryTask client API and its delivered methods
SchemaImport client API and its delivered method
SCLBCommunicationManagement client API and its delivered methods
SCLBCommunicationManagementDetails client API and its delivered methods
SCLBManageQualityAssuranceReviewPlan client API and its delivered methods
SCLBQualityAssuranceRegister client API and its delivered methods
SCLBQualityAssuranceReview client API and its delivered methods
SCLBQualityAssuranceReviewDetails client API and its delivered methods
SDAApproveSDVJob client API and its delivered methods
SDACopyDataBookContent client API and its delivered method
SDACreateClassObjAndRelFromMarkup client API
SDADeleteSDVJob client API and its delivered method
SDAImpactAnalysis client API and its delivered methods
SDAManageDataTree client API and its delivered methods
SDAManageMarkupLayersForRendition client API and its delivered methods
SDARelationshipBuilder client API and its delivered methods
SDASDVDownloadValidationReport client API and its delivered method
SDAShowMySDVJobs client API and its delivered method
SDAViewSDVJobSummary client API and its delivered method
SDAWorkflowStepUserAssignment and its delivered methods
SDxCreateClassObjAndLoad client API and its delivered methods
SDxShowMySDVJobs client API and its delivered methods
SectionGenerate client API and its delivered method
SetActiveScope client API and its delivered method
SetAsCurrentConfiguration client API and its delivered method
SetContainer client API and its delivered methods
SetObjStatus client API and its delivered methods
SharePointSearchAccess client API and its delivered methods
ShareUrl client API and its delivered method
ShowInbox client API and its delivered method
ShowInboxForObject client API and its delivered method
ShowObj client API and its delivered methods
ShowTaskFailure client API and its delivered method
ShowWorkflow client API and its delivered methods
SignOff client API and its delivered method
SignOffWithForm client API and its delivered method
SmartPlantReview client API and its delivered methods
SOPSCommunicationManagement client API and its delivered methods
SOPSCommunicationManagementDetails client API and its delivered methods
SOPSManageMarkupLayersForRendition client API and its delivered methods
SPFCopyConfigAccess client API and its delivered method
SPFExchangeData client API
SPFNCDTCreationFromSelectedDocuments client API and its delivered methods
SPFNCheckInWithContentExtraction and its delivered method
SPFNContentExtraction and its delivered method
SPFNCreateMasterRevision and its delivered method
SPFNCreateRelationshipsForSelectedDocuments and its delivered method
SPFNSetAsMasterFile and its delivered method
SPFNTagClassification client API and its delivered method
SPFNViewFilesRelatedToTag client API and its delivered methods
StartScheduler client API and its delivered method
StepAcceptAction client API and its delivered methods
StepClaim client API and its delivered methods
StepReAssign client API and its delivered method
StepRejectAction client API and its delivered methods
StepUpdateDates client API and its delivered method
StepUpdateDesc client API and its delivered method
StepUpdateRecip client API and its delivered method
StopScheduler client API and its delivered method
TakeWorkflowOffHold client API and its delivered method
TaskReassignmentConfiguration API and its delivered methods
TerminateObj client API and its delivered methods
TerminateWorkflow client API and its delivered method
UnCancelDocument client API and its delivered method
UnClaimObj client API
UndoCheckOut client API and its delivered method
UndoEditFiles client API and its delivered method
UndoSignOff client API and its delivered method
UnlockMarkup client API and its delivered methods
UnlockUserAccount client API and its delivered method
UpdateGraphicsMapFiles client API and its delivered method
UpdateGraphicsMapFileWithFDWTag and its delivered method
UpdateMarkup client API and its delivered method
UpdateReferences client API and its delivered methods
UpdateReferredBy client API and its delivered methods
UploadDocument client API and its delivered method
UserPreference client API and its delivered method
ValidateConditions client API and its delivered method
ValidateSPFSite client API and its delivered method
ViewAdhocQuery client API and its delivered method
ViewBatchRenditionLog client API and its delivered methods
ViewFileWrapper client API and its delivered methods
ViewForm client API and its delivered method
ViewInDocument client API and its delivered methods
ViewItemIn3DModel client API and its delivered methods
ViewItemInRelatedDocument and its delivered method
ViewLookAhead client API and its delivered method
ViewRelatedFiles and its delivered method
ViewRelatedItems client API and its delivered methods
ViewRelationshipObjects client API and its delivered method
ViewTagFiles client API and its delivered methods
VTLDeleteJob client API and its delivered method
VTLViewAllJobs client API and its delivered method
WebClientExtensibility client API and its delivered methods
WFDoExpirationChecks client API and its delivered method
WorkflowDetailsReport client API and its delivered method
WorkflowEdit client API and its delivered methods
WorkflowHistory client API and its delivered method
XmlDiff client API and its delivered method
XmtlCancel client API and its delivered methods
XmtlMakeTemplate client API and its delivered method
XmtlSetPlannedDate client API and its delivered method
XmtlSetPropToRecip client API and its delivered method
XmtlUndoCancel client API and its delivered methods
XmtlUpdateRecip client API and its delivered method
Deactivated and non-supported Client APIs and their delivered methods
Workflow process step types
Are items mergeable
Attach a workflow to an object
Merge a workflow item
Delete relationships between markups and a change request
Claim your change request to project scope
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 workflow markups
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 to as-built
Propagate milestone property
Propagate reason for rejection
Propagate roles or users to a workflow process step
Revise document attached to an action
Relate the latest issue purposes to the document
Revise a collaboration workflow object
Schedule a task to start a review temporary change workflow
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 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
Keywords
Support, Copyright, and Legal Information
Copyright Notice
Customer Support and Technical User Forum
Hexagon PPM 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 list
data sheet
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
folder
form
function
function code
GET
graphic report
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
wildcard
work breakdown structure
work package
work process diagram
workflow
working document
XML

Back to home page