Chat now with support
Chat with Support

Active Roles 7.5 - Add-on Manager Readme

Add-on Manager command line interface

You can use Add-on Manager from the command line. For a complete command line reference, switch to the Add-on Manager installation folder at the command prompt and run the following command: ActiveRolesAddOnManager_7.5.exe /?

Using Add-on Editor

Add-on Editor is a tool for creating and editing add-ons. Add-on Editor creates a functional add-on which you can use immediately after it was created. After Add-on Editor generates an add-on, you can always customize it by adding objects and scripts to your add-on.

Creating an add-on

You can use the following steps to create an add-on:

  1. To open Add-on Editor, click Create New on the Add-on Manager application page in the Active Roles console, or click Add-on Editor on the Start menu.
  2. In the Connect to Administration Service dialog box, select the Active Roles Administration Service you want Add-on Editor to connect to, and specify a user name and password.
  3. On the Create or Edit Add-on page, select the option Create a new add-on and click Next.
  4. On the General Add-on Settings page, fill in the provided text boxes and click Next.
  5. On the Add-on Objects page, select Active Roles objects and Web Interface customization items for your add-on:
    • To add Active Roles objects, click Add Active Roles Objects. Then, on the Add Active Roles Objects page, select check boxes to specify the objects to be included in the add-on, and click OK.
    • To add Web Interface customization items, click Add WI Customization items. Then, on the Add Web Interface Customization Items page, specify the configuration from which you want to export customization items, select check boxes to specify the items to be included in the add-on, and click OK.
  6. Once you have selected add-on objects, click Next to continue.
  7. On the Save Add-on page, select the file your add-on will be saved to, and click Next.
  8. 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.
  9. On the Advanced Settings page, configure the following settings for your add-on and click OK:
    • Show in Raw mode only  Select this check box if you want Add-on Manager to display your add-on only when the Active Roles console is in Raw view mode.
    • Show Uninstall link  Select this check box to have Add-on Manager provide the Uninstall command for your add-on in the Active Roles console. If you don’t select this check box, the only way to uninstall your add-on is by using Add-on Manager command line. For a list of command-line options, type AddOnManager.exe /? at a command prompt.
    • Show Add-on Configuration page  By default, the add-on title link on the Add-on Manager page opens the Add-on Details dialog box. If your add-on has a configuration page, you can configure the add-on title link to open the configuration page. Select the Show Add-on Configuration page check box and supply the DN of the application object included in your add-on if you want the add-on title link to open the configuration page for your add-on.
    • Web Interface customization label  Use this text box to enter the Web Interface customization label. All Web Interface customization items added by this add-on will be marked in the add-on XML by this label. By default, the label consists of the add-on name and version.
    • Show Web Interface customization link  Select this check box to have Add-on Manager provide the Web Interface Customization link for your add-on in the Active Roles console. By clicking that link, you can select Web Interface configurations and sites you want your add-on to customize, and apply customization items to the selected configurations and sites.
    • Apply customization to Site for Administrators  Select this check box for your add-on to apply Web Interface customization items to the Active Roles Web Interface site for Administrators.
    • Apply customization to Site for Help Desk  Select this check box for your add-on to apply Web Interface customization items to the Active Roles Web Interface site for Help Desk.
    • Apply customization to Site for Self-Service  Select this check box for your add-on to apply Web Interface customization items to the Active Roles Web Interface site for Self-Administration.
    • In the System Requirements area, specify minimum and maximum versions of the Active Roles product supported by your add-on.
    • In the Required add-ons area, click Add to specify add-ons that must be installed before installation of your add-on.
    • Pre-install script  Select this check box to specify a script to run before installing your add-on and enter the script in the text box. Note: Add-on Manager supports only PowerShell scripts.
    • Post-install script  Select this check box to specify a script to run after installing your add-on and enter the script in the text box.
    • Pre-uninstall script  Select this check box to specify a script to run before uninstalling your add-on and enter the script in the text box.
    • Post-uninstall script  Select this check box to specify a script to run after uninstalling your add-on and enter the script in the text box.
  10. Click Finish to create the add-on.

Editing an add-on

You can use the following steps to edit an add-on:

  1. To open Add-on Editor, click Create New on the Add-on Manager application page in the Active Roles console, or click Add-on Editor on the Start menu.
  2. In the Connect to Administration Service dialog box, select the Active Roles Administration Service you want Add-on Editor to connect to, and specify a user name and password.
  3. On the Create or Edit Add-on page, select the option Edit the following add-on and click Browse to select the add-on file. Click Next.
  4. On the General Add-on Settings page, if necessary, edit the information about your add-on and click Next.
  5. On the Add-on Objects page, review Active Roles objects and Web Interface customization items included in your add-on:
    • To add Active Roles objects, click Add Active Roles Objects. Then, on the Add Active Roles Objects page, select check boxes to specify the objects to be included in the add-on, and click OK.
    • To add Web Interface customization items, click Add WI Customization items. Then, on the Add Web Interface Customization Items page, specify the configuration from which you want to export customization items, select check boxes to specify the items to be included in the add-on, and click OK.
  6. Once you have selected add-on objects, click Next to continue.
  7. On the Save Add-on page, select the file your add-on will be saved to, and click Next.
  8. 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.
  9. On the Advanced Settings page, configure the following settings for your add-on and click OK:
    • Show in Raw mode only  Select this check box if you want Add-on Manager to display your add-on only when the Active Roles console is in Raw view mode.
    • Show Uninstall link  Select this check box to have Add-on Manager provide the Uninstall command for your add-on in the Active Roles console. If you don’t select this check box, the only way to uninstall your add-on is by using Add-on Manager command line. For a list of command-line options, type AddOnManager.exe /? at a command prompt.
    • Show Add-on Configuration page  By default, the add-on title link on the Add-on Manager page opens the Add-on Details dialog box. If your add-on has a configuration page, you can configure the add-on title link to open the configuration page. Select the Show Add-on Configuration page check box and supply the DN of the application object included in your add-on if you want the add-on title link to open the configuration page for your add-on.
    • Web Interface customization label  Use this text box to enter the Web Interface customization label. All Web Interface customization items added by this add-on will be marked in the add-on XML by this label. By default, the label consists of the add-on name and version.
    • Show Web Interface customization link  Select this check box to have Add-on Manager provide the Web Interface Customization link for your add-on in the Active Roles console. By clicking that link, you can select Web Interface configurations and sites you want your add-on to customize, and apply customization items to the selected configurations and sites.
    • Apply customization to Site for Administrators  Select this check box for your add-on to apply Web Interface customization items to the Active Roles Web Interface site for Administrators.
    • Apply customization to Site for Help Desk  Select this check box for your add-on to apply Web Interface customization items to the Active Roles Web Interface site for Help Desk.
    • Apply customization to Site for Self-Service  Select this check box for your add-on to apply Web Interface customization items to the Active Roles Web Interface site for Self-Administration.
    • In the System Requirements area, specify minimum and maximum versions of the Active Roles product supported by your add-on.
    • In the Required add-ons area, click Add to specify add-ons that must be installed before installation of your add-on.
    • Pre-install script  Select this check box to specify a script to run before installing your add-on and enter the script in the text box. Note: Add-on Manager supports only PowerShell scripts.
    • Post-install script  Select this check box to specify a script to run after installing your add-on and enter the script in the text box.
    • Pre-uninstall script  Select this check box to specify a script to run before uninstalling your add-on and enter the script in the text box.
    • Post-uninstall script  Select this check box to specify a script to run after uninstalling your add-on and enter the script in the text box.
  10. Click Finish to save your change to the add-on.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating