Client Instance Management
The developer account comes with an admin console which facilitates the management and monitoring of the running instance.
This includes but is not limited to:
- application user management
- client instance configuration management
- reference data management
- API analytics
- billing options
Clicking the tabs navigates to the relevant sections.
Dashboard
The Dashboard shows activity with different granularity also offering the possibility to pick a desired time frame to analyse.
General
In the General tab the user can provide information about their corporate identity, customize email messages, choose identity providers for the application and email SMTP configuration, by navigating to the relative sub tabs.
In the Corporate identity the application logo can be uploaded.
The file type must be a PNG and have a maximum file size of 1MB. Image size must be between 100x100 and 1200x1200 pixels and a transparent background is recommented.
Email messages provides customizable messages for the email verification, reset password, update account, the greeting and footer message. Use the filters on the right to choose font family and size.
In the Identity providers, select one or more providers the users can use to register and login to your application. Available options are:
- Guest Session
- OpenID connect
In the Email SMTP configuration the custom SMTP can be enabled.
Applications
The Applications tab is where the user can choose to connect their back-end and/or front-end application as described here, to the Envizage APIs, as well as the tools available for deployment.
Usage & Billing
In the Usage & billing tab the user can monitor their applications API calls usage and user registration through time, as well as choose a suitable billing plan.
Available time frames for monitoring are:
- Today
- This week
- This month
- This year
- Custom time frame
Users
The Users tab brings up the user management screen. These are the users that are created through the API or from the application that is authenticated to the API you are developing.
Use the filter on the top to find a desired user or a group of users.
By clicking on Add a new user button, brings up the new user creation form where all aspects of a user can be created.
Clicking edit on a user, brings up the user edit form where all aspects of a user can be edited.
Here a user can also be removed, by clicking the delete button.
Configuration
This is the configuration section where the behaviour and the default values of the instance can be changed.
Each configuration entry is a represented by a key and a value. The value can be a simple numeric value or a complex construct.
The entries are documented but if in doubt, please contact us.
The console won't prevent you from inputting invalid values. Providing input values might render the instance unusable until the values are reset. Always make a back-up before configuring it.
Calibration
The Calibration tab offers the user the ability to generate a documentation for their application and its configurations with markdown language and export it to a pdf file.
Account
Here the user can access their profile where the relative information can be viewed and edited, have a security overview of the application and logout of its session.