access

Type: Array of JSON objects
Required: No

"access": [
   {
      "name": "myCustomRight",
      "displayName": "myCustomRight",
      "description": "This is a sample for access rights in the framework control.",
      "visible": true,
      "defaultValueInternal": null
   }
]

This property contains a list of user-specific access rights that can be configured via the Engineering. Access rights restrict user groups in their activities (see authorization system). A user-specific access right must be evaluated in Source.js with corresponding user-specific logic.

An access right object contains the following properties:

• name {String}: Internal name of the access right.
• displayName {String}: Name of the access right that is displayed in the Engineering.
• description {String}: Description of the access right, which is displayed as a tooltip in the Engineering on mouseover.
• visible {Boolean}: This property switches the visibility of the access right. If "visible" is set to "false", the access right is not displayed in the Engineering.
• defaultValueInternal {Boolean}: This property defines the internal default value that is to apply if the access right is not configured via engineering. "true" means access is granted by default. "false" means access is not granted. "null" means access is not defined and the parent control is queried. If the parent control does not know this right, the value set here applies. For a detailed description of the behavior of defaultValueInternal see authorization system.

Various user groups are assigned to an access right via the Engineering, which are structured according to the following schema: tchmi:framework#/definitions/ControlAccessRight
This schema defines the type of access (Allow, Deny, Inherit) the respective user group has to the access right.

In the Engineering, the access right is displayed in the Properties window as follows (for two different user groups):

For more information, see section Access rights.