Configure Modules

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

A variety of modules can be installed in Journey Manager according to your requirements and license agreements. 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.

Note

If you can't see a module you are after, it is possible that 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.

Manager view mproduct modules

The list displays the following details:

  • Name: a name of a module.
  • URL: a context path of a module, which is used by services, application forms, and REST APIs.
  • Description: a meaningful description of a module.
  • Version: a version of a deployed module.
  • Last Modified: a day when a module was modified and a user who modified it.
  • Module WAR File: a file name of a deployed WAR file containing a module.

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.
    Manager configure a module
  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, which will be used authenticate and authorize users trying to access this module via the Context Path URL.
  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.

Each module has some specific configuration, so let's look at each of the modules in more detail.

Configure the Transact Exchange Module

To configure the Transact Exchange module's properties:

  1. Select the Properties Edit tab.
    Manager configure module's properties of Exchange
  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.
  6. Note

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

  7. Update the Exchange Dashboard URL in the Exchange Dashboard URL field, for example, https://dashboard.my-domain.com.
  8. 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.
    Manager configure module's properties of Operations
  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.
    Manager configure module's properties of Analytics
  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.

Configure the Transact Maestro Module

To configure the Transact Maestro module's properties:

  1. Select the Properties Edit tab.
    Manager configure module's properties of Maestro
  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

One of the most important module's configuration is a context path, which can be used by various services. The Configuration Service requires the correct context path set up before it can be run to update and create system configurations. You can configure the content path any time after Manager is installed. However, the installer allows you to do it during the system installation. For more information, see Installation > Context Path.  |  24.04 This feature was introduced in 24.04

To configure the Transact Manager module's properties:

  1. Select the Properties Edit tab.
    Manager configure the Transact Manager module
  2. Click the Admin Environment CSS Style link to update a CSS style of the Admin Environment Name. For example,
    #environmentCssStyle {
        position: absolute;
        top: 10px;
        text-align: center;
        width: 100%;
    }                   
    #environmentCssStyle span { 
        color: #000000;
        background-color: #fcfcfc;
        font-weight: bold;
        padding: 3px 6px;
        border: 1px solid #a0a0a0;
    }
  3. Edit a name of the server environment in the Admin Environment Name field to distinguish between various environments. This name is displayed in the Screen Header of the Management Dashboard.
  4. Edit a comma-separated list of allowed hostnamesHostname is a label that is assigned to a device connected to a computer network and that is used to identify the device. in the Allowed Host Names field. The default is to allow any hostname.
    Note

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

  5. Select Web Services requiring authenticated and authorized access control from the Authenticated Web Services dropdown list, which can be one of the following:
    • Groovy and Task Web Services:
    • All Web Services:
    • No Web Services:
    • Blank:
  6. Select the Browser Auto Logout to automatically logout any open browser windows when the Security Manager Session Timeout has been reached. This is done by running a JavaScript.
  7. 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.
  8. 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.

  9. 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.
  10. Edit a URL to a documentation site in the Documentation Url field. The default is https://journey.temenos.com/docs/product-document.html.This URL is used to point to several specific sections of the documentation, such as Journey SDK, Services Guide and Fluent API. For more information, see Journey Manager Developers Documentation.
  11. Click the Email 2 FA Message link to edit the email message for 2FA user account enrollment.
  12. Edit the Email 2 FA Subject, which is an email subject for 2FA user account enrollment.
  13. 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

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

Configure the Manager API Module

The Manager API module provides the Journey Manager API (Fluent, REST, SOAP) endpoints that can be authenticated by using a security manager that is different to one configured in the Transact Manager module.  |  24.10 This feature was introduced in 24.10

To call the Journey Manager API, you need to use the URL defined in the Context Path of the Manager API module, for example, https://my-domain.com/manager-api/.

Note

You can also call the API using the Transact Manager module, for example, https://my-domain.com/manager/.

To configure the Manager API module's properties:

  1. Select the Properties Edit tab.
    Configure Manager API module properties.
  2. Configure properties as described in Configure the Transact Manager Module.

Configure the Transact Receipts Module

No extra configuration is required for the Transact Receipts module.

Remove a Module

Manager allows you to remove a module if you wish to do so.

To remove a module:

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

Next, learn about server nodes.