Skip to main content

Managing Roles

This guide covers administrator tasks on the Roles page: creating roles, assigning features, and initializing permissions.

Opening the Roles List​

  1. Click Configurations in the main sidebar.
  2. Under System Settings, click Roles.
  3. The roles list opens at /settings/role/list.

Each row displays:

ColumnDescription
Role IdUnique system identifier (for example, 01KJVH1KR79M8P1SVB2CBDN86R)
NameRole display name (for example, ADMIN, RM, Sumo User Guide)
FeaturesComma-separated list of features assigned to the role
DescriptionBrief explanation of the role's purpose

Creating a Role​

  1. On the Roles page, click + Add.
  2. The Add Role dialog opens.
  3. Fill in the fields:
FieldDescription
Role NameUnique name for the role (for example, Sumo User Guide). Use uppercase or descriptive names consistent with your organization.
DescriptionOptional text describing the role's purpose (for example, For Sumo User Guide).
  1. Click Add.
  2. The new role appears in the roles table.

After creating a role, assign features using Set Feature or Create All Permission (see below).

Assigning Features to a Role​

Features control which modules and actions a role can access. Use Set Feature to assign specific permissions.

Configuration Procedure

  1. On the Roles page, click Set Feature.
  2. The Set Feature dialog opens.
  3. Select a Role Name from the dropdown (for example, Sumo User Guide).
  4. Under Feature, select one or more features from the checklist.
  5. Click Set Feature.
  6. Verify the selected features appear in the Features column for that role.

Feature Categories​

Features fall into several groups:

Configuration features (CONF_*)

FeatureGrants Access To
CONF_PRODUCTProduct Configuration
CONF_COA_MAPPINGCOA Mapping
CONF_TARIFFTariff Configuration
CONF_PROCESSProcess Configuration
CONF_TABLETable Configuration
CONF_FEEDFeed Configuration
CONF_CONTRACTContract Type Configuration
CONF_TXN_CONTROLTransaction Controls
CONF_ASSETSAsset Groups
CONF_CHANNELSChannel Types
CONF_USERSUser Management
CONF_RGReporting Groups
CONF_JOBSJobs Configuration

Operational features

FeatureGrants Access To
DASHBOARDHome dashboard
TASKSTasks module
PROCESS_TXNSTransaction processors
EXEC_JVJournal voucher posting
PRODUCT_ACCOUNTSProduct accounts
CONNECTConnect integrations
TABLETable (operations)
FEEDFeed (operations)
TARIFFTariff (operations)
CONTRACTContracts
JOBSJobs

Reporting features

FeatureGrants Access To
TRIALBALANCETrial Balance report
TXN_REPORTPostings / transaction report

System features

FeatureGrants Access To
AUTH_SERVICEAuthentication and API access
LOAD_CONFLoad Configuration In Memory
LOGSSystem logs

Important Notes

  • Assign only the features required for each role — avoid granting unnecessary configuration access.
  • Configuration features (CONF_*) control access to the Configurations subsections.
  • Operational features control access to day-to-day ledger functions in the main sidebar.

Create All Permission​

Create All Permission initializes the complete set of system features for a role. Use this when setting up a demo, training, or full-access role.

Configuration Procedure

  1. On the Roles page, click Create All Permission.
  2. A success notification confirms creation (for example, Created All Permissions).
  3. Verify the role's Features column shows the full feature list.

Example: The Sumo User Guide role after Create All Permission includes features such as TASKS, CONF_FEED, CONF_COA_MAPPING, CONF_TARIFF, TRIALBALANCE, EXEC_JV, DASHBOARD, PRODUCT_ACCOUNTS, LOGS, and AUTH_SERVICE.

Important Notes

  • Use Create All Permission only for roles that genuinely require full system access.
  • Review the resulting feature list before assigning the role to production users.
  • Prefer Set Feature for roles with limited, specific access needs.

Example Role Configurations​

RoleFeaturesDescription
ADMIN(unrestricted)Full administrative access
USER—Normal user for viewing reports
API_USERAUTH_SERVICEAPI and service integration account
RMAUTH_SERVICE, DASHBOARD, TASKSRelationship Manager
BMTASKSBranch Manager
Sumo User GuideAll featuresDemo and training role

Load Configuration In Memory​

After creating or updating roles, publish changes to the running service:

  1. Click Load Configuration In Memory in the top-right corner.
  2. Confirm the action if prompted.

Important Notes

  • Role changes may not take effect until configuration is loaded into memory.
  • Coordinate with your team before reloading configuration in production.

Configuration Checklist​

Before assigning a role to users:

  • Role name is unique and follows naming conventions.
  • Description explains the role's purpose.
  • Required features are assigned via Set Feature or Create All Permission.
  • Feature set has been reviewed — no unnecessary configuration access granted.
  • Configuration has been loaded into memory if required.
  • A test user with the role can access expected modules and is blocked from unauthorized areas.