Skip to main content

Role Management

Role management is a critical security feature in Softyflow that allows administrators to control what users can see and do across the platform. By defining roles, you can enforce fine-grained access control, ensuring that users only have permissions relevant to their responsibilities. This is essential for maintaining security, simplifying user administration, and ensuring compliance.

Roles are assigned to users separately in each environment: TEST, UAT and PROD. Roles are global to the platform: a role can be labelled with a project to sort it, and listed in the projects that use it. This functionality is deeply integrated with other platform features like authentication systems, deployment management, and the design of web interfaces and process workflows.

1. Accessing the Roles PageDirect link to 1. Accessing the Roles Page

To begin managing roles, open the Roles page:

  1. In the navigation dock on the left of the IDE, open the Account group.
  2. Click Roles (keyboard shortcut: G then R), or go directly to /ide/roles.

The page is available to IDE users who have the Users & Roles right. It lists all existing roles with their name and description, their Tag, the Projects that use them, and the date and author of the last update.

The Roles page: search, filters and the list of roles with their tag, projects and last update.
The Roles page: search, filters and the list of roles with their tag, projects and last update.

From this page you can:

  • Search roles with Search roles by name….
  • Click Filters to search by Role identifier, Last updated date range or Last modified by. Reset clears the filters.
  • Click Export CSV to download the list of roles.
  • In the Actions column, copy the role identifier (copy icon), delete the role (trash icon) or open it (arrow, or a click on the row).

2. Core Actions for Role ManagementDirect link to 2. Core Actions for Role Management

2.1. Creating a New RoleDirect link to 2.1. Creating a New Role

Creating a new role is the first step in defining a set of permissions.

  1. Click the Create Role button located in the top right corner of the page.
  2. The Create Role dialog appears. Fill in the following fields:
    • Name: Enter a clear and descriptive name for the role (e.g., HR_Manager, Process_Administrator).
    • Description: Optionally, explain what the role is for.
    • Tag: Optionally, choose a project, or type a free label, to sort the role. When the tag is a free label, you can also pick its Color.
    • Projects: Optionally, select the projects that use this role.
  3. Click Create Role.

Upon creation, Softyflow assigns a unique, system-generated Role ID. This ID is useful for internal referencing, integration scripts, and configuring home page redirections. You can copy it with the copy icon in the Actions column of the list, or with the link icon next to the identifier in the role page.

✅ Best Practice: Adopt a consistent naming convention for your roles to improve long-term maintainability. For example: TeamName_Function (e.g., Finance_Approver).

The Create Role dialog: name, description, tag and projects.
The Create Role dialog: name, description, tag and projects.

2.2. Opening a RoleDirect link to 2.2. Opening a Role

Click a role in the list to open its page (/ide/roles/<role id>). The header shows the role name, its tag, its number of members and its identifier. The page has three parts:

  • Role details: the name, description, label and projects of the role.
  • Add a user: add a member to the role.
  • Role members: the members and their environments.

Changes are saved automatically: the indicator at the top right shows Autosave enabled, then Unsaved changes, Saving and Role saved. A field of Role details is saved when you leave it; you can also press Ctrl + S.

The role page: role details on the left, adding a user and the role members on the right.
The role page: role details on the left, adding a user and the role members on the right.

2.3. Assigning Users to a RoleDirect link to 2.3. Assigning Users to a Role

  1. In the Add a user card, search the user by name or e-mail in User to add.
  2. Under Environments to assign, keep or untick TEST, UAT and PROD.
  3. Click Add to role.

The Role members table lists each member with their status (IDE access, No IDE access or Blocked) and one checkbox per environment, with the number of members in each environment in the column header:

  • Tick or untick an environment to add or remove the user in that environment only.
  • Click the trash icon to remove the user from the role in every environment (a confirmation is asked).
  • Use Search existing members… and the All environments list to filter the members.

Membership changes are saved automatically. You can also assign roles from the user's panel (Groups & Roles tab) or in bulk with the Excel import.

⚠️ Caution: Assign roles with care, especially in the PROD environment, to prevent granting excessive privileges.

Adding a user to a role, and managing the environments of each member.
Adding a user to a role, and managing the environments of each member.

2.4. Updating an Existing RoleDirect link to 2.4. Updating an Existing Role

Organizational needs change, and roles must adapt. You can modify a role at any time:

  1. Open the role from the Roles page.
  2. In Role details, change its Name, Description, Label or Projects.
  3. The change is saved when you leave the field (or with Ctrl + S).

Modifications take effect immediately and are shown in the Last updated column. For auditing purposes, role changes are recorded in the system logs (UPDATE_GROUP, ADD_USER_TO_GROUP, REMOVE_USER_FROM_GROUP).

The name, project, description and tag of roles can also be changed in bulk in the Role catalogue sheet of the Excel export. The Excel import never creates roles.

2.5. Deleting a RoleDirect link to 2.5. Deleting a Role

If a role is no longer needed, you can delete it.

  1. Go to the Roles page.
  2. Click the trash icon of the role in the Actions column.
  3. Confirm with Delete the role.

Its members lose the rights it gives, in every environment. This cannot be undone. The action is recorded in the system logs (DELETE_GROUP).

Confirming the deletion of a role.
Confirming the deletion of a role.

3. Project-Specific Role ManagementDirect link to 3. Project-Specific Role Management

3.1. Attaching a Role to a ProjectDirect link to 3.1. Attaching a Role to a Project

You can attach a role to a project with its label:

  1. Open the role.
  2. In Role details, under Label, choose Project, then choose the project (e.g., Purchase requests). None removes the label; Text sets a free label with a color.

The label sorts the role in the list of roles. With a project, the roles offered in that project are filtered: the role appears in the project's Roles page and in the role pickers of the project. The Projects field lists the projects that use the role.

The Role details card: the label set to a project, and the projects that use the role.
The Role details card: the label set to a project, and the projects that use the role.

3.2. Viewing Roles Attached to a ProjectDirect link to 3.2. Viewing Roles Attached to a Project

You can also view the roles of a project directly from the project:

  1. Open the project from the Projects page.
  2. Choose the Design mode in the mode bar at the top right (Alt + 1).
  3. In the project dock on the left, click Roles.

This page lists the roles attached to the project, with their tag and last update. New role creates a role already attached to the project; the arrow of a row opens the role page, where you manage its members in each environment (Test, UAT, Prod). This is crucial for maintaining a secure deployment pipeline.

The Roles page of a project, in the Design mode.
The Roles page of a project, in the Design mode.

4. Integration and Best PracticesDirect link to 4. Integration and Best Practices

4.1. Role-Based Access in DevelopmentDirect link to 4.1. Role-Based Access in Development

Roles are a fundamental part of the development lifecycle in Softyflow:

4.2. Environment-Specific Role ConfigurationDirect link to 4.2. Environment-Specific Role Configuration

Tailor role permissions for each environment to enhance security and testing effectiveness:

  • Test: Grant broad access to developers for thorough testing.
  • UAT: Provide restricted access to business users for acceptance testing.
  • Prod: Enforce the principle of least privilege with minimal required access for all users.

Learn more about this in the Test & Deploy documentation.

Keep track of how roles are being used and modified:

What's Next?Direct link to What's Next?

Now that you have a solid understanding of role management, explore related administration and development topics:

Administration:

Development: