Account


Note: This tab is only available to users with account holder credentials.

In a Nutshell

It is in the Account tab where you can view account information.

It is an Account to which Companies and Users are assigned, and to which subscription billing information is sent.


Account Access

App Name & Module Client ID Who needs this? Abbreviation
Knowledge Management - Checklist Instances checklist-data-collector Backoffice engineers, dispatchers or technicians who want to fill in checklists from a Web Application accessable from WFM or KM CDC
Store store2 Backoffice engineers responsible for setting user group permissions. STORE
Workforce Management - Time & Material time-material-journal Dispatchers, team leads or project managers who review and approve recording for time and material TM

A Closer Look

When you navigate to the Account tab, you will see the following information:

Field Description
ID The unique ID of the account. This value is automatically generated by the application.
Name The name associated with the account.
Email The email address associated with the account.
Clients (legacy API) If applicable, the clients associated with the legacy API.
Clients (OAuth2 API) If applicable, the clients associated with API that uses OAuth2 for authentication.
Cluster The server cluster associated with the account (note: all trial accounts use the Ireland-based server cluster).
Created The date on which the account was created.
Password Encrypted.
Password Expiry Date The expiration date of the account password.
Password Status The current status of the password.
Roles The role assigned to the account. Examples include: Customer, Admin, etc
Active True or false. When true, the account is currently in use and perform application activities.
Audit Logs True or false.
Default SAML Configuration If applicable. For more information on SAML, please refer to the following topic on Federated Authentication
Deleted True or false. When deleted, it will display True and remain available for historical record-keeping purposes.

Minimum App Version

In the Account tab of the Admin module, you can define which minimum app version can be used for mobile and web-based applications. This can be used to ensure that users are using the latest version possible, or a version specific to desired functionality.

To configure or update an minimum app version, you must Edit the account configuration.

Field Description
ID The client ID
Name The name of the account.
Email The email address of the primary account holder.
Clients (Legacy API) If applicable, the clients associated with the legacy API.
Clients (OAuth2 API) If applicable, the clients associated with API that uses OAuth2 for authentication.

Client IDs

A minimum version can be configured for the following clients:

App Name Short Description Client Id
Administration Admin admin
Analytics & Reporting AR reporting
Configuration CO or Config configuration
Data Loader DL data-loader
Knowledge Management KM knowledge-management
Map Map map2
Market Place MP (TBC) marketplace
Master Data Management MDM master-data-management
Mobile Field Service App - Android Android android
Mobile Field Service App - iOS iOS ios
Mobile Field Service App - Windows Windows windows
Project Management PM project-management
Report Designer (JasperSoft Plugin) RD reportdesigner
Scribe Integration SI scribe
Service Crowd SC (TBC) service-crowd
Sign Up SU sign-up
System Monitoring SM monitoring
Workforce Management WFM workforce-management
Zapier Integration ZI zapier

This Client ID can be entered into the client ID field, after which a minimum version can be set for it in the field beside it (example: 6.0.0).

Notes

Description Impact
Under “Clients (legacy API)” the following description is displayed: “Define which clients using the legacy API are allowed to access the specific account. This list is exclusive for all clients using the legacy API.” This setting does not have any effect on updated clients using the recommended oAuth2 API.
Under the “Clients (OAuth2 API)” the following description is displayed: “Define the allowed IP ranges of client ids. This list is exclusive which means access is only possible for the clients and IP ranges defined here. In case only one client application is defined here, the access is disabled for all other clients.
Under the “Minimum Client Versions” the following description is displayed: “Define minimum versions required for different clients. In case a specific client application is not defined here access is allowed for any client application version.