Install a New Add-In

Using the Add-In Manager, you can quickly upload files and assign profile permissions to use the add-ins.

You can also specify custom values for .NET attributes from the Add-In Manager. Additionally, you can specify different values for each profile and interface and the specified values are stored in the Oracle database. This eliminates the need to store custom values for attributes in client-side XML configuration files.

The Add-In Manager is available to only those staff members with the Configuration permission selected on their profile’s Administration tab.

  1. Click Configuration on the navigation pane.
  2. Expand Site Configuration, then double-click Add-In Manager.
    The Add-In Manager opens on the content pane.
  3. To open an existing add-in for editing, click the add-in name. If the add-in’s .dll or .zip file has been modified or replaced by a different file, you can update the add-in to reflect the changes.
  4. To install a new add-in, click New, then select Agent Desktop Add-In.
    Note: When the Open window initially displays, only .dll files appear. To view .zip files, click the Files of Type drop-down list and select Compressed Add-In Files.
    1. Select the add-in’s file and click Open.
      The Add-In Details editor displays. The Name and API DLL Version fields are populated.

      Add-In Details

      Field Description
      Name The name of the .dll or .zip file you uploaded.
      API DLL Version The version of the add-in API that the file was built against.
      Created The date and time the add-in was initially uploaded.
      Created By The staff member who uploaded the add-in.
      Updated The date and time the add-in was most recently updated.
      Updated By The staff member who most recently updated the add-in.
  5. To select a different file for the add-in, click Folder in the Name field, select the file, and then click Open.
  6. To add a note to the add-in, enter it in the Notes field.
  7. To specify the profiles that can access the add-in, click Profile Access.
    1. Select the profile in the Profiles Allowed to Access section.
    2. Select the appropriate interface check boxes in this section. Only interfaces that the profile has permission to access are displayed in the Interfaces section.
    3. To give the selected profile access to the add-in on all interfaces, select the Select All check box.
    4. To grant add-in access to all profiles on all interfaces, click Apply All.
    5. To remove add-in access from all profiles and interfaces, click Clear.

    When you enable the add-in for a profile and interface, the class names, property names, and default values for the add-in’s configurable properties display.

  8. Select the property you want in the Server Configuration Properties section, then double-click the property’s Value field.
    1. To change the value for a property with a string or numeric type, enter the numbers or text you want for the property’s value.
    2. To change the value for a property with a Boolean (yes/no) type, select or clear the check box that displays.
  9. To specify different property values for another interface, select the interface and repeat step 7.
  10. To specify different property values for another profile, select the profile and repeat step 7.
  11. To automatically apply the property values you specified to other profiles and interfaces, click Apply, then select the appropriate option.
    1. To apply the property values to all interfaces for the profile, select Apply this Configuration to All Interfaces for the Selected Profile.
    2. To apply the property values to all profiles and interfaces, select Apply this Configuration to All Profiles and Interfaces.
  12. To automatically remove customized property values from profiles and interfaces, click Restore and select the appropriate option.
    1. To reset the values for all profiles and interfaces, select Restore the Default Configuration to All Profiles and Interfaces.
    2. To reset the values for all interfaces enabled for the selected profile, select Restore the Default Configuration to All Interfaces for the Selected Profile.
  13. Click Save.