Installing Modules

This document demonstrates all the possible ways a user can install a Module in the platform.

Module not visible after installing?

After installation, Modules Flow steps cannot be directly used in the designer entities. Users must create a Module Dependency at the Project level to expose it to that specific Project. To create a Dependency, refer to Project Dependencies.

Uninstalling Modules

Uninstalling Modules without understanding their dependencies can lead to issues and potentially break the functioning of other components. It is not recommended to uninstall a Module. Please contact support@decisions.com for any assistance.

From the Platform

All the Modules can be directly installed from the platform. The following section demonstrates how to install a Module from the platform.

1. Access the list of Modules by navigating to System > Administration > Features.

2. Hovering on the Modules will show two buttons at the bottom.

   1. Details: Clicking this will reveal a dialog box with module details and links to documentation sites.

   2. Install: Button to install the Module.

3. Click on Install. A confirmatory dialog box appears. Click on Continue. A window will appear indicating the installation progress of the Module and its dependent Modules.

   

4. After the Module is installed successfully, the window will display the Installed in orange color to indicate completion.

Version 9 Changes

Starting in v9, Identity Provider Modules such as Okta, OpenID, and SAML will not be stored with the rest of the available Modules. Instead, they will be able to be found by navigating to System > Security > Identity Providers.

Installing Modules from GitHub

When the Decisions Server is unable to make external requests to GitHub, admin users can download and install the GitHub Modules manually. The following section demonstrates how to download and install a Module from GitHub.

1. Visit the GitHub Modules Page and click on the desired Module.

2. Click on Releases.

   

   
   

3. Expand the appropriate version and Click on the Decisions[Module_Name].zip. A .zip file then gets downloaded.

4. To install the Module in the platform, refer to the next section, Uploading and Installing a Custom Module.

   

Uploading and Installing a Custom Module

1. Navigate to the System > Administration > Features.

2. Click on the Upload and Install Module located at the top of the Features Page.

3. Upload the .zip file in the file upload area.

4. Ensure that the Install Module is checked. If unchecked, this will just upload the module into the platform, and users can choose to install it later.

5. Click Ok. The Module will get installed.

Updating a Custom Module

Once a Custom Module is installed, users can update it by repeating the same steps performed to upload the module. However, to reflect the changes, users must restart the Decisions Server.

Module Dependencies

After a Module is installed a dependency must be made to the Project that it will be used in. For more details see Project Dependencies.

1. Go to the Project
2. In the Folder Tree select Configurations > Dependencies.
3. Press the MANAGE button, then select the Modules category.
4. Pick the needed Module.

Scripting Modules

One exception to this is scripting Modules such as Python or R. Custom steps created through the use of those Modules can be available in Projects that do not have dependencies to the Module. However, the Project will need a dependency to the Project where the Module was used to create the Step.

Example:

Project A has a dependency to the Python Module. A user created a Step called SnakeDance. 

Project B needs to use the SnakeDance step. It does not have any dependencies. The step does not appear in the Flow Designer Toolbox.

Project B creates a dependency to Project A. Now the SnakeDance step appears in the Flow Designer Toolbox.

Feature Changes