Configure Modules

   Journey Manager (JM) The transaction engine for the platform.  |    System Manager / DevOps  |  23.04This feature was updated in 23.04

A variety of modules can be installed in your Journey Manager environment according to your requirements and license agreement. These modules are selected during Journey Manager installation. Subsequently, Manager allows you to view, configure, and remove the installed modules. For more information, see Installation guide > Modules and Form Spaces.

If you can't see a module you are after, it is possible it has not been installed, so check with your system administrator or the Cloud Services team.

View Modules

To view the modules, select System > Modules Config.

To search for a module, type its name and click Search.

Click Clear to reset the search criteria.

Click Export Data to export the displayed data as a Microsoft Excel (XLS) file.

Configure a Module

To configure a module:

1. Select System > Modules Config.
2. Locate a module and click Edit.
3. Select the Module tab to update the module's hosting configuration.

   

4. Update the portal application fully qualified domain name in the Context Path field, for example, https://my-domain.com/manager/.
5. Select a security manager from the Security Manager dropdown list.
6. Click Save to update the changes.
7. Select the Properties Edit tab to update the module's specific configuration. Each module has different properties which are described below.
8. Select the Properties tab to see all the properties in a table format.
9. Click New to add a new property.



10. Enter the property name in the Name field.
11. Provide a meaningful property description in the Description field.
12. Select a property type from the Type dropdown list, which can be one of the following:
    • Boolean
    • CSV
    • HTML
    • Image
    • JSON
    • List
    • Long Text
    • Number
    • String
13. Click Save to update the changes.

Remove a Module

To remove a module:

1. Select System > Modules Config.
2. Locate a module and click Remove Portal to delete it.

Configure the Transact Exchange Module

To configure the Transact Exchange module's properties:

1. Select the Properties Edit tab.

   

2. Update authentication credentials used to generate auth header for API calls the API Access Key field.
3. Edit the Base URI to the API Gateway hosting the remote Exchange APIs in the API Endpoint field, for example, https://api.my-domain.com.
4. Edit authentication credentials used to generate authentication header for API calls in the API Secret Key field.
5. Click the CORS Headers link to update the Cross-Origin-Resource-SharingCross-Origin Resource Sharing (CORS) is a mechanism that uses additional HTTP headers to tell a browser to let a web application running at one origin (domain) have permission to access selected resources from a server at a different origin. A web application executes a cross-origin HTTP request when it requests a resource that has a different origin (domain, protocol, and port) than its own origin. (CORS) security HTTP header values.
Note

A form space can have the CORS Headers property configured as well.

6. Update the Exchange Dashboard URL in the Exchange Dashboard URL field, for example, https://dashboard.my-domain.com.
7. Click Save to update the changes.

Configure the Journey Operations Module

To configure the Journey Operations module's properties:  |  22.10 This feature was introduced in 22.10.

1. Select the Properties Edit tab.

   

2. Click the CORS Headers link to update the Cross-Origin-Resource-Sharing (CORS) security HTTP header values.
3. Select the CSRF Protection to enable Cross Site Request ForgeryCross-site request forgery (CSRF), also known as one-click attack or session riding, is a type of malicious exploit of a website where unauthorized commands are transmitted from a user that the web application trusts. protection.
   Note

   You must restart the form space for the change to take effect.

4. Click the Email 2 FA Message link to edit the email message for 2FA user account enrollment.
5. Edit the Email 2 FA Subject.
6. Click the Param Value Validation Def link to edit API update param value validation definition.
7. Click Save to update the changes.

Configure the Transact Insights Module

To configure the Transact Insights module's properties:

1. Select the Properties Edit tab.

   

2. Click the CORS Headers link to update the Cross-Origin-Resource-Sharing (CORS) security HTTP header values.
3. Edit a dashboard URL in the Insights Dashboard URL field, for example, https://dashboard.my-domain.com.
4. Edit an URL of a visualizer in the Insights Visualiser URL field, for example, https://visualizer.my-domain.com.
5. Click Save to update the changes.

To configure the Transact Maestro module's properties:

1. Select the Properties Edit tab.

   

2. Click the CORS Headers link to update the Cross-Origin-Resource-Sharing (CORS) security HTTP header values.
3. Click the Email 2 FA Message link to edit the email message for 2FA user account enrollment.
4. Edit the Email 2 FA Subject.
5. Create or update a message shown on the Maestro login page in the Login Message field.
6. Click Save to update the changes.

Configure the Transact Manager Module

To configure the Transact Manager module's properties:

1. Select the Properties Edit tab.

   

2. Click the Admin Environment CSS Style link to update the environment label style of the module.
3. Edit a name of the server environment in the Admin Environment Name field to distinguish between various environmanet. This name is displayed in the Screen Header of the Management Dashboard.
4. Select the Authenticated Web Services.
5. Select the Browser Auto Logout.
6. Click the CORS Headers link to update the Cross-Origin-Resource-Sharing (CORS) security HTTP header values. For more information, see standard form space properties.
7. Select the CSRF Protection to enable Cross Site Request ForgeryCross-site request forgery (CSRF), also known as one-click attack or session riding, is a type of malicious exploit of a website where unauthorized commands are transmitted from a user that the web application trusts. protection. This setting is only relevant for the /manager and /workspace contexts.
Note

You can turn off some of the CSRF security hardening settings in non-production environments to make it easier to work with multiple browser tabs open at the same time.

8. Select the CSRF Protection Host Check to enable Cross Site Request Forgery protection host check. This setting is only relevant for the /manager and /workspace contexts.
9. Update the Documentation Url, for example, https://docs.my-domain.com.
10. Click the Email 2 FA Message link to edit the email message for 2FA user account enrollment.
11. Edit the Email 2 FA Subject, which is an email subject for 2FA user account enrollment.
12. Select the Production Mode checkbox to enable the module to be run in the production environment. This is selected by default.  |  23.04 This feature was introduced in 23.04

    To help you avoid enabling the Groovy Debug Logging option for Groovy services and functions by mistake in a production environment, Manager checks if the Production Mode option is selected and then sets the Groovy Debug Logging option to false for them.

    When you import a Groovy service or a function, Manager performs the same check and set the Groovy Debug Logging option to false even if it was set to true in an archive file. This is recorded in the Audit Log

13. Select the Show Deprecated Features to enable access to deprecated features.
14. Click Save to update the changes.

Configure the Transact Receipts Module

No extra configuration is required for the Transact Receipts module.

Next, learn about server nodes.