Share Object or Document Link
- Maciej Zabielski
- Martin SWG (Unlicensed)
Introduction
Any object, including documents, can be shared via a link. This link contains information about the user interface configuration required to display the desired object.
Sharing via a link is only possible between users with similar sets of access rights and does not allow bypassing security in any way.
The user receiving the link must have at least view rights for the given object and context objects necessary to correctly display the target object.
Automatic Link Creation
Links can be automatically generated and copied using the context menu function. Simply right-click on an object you would like to share, then select Share → Copy Link as shown in the image below:
A link will be placed in your system clipboard, similar to this one:
http://server/client/?Navigate=1&OID=5153&CID=107&VID=tree&TPID=8&GPID=10
The link, when clicked, will open the user interface and prompt for login if necessary. You can copy objects from either the tree or grid view. However, copying a Room from the tree will result in it being displayed in the tree as well.
In contrast, if you copy a Room from the grid view and that Room has a location on a drawing, that specific drawing will also load with the corresponding Room highlighted.
Links with Version
An additional option on the menu allows the creation of links with a version ID. This enables users to be directed to a specific version instead of the default system version. This feature can be particularly useful when sharing an object from within a Draft or when access to a specific version in the past is required.
If the version ID is not set (as in a standard link), the system will attempt to locate the object in the current system version. However, this operation may fail if the object only exists in a Draft.
Note: Remember to share a Draft with a user first; otherwise, they will not be able to access it.
Manual Links Creation
It's possible to create links manually or by using external software. These links can also utilize an external ID that is specific to a particular system. In this scenario, both the domain ID and external ID must be provided.
The system will automatically translate the ID into an internal system ID, and the object will be displayed as usual. The parameters that can be used are listed in the table below:
Â
Parameter | Abbr | Required | Description |
|---|---|---|---|
Navigate | * | Base parameter indicating whether navigation to target object should be performed (set to Navigate=1) | |
ObjectId | OID | */- | Object id, either internal or external (Not required with GUID) |
ClassId | CID | */- | Object classId (internal) - (Not required with GUID) |
ClassName | CN | */- | External class name (To be used with a Domain config) - (Not required with GUID) |
Domain | DN | Doamin id, when given, objectId and classId is considered to be external. Translation is performed automatically. | |
TreePsetId | TPID | Perspectiveset that should be used to show this object in Tree View. | |
GridPsetId | GPID | Perspective set that should be used to show this object in Grid View. | |
ViewId | VID | Preferred view ID, mainly used by links generated by HDC. Determines preferred target view (grid or tree) to be used to show object (e.g. Room can be seen both in tree and grid). Available values: tree, grid | |
| CTID | Additional context object that can be used while navigating. This object will be selected in a TreeView when main object is selected in GridView. In another words, this object will be used as a parent in TreeView, if there are multiple parents available This parameter is mostly used by system generated URLs | |
ContextClass | CCLS | Class ID if the context object is used. | |
contextClassName | CCN | Â | Context object class name, when used with domain conversion. Since v5.0 |
Version | VER | Version ID | |
Alternative | ALT | Alternative ID | |
contextGuid | CG | Â | MasterGUID for context object (optional) Since v5.0 |
guid | GUID | Â | MasterGUID for main object. Note: skip other parameters like: ObjectId, ClassId, ClassName, DomainSince v5.0 |