Setting Global Tags To User (for n-level multi-tenancy)

There are some predefined global tags (values) which you can use in every API called from the UI. You can also specify custom global tags (values) and use them in every API called from the UI.

I. Following are predefined global tags

A) User Id

  1. JSScript: session.getUser().getId()

  2. DB Action: Specify the parameter name in Input > User Id Parameter Name

  3. DB Action (Manual SQL): select:_userid from <Table name>

B) Username

  1. JSScript: session.getUser().getUsername()

  2. DB Action: Specify the parameter name in Input > Username Parameter Name

  3. DB Action (Manual SQL): select:_username from <Table name>

C) Tenant Id

  1. JSScript: session.getUser().getTenantIdentifier();

  2. DB Action: Specify the parameter name in Input > Tenant Id Parameter Name

  3. DB Action (Manual SQL): select:_tenantid from <Table name>

D) User Role

  1. JSScript: session.getUser().getRole()

  2. DB Action: Specify the parameter name in Input > Role Parameter Name

  3. DB Action (Manual SQL): select:_role from <Table name>

E) User's Browser Locale

  1. JSScript: context._userLanguage

  2. DB Action: _userLanguage (only if DB action is API called from UI)

F) User's Time Zone Offset (in minutes)

  1. JSScript: context._timezoneOffset

  2. DB Action: _timezoneOffset (only if DB action is API called from UI)

II. You can add additional custom global tags as follows

If you want to get organizationId of the logged-in user and set it as a global tag (usable from any JavaScript or DB Action):

  1. Select your Authentication Service mapped to your Web Application.

  2. In the Post Authentication Script property, define the tags as follows:

    user.userDetails = utils.createMap(); user.userDetails.organizationid = user.organizationid; // organizationid is a DB field in user table representing id of organization for logged in user.if (!utils.isNullOrEmpty(user.organizationid)) { // This method sends organizationid to EVERY server request from the UI utils.setValueAtPath(user, "userDetails.globalTags.organizationid", user.organizationid); }

  3. Click SAVE.

III. You can use additional custom global tags as follows

  • In JSScript actions: context.<GLOBAL_TAG_NAME> (for example, context.organizationid)

  • In DB Actions (SQL): select:organizationid from <Table name> (based on our example above)