Skip to main content

Version: 24.10

Setup Journey SDK

If you have previously relied on Maestro and/or the Journey Manager (JM) Console to develop JM applications, you may not be familiar with using an IDE to achieve the same result. This guide does not assume any prerequisite knowledge, and is suitable for developers who have not had a lot of exposure to IDEs.

System Requirements​

Building Journey SDK applications requires Java, Groovy and Ant to be installed on your computer. The installers for many modern IDEs can install additional software products such as Groovy and Ant. If your IDE's installer does not include these products, you will need to add them to your IDE manually.

The following software product versions are recommended for use with Journey SDK.

info

Some Java 11 features are not available with Groovy 2.4.

Install Journey SDK​

To install Journey SDK:

  • Download Journey SDK (login required) from the Temenos Journey Manager resources website. The distribution file is called transact-sdk-<version>.zip; for example transact-sdk-23.4.0.zip.
  • Unzip the distribution ZIP file into a folder of the same name as the ZIP file.
note

It is important that you extract the ZIP file into the correctly named folder, otherwise classpath settings for scaffolded projects will not resolve classes correctly.

(Optional) Install Maven Plugin​

The optional Journey SDK Maven plugin includes a set of Maven goals and build lifecycles that support Journey SDK platform development.

note

In order to use the Journey SDK Maven plugin, you need access to the Temenos Journey Manager Artifactory. If you don't have this access, contact your Temenos support representative to request access.

To install the Journey SDK Maven plugin:

  • Download the Journey SDK Maven plugin (login required) from the Temenos Journey Manager resources website. The distribution file is called transact-sdk-maven-<version>.zip; for example transact-sdk-maven-23.4.0.zip.
  • Extract the contents of the distribution file into your Journey SDK folder.

Configure Journey Manager Permissions​

To access SDK functionality in Journey Manager, each application developer must be provisioned a role or roles which have one or more of the following Journey Manager permissions.

  • REST Application Package API
  • REST Delivery Service API
  • REST Form Groups API
  • REST Groovy Service Invoke
  • REST Service Definitions API

For security reasons, none of these permissions are assigned by default to existing Journey Manager roles; therefore, suitable roles must be assigned to user accounts manually.

Best practice is to create a new role or roles, such as 'IDE Developer' and assign permissions to the Journey Manager module as required.

Assign permissions to a role in Journey Manager

  1. IDE Developer role
  2. Journey Manager module
  3. Assigned permissions

To provide even finer granularity, create roles such as 'IDE Application Package Developer' and assign individual permissions to it.