Last updated on April 08, 2016

Managing Extensions

Important

This is only applicable for On-Premise deployments.

This article will guide you through the various administrative actions relating to the managing of extensions within your Appspace instance.


Prerequisites

  • Portal Administrator permissions required

Disabling and Enabling Extensions

There are two different options for an administrator to remove access to an extension from a global level. If you have an extension on your Appspace instance that you choose to remove (possibly for re-installation or upgrade reasons) – you should use the Delete option to completely remove the extension from the Appspace instance. You also have the ability to Disable an extension which renders the extension inaccessible by all users on the server until it has been re-enabled. Disabling an extension will preserve all configurations, data files, and assets that are related to that extension.

  1. In Extensions, click the desired extension to be disabled, and click the Disable button.


  2. Click Yes to confirm.

  3. The disabled extension is grayed out (disabled), and is not accessible in the Appspace menu.

  4. To re-enable the extension, select the disabled extension, and click the Enable button.


Managing Role Accessibility

Each extension has by default certain role(s) associated with it that grants users with permissions to access the extension. As an administrator, you have the ability to fine-tune these roles (add or remove roles) for each extension. Current roles with accessibility to each extension is listed under the Roles column.

  1. In Extensions, click the extension name link to edit the roles of the extension.

  2. In the Extension Details page, scroll down to the Roles section to see the current assigned roles of the extension. Click on the Manage Roles button to edit the roles assigned of the extension.

  3. In the Manage Roles window, select the desired role(s) that are able to access the extension, and click OK.

  4. Verify the changes in the Roles section, and click Save to complete the process.


Acquiring Extensions

In addition to the Appspace extensions that come pre-installed, referred to as Core extensions, you may acquire additional ‘Premium’ extensions from the Downloads page. The Downloads page is accessible from the Systems group in the Appspace menu.

Within the Extensions page, you have the ability to download an extension to your local machine. This is accomplished by clicking the Download link under the Action column of the respective extension. The extension is downloaded to the default downloads folder and saved in the .zip file format.

Note

The appropriate Appspace Omni subscription or traditional license is required to install the extension to your Appspace instance.


Installing Extensions

In order to install additional extensions to your Appspace instance, you must already have the extension file downloaded. Extensions can be acquired from the Downloads page.

Note

Extension files are packaged in a .zip file format. Preserve the extension file in a .zip file format when installing.

  1. In Extensions, click the Install button.


  2. In the Create New Extension page, click the Browse icon and select the desire extension .zip file to be installed. Click Upload to continue.

    Note

    The upload process may take some time, depending on the extension’s file size and speed of the network connection between the local machine and the Appspace instance.

  3. Review and verify the installed extension details, as some detail fields are auto-populated with the default values of the extension. Click Save to complete the installation process.

    The newly installed extension is now available and appears in the Appspace menu.


Deleting Extensions

  1. In Extensions, click the desired extension to be deleted from the Appspace instance, and click the Delete button.


  2. Click Yes in the Confirmation window to continue deleting the extension.

    The deleted extension is no longer visible and removed from the Appspace instance.