Users can create, update, or delete markup layers within SmartPlant Markup Plus based on user access configured in SmartPlant Foundation. This configuration respects all usual role, configuration, and conditional control.
The following client methods are provided for markup security:
-
CreateMarkup
-
UpdateMarkup
-
DeleteMarkup
-
LimitViewMarkup (optional)
-
LockFileMarkups
-
UnlockFileMarkups
-
LockMarkupFile
-
UnlockMarkupFile
-
LockMarkups
-
UnlockMarkups
-
Methods for deleting, locking, and unlocking apply only to supported SmartPlant file formats.
-
The markup methods UpdateMarkup and DeleteMarkup that are delivered with the core document model have the condition IsMarkupUnlockedAndUserInOwningGroup set on them. The method CreateMarkup has no conditions set (that is, it is open for all).
-
When you launch SmartPlant Markup Plus, each markup is tested for access using the UpdateMarkup and DeleteMarkup methods.
CreateMarkup
The CreateMarkup method allows you to specify whether an owning group is required for a markup. You can also specify an initial owning group, if needed.
If a condition is written for the CreateMarkup method, it should be written so that it can be applied to the file and the document version. For example, to restrict markup creation to working documents, use the following condition: Obj->SPFFileComposition_12->SPFRevisionVersions_21.SPFRevState='WORKING' OR Obj->SPFRevisionVersions_21.SPFRevState='WORKING'.
UpdateMarkup
To modify or consolidate existing markup layers, the layers must be unlocked and you must have access to the UpdateMarkup method. To control who can update a markup layer, set a condition on the UpdateMarkup - Access Group relationship definition. For example:
DocumentView - IsOwner
ENGINEERING - IsInOwningGroup
LimitViewMarkup
You can limit markup viewing by attaching the LimitViewMarkup method to the DocumentView group with the IsMarkupUnlockedAndUserInOwningGroup condition. In this case, users from the DocumentView group can view markups only if they are the owner of the markups or have access to the owning group of the markups.
Without the use of the LimitViewMarkup method, all users can view all markups.
LockFileMarkups
This method locks all the markup layers available for a file, even when the file is not being viewed. This method is available only in the Desktop Client.
UnlockFileMarkups
This method unlocks all the markup layers available for a file, even when the file is not being viewed. This method is available only in the Desktop Client.
LockMarkupFile
This method locks selected markup layers when a file is being viewed in SmartPlant Markup. This method is available in both the Desktop Client and the Web Client.
UnlockMarkupFile
This method unlocks selected markup layers when a file is being viewed in SmartPlant Markup. This method is available in both the Desktop Client and the Web Client.
LockMarkups
This method locks all the markup layers available for all the files related to a document, even when those files are not being viewed. This method is available only in the Desktop Client.
UnlockMarkups
This method unlocks all the markup layers available for all the files related to a document, even when those files are not being viewed. This method is available only in the Desktop Client.