Active Roles Add-on Manager is an application for installing and managing add-ons for Active Roles. You can also create new addons with the solution's Add-on Editor.
For more information on installing Add-on Manager, see Steps to install Add-on Manager in the Active Roles Quick Start Guide.
You can use the Active Roles Add-on Manager from the command-line.
To run Add-on Manager
-
Open the Windows command prompt.
-
Navigate to the folder where the Add-on Manager is installed.
-
Run the ActiveRolesAddOnManager_8.0.1.exe file with the appropriate parameters.
TIP: To list the available parameters, run the following command:
ActiveRolesAddOnManager_8.0.1.exe /?
You can create new add-ons with the Add-on Editor component of the Add-on Manager.
To create a new add-on
-
To open the Add-on Editor, perform one of the following steps:
-
In the Windows Start menu, click Add-on Editor.
-
In the Active Roles Console, navigate to the Add-on Manager application page, and click Create New.
-
In the Connect to Administration Service dialog, select the Active Roles Administration Service you want the Add-on Editor to connect to, then specify a user name and password.
-
On the Create or Edit Add-on page, select Create a new add-on and click Next.
-
On the General Add-on Settings page, configure all settings and click Next.
-
On the Add-on Objects page, select the Active Roles objects and/or Web Interface customization items you want to include in your add-on.
-
To add Active Roles objects, click Add Active Roles Objects. Then, on the Add Active Roles Objects page, select the objects to include in your add-on. To apply your selection, click OK.
-
To add Web Interface customization items, click Add WI Customization items. On the Add Web Interface Customization Items page, specify the configuration from which you want to export customization items, then select the items to include in the add-on. To apply your selection, click OK.
-
Once you selected the objects to include in the add-on, click Next.
-
On the Save Add-on page, specify the file name of your add-on and click Next.
-
On the Ready to Create Add-on page, review the settings for your add-on. If you want to specify advanced settings, click the Advanced button.
-
(Optional) On the Advanced Settings page, configure the following settings for your add-on. To apply your advanced settings, click OK.
-
Show in Raw mode only: If selected, Add-on Manager will display your add-on only if the Active Roles Console is in Raw view mode.
-
Show Uninstall link: If selected, Add-on Manager will show the Uninstall option for your add-on in the Active Roles Console.
NOTE: If this option is not selected, you can only uninstall your add-on later via the Add-on Manager command line.
For the list of command-line options, use the AddOnManager.exe /? command in the Windows command prompt.
-
Show Add-on Configuration page: If selected, the add-on title link in the Add-on Manager page will open the Add-on Details dialog.
TIP: One Identity recommends selecting this option if your add-on has a configuration page, then configuring the add-on title link to open that configuration page.
To do so, select Show Add-on Configuration page, then supply the Distinguished Name (DN) of the application object included in your add-on.
-
Web Interface customization label: Contains the Web Interface customization label. All Web Interface customization items added by the configured add-on will be marked in the add-on XML with this label. By default, the label consists of the add-on name and version.
-
Show Web Interface customization link: If selected, Add-on Manager will provide the Web Interface Customization link for your add-on in the Active Roles Console. When clicking this customization link, you can select the Web Interface configurations and sites you want your add-on to customize, then also apply the customization items to the selected configurations and sites.
-
Apply customization to Site for Administrators: If selected, the customization items of your add-on will be applied to the Active Roles Web Interface site for Administrators.
-
Apply customization to Site for Help Desk: If selected, the customization items of your add-on will be applied to the Active Roles Web Interface site for Helpdesk.
-
Apply customization to Site for Self-Service: If selected, the customization items of your add-on will be applied to the Active Roles Web Interface site for Self-Service.
-
System Requirements: Use this setting to specify the minimum and maximum versions of Active Roles supported by your add-on.
-
Required add-ons: Use this setting to specify add-ons that must be installed before installing your add-on. To specify a new add-on, click Add.
-
Pre-install script: If selected, you can specify a script to run before installing your add-on. Enter the script in the text box of the setting.
NOTE: Add-on Manager supports only PowerShell scripts.
-
Post-install script: If selected, you can specify a script to run after installing your add-on. Enter the script in the text box of the setting.
-
Pre-uninstall script: If selected, you can specify a script to run before uninstalling your add-on. Enter the script in the text box of the setting.
-
Post-uninstall script: If selected, you can specify a script to run after uninstalling your add-on. Enter the script in the text box of the setting.
-
To create the add-on, click Finish.