Skip to main content

Roles

The Roles window in the Settings tab within the AutomatR Orchestrator application provides a mechanism for defining and configuring roles and their permissions. This tab ensures controlled access to various entities and functionalities within the AutomatR Orchestrator environment. Here's a comprehensive overview of the components and options available within the Roles tab:

Select Entity

The Select Entity offers a list of options that correspond to different entities and functionalities within the AutomatR Orchestrator environment. Users can select from the following options:

EntityDescription
AlertsConfigThis entity corresponds to alert configurations, which define how alerts are generated and delivered.
APIKeysAPI keys are used for secure authentication and authorization when interacting with the AutomatR Orchestrator's API.
AppTokensApp tokens are used for secure authentication and authorization for external applications.
BotThe Bot entity pertains to bot-related configurations and permissions.
BotLogsThis entity relates to permissions for viewing and managing bot logs.
ConfigurationPermissions for managing configurations and settings are associated with this entity.
CredentialCredential-related permissions are managed through this entity.
FlowThe Flow entity deals with permissions related to automation workflows.
FormPermissions for managing forms within the AutomatR Orchestrator environment are defined here.
InstancePermissions for orchestrating instances of automation processes are associated with this entity.
JobThe Job entity covers permissions for managing and executing jobs.
JobRunPermissions for managing the execution of job runs are associated with this entity.
LibraryThis entity pertains to permissions for managing automation libraries.
QueueQueue-related permissions, including managing queue items, are defined here.
QueueCustomStatusPermissions for custom status management within queues are associated with this entity.
QueueItemPermissions for managing individual items in a queue are defined here.
QueuePriorityThis entity covers permissions for defining queue priorities.
QueueSortingStrategyPermissions related to queue sorting strategies are managed through this entity.
RolePermissionPermissions for managing role permissions themselves are associated with this entity.
RolesThe Roles entity deals with permissions for defining and managing user roles.
TaskPermissions for managing tasks within automation processes are defined here.
TenantUsersThis entity pertains to permissions for managing users within a tenant.
WorkspacePermissions for managing workspaces are associated with this entity.

Select Role

The Select Role offers two predefined role options:

RoleDescription
AdminThe Admin role holds the highest level of authority with platform-wide control and permissions.
Workspace ManagerThe Workspace Manager role focuses on managing a specific workspace within the AutomatR Orchestrator environment.

The Roles window in the Settings tab is a critical component for defining and managing permissions. It enables users to configure roles and their corresponding permissions for various entities and functionalities within the AutomatR Orchestrator environment. This feature contributes to effective access control, security, and administrative control over the platform.


Adding a Role

Here's a brief procedure to add a role from the Roles window within the Settings Tab in the AutomatR Orchestrator application:

  • Open the AutomatR Orchestrator application and navigate to the Settings tab and select the Roles window.

  • Click the Add Role Button.

  • Enter Role Name:

    • A form will appear. In this form, there will be a field to Enter Name.
    • Type the desired name for the new role.
  • After entering the role name, click the Add button to create the new role.

  • You will receive a confirmation message indicating that the role has been successfully added.

You have successfully added a new role, this role can now be assigned to users based on the permissions and responsibilities you've defined for it. Remember that configuring the specific permissions associated with this role may require further customization within the AutomatR Orchestrator's role management settings.


Adding Role Permissions

Here's a brief procedure to add role permissions from the Roles Tab in the Settings window:

  • Open the AutomatR Orchestrator application and navigate to the Settings tab and select the Roles window.

  • From the role drop-down, choose the specific role to which you want to add permissions (Admin or Workspace Manager).

  • Select the entity for which you want to configure permissions from the entity drop-down.

  • Depending on the chosen entity, the available actions will be tailored to that entity's functionalities.

  • In the Actions drop-down, choose the action you want to allow for the selected entity.

    • The available actions might include Create, View, Edit, Delete etc.
  • Click the Add button. The selected role is now granted permission for the chosen action on the selected entity.

You have successfully added specific permissions to the chosen role for the selected entity. This configuration ensures that users assigned this role will be able to perform the designated actions within the AutomatR Orchestrator environment.

NOTE: The available actions in the Actions drop-down will depend on the entity you've selected. Different entities may have distinct actions associated with them, and you can customize role permissions accordingly.