Entity operations
The entity Operation component defines which operation buttons are available on the Entity Detail page. The list of available operations depends on the entity definition set for the page.
Entity operations settings
Entity Operations are highly configurable.
The following list presents all the different settings with their respective options.
-
Display settings:
These settings define how the operation is displayed on the entity's Detail page.
-
Display Format:
-
Icon: Renders the icon only on the entity's Detail page.
-
Label: Renders the action's label only on the entity's Detail page.
-
Icon + Label: Renders both the icon and the label on the entity's Detail page in that order.
-
-
Icon: An icon can be picked from the M-icon collection to reflect the specified operation.
-
Label: This field represents the action's rendered label. It is also displayed in the icon's tooltip.
-
Button style:
- Default: Defined by the default button style.
- Primary: Defined by the primary button settings of the theme.
- Secondary: Defined by the portal theme’s main color with an additional border.
-
Link: Color of the icon and/or the label is defined by the theme’s main color.
-
-
Operations settings:
These settings define how some system actions work. The configurable properties depend on the operation's type.
-
Redirect page: Determines the page to which the user is redirected after a successful execution of the entity's operation.
-
Confirmation dialog: Determines whether the user is required to confirm prior to executing the specified operation.
-
Renditions: Determines which renditions are allowed to be downloaded. The list of available download options on the entity's Detail page depends on the user’s permissions.
-
-
Visibility settings:
A condition can be added based on a property data type or a nested relation. When a condition is set, the operation only appears if the condition's rule matches the entity’s state.
-
Permissions:
A permission can be added to an operation. It indicates that only the users who are granted the selected permission on that content definition are able to perform the operation. If no permission is specified, users with read permissions are able to perform the specified operation.
Note: the list of system actions is based on configuration files. Hence they are not editable.
External action
Users can add a custom action on the entity's Detail page. Adding a custom action of type External action adds a button on the entity's Detail page that allows users to manually trigger any pre-configured action.
Additionally, properties and relations can be added in the payload sent to the destination system when users trigger the action.
The Visibility settings and Permissions apply to this type of actions.
For more information, please see the action documentation.
Entity public links
In order to be able to share public links to renditions of an Entity, users can add an Entity action of type public links. This provides the public link icon in the entity detail page.
In order for users to have the ability to create public links, they need to add the following configuration on the usergroup level.
To allow the creation of public links for a usergroup, go to the usergroup's policies and add the configuration as shown below for the PublicLink entity definition. It allows this group to create entities of that entity definition.
Apart from the configuration of the public link entity, the group is also provided with the access to visualize the icons related to the creation and deletion of public links. To achieve that, a new configuration needs to be made on the Asset and File entity definitions.