Documentation Center

Viewing the details of an Add-on

On the Add-ons screen, you can select an existing Add-on package to view more information on the package and the individual Extensions contained within it.

Procedure

  1. From the slide-out navigation menu, select Add-ons.
    The Add-ons page appears, showing the Manage tab.
  2. In the list of Add-ons, locate the Add-on you want to view, and select its row.
    A details page for the Add-on opens, providing details about the Add-on:
    General Add-on properties
    • the name of the Add-on
    • the version of the Add-on
    • the author of the Add-on
    • the Add-on icon
    • a description of what the Add-on does
    • the status of the Add-on (shown in the panel at right)
    Add-on status
    The status of an Add-on can be one of the following:
    StatusDescription
    Waiting for configurationThis status is returned when the Add-on requires a custom configuration, to be supplied by an application administrator, and will not be active until that point.
    Pending ActivationThis status is returned when the Add-on is in a queue and should be activated shortly.
    FailThis status is returned when the Add-on package (ZIP file) could not be properly unpacked. Among the possible reasons for this failure are:
    • The ZIP file is corrupted.
    • The ZIP file does not contain a manifest.json file in its root directory.
    • The manifest.json file is invalid.
    • The ZIP file could not be unpacked to the destination folder, because the application has no write rights to that directory.
    • At least one Extension failed.
    SuccessThe deployment of the Add-on was successful.

    Depending on the status returned, more detailed information may be available in the Message property of the reply.

    Extensions list
    You also see a list of the individual Extensions that are part of the Add-on, along with a Refresh button that you can use to update the list to include the most recent status of the Extensions. For each Extension, you see:
    PropertyDescription
    NameThe name of this Extension
    TypeThe type of this Extension, that is, which part of the product it extends
    StatusThe status of this Extension.
    Extension status
    The status of an Extension can be one of the following:
    StatusDescription
    Waiting for configurationThis status is returned when the Add-on that contains this Extension requires a custom configuration, to be supplied by an application administrator, and will not be active until that point.
    Pending ActivationThis status is returned when the Add-on that contains this Extension is in a queue and should be activated shortly.
    FailThis status is returned when the Extension failed to initialize.
    SuccessThe deployment of the Extension was successful.
    DisabledThe custom configuration file associated with the current Add-on specifies that in a specific environment or environments, the Extension must be disabled.

    Depending on the status returned, more detailed information may be available in the Message property of the reply.

    Actions
    At top right, you also see buttons to perform actions on the Add-on:
    ButtonDescription
    DownloadDownload the Add-on package (ZIP file) to a folder on your local machine or local file system.
    RemoveRemove this Add-on from the environment.
    UpdateUpload a package (ZIP file) that contains a more recent version of this Add-on. The manifest.json manifest file within this ZIP file must have an id property set to the same value as that of the current Add-on.
  3. To exit the details page, click Back to Add-ons.