Skip to main content
Version: 2025.1

tools

JDito Funktionen zur Verwaltung der Datenmodelle, etc.

Methods​

addUserToken​

addUserToken(pTokenId, pUserTitle?, pReferenceUserId?, pValidFrom?, pValidTo?, pValidOnce?, pGroupId?): string

Create a new user token.

A token is required to specify the login user. The reference User ID provides additional identification of a user. For example, a login user can be defined for a survey, which thus consumes only one license. Nevertheless you can identify who has actually logged in. Newly created tokens are always marked as valid.

Parameters​

pTokenId
string | number | boolean

The be ID of the token (UID).

pUserTitle?
string | number | boolean

The login name of the user to whom the token is associated (for example, 'Admin'). Important: This user will run the login.

pReferenceUserId?
string | number | boolean

This ID (reference User ID) identifies a user.

pValidFrom?
number

From this date on, the token is valid (given in milliseconds from 1970)

pValidTo?
number

At this date, the token is no longer valid (specified in milliseconds from 1970)

pValidOnce?
boolean

Indicates whether the token should be invalidated at first login

pGroupId?
string | number | boolean

Additional information for evaluation purposes

Returns​

string

The ID of the token that was created (UID).

Throws​

May throw an exception.

Example​

tools.addUserToken(null, 'Admin', 'Tim Admin', 1488927600000, 1488927600000, true, 'Group 1');

clearPermissionCache​

clearPermissionCache(): void

Clears the permission cache.

Returns​

void

Throws​

May throw an exception.

Example​

tools.clearPermissionCache();

clearRoleCache​

clearRoleCache(): void

Clears the role cache.

Returns​

void

Throws​

May throw an exception.

Example​

tools.clearRoleCache();

clearUserCache​

clearUserCache(): void

Clears the user cache.

Returns​

void

Throws​

May throw an exception.

Example​

tools.clearUserCache();

containsAnyRole​

containsAnyRole(pRoles, pRoleNames): boolean

Returns whether the first array contains one of the roles specified in the second array.

Parameters​

pRoles
any

The array with the roles you passed.

pRoleNames
string[]

The roles you are searching for.

Returns​

boolean

"true" if the array contains one of the roles.

Throws​

May throw an exception.

Example​

import("lib_util");



 var users = tools.getStoredUsers();
  var roles = tools.getAllRoles(["INTERNAL", "PROJECT"]);



 for (var i = 0; i < users.length; i++)
  {
  var userRoles = tools.getRoles(users[i][1]);
  for (var z = 0; z < userRoles.length; z++)
  {
  if (tools.containsAnyRole(roles, userRoles))
  question.showMessage("User has the required role" );
  else
  question.showMessage(" User has none of the required roles");
  }
  }

containsRole​

containsRole(pRoles, pRoleName): boolean

Returns whether the role array you passed contains a particular role or not.

Parameters​

pRoles
any

The array with the roles you passed.

pRoleName
string | number | boolean

The name of the role you are searching for.

Returns​

boolean

'true' if the array contains the role.

Throws​

May throw an exception.

Example​

import("lib_util")



 // Determine roles that do not exist in the user models



 var users = tools.getStoredUsers();
  var roles = tools.getAllRoles(["INTERNAL", "PROJECT"]);



 for (var i = 0; i < users.length; i++)
  {
  var wrongRoles = [];
  var rightRoles = [];
  var userRoles = tools.getRoles(users[i][1]);
  for (var z = 0; z < userRoles.length; z++)
  {
  if (!tools.containsRole(roles, userRoles[z]))
  question.showMessage(" User role does not exist: " + userRoles[z] )
  else
  question.showMessage(" User role exists: " + userRoles[z] )
  }
  }

createRole​

createRole(pName, pTitle, pDescription, pIsAssignable, pAssignedChildren): boolean

Create a role

Parameters​

pName
string | number | boolean

mandatory

pTitle
string | number | boolean

mandatory

pDescription
string | number | boolean
pIsAssignable
boolean
pAssignedChildren
string[]

Returns​

boolean

Throws​

May throw an exception.

currentUserHasAnyRole​

currentUserHasAnyRole(pRoleNames): boolean

Returns whether the logged in user has one of the roles passed.

Parameters​

pRoleNames
string[]

The roles.

Returns​

boolean

'true' if the user has one of the given roles.

Throws​

May throw an exception.

Example​

var roleNames = ["PROJECT_Fachadministrator", "PROJECT_Service"];
  var hasAnyRole = tools.currentUserHasAnyRole(roleNames);

currentUserHasRole​

currentUserHasRole(pRoleName): boolean

Returns whether the logged on user has a specific role.

Parameters​

pRoleName
string | number | boolean

The role to check whether the user has it.

Returns​

boolean

'true' if the user has the role.

Throws​

May throw an exception.

Example​

var hasRole = tools.currentUserHasRole("PROJECT_MANAGEMENT");

deleteRole​

deleteRole(pName): boolean

Deletes a role

Parameters​

pName
string | number | boolean

the name of the role to delete

Returns​

boolean

true, if this action was successful

Throws​

May throw an exception.

deleteUser​

deleteUser(pTitle): void

Deletes a user.

Parameters​

pTitle
string | number | boolean

The login name of the user you want to delete.

Returns​

void

Throws​

May throw an exception.

Example​

tools.deleteUser("Admin");

deleteUserToken​

deleteUserToken(pUid): void

Deletes the user token with the specified UID.

Parameters​

pUid
string | number | boolean

The ID of the token

Returns​

void

Throws​

May throw an exception.

Example​

tools.deleteUserToken('fb585dd3-9c8d-460e-a667-57a8e6b763a2');

existUsers​

existUsers(pTitle): boolean

Returns whether the specified user(s) exist(s).

Parameters​

pTitle
any

Login name(s) of the user(s). As string for one user, otherwise as array.

Returns​

boolean

'true' if the user(s) exists.

Throws​

May throw an exception.

Example​

var users = tools.existUsers(new Array("Viri Walden", "Manai Weber"));

generateNewUserName​

generateNewUserName(): string

Generates a new generic user name. The user object itself is NOT created. This method has no parameters.

Returns​

string

a new generic username, consisting in a prefix, followed by a UID

Throws​

May throw an exception.

Example​

var myUserName = tools.generateNewUserName();

// _____USER_75223eec-4703-4bbd-9554-402351a50d56 logging.log(myUserName);

getAllGroups​

getAllGroups(): Map<any, any>

Returns all groups that exist in the ADITO system.

Returns​

Map<any, any>

The groups, as an array.

Throws​

May throw an exception.

Example​

var groups = tools.getAllGroups();
  for (var i=0; i<groups.length; i++)
  {
  question.showMessage(groups[i][0] + "\n" + groups[i][1]);
  }

getAllRoles​

getAllRoles(pRoleTypes, pIncludeUnassignable?): Map<any, any>

Returns all available roles.

Parameters​

pRoleTypes
string[]

The role types to be returned ("INTERNAL", "PROJECT", "CUSTOM").

pIncludeUnassignable?
boolean

'true' to include roles, which cannot be assigned to a user directly

Returns​

Map<any, any>

The available roles in the following format:

Key: ID/RoleName

Value[0]: title

Value[1]: type

Value[2]: description

Value[3]: ID/RoleName

Value[4]: isAssignable

Throws​

May throw an exception.

Example​

var x = tools.getAllRoles(new Array("INTERNAL"));
  for(var i in x)
  {
  question.showMessage("i: " + i + "\nx[i]:\n" + x[i].join("\n"));
  }

getAllUserTokens​

getAllUserTokens(onlyValid): Map<any, any>[]

Loads all user tokens.

Parameters​

onlyValid
boolean

Flag whether only valid tokens should be loaded.

Returns​

Map<any, any>[]

All tokens

Throws​

May throw an exception.

Example​

var tokens = tools.getAllUserTokens(true);

getCurrentUser​

getCurrentUser(): Map<any, any>

Returns data on the current user, as an object structure.

Returns​

Map<any, any>

The user data, as a map.

Throws​

May throw an exception.

Example​

var user = tools.getCurrentUser();
  var setting = user[tools.PARAMS][tools.SELECTION_IGNORECASE];
  question.showMessage(setting);

getPermissionFilter​

getPermissionFilter(pPermissionAction, pEntity, pField?, pUser?): string

Returns a filter that restricts results to values that the user has permissions for.

Parameters​

pPermissionAction
string | number | boolean

the kind of permission, that should be checked, look at PERMISSION_* constants

pEntity
string | number | boolean

the name of the entity, that should be checked. For example: "Person_entity"

pField?
string | number | boolean

the field, that should be checked for permissions, null if you're checking entity level permissions. For example: "FIRSTNAME"

pUser?
string | number | boolean

the login of the user, that should be checked for permissions. For example: "admin". If this is null then the current User will be used

Returns​

string

the filter as a stringified JSON-Object. (You can use JSON.parse() if you want to use it as an object)

For example: "{"type":"group","operator":"AND","childs":[{"type":"row","name":"#EXTENSION.IsEmployee_filter.IsEmployee_filter#BOOLEAN","operator":"EQUAL","value":"Ja","key":"true","contenttype":"BOOLEAN"}]}"

Throws​

May throw an exception.

Example​

var permissionFilter = tools.getPermissionFilter(tools.PERMISSION_UPDATE, "Person_entity");

  result.string(permissionFilter);

getRoles​

getRoles(pUserLogin): string[]

Returns the user's roles.

Parameters​

pUserLogin
string | number | boolean

The login name of the user.

Returns​

string[]

The roles, as a string array.

Throws​

May throw an exception.

Example​

var roles = tools.getRoles(vars.getString("$sys.user"));

getStoredUsers​

getStoredUsers(): string[][]

Returns all users that exist in the system database.

Returns​

string[][]

The entries are returned as an array with the following values:

Entry[0] = Name,

Entry[1] = Title.

Throws​

May throw an exception.

getUser​

getUser(pTitle, pProfile?): Map<any, any>

Returns data on a user, as an object structure.

Parameters​

pTitle
string | number | boolean

The login name of the user.

pProfile?
string | number | boolean

Returns​

Map<any, any>

The user data, as a map, with the attributes of the default profile (see tools.PROFILE_DEFAULT)

Throws​

May throw an exception.

Example​

var user = tools.getUser("Admin");
  var setting = user[tools.PARAMS][tools.SELECTION_IGNORECASE];
  question.showMessage(setting);

getUserByAttribute​

getUserByAttribute(pAttribute, pValue, pProfile?): Map<any, any>

Returns data on a single user, as an object structure, based on the specified attribute.

Parameters​

pAttribute
string | number | boolean

The attribute you want to search the user list for.

pValue
string | number | boolean

The value of the attribute to be searched for.

pProfile?
string | number | boolean

The profile to load, see tools.PROFILE_*

Returns​

Map<any, any>

The user data, as a map, 'null' if no user was found.

Throws​

May throw an exception.

Example​

var user = tools.getUserByAttribute(tools.TITLE, ["Admin"], tools.PROFILE_FULL);
  question.showMessage(users);

getUsers​

getUsers(pTitle, pProfile?): Map<any, any>[]

Returns data on multiple users, as an object structure, based on the specified attributes.

Parameters​

pTitle
any

Login names of the users, as an array.

pProfile?
string | number | boolean

The profile to load, see tools.PROFILE_*

Returns​

Map<any, any>[]

The users as a map.

Throws​

May throw an exception.

Example​

var users = db.array(db.COLUMN, "select login from employee where login not like 'Multi%'");
  activeUsers = tools.getUsers(users, tools.PROFILE_FULL);

getUsersByAttribute​

getUsersByAttribute(pAttribute, pValues, pProfile?): Map<any, any>[]

Returns data on multiple users, as an object structure, based on the specified attribute.

Parameters​

pAttribute
string | number | boolean

The attribute you want to search the user list for.

pValues
any

The value of the attribute to be searched for.

pProfile?
string | number | boolean

The profile to load, see tools.PROFILE_*

Returns​

Map<any, any>[]

The users as a map. The order is independent of the values passed.

Throws​

May throw an exception.

Example​

var users = tools.getUsersByAttribute(tools.ISACTIVE, ["true"], tools.PROFILE_FULL);

getUsersWithAnyRole​

getUsersWithAnyRole(pRoleNames): string[]

Returns the titles of the users having one of the specified roles.

Parameters​

pRoleNames
string[]

The names of the roles for which you want to find users.

Returns​

string[]

The titles (login names) of all users.

Throws​

May throw an exception.

Example​

var users = tools.getUsersWithAnyRole(["PROJECT_Administration", "PROJECT_FieldService"]);

getUsersWithRole​

getUsersWithRole(pRoleName): string[]

Returns the titles of the users having the specified role.

Parameters​

pRoleName
string | number | boolean

The name of the roles for which you want to find users.

Returns​

string[]

The titles (login names) of all users.

Throws​

May throw an exception.

Example​

var users = tools.getUsersWithRole("PROJECT_Administration");

getUserToken​

getUserToken(pTokenId): Map<any, any>

Loads the user token with the specified ID (pTokenId).

Parameters​

pTokenId
string | number | boolean

the ID of the token (UID)

Returns​

Map<any, any>

The token.

Throws​

May throw an exception.

Example​

var token = tools.getUserToken('fb585dd3-9c8d-460e-a667-57a8e6b763a2');

hasAnyRole​

hasAnyRole(pUserLogin, pRoleNames): boolean

Returns whether a user has one of the roles you passed.

Parameters​

pUserLogin
string | number | boolean

The login name of the user.

pRoleNames
string[]

The roles you are searching for.

Returns​

boolean

'true' if the user has one of the roles.

Throws​

May throw an exception.

Example​

if(tools.hasRole(vars.getString("$sys.user"), ["PROJECT_Administration", "PROJECT_FIELDSERVICE"]));

hasPermission​

hasPermission(pPermissionAction, pEntity, pField, pUser?, pObjectRowIds?): boolean

Returns true, if a user has a specific permission.

Parameters​

pPermissionAction
string | number | boolean

the kind of permission, that should be checked, look at PERMISSION_* constants

pEntity
string | number | boolean

the name of the entity, that should be checked. For example: "Person_entity"

pField
string | number | boolean

the field, that should be checked for permissions, null if you're checking entity level permissions. For example: "FIRSTNAME"

pUser?
string | number | boolean

the login of the user, that should be checked for permissions. For example: "admin". If this is null then the current User will be used

pObjectRowIds?
string[]

the object ids of the records, which should be checked for permissions (for conditional permissions)

Returns​

boolean

true if the permission is granted

Throws​

May throw an exception.

Example​

if (tools.hasPermission(tools.PERMISSION_VIEW, "Person_entity"))
{
// The current user can view the Person-Entity
}

hasRole​

hasRole(pUserLogin, pRoleName): boolean

Returns whether a user has a particular role.

Parameters​

pUserLogin
string | number | boolean

The login name of the user.

pRoleName
string | number | boolean

The role you are searching for.

Returns​

boolean

'true' if the user has one of the roles.

Throws​

May throw an exception.

Example​

if(tools.hasRole(vars.getString("$sys.user"), "PROJECT_Administration"))
  question.showMessage("You are an admin!");

insertUser​

insertUser(pUser, pName?): string

Creates a new user.

Parameters​

pUser
any

The user, as an object.

pName?
string | number | boolean

The name of the new user. The name has to start with "____USER". No value generates a new name.

Returns​

string

The name (not the title) of the user.

Throws​

May throw an exception.

Example​

var user = new Array();
  user[tools.TITLE] = "newUser";
  user[tools.PASSWORD] = "test1234";
  user[tools.PARAMS] = new Array();
  user[tools.PARAMS][tools.FIRSTNAME] = "new";
  user[tools.PARAMS][tools.LASTNAME] = "User";
  tools.insertUser(user);

refreshCurrentUser​

refreshCurrentUser(): void

Saves the changes to the current user and reloads them from the database.

Returns​

void

Throws​

May throw an exception.

Example​

tools.refreshCurrentUser();

resolveUser​

resolveUser(pLogin): string

Returns the internal names of a user based on the login name you passed.

Parameters​

pLogin
string | number | boolean

The login name of the user, as a string.

Returns​

string

The internal user name, as a string. 'null' if no user exists.

Throws​

May throw an exception.

Example​

var users = tools.resolveUser("Admin");

resolveUsers​

resolveUsers(pLogin): string[]

Returns the internal names of a user based on the login names you passed.

Parameters​

pLogin
any

The login names of the users, as an array.

Returns​

string[]

The internal user names, as a string array, array element is 'null' if user with title does not exist.

Throws​

May throw an exception.

Example​

var users = tools.resolveUsers(new Array("Admin", "Administrator"));

updateCurrentUser​

updateCurrentUser(pAttributes): void

Updates the current user data.

Parameters​

pAttributes
any

The attributes to be updated.

Returns​

void

Throws​

May throw an exception.

Example​

var update = new Array();
  update["title"] = "Admin";
  update["description"] = "My description";
  tools.updateCurrentUser(update);

updateRole​

updateRole(pName, pTitle, pDescription, pIsAssignable, pAssignedChildren): boolean

Updates a role. 'null'-Parameters are not updated.

Parameters​

pName
string | number | boolean

mandatory

pTitle
string | number | boolean
pDescription
string | number | boolean
pIsAssignable
boolean
pAssignedChildren
string[]

Returns​

boolean

Throws​

May throw an exception.

updateUser​

updateUser(pUser): void

Updates a user.

Parameters​

pUser
any

The user, as an object.

Returns​

void

Throws​

May throw an exception.

Example​

var user = tools.getUser("Admin");
  user[tools.PARAMS][tools.FIRSTNAME] = "newFirstname";
  user[tools.PARAMS][tools.LASTNAME] = "newLastname";
  tools.updateUser(user);

updateUserToken​

updateUserToken(pUid, pLoginUser, pReferenceUserId, pValidFrom, pValidTo, pValidOnce, pValid, pGroupId): void

Update the user token with the specified ID in the database.

Parameters​

pUid
string | number | boolean

The desired ID of the token (UID)

pLoginUser
string | number | boolean

The login name of the user to whom the token is associated (for example, admin). Important: This user will run the login.

pReferenceUserId
string | number | boolean

This ID (reference User ID) identifies a user.

pValidFrom
number

From this point on, the token is valid (given in milliseconds from 1970)

pValidTo
number

At this point, the token is no longer valid (specified in milliseconds from 1970)

pValidOnce
boolean

Indicates whether the token should be invalidated at first login

pValid
boolean

Indicates whether the token is valid

pGroupId
string | number | boolean

Additional information for evaluation purposes

Returns​

void

Throws​

May throw an exception.

Example​

tools.updateUserToken('fb585dd3-9c8d-460e-a667-57a8e6b763a2', 'admin', 'Tim Admin', 1488927600000, 1488927600000, true, 'Group 1');

validatePasswordPolicies​

validatePasswordPolicies(pPassword, pUserLogin): string[]

Checks whether the password passed complies to the configured policies.

Parameters​

pPassword
string | number | boolean

The password to be checked.

pUserLogin
string | number | boolean

The user's login name. Empty string for new user.

Returns​

string[]

An array of messages indicating which policies have not been met. Empty, if everything is fine.

Throws​

May throw an exception.

Example​

let policyMessages = tools.validatePasswordPolicies(vars.get("$local.value"), vars.get("$sys.user"));
  let messages = [];

  if(policyMessages.length > 0) {
  for(let msg in policyMessages) {
  messages.push(policyMessages[msg]);
  }
  result.string(messages.join("\n", messages));
  }

verifyPassword​

verifyPassword(pUserLogin, pPassword, pDisableSleep?): boolean

Checks whether the password you passed is correct.

This overloaded method variant allows you to disable the security-related sleeping, which sometimes may lead to unwanted delays. IMPORTANT: Only use it if you can be sure, that the user is already authenticated/logged-in.

Parameters​

pUserLogin
string | number | boolean

The user whose password you want to check.

pPassword
string | number | boolean

The password to be checked.

pDisableSleep?
boolean

An optional Boolean to disable sleeping.

Returns​

boolean

'true' if the password you passed is correct. 'false' if the password you passed is wrong.

Throws​

May throw an exception.

Properties​

Example​

var password = question.askQuestion("Password?", question.QUESTION_EDIT, "");
  var checked = tools.verifyPassword("Admin", password, true);
  question.showMessage("The result is: " + checked + " / " + typeof(checked));

BLOCKEDTIMESTAMP​

string
​

CAL_HOURPARTITION​

string
​

CAL_LASTVIEWMODE​

string
​

CAL_MAINTIME_END​

string
​

CAL_MAINTIME_START​

string
​

CAL_TASKSELECTION​

string
​

CAL_USER_SORTING​

string
​

CAL_VIEWMODE​

string
​

CALDAV_LOGIN​

string
​

CALDAV_PASSWORD​

string
​

CALDAV_PATH​

string
​

CALENDAR_ALIAS​

string
​

CALENDAR_USERFAVORITES​

string
​

CALENDARID​

string
​

CALENDARSYNC_ENABLED​

string
​

CALENDARSYNC_LASTDATE​

string
​

COMPONENT_MODE​

string
​

CONTACTID​

string

Constant for reading and setting user properties.

This is the contact-id of the user.

This corresponds to the description property in the user area of the System Editor.

This property is set and retrieved via user[tools.CONTACTID].

COUNTRY​

string
​

DESCRIPTION​

string

Constant for reading and setting user properties.

This is the description of the user.

This corresponds to the description property in the user area of the System Editor.

This property is set and retrieved via user[tools.DESCRIPTION].

DOMINOREST_DATABASE​

string
​

DOMINOREST_INTERNETADDRESS​

string
​

DOMINOREST_LOGIN​

string
​

DOMINOREST_PASSWORD​

string
​

DOMINOREST_USERNAME​

string
​

EMAIL​

string
​

EXCHANGE_DOMAIN​

string
​

EXCHANGE_EMAIL​

string
​

EXCHANGE_FOLDERCALENDAR​

string
​

EXCHANGE_FOLDERTASK​

string
​

EXCHANGE_LOGIN​

string
​

EXCHANGE_PASSWORD​

string
​

EXCHANGE_USERTITLE​

string
​

EXTERNAL_USER_ID​

string
​

FIRSTNAME​

string
​

FRAME_SEARCHFAVORITES​

string
​

FRAME_STOREDSEARCHES​

string
​

GROUPS​

string

Constant for reading and setting user properties.

These are the groups of the user, to which he can only access reading.

This property is set and retrieved via user[tools.PARAMS][tools.GROUPS].

HASUNREADWHATSNEW​

string
​

ICON​

string

Constant for reading and setting user properties.

This is the icon.

This corresponds to the icon property in the user area of the System Editor.

This property is set and retrieved via user[tools.PARAMS][tools.icon].

IS_ENABLED​

string

Compatibility-Cases. Use ISACTIVE

ISACTIVE​

string
​

ISBLOCKED​

string
​

ITEM_USER_FAVORITES​

string
​

KERBEROS_LOGIN​

string
​

LANGUAGE​

string
​

LAST_LOGIN​

string
​

LAST_LOGOUT​

string
​

LASTMODIFIED​

string
​

LASTNAME​

string
​

LDAP_LOGIN​

string
​

LOCALE​

string
​

LOGIN_LIMIT​

string
​

MAIL_CHECKER_INTERVAL​

string
​

MAIL_USERSERVERENABLED​

string
​

MAILSERVER_ALIAS​

string
​

MAILSERVER_INBOX​

string
​

MAILSERVER_OUTBOX​

string
​

MAILSERVER_PASSWORD​

string
​

MAILSERVER_TRANSPORT_PASSWORD​

string
​

MAILSERVER_TRANSPORT_USER​

string
​

MAILSERVER_USER​

string
​

MODELS​

string

Constant for reading and setting user properties.

These are the data models of the user in the groups.

This property is set and retrieved via user[tools.PARAMS][tools.MODELS].

MYROLE​

string

Constant for reading and setting user properties.

This is your own role, which is the same as the name.

This property is set and retrieved via user[tools.PARAMS][tools.MYROLE].

NAME​

string
​

NONWORKDAYS​

string
​

OAUTH2_LOGIN​

string
​

OPEN_NEW_TAB​

string
​

PARAMS​

string

These are the user's parameters.

The parameters can be used to get or set the user's properties, e.g. user[tools.PARAMS][tools.LASTNAME].

PASSWORD​

string

Constant for reading and setting user properties.

This is the password if it is specified using the user properties.

This corresponds to the password property in the user area of the System Editor.

This property is set and retrieved via user[tools.PASSWORD].

PASSWORD_CHANGED​

string
​

PASSWORD_HASH​

string

Constant for reading and setting user properties.

This is the hash value of the password.

This property is set and retrieved via user[tools.PARAMS][tools.PASSWORD_HASH].

PASSWORD_HISTORY​

string
​

PERMISSION_CREATE​

string

Constant for permissions: CREATE is granted

PERMISSION_DELETE​

string

Constant for permissions: DELETE is granted

PERMISSION_READ​

string

Constant for permissions: READ is granted

PERMISSION_UPDATE​

string

Constant for permissions: UPDATE is granted

PERMISSION_VIEW​

string

Constant for permissions: VIEW is granted

PHONE_ADDRESS​

string
​

PREFERRED_THEME​

string
​

PROFILE​

string
​

PROFILE_DEFAULT​

string

Constant for the profile that can be specified when users are fetched through tools.getUser(), rools.getUsers(), tools.getUserByAttribute(), and tools.getUsersByAttribute().

The default does not include the following features of the user:

tools.ICON, tools.DESCRIPTION, tools.FRAME_SEARCHFAVORITES, tools.FRAME_STOREDSEARCHES, tools.ITEM_USER_FAVORITES, tools.CALENDAR_USERFAVORITES, and tools.PASSWORD_HISTORY.

NOTE: If just the user title is required, use the constant PROFILE_TITLE instead to improve the performance.

PROFILE_FULL​

string

Constant for the profile that can be specified when users are fetched through tools.getUser(), tools.getUsers(), tools.getUserByAttribute(), and tools.getUsersByAttribute().

The full profile loads the entire profile with all the properties.

CAUTION! Loading the full user profile is significantly slower compared to PROFILE_DEFAULT and PROFILE_TITLE. Avoid using this profile for a large number of users as this can lead to severe performance issues.

PROFILE_TITLE​

string

Constant for the profile that can be specified when users are fetched through tools.getUser(), tools.getUsers(), tools.getUserByAttribute(), and tools.getUsersByAttribute().

The title profile only loads the user's title.

ROLE_CUSTOM​

string

Constant for reading and setting user properties. This is the role type 'CUSTOM'.

This property is set and retrieved via user[tools.PARAMS][tools.ROLE_CUSTOM].

ROLE_INTERNAL​

string

Constant for reading and setting user properties.

This is the role type 'INTERNAL'.

This property is set and retrieved via user[tools.PARAMS][tools.ROLE_INTERNAL].

ROLE_PROJECT​

string

Constant for reading and setting user properties. This is the role type 'PROJECT'.

This property is set and retrieved via user[tools.PARAMS][tools.ROLE_PROJECT].

ROLENAMES​

string
​

ROLENAMES_ASSIGNED​

string

Constant for reading and setting user properties.

This are the names of roles of the user which are directly assigned. Transient Roles are omitted.

This property is set and retrieved via user[tools.PARAMS][tools.ROLESNAMES_ASSIGNED].

ROLES​

string

Constant for reading and setting user properties.

These are the roles of the user.

This property is set and retrieved via user[tools.PARAMS][tools.ROLES].

ROLES_ASSIGNED​

string

Constant for reading and setting user properties.

This are the roles of the user which are directly assigned. Transient Roles are omitted.

This property is set and retrieved via user[tools.PARAMS][tools.ROLES_ASSIGNABLE].

ROLES_NOSELF​

string

Constant for reading and setting user properties.

This is the role of the user without its own role (read only).

This property is set and retrieved via user[tools.PARAMS][tools.ROLE_NOSELF].

SELECTION_BOTH​

string

Constant for the type of placeholder (tools.SELECTION_PLACEHOLDER).

In this case, placeholders are set before and behind the search term.

SELECTION_IGNORECASE​

string
​

SELECTION_NEITHER​

string

Constant for the type of placeholder (tools.SELECTION_PLACEHOLDER).

In this case, placeholders are taken into account.

SELECTION_NULL​

string

Constant for the type of placeholder (tools.SELECTION_PLACEHOLDER).

In this case, placeholders are ignored.

SELECTION_PLACEHOLDER​

string
​

SELECTION_POSTFIX​

string

Constant for the type of placeholder (tools.SELECTION_PLACEHOLDER).

In this case, placeholders are set behind the search term.

SELECTION_PREFIX​

string

Constant for the type of placeholder (tools.SELECTION_PLACEHOLDER).

In this case, placeholders are set before the search term.

SELECTION_USE_LEADING_WILDCARD​

string
​

SHOW_FLOATING_ACTION_BUTTON​

string
​

SHOW_WEEKEND​

string
​

SSPI_LOGIN​

string
​

TABLEPAGEFLIP​

string
​

TASKS_ALIAS​

string
​

TEAMS_AZUREID​

string
​

TEAMS_AZUREUPN​

string
​

TIMEZONE​

string
​

TITLE​

string

Constant for reading and setting user properties.

This is the login of the user.

This corresponds to the title property in the user area of the System Editor.

This property is set and retrieved via user[tools.title].

USER_TOKEN_GROUP_ID​

string

Constant for reading and setting user properties. This is the Group ID of the user token.

USER_TOKEN_LOGINUSER​

string

Constant for reading and setting user properties. This is the Login User Title of the user token.

USER_TOKEN_REFUSER​

string

Constant for reading and setting user properties. This is additional user information of the user token.

USER_TOKEN_UID​

string

Constant for reading and setting user properties. This is the UID of the user token.

USER_TOKEN_VALID​

string

Constant for reading and setting user properties. Specifies whether the user token is valid.

USER_TOKEN_VALIDFROM​

string

Constant for reading and setting user properties. This is the date from which the user token is valid.

USER_TOKEN_VALIDONCE​

string

Constant for reading and setting user properties. Specifies whether the user token is valid once.

USER_TOKEN_VALIDTO​

string

Constant for reading and setting user properties. This is the date until the user token is valid.