| Document number | Revision |
|---|---|
| DOCU13133 | 1 |
<vector-role> Element - Schema Reference
<vector-role> Element - Schema ReferenceDefinitionContent modelAttributesElementsSpecial elementsSamplesCreating a new <vector-role> with an available user groupRelevant tools and utilitiesViewing all available Vector rolesInspecting required and applied security permissions (Trace security)
Definition
Parent element(s): <schema>.
The <vector-role> element can be used to create new or modify existing vector roles in Highstage.
A vector role is a dynamic role for controlling permissions, and is granted to individual users when specific requirements are met. It is primarily through applied vector roles that users are granted permissions to view, create and edit contents in Highstage.
Highstage is shipped with a large assortment of vector roles that are assigned and granted to users permanently or when specific conditions are met (e.g. when a user is an author on a working document, or an assigned resource on an active step in an action process).
In addition, custom vector roles can be created and assigned to a specific user group in Highstage. Members of the user group will be permanently assigned to the associated vector role, enabling explicit permissions to be granted to those select users.
Content model
The specification of what attributes, elements and data that are available and allowed within the <vector-role> element.
Attributes
This section introduces you to the XML attributes and values that are available and can be included within the <vector-role> element.
| Attribute | Description | Mandatory |
|---|---|---|
| name | unique element name. | ✔️ |
| usergroup | Name of user group (members of assigned user group will be granted the associated vector role and can be used to permit explicit permissions in Highstage for specific actions) | ✔️ |
| description | Optional description. | ❌ |
Elements
Special elements
Samples
Creating a new <vector-role> with an available user group
The following sample illustrates how a custom <vector-role> can be created and assigned to be granted to a specific user group. All members of the user group will be granted the specific vector role:
x
<vector-role name="All" usergroup="TSDUSERS" description="General users in Highstage" />Tip: As an administrator (with a set userlevel of AdminRead/AdminWrite) you can access SYSTEM > USERS AND GROUPS > GROUPS to get a full overview of available user groups in Highstage.
Relevant tools and utilities
Viewing all available Vector roles
As an administrator (with a set userlevel of AdminRead/AdminWrite), you can access SYSTEM > DIAGNOSTICS > VECTOR ROLES to get a full overview of available Vector Roles in Highstage.
The list includes standard vector roles that is shipped with Highstage (dynamically granted to users' when specific conditions and requirements are met) as well as custom vector roles assigned to specific user groups (permanently granted to all users of the associated user group):
Inspecting required and applied security permissions (Trace security)
It is possible for users of Highstage (with a minimum set userlevel of SuperUser) to inspect the required and applied security permissions for contents in Highstage using the Security trace functionality by navigating to TRACE > SECURITY from the top navigation menu.
From this view, you are able to see which specific vector roles are currently granted to the active user, as well as what is required to view and modify contents:
Enabling the Trace security will display detailed security information in various sections as well as for individual data columns when accessing any item.
