Working With the Settings Microapp
About the Settings Microapp
All new AppHub service instances that use ARCS include the Settings microapp, which you can use to perform many configuration and management tasks.
The Settings microapp has an easy, intuitive UI that simplifies AppHub configuration tasks and removes the need for command-line usage after you create your new instance. You can use the Settings microapp to:
- Configure the look and feel of your AppHub service instance.
- Inject JavaScript across all microapps in your service instance.
- Add new microapps and configure new and existing microapps.
- Define navigation and role-based access for each microapp.
- Add new themes and configure new and existing themes.
- Define the look and feel of new and existing themes.
- Set language and locale preferences for your service instance.
- Specify server-based authentication and access control for your service instance.
Configuring AppHub Settings
Before You Begin
To use the Settings microapp, you must first create an AppHub service instance and create any microapps or themes you want to add to the instance.
Procedure
- Log into your AppHub service instance with an account that has administrator rights.
- In the left navigation pane, at the bottom, click the gear icon, then select Settings App.
- Make settings in any of the following tabs:
- Click Save.
Global Config Tab
In the Global Config tab, you can define and modify settings for your AppHub service instance.
| Section | Option | Description |
|---|---|---|
| General Settings | Application Name | The name for your AppHub service instance, which appears at the top of the left navigation pane. (Required) |
| Logo URI | The URI to an image file to use as a logo next to the instance name. (Optional) | |
| Theme | The theme you want to apply to your AppHub instance. The available options are based on themes you configure in the Themes tab. If not set, the default AppHub theme is applied. (Optional) | |
| Enable application chrome | When selected, this option disables the left navigation pane. | |
| Scripts | Add  | Adds a field you can use to specify a JavaScript file to inject into your AppHub instance. |
| URL | The fully qualified URL to a JavaScript file to be injected into your AppHub instance. (Required) | |
Remove  | Removes a field to delete a linked script. |
Apps Tab
In the Apps tab, you can add and configure microapps for your AppHub service instance.
| Section | Option | Description |
|---|---|---|
| Microapps subpane | A list of the microapps in your AppHub instance, with arrows to modify the display order and a delete button. Microapps appear in the AppHub left navigation pane in the order listed in this subpane. | |
| Add new app | Adds a new microapp entry at the bottom of the list. You can then make configuration settings in the right subpane. | |
| App details | ID | The microapp name or title. (Required) |
| Path | The relative path to the microapp on the server. (Required) | |
| Hostname | The host server for the microapp. (Required) | |
| Template | The relative path to the main template file for the microapp on the server. (Required) | |
| Label | The display name for the microapp. (Required) | |
| Icon | The display icon for the microapp. (Required) | |
| Menu Location | Microapps can appear in the Main, in the Profile, or Settings menus. (Optional) | |
| Order | The display order for microapps in the left navigation pane. A value of 0 means the microapp is listed first. If no value is entered here, microapps appear in the list in the order they were added. (Optional) | |
| Navigation Service | The URL for the navigation server that you want to use for the microapp. When a value is set in this field, the Sub-Navigation links section is disabled. (Optional) | |
| Enable as Default Display App | When selected, this microapp is assigned order 0 and appears in the first AppHub view that users see after they log in. | |
| Sub-Navigation | Add | Adds a set of fields to define sub-navigation links or user groups for your microapp. (Optional) |
| Label | The sub-navigation field text label. (Required) | |
| Path | The relative path for the sub-navigation link. (Required) | |
| Remove | Deletes a set of fields to remove sub-navigation links or user groups. | |
| Capabilities | Group Name | User groups that can access this microapp. The groups listed here should match what is defined in the OAuth2 client for the microapp. |
Themes Tab
In the Themes tab, you can add and configure themes for your AppHub service instance.
| Section | Option | Description |
|---|---|---|
| Microapps subpane | A list of the themes configured for your AppHub instance, with a delete button for each entry. | |
| Add new theme | Adds a new theme entry. You can then make configuration settings in the right subpane. | |
| Theme | Display Name | The name to use for this theme in the UI. (Required) |
| Demo Link | A clickable link to a demo AppHub instance with this theme applied. (Optional) | |
| Description | A brief description of the theme. (Optional) | |
| Base URL | The URL where the theme is hosted. (Required) | |
| Main Template | The relative path to the HTML template to use for the main page view for the microapp. (Required) | |
| Error Template | The relative path to the HTML template to use for errors. (Required) | |
| Minimal Error Template | The relative path to the HTML template to use for errors when running in chromeless mode. (Optional) | |
| Theme Options | Add | Adds a set of fields to define theme options to pass to your microapp. Values in these fields must reflect the skin options implemented in the theme. (Optional) |
| Name | The option name. (Optional) | |
| Value | The option value. (Optional) | |
| Remove | Deletes a set of fields to remove theme options. |
Preferences Tab
In the Preferences tab, you can configure language preferences for your AppHub service instance.
| Section | Option | Description |
|---|---|---|
| Preferences | Preferred Locale | The default language to use for your AppHub service instance. (Optional) |
| Preference URI | The fully qualified URL to a preferences server for the specified default language. (Required) |
Privileges Tab
In the Privileges tab, you can configure server-based access for your AppHub instance.
| Section | Option | Description |
|---|---|---|
| Privileges | Privileges URI | The URL to the privileges server to use for access control for your AppHub service instance. |
| UAA Metadata | URI | The URI for the Predix UAA service instance associated with your AppHub instance. |
| Client ID | The admin client ID for the UAA service instance. | |
| Client Secret | The admin client secret for the UAA service instance. |