ONE Administration Guide
This guide will describe how to manage the various aspects of the portal including endpoints, users, roles, themes and micro-apps. This section will also show users where to find important software and how to query the error logs.
Micro-apps and card apps that get built using the AppBuilder may use interfaces to systems like SAP, SharePoint and others to get the data they need. These interfaces have endpoints in the ONE Cloud. While new endpoints must be created in the AppBuilder, various settings can be changed from within the portal. These endpoints can be deleted and pinged from the portal.
The Users Page supports many important user management features:
- Automatic creation and approval of users
- Manual adding of users including bulk-loading
- Automatic assignment of roles to users. (A role defines which apps a user has access too. These are configured on the Roles page described below).
The Rules section on the Users Page lists the automatic role-assignment rules that have been created. A rule maps an email address pattern to a role. This means that new users whose email address contains a pattern that corresponds to one of the rules will have the associated role assigned to them. A role specifies which micro-apps the user has access too on their mobile client. Roles are configured on the Roles Page (described in the Roles section).
To create a new rule, click Add Rule and fill in the email pattern to be matched against. Click Create.
If a user would like the automatically-assigned role for the new pattern to be different than the default, select another role from the drop-down. To delete a rule, click on the Remove Link that corresponds to the rule.
To automatically approve new users, select the Automatic Approval option. If this is not selected, users will need to be manually approved as described below.
To specify the email address for support queries for a ONE instance, enter it in the Support section in the Support Email field and click Save. The support email is referenced in the welcome email to new users.
To add new users manually go down to the Users section on the Users Page.
To create a single user, click on Create User and enter the First Name, Last Name and Email Address. Select the appropriate role and language and click Save.
To bulk load users, click on Import Users and specify a CSV file that has column names firstname, lastname, email address, role and language.
The Active Users section supports searching users, granting admin access, account lock-out (and unlock), profile editing and account removal.
To search for an active user, enter text in the Search box that corresponds to the user’s name. All users that match that text in the first name, last name, role or email field will be displayed.
To grant administrative access to a user, click on the Admin link in the admin column corresponding to the user’s name. To remove access, click on the No Admin link that corresponds to the user’s name. Administrative access allows a user to perform administrative functions like user management.
To remove access to a user (non-administrator), click on the Lock link corresponding to the user’s name. To restore access to a locked account, click on the Unlock link corresponding to the user’s name.
To change the first name, last name or role for a user, click on the Edit link corresponding to the user’s name. An Edit User dialog will appear. Click on Save to store the changes.
To delete an account, click on the Delete link corresponding to the user’s name. Deleting a user from the active user list can be undone from the Deleted Users section.
The Pending Users section supports searching pending users (users that have made an account request) and the approving or declining an account request.
To search for a pending user, enter text in the Search box that corresponds to the user’s name. All users that match that text in the first name, last name, role or email field will be displayed.
To approve a pending user, click the Approve link corresponding to the user’s name. To decline an account request, click the Decline link corresponding to the user’s name.
To complete the activation process, the user must confirm their email address by clicking on the validation link in the registration email that is sent to them after they make the account request. If the user does not receive the email or does not click on the link within a reasonable timeframe, the account cannot be activated. If the user would still like to create an account with the same email address, an administrator must remove the deactivated account before the user can re-request the account. To remove the deactivated account, click on the Delete link that corresponds to the user in the Not yet activated users list.
The Deleted Users section list users that have been deleted but not permanently. To restore a user (i.e. to undo a delete action described above), click on the Restore link corresponding to the user’s name. To permanently delete a user, click on the Delete link corresponding to the user’s name.
A given company may have many, possibly hundreds, of micro-apps. Since not all micro-apps will be relevant to all users and subsets of micro-apps will be relevant to people in a particular role, administrators can map micro-apps to a role. Since roles can be associated to a user (as described in the User Management section), only those micro-apps that are relevant to the given user are displayed on their device.
This section describes all of the different role management features available on the Roles Page.
To create a new role, click on Add Role. This will create a place holder for a new role and will initially be called NewRoleN (where N is the number of placeholders that haven’t been renamed to a real role name). To rename a role, see Configuring a role below).
To rename a role or to change its theme, click on the Configure link beside the selected role and change accordingly.
Since a given role may have many micro-apps, categories can be created and associated with the role to help thematically organize them. To create a category to the role, click on Yes under Do you want to create a category? Click on New Category in the text box and type in the name of the new category for the role (NewRoleCategory1 in the example below).
To configure the categories and apps for another language, click on the flag icon on the top right of the mobile-device emulator. Make the appropriate changes and then click Save.
From the Themes page, customers can easily brand their client with their company logo and color.
Click Save at the bottom of the theme configuration area to save changes (or Reset to start from scratch or Delete to remove the theme altogether).
To set the default client display theme for new roles, select a theme from the Default Theme menu and click Save
To create a new theme, click on the +Create link (beside the Edit Theme menu). Enter the name of the theme and click Create.
To configure a new or existing theme, go to the Edit Theme section. To the right of that section is a theme emulator which helps give an idea of what the theme will look like.
The theme name is automatically filled-in the Name field but can be edited.
Click on Upload New Logo to load in a new logo. The user is prompted to choose a file and then clicks Upload to load the file into the portal. (The URL of the uploaded logo appears in the Logo field.). The logo will appear at the top of the client as emulated under the Start Screen and Apps Screen tabs to the right of the Theme Editing area. Multiple logos can be uploaded and the default logo can be changed from that list by clicking on View uploaded logos, selecting a new default and clicking Choose.
Underneath the logo upload area is where the following colors can be specified:
- Primary Color (header color, link colors, navigation indicators, app list color, etc.)
- Header Font Color (text color in the header)
- Tint Color (gear icon, back and more text, etc.)
To specify a color, click on the menu and drag the black dot and spectrum selector to the desired color on the Pantone selector.Alternatively, specify the color number (with #prefix underneath the palette). Click Choose to save changes.
The selected colors can also be previewed in the theme emulator to the right of the theme configuration area as seen below.
The Micro-Apps page lists which micro-apps have been released and which ones are currently in development. Released micro-apps can be deleted from this page by clicking on Delete Link to the corresponding micro-app.
Micro-apps that are in development can be released for native clients to use by clicking on Make Productive. Micro-apps in development can be removed from here by clicking on the Delete link. Note that new micro-apps can only be created from within the AppBuilder.
A wide range of helpful reports are available on the Reports Page. The first page shows the breakdown of role activity and device-type usage over the last week, last month and for all time.
The second page shows the following metrics from the current day, the last 7 days and the last 30 days.
This is the average time it takes to make a call from a micro-app to the ONE server in milliseconds during the reporting period.
The number of calls to the server during the reporting period.
The average number of calls during each one-hour period in a 24-hour timeframe during the reporting period.
The average number of push notifications per-day over the reporting period.
The number of errors per-day over the reporting period.
The Log Page provides error reports from the ONE cloud. Reports can be displayed by time frame and error type. To look for a certain type of error for a given time period, select the From Date and To Date and Error Type and click Get.
Error report details can be viewed by clicking on the zoom icon at the beginning of the error log entry.
Error reports can also be generated by correlation ID. Enter the correlation ID and click Get. Again, error report details can be viewed by clicking on the zoom icon at the beginning of the error log entry.