Extensions

Updated: December 6, 2022
Contents

    The system provides a catalog of extensions that are available for your CloudBlue Connect account. Extensions are used to automate various business operations, streamline communication with your business partner, and simplify many other processes.

    Therefore, the system allows installing extensions from the catalog, redeeming invitation codes, access detailed information on each installation, and also uninstall an extension that is no longer necessary.

    Bring your own extension

    The Connect platform provides toolkits and libraries to quickly and easily deploy and manage your extensions. For more information on how to bootstrap your extension project, refer to the DevOps module documentation.

    The following describes the user interface for your available extensions and also demonstrates how to install an extension, how to redeem a code to install an extension provided by your business partners, and also how to uninstall an extension.

    Installation Instructions

    Extensions that are available for your Connect account are presented within the Catalog tab. In general, all extensions are grouped by a specific category. The system also allows accessing viewing all provided extensions within a category by clicking More next to your selected category.

    In case you want to install a presented extension, follow the steps below:

    Note

    The following steps demonstrate how to install extensions that are presented in the Catalog tab. If it is necessary to install an extension by using an invitation code, follow the instructions under the Redeeming Invitation Code heading.

    1. Access the extension details screen by clicking on the extension that you want to install. Use the provided information to learn more about on your selected extension (such as required permissions, associated UI components, version history, etc.).
    2. Click the Install button at the top-right corner of the details screen to start installing your selected extension.
    3. The system will ask to provide permissions to specific modules on Connect for your selected extension. Grant all permissions by clicking Install.

    Therefore, the system initiates the extension installation process and displays the corresponding Installing status within the details screen. When your extension is installed, the status will be switched to Installed and the system will also display the check icon next to your installed extension. The detailed insights on your installations can also be accessed via the Installations tab.

    Redeeming Invitation Code

    To successfully install an extension provided by your business partners, it is required to redeem a code that is generated by developers of this extension (or any other associates that can access a deployed extension project and create an invitation code). Once such a code is provided for your organization, redeem your code as described below:

    1. Access the Installations tab that is used to manage your extension installations.
    2. Open the additional menu by using the vertical ellipsis () button at the top-right corner of the screen. Thereafter, select the Redeem Activation Code option.
    3. Enter your invitation code to the following form and click Proceed.
    4. The system will ask to provide permissions to specific modules on Connect for your selected extension. Grant all permissions by clicking Install.

    As a result, your extension will be successfully installed via your provided invitation code. The system will also add a new installation to the list.

    Uninstalling Extensions

    In case certain extension is no longer relevant or required for your organization, the system allows uninstalling extensions by accessing the Installations tab. The following steps demonstrate how to remove an installation from your Connect account:

    1. Navigate to the Installations tab and locate an extension installation that you want to remove.
    2. Open the additional menu by using the vertical ellipsis () icon next to your selected installation and click Uninstall.
    3. Thereafter, the system asks to confirm uninstallation and optionally submit your feedback. Confirm your decision by clicking Uninstall.

    Consequently, your selected extension will be successfully uninstalled. If your removed extension is once again required for your organization, it will be possible to install an extension by using the catalog or redeeming a new invitation code.

    Is this page helpful?
    Translate with Google
    Copied to clipboard