Journey SDK Maven plugin

   Temenos Journey ManagerPreviously known as the Transact Platform   |    Platform Developer |  22.04 This feature was introduced in 22.04.

The Journey SDK Maven plugin provides goals and lifecycles to build and deploy Journey Manager (JM) form applications from the Maven command line. Maven plugin goals provide functionality supporting Journey Manager platform development, and can be used in place of the Ant tasks used by all versions of Journey SDK. Two new customized lifecycles, app and svc, join Maven's built-in build lifecycles (default, clean and site) to enhance the Journey SDK CI/CD process. To learn more about this plugin, see Journey Manager SDK Maven Plugin.

Let's learn how to start a new Journey Manager project using the Journey SDK Maven plugin.

Requirements

When you build a Journey Manager project based on the Journey SDK Maven plugin project template, all required dependencies are downloaded from CS Artifactory including the Journey SDK Maven plugin. If you don't have access to CS Artifactory, contact your TJM support representative to request access. When your account is created, you'll receive an email that includes instructions for setting up the settings.xml file. Make sure your Maven settings.xml is configured to connect to the correct Artifactory in order to download the required dependencies.

Project setup

To learn how to setup a Journey SDK Maven project, see Setup Journey SDK > (Optional) Setup a Journey SDK Maven project.

Examples

Examples for all goals and phases are available in Journey SDK Plugin Examples.

  • Run a specific goal

    For example, run the app-scaffold goal:

    mvn initialize tm-sdk:app-scaffold
  • Run a phase

    For example, run the app-package phase:

    mvn initialize app-package

Development Tips

Passing arguments

There are two ways to pass input parameters to a Maven goal: command-line parameters, or POM properties.

  • Command-line parameters:

    Pass command-line parameters to a Maven goal using the -D or --define option. For example:

    mvn initialize tm-sdk:app-scaffold-connect -Dconnection.name="My Connect"
  • POM properties:

    POM properties are added to the pom.xml file. For example:

    <!-- Example parameter for app-scaffold-connect -->
    <connectionName>My Connect</connectionName>

    Then, when you run the goal, the property's value is loaded from the pom.xml file. For example:

    mvn initialize tm-sdk:app-scaffold-connect

Running unit tests

You can run unit tests on the command line or in your preferred IDE.

  • To run a unit test on the command-line:

    Start by running the mvnDebug command:

    mvnDebug initialize tm-sdk:app-scaffold-connect

    Now, you can debug your application on your local machine (using port 8000) by creating and running a remote JVM debug connection.

  • To run a unit test in an IDE such as IntelliJ IDEA:

    Open IntelliJ and configure Groovy Sources, Tests, Resources and Test Resources as shown below, then debug the unit test as required.

Next, learn about Continuous Integration.