Viewing and managing 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. You can also perform a number of actions to manage the Add-on, including uploading a new configuration.
Procedure
- From the slide-out navigation menu, select Add-ons.
The Manage tab of the Add-ons screen shows all of the Add-ons that are present in this environment (including disabled Add-ons).
- In the list of Add-ons, select the row of Add-on you want to view.
The details page gives more information about the Add-on, including the following:
- Add-on status
-
The status of an Add-on can be one of the following:
Status Description Success The deployment of the Add-on was successful. Pending Activation The package for this Add-on has been uploaded, and Tridion Sites will activate it as soon as possible. Waiting for configuration The Add-on requires a custom configuration file to be uploaded, to be supplied by an application administrator. The Add-on will not be active until that point. Disabled The Add-on is still loaded in the system but disabled for use across all services. You can re-enable it, as needed. Failed The Add-on has failed to load. For information on resolving a failed Add-on, see the related troubleshooting topic. Depending on the status returned, more detailed information may be available in the
Messageproperty of the reply. - Extensions list
-
This section shows 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:
Property Description Name The name of this extension Type The type of this extension, that is, which part of the product it extends Status The status of this extension Depending on the status returned, more detailed information may be available in the
Messageproperty of the reply. - Actions
-
The buttons located at the top right of the screen enable you to perform the following actions on the Add-on:
Button Description Update Upload 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
idproperty set to the same value as that of the current Add-on.Download Download an Add-on package to your browser's default download location. Each Add-on is downloaded as a ZIP file. Disable Disable an Add-on across the environment. The Add-on will remain loaded in the system and you can re-enable it, as needed. Enable Enable an Add-on that is currently disabled. Delete Permanently remove an Add-on from the environment. This includes deleting the Add-on data from the database and the package from its storage location. CAUTION:Be aware that you cannot undo this action. As a precaution, we recommend downloading both the Add-on and the associated configuration before deleting the Add-on.
- To exit the details page, click Back to Add-ons.