Running a Goal

Each JM SDK Maven Plugin goal is responsible for executing one specific task. You can run multiple goals in sequence to perform more complex actions.

All goals in this plugin require arguments to be specified, and these can be provided either in property files or as command-line parameters. Each new Maven project provides a number of base parameters configured in the build.properties and transact-auth.properties files. Some examples of base parameters are app.name, archive.file, manager.url, and manager.username.

Defining goal parameters in *.properties files reduces or eliminates the need to pass these parameters on the command line. For example, the tm-sdk:app-scaffold-connect goal, which scaffolds an application package connection, has two mandatory properties: dir and connection.name. If the dir property is defined in a *.properties file, only the connection.name parameter needs to be provided on the command line. The full Maven command looks like this:

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

Note that the command above includes the initialize phase which is required by all goals and lifecycle phases to read the base parameter values from build.properties and transact-auth.properties.

The following sections list all of the available goals, and provide a usage example for each goal.

Running a Lifecycle Phase

A Maven phase represents a stage in the build lifecycle. Each phase is a sequence of one or more goals. Phases are executed in a specified order. This means that if we run a specific phase, it executes all the preceding phases as well as the specified phase and all configured goals.

For example, the app-package phase is the third phase in the App build lifecycle, preceded by the app-imports and app-typecheck phases (see App Lifecycle Phases below). As each phase is linked to a single goal, running the app-package phase is equivalent to running the following goals in this order:

mvn initialize tm-sdk:svc-imports
mvn initialize tm-sdk:svc-typecheck
mvn initialize tm-sdk:app-package

The following sections list all of the available phases, and provide a usage example for each phase.