Working with documents - SmartPlant Foundation - IM Update 46 - Help

Working with documents - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Web Client Help

Language

English

Product

SmartPlant Foundation

Search by Category

Help

SmartPlant Foundation / SDx Version

You work and manage documents in the document life cycle using actions which are configured out of the box on documents for basic functionality.

How do you use the different document commands?

The following table shows the different document commands and their capability, which is dependent on the object's state in the revision schema.

Action	What it does
Revise	The CURRENT document is revised, which creates a new WORKING version.
Edit Files	A new WORKING document version is created and marked as checked out. Files attached to the previous working version can be downloaded to a client device for editing. You must manually check in the new document version after editing.
Check In	Check in the new document version, created when the Edit Files command was used, along with any files that were checked out for editing.
Sign Off	Signs off a complete document and changes the status of the document revision from WORKING to CURRENT.
Sign off with form	Signs off a complete document revision and allows you to update properties and revision notes. The document revision status changes from WORKING to CURRENT.
Update Document	Update the master properties of the document.
Update Latest Revision	Update the properties of the latest revision of the document.
Copy	Creates a new copy of the document with a new name, and allows you to select the required property details and values on the Copy form.

Document Controller role only

Action	What it does
Undo Sign Off	Changes the status of the document revision from CURRENT to WORKING.
Cancel	Cancels a document when it is in the RESERVED state.

What do the document icons mean?

The document revision state is indicated by its icon.

Icon	Document Revision State	Notes
	Current revision	The Current revision. The working revision is signed off. No claim state.
	Current revision superseded	A Current revision has been revised for further editing. No claim state.
	Current revision result of a claim	The Current revision is the result of a claim from a higher configuration.
	Current revision result of a claim superseded	The Current revision claimed from a higher configuration has been superseded.
	Current revision source of a claim	The current revision is the source of a claim to a lower configuration.
	Current revision result of a claim and source of a claim	The Current revision has been claimed from a higher configuration and is the source of a claim to a lower configuration. Result of a three tier-hierarchy scenario.
	Superseded revision	The revision that was previously signed off as the Current revision, but has been superseded by another signed off revision. No claim state.
	Superseded revision result of a claim	The revision is the result of a claim from a higher configuration and superseded by a newer Current revision.
	Superseded revision source of a claim	The revision is the source of a claim to a lower configuration and superseded by a newer Current revision.
	Working revision/version	The working revision or version. Either a previous Current revision has been revised to create a new working revision and version, or this is the first revision of the document. No claim state.
	Working version superseded	The previous working version has been superseded by a check in. No claim state.
	Working version checked out	A new working version has been checked out for editing. No claim state.
	Working version checked out superseded	The new working version checked out for editing has been superseded. No claim state.
	Working version result of a claim	A new working version is the result of a claim from a higher configuration by revising the Current revision.
	Working revision source of a claim	The working version that is the source of a claim to a lower configuration.