Creating configuration settings for your Digital Service application
In BMC Helix Innovation Studio, you can create configuration settings and configuration functions for your application. The types of configuration settings includes a set of parameters, key-value pairs, or a data wizard.
Types of configuration settings
You can define one of the following configuration setting for a bundle:
Setting Type | Description |
---|---|
External Settings | When your configuration is outside BMC Helix Platform, you can add a link to the external configuration setting in your bundle. When users click the link, the configuration setting page opens in a web browser. For more information, see Creating External Settings. |
In-bundle Settings | In-bundle Settings leverages record definition and view definition in the bundle. This setting allows the configuration to have custom data and custom UI. Since the record definition and view definition is a part of the bundle, you can create custom logic and behavior within your application to manage the settings. For more information, see Creating In-bundle Settings. |
Shared Settings | Shared settings are located in one bundle and can be accessed by other bundles. Shared configuration settings have a common storage location and UI. Benefits of Shared Settings
Limitations of Shared Settings
More information on Creating Shared Settings. |
To create external settings
Add a link to your application that points to an external page with configuration settings. When users click the external link, the page is opened in a new tab of the web browser.
- Log in to BMC Helix Innovation Studio and navigate to the Workspace tab.
- Select the application or library bundle for which you want to create an External Setting.
- Click the Configurations tab.
- Select New > External Settings.
In the New External Settings window, specify the properties for the setting.
The following table provides information about the properties:Property Description Sample values Component Name Enter a unique name for your Setting. The name is displayed in the Configurations tab in your bundle's Workspace. GoogleSettings External Link Specifies the URL that is launched when the user clicks the setting. Status Select the status of the setting as ON or OFF. ON Available in Navigation Sidebar If you want the setting to appear in the left hand navigation of the Settings menu either in your application or in the BMC Helix Innovation Studio Administration tab, select ON.
ON Component Label Enter the display name of the Setting that appears in your application or in BMC Helix Innovation Studio.
Google Settings Show In Select the location of your setting—in your application's Settings menu or in the Administration tab of BMC Helix Innovation Studio, or both.
Application Permissions Select the roles and groups that can access the Setting. You can add permissions to groups or application roles. You can select roles from multiple applications deployed on the system. Administrator group First Menu Enter the name of the top level navigation item that is displayed in the left hand navigation of the Settings menu. If multiple settings use the same name for First Menu, then all those settings appear under the same navigation item. External Settings Second Menu Enter the name of the second level navigation item that is displayed in the left hand navigation of the Settings menu. If left blank, no second level item will appear. If multiple settings use the same name for Second Menu, then all those settings appear under the same navigation item.
Level 2 Click Save.
To create in-bundle settings
You can create an In-bundle Setting by using any of the following methods:
- By using Angular JS: Register a custom angular app by using Angular JS, and then use that app for creating an In-bundle Configuration setting in BMC Helix Innovation Studio.
- By using BMC Helix Innovation Studio: Use a View definition for creating an In-bundle Setting for your application or library.
By using Angular JS
Step 1: Register the custom angular app by using Angular JS
- Decide how you want to manage your Setting in an application.
- Create a directive for your UI entry point.
Register with the Admin Settings Service Provider.
Example:
(function() { 'use strict'; angular.module('ax.tenants').config(function(rxAdminSettingsCustomViewProvider) { rxAdminSettingsCustomViewProvider.registerComponent({ componentName: 'manage-tenants', runTimeDirective: 'manage-tenants' }); }); })();
Step 2: Use the custom angular app in BMC Helix Innovation Studio
- Log in to BMC Helix Innovation Studio and navigate to the Workspace tab.
- Select the application for which you want to create an In-bundle Setting.
- Click the Configurations tab.
- Select New > In-bundle Settings.
In the New In-bundle Settings window, specify the properties for the setting.
The following table provides information about the properties:Property Description Sample values Component Name Enter a unique name for your Setting. The name is displayed in the Configurations tab in your bundle's Workspace. Tenant activation Is View Component Opens a view definition in the bundle in the application Selected Registered Module Name Specifies the unique name of the registered module manage-tenants
Status Select the status of the setting as ON or OFF. ON Available in Navigation Sidebar If you want the setting to appear in the left hand navigation of the Settings menu either in your application or in the BMC Helix Innovation Studio Administration tab, select ON.
ON Component Label Enter the display name of the Setting that appears in your application or in BMC Helix Innovation Studio.
Activating tenants Show In Select the location of your setting—in your application's Settings menu or in the Administration tab of BMC Helix Innovation Studio, or both.
Application Permissions Select the roles and groups that can access the Setting. You can add permissions to groups or application roles. You can select roles from multiple applications deployed on the system. Administrator group First Menu Enter the name of the top level navigation item that is displayed in the left hand navigation of the Settings menu. If multiple settings use the same name for First Menu, then all those settings appear under the same navigation item. My settings Second Menu Enter the name of the second level navigation item that is displayed in the left hand navigation of the Settings menu. If left blank, no second level item will appear. If multiple settings use the same name for Second Menu, then all those settings appear under the same navigation item. Tenant settings Click Save.
By using BMC Helix Innovation Studio
In this method, you use a newly created or existing view definition to create the configuration setting for your application.
- Log in to BMC Helix Innovation Studio and navigate to the Workspace tab.
- Select the application for which you want to create an In-bundle Setting.
- Click the Configurations tab.
- Select New > In-bundle Settings.
In the New In-bundle Settings window, specify the properties for the setting.
The following table provides information about the properties:Property Description Sample values Component Name Enter a unique name for your Setting. The name is displayed in the Configurations tab in your bundle's Workspace. Tenant activation Is View Component Opens a view definition in the bundle in the application Selected Registered Module Name Specifies the unique name of the registered module, which is the view definition that you created Approval Console
Status Select the status of the setting as ON or OFF. Selected Available in Navigation Sidebar If you want the setting to appear in the left hand navigation of the Settings menu either in your application or in the BMC Helix Innovation Studio Administration tab, select ON.
Selected Show In Select the location of your setting—in your application's Settings menu or in the Administration tab of BMC Helix Innovation Studio, or both.
Application Permissions Select the roles and groups that can access the Setting. You can add permissions to groups or application roles. You can select roles from multiple applications deployed on the system. Administrator group Component Label Set the display name of the Setting that is shown in your application or in BMC Helix Innovation Studio.
Activating tenants First Menu Enter the name of the top level navigation item that is displayed in the left hand navigation of the Settings menu. If multiple settings use the same name for First Menu, then all those settings appear under the same navigation item. My settings Second Menu Enter the name of the second level navigation item that is displayed in the left hand navigation of the Settings menu. If left blank, no second level item will appear. If multiple settings use the same name for Second Menu, then all those settings appear under the same navigation item. Tenant settings Click Save.
To create shared settings
- Log in to BMC Helix Innovation Studio and navigate to the Workspace tab.
- Select the application or library bundle in which you want to create the shared setting.
- Click the Configurations tab.
- Select New > Shared Settings.
In the New Config window, on the General tab, specify the properties for the setting.
The following table provides information about the Setting properties:Property Description Component Name Enter a unique name for your Setting. The name is displayed in the Configurations tab in your bundle's Workspace. Show In Select the location of your setting—in your application's Settings menu or in the Administration tab of BMC Helix Innovation Studio, or both.
Component Label Enter the display name of the Setting that appears in your application or in BMC Helix Innovation Studio.
Status Select the status of the setting as ON or OFF.
Setting Repeat Select on the the following options:
ON—If the setting can have multiple saved values.
OFF—If the setting can only have one saved value.
Setting Parent Select the parent for this setting. When selected, this setting will show up within the selected Setting and not in a menu. Permissions Select the roles and groups that can access the Setting. You can add permissions to groups or application roles. You can select roles from multiple applications deployed on the system. Available in Navigation Sidebar If you want the setting to appear in the left hand navigation of the Settings menu either in your application or in the BMC Helix Innovation Studio Administration tab, select ON.
First Menu Enter the name of the top level navigation item that is displayed in the left hand navigation of the Settings menu. If multiple settings use the same name for First Menu, then all those settings appear under the same navigation item. Second Menu Enter the name of the second level navigation item that is displayed in the left hand navigation of the Settings menu. If left blank, no second level item will appear. If multiple settings use the same name for Second Menu, then all those settings appear under the same navigation item. To add one or more fields in the Settings window, click (+) New Field and then select the field type.
In the Properties tab, specify the properties of the field.
The following table provides information about the field properties:Property Description Field Name Enter a unique name for the field. The name is displayed in list of fields for your setting. Field Label Enter the display name of the field that appears in your application or in BMC Helix Innovation Studio.
Required Select this option when you want it to be a mandatory configuration field. Permissions Select the roles and groups that can access the Setting. You can add permissions to groups or application roles. You can select roles from multiple applications deployed on the system. Default Value Set the default value of the field. If left blank, the field will not have a default value. Key Field for Repeated Setting Select if this field is repeated. - (Optional) To add a field group to a shared setting, click Manage Field Groups and then select the field group.
Click Save.
Example scenarios of configuration settings for an application
Where to go from here
Action | Reference |
---|---|
Extend the service objects and customize their behavior. | |
If you have completed all tasks of developing your application, package and test the application. |
Comments
Log in or register to comment.