Users panel

Overview

The Users panel provides administrative capabilities for managing workflow engine user accounts and their access privileges. This panel allows administrators to create new users, modify existing user properties, assign roles, and control access to the workflow system. The Users panel is exclusively accessible to members of the ROLE_ADMIN role.

The Users panel is only accessible to administrators who are members of the ROLE_ADMIN role. Regular users cannot view or access this menu option.

Panel Layout

The Users panel is structured with three main areas:

  • Top navigation bar: Contains the main menu options (Home, Designer, Users, Tools, Admin)
  • Left sidebar menu: Provides quick access to user management actions
  • Center content area: Divided into two sections for the users list and user details

Left Sidebar Menu

The vertical sidebar on the left provides quick access to user management operations:

ActionDescription
Create new user Opens a form to create a new workflow engine user account with Id, Name, Mail, and Role properties
Refresh user list Reloads the user list to reflect the latest changes

Users List Section

The left section of the center area displays a paginated table of all users registered in the workflow engine. This section provides comprehensive user management with filtering and pagination capabilities.

Table Columns

ColumnDescription
Id Unique identifier for the user account. This is the login username used to authenticate with the workflow engine.
Name Display name of the user. This is the friendly name shown throughout the workflow interface.
Mail Email address associated with the user account. Used for notifications and communications.
Role The role assigned to the user. Common roles include ROLE_ADMIN (administrators with full access) and ROLE_USER (regular users).
Actions Management options for the user account (typically edit and delete operations)

Pagination and Filtering

  • Pagination control: Default page size is 10 users, which can be modified using the "Show" dropdown selector
  • Name filter: Filter users by name using the search field. Press Enter to apply the filter
  • Page navigation: Use First, Previous, Next, and Last buttons to navigate through pages of users

User Details Section

The right section of the center area displays detailed information for the selected user. When a user is selected from the list, their complete profile information appears in this panel.

User Information Display

FieldDescription
Id The unique identifier (username) for the user account
Name The display name of the user
Mail The email address associated with the user
Role The role assigned to the user, determining their access level and permissions

Edit User

An "Edit" button in the top-right corner of the user details section allows administrators to modify user properties:

  • Name: Update the user's display name
  • Mail: Change the email address
  • Role: Modify the user's role to grant or restrict administrative privileges
  • Password: Reset the user's password (if applicable)

User Roles

The workflow engine implements role-based access control to manage user permissions:

RoleDescriptionAccess Level

ROLE_ADMIN

Administrator role with full access to all workflow engine features

Can access:

  • Home panel (workflow management)
  • Designer panel (workflow editing)
  • Users panel (user management)
  • Tools panel (database queries)
  • Advanced administrative functions ( Show debug)

ROLE_USER

Regular user role with restricted access to workflow operations

Can access:

  • Home panel (limited workflow viewing)
  • Designer panel (when editing assigned workflows)

Users managed in the Users panel are specific to the workflow engine. These user accounts are separate from OpenKM application users, though they may correspond to the same individuals. Workflow engine users authenticate separately to access workflow management features.

User Management Operations

Creating a New User

To create a new user account:

  1. Click the "Create new user" icon in the left sidebar
  2. Enter the user details:
    • Id: Unique username for login (cannot be changed after creation)
    • Name: Display name for the user
    • Mail: Email address for notifications
    • Role: Select appropriate role (ROLE_ADMIN or ROLE_USER)
    • Password: Set initial password for the user
  3. Save the user account
  4. The new user will appear in the users list

Editing an Existing User

To modify user properties:

  1. Select the user from the users list
  2. Review the user details in the right panel
  3. Click the "Edit" button in the top-right corner
  4. Modify the desired properties (Name, Mail, Role, Password)
  5. Save the changes

Deleting a User

To remove a user account:

  1. Select the user from the users list
  2. Click the delete action icon in the Actions column
  3. Confirm the deletion
  4. The user will be removed from the workflow engine

Deleting a user account permanently removes their access to the workflow engine. Active workflows or tasks assigned to the deleted user may be affected. Ensure proper reassignment of responsibilities before deleting user accounts.

Best Practices

  • Use descriptive user IDs: Choose clear, meaningful usernames that identify individuals or roles
  • Maintain accurate email addresses: Ensure email addresses are current for workflow notifications
  • Assign roles appropriately: Only grant ROLE_ADMIN to users who require full administrative access
  • Regular user audits: Periodically review the user list to identify inactive accounts
  • Secure password policies: Implement strong password requirements for user accounts
  • Remove inactive users: Delete or disable accounts for users who no longer require workflow access
  • Test new user accounts: Verify that newly created users can authenticate and access appropriate features
  • Use filtering efficiently: Take advantage of name filtering to quickly locate specific users in large user lists

When creating users who will manage workflows but shouldn't have full administrative access, use ROLE_USER and grant them edit permissions on specific workflows through the Home panel instead of assigning ROLE_ADMIN.

Security Considerations

  • Limit ROLE_ADMIN assignments: Restrict administrator access to essential personnel only
  • Regular password updates: Encourage or enforce periodic password changes

User authentication and authorization in the workflow engine is independent of OpenKM's user system. Users must have separate accounts in both systems if they need access to both the workflow engine and OpenKM features.