SmartPlant Foundation Web Client Help - SmartPlant Foundation - Update 53.1 - Help - Hexagon

Language: English
Product: SmartPlant Foundation
Search by Category: Help

SmartPlant Foundation Web Client Help
Introduction to Web Client
Understanding information access
Understanding scopes
Understanding roles
Basic tasks in the Web Client
Find your way around the Web Client
Search for data and objects in your system
Search for objects
Search for multiple items
Export object data to Excel
Run a report
Use the Actions menu to manage objects
Displaying actions as shortcut icons
Add objects to the Pinboard
Review your work in the To Do List
Use the Info Map to visually navigate information
Change your user settings and personalize your experience
Working with scopes
Change the query scope
Change the create scope
Query by selected configurations only
Scope filter options
Life cycle status filter
Change your roles
User preferences
Set the user options
Reassign your tasks
Resize your menu panes
Change your password
Editing object data
How do I use the Web Client?
Using the Pinboard
Adding items to your Pinboard
Group your pins in lists
Pins menu shortcut icons
Modify the pins lists
Move or copy pins
Create an object related to a pin
Managing documents and files
Working with documents
Documentation life cycle
Create a document
Copy a document
Revise a document
Edit and check in a document
Replace the files for a document
Sign off a document
Update a document
Sign off with form
Undo sign off
Insert a historical revision
Cancel a document
Working with files
Edit files
Replace files
Manage files
Check in files
Undo edit files
Revise and replace files
Download attached files
Generate PDF renditions of files
Generate thumbnail images of files
Working with reference files and relationships
Attach master file which references other files
View reference relationships
View nested reference documents
View nested reference files
Update reference relationships
Update referred by relationships
View and manage laser scans
Working with objects
Create and manage objects
Copy an object
View the object details
Update an object
Delete an object
Terminate an object
Relate the objects in a wizard
Visualizing your data
What file formats are supported in the Web Client?
Viewing and navigating your files
Navigating Hexagon 3D file formats
Navigate Hexagon 3D file formats using touch gestures
Navigate Hexagon 3D file formats using a keyboard, keypad, and mouse
Navigate Hexagon 3D file formats using the menu bar
Navigate Hexagon 3D file formats using navigation and selection commands
Measure distances in Hexagon 3D model file formats
Work with markups for Hexagon 3D models
Navigating 2D file formats
Navigate 2D file formats using touch gestures
Navigate 2D file formats using the menu bar
View SmartFrame layers in a 2D drawing
View Smart Interop Objects in a 2D drawing
Navigating tags in split-screen mode
Marking up and comparing your files
Navigating non-Hexagon file formats
Navigate non-Hexagon file formats using touch gestures
Navigate non-Hexagon file formats using a keyboard, keypad, and mouse
Using the Markup Toolbar
Download a file with markup layers
Print a non-Hexagon file format
Using the Markup Layers Manager
Create a markup layer
View a markup layer
Edit a markup layer
Copy a markup layer
Consolidate markup layers
Lock or unlock markup layers
Delete one or more markup layers
Annotating a file using markup layers
Add annotations to a markup layer
Add dynamic stamps with token values to a markup layer
Format annotations in a markup layer
Comparing files using the viewer
Compare files attached to different documents
Compare design files
Compare text files
Using the hotspot bubble
Using visual intelligence to analyze your data
Search for tags
Run a visual intelligence report
Visual intelligence options
Analyze Smart 3D AsBuilt (PAB) models
Define your workspace using visual intelligence
View the design status of items in a project
Printing your files
Visualization troubleshooting
Troubleshooting the Graphic View Control (GVC)
An error occurred during display
Application has run out of memory
Cannot load Hexagon 3D models
Cannot start the viewer
Viewer is unresponsive to touch gestures
Slow performance when loading Hexagon 3D models
Unable to interact with the GVC on an iPad
Troubleshooting the view and markup control
Unable to download a file
Unable to retrieve the markup rendition
Annotations change to a draft image when rotated in Adobe Acrobat
Rendering limitations
Conversion fails for markup layers
Viewer does not load correctly
Managing CAD custom fonts
Existing markup annotations shift when opening a markup snapshot file for viewing
Querying for data
Use the Advanced search
Create a query
Save a query
Delete a query
View search results
Results table options
Filter or sort the results
Export object data to Excel
Full text search option
Reporting on your data
Run saved reports
Run a report with a prompt (Query)
View notifications of reports
Run formatted Word reports
Summary Reports
Using visual intelligence to analyze your data
Run a visual intelligence report
Search for tags
Visual intelligence options
Create a relationship between objects
Create and edit a relationship
Terminate an existing relationship
Using ENS with documents and objects
Create multiple documents or objects with ENS
ENS preview summary
Using the Info Map
Create a relationship tree
Limitations using Info Map
Using workflows
View a workflow details report for an object
Using List Edit
Edit object data in the results grid
Using the To Do List
To Do List overview
Results table
Workflow viewer
Workflow viewer options
Task details
Parallel tasks
Viewing the History
View attribute details
View the object timeline
Grouping attributes by column header
Filter and sort the attributes
Document overview
View document details
Viewing attached files
Viewing and Navigating Published Data
Registering a tool with the data warehouse
Viewing inconsistencies
Viewing inconsistency reports in Microsoft Excel
Generating inconsistency reports on published data
Generating inconsistency reports for configurations
Using Concurrent Engineering
Modify objects in a project
Claim objects
Unclaim objects
Claim and Unclaim related objects
Merging objects
Merging a single object or group of objects
Merging a structure of data
Merging a project
Merge summary
Resolve conflicts
Merge command
Merge progress notification
Merge object failures
Modify documents in a project
Revise a document to a project
Merging documents
Conflict resolution in documents
How do I configure the Web Client?
Configure user access
Create a new user
Update a user
Unlock a temporarily locked user
Manage user role assignments
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
Configure security
Configure security rules
Create a security rule
View and update security rules
Configure feature sets
Create a feature set
Create a feature set in the Desktop Client
Relate a method to a feature set
Relate a method to a feature set in the Desktop Client
Modify a feature set
Modify a feature set in the Desktop Client
Create a method in the Desktop Client
Configure the form used on create methods
Configure the default method action for object types
View files default action
Modify the display of method functions in a feature set
Manage method access groups
Manage method access groups
Suppress the display of methods in the Web Client
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
Create an API Entry Point group
Configure API Entry Point relationships
Update an API Entry Point
Relating a column set to an API Entry Point
Configure API Entry Points to display as functions in a feature set
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
Configure the default search bar criteria
Configure peek search request value
Disable peek search
Change the default search operator
Edit the display name of a search menu item
Edit property comparison criteria
Configure the default search filter column set items
Exclude search filter column set items
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 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 display items and forms in the Web Client
Control the access to display item hyperlinks
Control ENS display in create forms
Configure display items for related objects in create and update forms
Configure display items and forms
Configure column items in dynamic forms
Suppress the Apply button on forms
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 reports
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 view item commands after upgrade
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
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
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
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
Troubleshooting the view and markup control
Unable to retrieve the markup rendition
Configure the Exchange Data functionality
Exchanging published documents
Create a view definition and a graph definition
Create a new export details object
Create a new report configuration object
Manage view definition options
Manage class definitions for inverted CSVs
Manage relationship definitions for inverted CSVs
Create a user-defined method for exchanging data
Exchange data
Run a silent job
Run a job
Configure projects
Create a project
Manage plant or project data
Configure the import of plant or project data
Configure prompted attributes on load jobs
Create a load job
Monitor the load job progress
Review validation errors
Review export stage errors
Configure workflow
Configure methods to automatically attach objects to a workflow
Configure To Do List filtering by roles
Web Client localization
Create localization resource files
Configure the Web Client for performance
Manage the expansion of nodes
More Information
What file formats are supported in the Web Client?
Find sample data on Smart Community
Working with tasks and notifications
Indicate a workflow step cannot be completed
Reassign work to a different user
Reassign your tasks temporarily
Reassign a workflow step
Working with Client APIs
Client APIs
Activate client API
AddOptionalIfaces client API
AddRecipient client API
AdminEntryPoints client API
AllOverdueStepsReport client API
AllowMarkupLabelsEdit client API
AllowMarkupPrint client API
AllowMarkupPublish client API
AllowMarkupWatermarksEdit client API
AllowNavigation client API
AllowViewDrawingLayers client API
ApplySchemaChanges client API
ArchivePurge client API
AttachWorkflow client API
BatchPrint client API
CancelDocument client API
ChangeOwnerOwningGroup client API
ChangeOwningGroup client API
ChangeStatus client API
ChangeUserPassword client API
CheckIn client API
CheckInFiles client API
CheckOut client API
ClaimObj client API
ClearTree client API
CompareAgainstPreviousVersion client API
CompareDBasis client API
CompareDocuments client API
CompareFiles client API
CompareLatestRetrievedData client API
CompareObjsToHigherConfig client API
CompareVersions client API
ConfigRoleAssignment client API
ConfigurationReport client API
ConfigureDatalist client API
ConflictResolution client API
ConvertForNavigation client API
CopyConfigObj client API
CopyDistributionMatrix client API
CopyNamedObject client API
CopyObj client API
CopyToLocalFile client API
CorrelateListEditContextMenu client API
CreateAdhocQuery client API
CreateBIReport client API
CreateClassObj client API
CreateClassObjAndLoad client API
CreateClassObjAndRel client API
CreateClassObjAndRelFromMarkup client API
CreateClassObjAndRelWithPropertyOverrides client API
CreateClassObjFromClass client API
CreateClassObjFromClassWithPropertyOverrides client API
CreateClassObjWithPropertyOverrides client API
CreateEntryPointFromQFind client API
CreateGraphicReport client API
CreateHistoricSnapshot client API
CreateListDocumentSnapShot client API
CreateMarkup client API
CreateNextSheet client API
CreateObj client API
CreateObjAndRel client API
CreateObjAndRelFromMarkup client API
CreateObjectFromSelectedObjects client API
CreateRegisterDocumentObj client API
CreateRenditionsInBatch client API
CreateSnapshot client API
CreateSnapshotReport client API
CreateWebGLSchedulerTask client API
CreateWizardClassObj client API
DataSheetDefinerAPIs client API
DeleteConfigHistory client API
DeleteConnectedGeoTag client API
DeleteMarkup client API
DeleteObj client API
DeleteOrphanedGeoTag client API
DeleteSavedQuery client API
DeleteWorkflow client API
DEVNavigateSchema client API
DocumentExecuteGraphicReport client API
DocVersionCompare client API
DocVersionGraphicCompare client API
DrilldownByGrouping client API
EditAdhocQuery client API
EditAllRels client API
EditBIReport client API
EditFiles client API
EditGraphicReport client API
EditObj client API
EditObjWithClassification client API
EditSavedQuery client API
EditSavedQueryFromListView client API
EditWizardObj client API
ExcelImporter client API
ExecuteAdhocQuery client API
ExecuteGraphicReport client API
ExecuteSavedReport client API
ExecuteSavedReportFromObject client API
ExecuteSavedUsrQuery client API
ExpandDocNestedStructure client API
ExpandFileNestedStructure client API
ExpandStructure client API
Export client API
ExportObjectStructure client API
ExportObjectStructureLocal client API
ExportVaultForBulkPublish client API
ExtractToExcel client API
ExtractToExcelTemplate client API
ExtractToExcelUserSelect client API
ExtractToText client API
FormBuilder client API
FormGenerate client API
FrameworkCorrelateRHM client API
FrameworkManageCases client API
FrameworkPublish client API
FrameworkPublishRHM client API
FrameworkRegisterInt client API
FrameworkRetrieve client API
FTRBulkIndex client API
FTRConfig client API
FTRPreview client API
FTRReport client API
FTRRHMConfig client API
FTRSearch client API
FutureChangesReport client API
GenDatasheet client API
GenerateAlternateRendition client API
GenerateClassTree client API
GenerateDatalist client API
GenerateMapFile Client API
GenerateMergedRendition client API
GenerateMergedRenditionForFiles client API
GenerateThumbnail client API
GenMultiDatasheets client API
GetDesignBasisData client API
GetItemsPublishedWithDocVersion client API
GetRetrievableDocs client API
GetSavedAdhocQueries client API
GetSavedUsrQueries client API
HelpAssistance client API
History client API
HotfixReport client API
InconsistencyReport client API
InconsistencyReportByQuery client API
InconsistencyReportWithStartingObject client API
InsertHistRev client API
InvalidMergableItemsReport client API
LaunchURL client API
LaunchURLFromFeatureSet client API
LaunchURLWithDynamicArgs client API
LimitViewMarkup client API
ListEditContextMenu client API
ListEditRelatedItems client API
ListEditRelatedItemsWithFilter client API
ListEditToolbar client API
ListEditUncontrolledItems client API
ListManagementConsole client API
Loader client API
LoadObject client API
LockMarkup client API
LScanSynchronizeSiteData client API
LScanViewScan client API
LScanViewSite client API
LScanViewTagInScan client API
MaintainCalendar client API
MaintainMatrixRecips client API
ManageAllClassSubscriptions client API
ManageAllClassSubscriptionsForCurrentUser client API
ManageAllObjectSubscriptions client API
ManageAllObjectSubscriptionsForCurrentUser client API
ManageClassSubscriptions client API
ManageClassSubscriptionsForCurrentUser client API
ManageFiles client API
ManageObjectSubscriptions client API
ManageObjectSubscriptionsForCurrentUser client API
ManagePrecedenceRulesAPI client API
ManageRelatedItems client API
MergeableItemSummary client API
MergeConfig client API
MergeIntoCompositeDoc client API
MergeObj client API
MergeStructure client API
MergeStructureSummary client API
ModuleAccess client API
MultiStepReAssign client API
Navigate client API
NotificationList client API
OpenXMLWordReport client API
OverdueStepsReport client API
Performance client API
PrgAcceptReplan client API
PrgCancelReplan client API
PrgEditCutOffDates client API
PrgHierarchy client API
PrgInitiateReplan client API
PrgManageActivityItemDates client API
PrgRegisterForProgress client API
PrgRunRollup client API
PrgUnregisterForProgress client API
PrgUpdateProgress client API
PrgViewDeliverable client API
PrgViewProgress client API
PrgViewProgressSCurve client API
PrgViewReplan client API
PrgWorkpackCreate client API
PrgWorkpackCreateFromTemplate client API
PrgWorkpackFreezeUnfreeze client API
PrgWorkpackQueryByHierarchy client API
PrgWorkpackRedistributeManHours client API
PrgWorkpackSetProgressUpdated client API
PrgWorkpackUpdate client API
PrgWorkpackView client API
Print client API
PrintContents client API
PrintFile client API
PurgeSupersededVersions client API
PutWorkflowOnHold client API
QFindObject client API
QueryByContainer client API
QueryClassObj client API
QueryClassObjFromClass client API
QueryForDocsByQueue client API
QueryObject client API
QueryObjectWithHistory client API
QueueManagement client API
ReclassifyObject client API
RegenerateAPIMetadata client API
RegenerateMetadata client API
RegenerateSchemaFiles client API
ReGenerateSharedObjs client API
RegisterAndCheckIn client API
RegisterAuthoringTool client API
RejectWorkflow client API
RelationshipManagement client API
RemoveDocInLoadQueue client API
ReplaceFiles client API
ResetProfile client API
ResponseManagement client API
RestartSchedulerPolling client API
RetryTask client API
Revise client API
RollupWithConfigOption client API
SchemaImport client API
SDAApproveSDVJob client API
SDADeleteSDVJob client API
SDARelationshipBuilder client API
SDASDVDownloadValidationReport client API
SDAShowMySDVJobs client API
SDAViewSDVJobSummary client API
SectionGenerate client API
SetActiveScope client API
SetAsCurrentConfiguration client API
SetContainer client API
SetDesignBasisCriteria client API
SetObjStatus client API
SetUserConfig client API
ShareUrl client API
ShowInbox client API
ShowInboxForObject client API
ShowObj client API
ShowTaskFailure client API
ShowWorkflow client API
SignOff client API
SignOffWithForm client API
SmartPlantReview client API
SPFCopyConfigAccess client API
SPFExchangeData client API
SPFNCDTCreationFromSelectedDocuments client API
SPFNCheckInWithContentExtraction client API
SPFNContentExtraction client API
SPFNCreateMasterRevision client API
SPFNCreateRelationshipsForSelectedDocuments client API
SPFNSetAsMasterFile client API
SPFNTagClassification client API
SPFNViewFilesRelatedToTag client API
StartScheduler client API
StepAcceptAction client API
StepClaim client API
StepReAssign client API
StepRejectAction client API
StepUpdateDates client API
StepUpdateDesc client API
StepUpdateRecip client API
StopScheduler client API
SummaryViewData client API
TakeWorkflowOffHold client API
TaskReassignmentConfiguration client API
TEFConsolidateDocument client API
TEFLaunchExternalSchemaApp client API
TEFLaunchSchemaEditor client API
TEFLoadPublishData client API
TEFMergeDelta client API
TEFPublishDatasheet client API
TEFReApplySameAsObjs client API
TEFSelectCorrelations client API
TEFShowFailure client API
TerminateObj client API
TerminateWorkflow client API
ToolVersionGraphicCompare client API
UnCancelDocument client API
UnClaimObj client API
UndoCheckOut client API
UndoEditFiles client API
UndoSignOff client API
UnlockMarkup client API
UnlockUserAccount client API
UpdateGraphicsMapFiles client API
UpdateMarkup client API
ViewConsolidatedDataForObject client API
UpdateReferences client API
UpdateReferredBy client API
UpgradeDataCaptureTagDocRels client API
UploadDocument client API
UserPreference client API
ValidateConditions client API
ValidateSPFSite client API
ViewAdhocQuery client API
ViewBatchRenditionLog client API
ViewFileWrapper client API
ViewForm client API
ViewInDrawing client API
ViewInSmartPlantReview client API
ViewItemIn3DModel client API
ViewLookAhead client API
ViewOPC client API
ViewRelatedItems client API
ViewRelationshipObjects client API
ViewSharedData client API
VTLDeleteJob client API
VTLViewAllJobs client API
WebClientExtensibility client API
WebClientExtensibilityMultiple client API
WFDoExpirationChecks client API
WorkflowDetailsReport client API
WorkflowEdit client API
WorkflowHistory client API
XmlDiff client API
XmtlCancel client API
XmtlMakeTemplate client API
XmtlSetPlannedDate client API
XmtlSetPropToRecip client API
XmtlUndoCancel client API
XmtlUpdateRecip client API
HxGN SDx Projects 2018 R1 with SmartPlant Foundation 2019 upgrade
Troubleshooting
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
CORS error when trying to log in to the Web Client
Error when configuring Smart API Manager using the saved configuration file
Web Client access error when SAM is hosted on a different server
Prompted to log on with IWA enabled when using Chrome
After applying an Update you receive runtime errors using the Web Client
Cannot log on with FIPS enabled
Concurrent engineering
Merge operation fails with large amounts of data
Configuring a site
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
Exception diagnosis
File viewing problems
Cannot view a file using View Native
Cannot view Microsoft Visio files that have a .vsdx file extension
PDF generation fails
PDF file containing 3D content appears blank
Excel to PDF File Conversion Fails
Files do not open
Multiple sites configured to use X-Frame Options headers
Missing border and/or title block information in PID file
Cannot search for tags using View and Markup
Cannot view object properties when viewing the file using Smart Review
Unsupported file format
Missing or corrupted fonts when viewing a Hexagon drawing in a browser
Localized characters do not display correctly
Hexagon 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 Hexagon 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
Markup rendition is not generated for large files
Merged rendition is not generated for large numbers of files or file sizes
Text in alternate renditions of PID files does not appear properly
Thread is aborted in remote services when generating alternate rendition for large files
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
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
Cannot view cross-domain results on a shared object
Load Manager issues
Web browser issues
Feature set images display as a question mark
Saved bookmarks no longer work
Web Client continually tries to authenticate
Slow performance using the search bar
Support, Copyright, and Legal Information
Hexagon Policy Against Software Piracy
Copyright Notice
Customer Support

Back to home page