1. Getting Started2. Generator Console3. Developer Console4. Template Editor5. Administrator Console5.1 Launching the AC5.2 Managing Users5.3 Data Backup & Recovery5.4 Viewing Plan Info5.5 Viewing App Info5.6 Single Sign-On (SSO)6. REST API7. Enterprise Integration8. Release Notes9. Support
5. Administrator Console
The Administrator Console is, as the name suggests, the workspace for all administration related tasks. Within this workspace, admins can manage users of the application, perform data backups, and read application metadata.
5.1 Launching the AC
Navigating to the AC is trivial. To do so, simply click on the "Administrator Console" link in the application header.
5.2 Managing Users
User management is performed within the Administrator Console. Users are created with one of three access levels.
- Administrator - An administrator has access to the entire application. They may generate configuration, modify templates, and manage other users.
- Developer - A developer has access to the Generator Console and Developer Console. They may generate configuration and modify templates. They are unable to access the Administrator Console.
- User - A user, also referred to as an operator, only has access to the Generator Console. They may generate configuration, but cannot modify templates or access any administration capabilities.
To create and modify users within the Administrator Console, fill out the form fields in the popup modal.
5.3 Data Backup & Recovery
Administrators may perform an application backup or recovery at any time. Additionally, Ultra Config offers customers an automated backup service that they are welcome to claim.
Create a Backup
To perform a backup, click on the Create Backup button. Once confirmation is made, a backup file will download locally to the administrator's machine.
Interested in performing automated backups yourself? Check out the REST API.
Restore a Backup
Administrators may restore the application to the state of a previous backup. To do so, click on the Restore Backup button and browse your machine for the backup file of interest. Finally, select the Restore button to confirm the recovery request.
Please note that restoring an application to a backup will not impact the state of users. It will only modify application data such as templates.
5.4 Viewing Plan Info
Information about plan usage and other licensing information can be checked within the Administrator Console.
A sample screenshot is displayed below.
5.5 Viewing App Info
Information about the software release of UCG can be checked within the Administrator Console.
A sample screenshot is displayed below.
5.6 Single Sign-On (SSO)
SSO allows users to login using their company credentials.
Our SSO is based on the SAML 2.0 protocol. Popular identity providers such as Okta, OneLogin and Azure AD will integrate seamlessly.
To configure SSO, navigate to the Authentication tab within the Administrator Console.
A table will display your SAML service provider (SP) settings. Configure these settings on your identity provider (IDP).
- Service Provider ACS URL - This is the SP Assertion Consumer Service URL.
- Service Provider Entity ID - This is the SP Entity ID.
- Service Provider Metadata - This is the SP Metadata URL. This is used by identity providers that support dynamic configuration.
- Service Provider Single Logout URL - Configure this URL on your identity provider if you wish to support SLO (Single Logout). This feature is optional.
- Service Provider Issuer - The SP Issuer. This field is mandatory for Single Logout.
- Service Provider X.509 Certificate - This is the SP certificate. This will enable a secure channel between the SP and IDP. The certificate is displayed in the PEM format.
Once configured, your IDP should generate the attributes below. Configure these attributes within the Authentication tab by clicking on the edit settings button.
- Identity Provider Login URL - Your SSO login URL. Users will be redirected to this endpoint when attempting to access Ultra Config.
- Identity Provider Logout URL - Your SSO logout URL. Leave this field blank if you do not wish to support SLO (Single Logout).
- Identity Provider X.509 Certificate - This is the IDP certificate. This will enable a secure channel between the SP and IDP. The certificate must be provided in the PEM format.
Once these tasks are complete, assign users to the SAML authentication type in the User Management tab.
This concludes the SSO setup. Users will now be redirected to your identity provider for authentication.