CICS build toolkit command line options

Summary of command line options

>>-+-build project-name-or-path--input path--+----------------------------------+--+--->
   |                                         '-target .target-file-or-target-ID-'  |
   +-resolve path--+-----------------+---------------------------------------------+
   |               '-properties path-'                                             |
   '-help--------------------------------------------------------------------------'
                                        .-encoding cp037---------.
>--output path--+--------------------+--+------------------------+--------------------->
                '-collectDiagnostics-'  '-encoding character-set-'

>--+---------+---+----------------+----------------------------------------------------><
   '-verbose-'   '-workspace path-'

List of command line options

--build, -b project-name-or-path

Specifies which CICS bundle projects, application projects, application binding projects, and platform projects to build from the directories that are specified by the --input option.

A project can be specified with either the symbolic name and version, for example MyBundleProject(1.0.1), or path to the project, for example /u/user/applications/testapplication. If you specify a symbolic name but do not specify a version, the CICS build toolkit builds the highest version of the project that is available. To build multiple projects in a single call, specify --build with multiple arguments, delimited by spaces. Alternatively, specify --build with no argument to build all projects in the path specified by --input.

The --build and --resolve options are mutually exclusive.

--collectDiagnostics, -c

Requests the collection of diagnostics data after a build completes.

The diagnostics data is stored in a .zip file. This data is written to the working directory in use when the build was started, or to your system's temporary directory if the working directory is read-only. You can send this diagnostics data to IBM® to help diagnose problems.

Alternatively, you can set the environment variable JAVA_TOOL_OPTIONS to -Dcollect.diagnostic.data to request the collection of diagnostics data.

--encoding, -e character-set

The IANA character set name that represents the default CCSID for the CICS region into which the bundle will be installed. If the option is not specified, the IANA character set cp037 is used. The encoding is used to convert Atom configuration files and JVM profiles that need representing in EBCIDIC.

For example, if the LOCALCCSID system initialization parameter for the CICS region is 00285, specify --encoding ibm285. For a list of CCSIDs and corresponding character set names, see CICS-supported conversions.

--help, -h

Prints a list of the available options.

--input, -i path

Specifies the path of the project that you want to build.

Multiple paths can be specified by using a space delimiter. You can also use an asterisk at the end of a path to specify all projects in that directory to build multiple projects in a single call, for example /path/to/top/level/directory/*.

--output, -o path

Specifies the path in which to place built or resolved projects.

The CICS build toolkit creates subdirectories for applications and bundles, built according to their symbolic name and version. If only applications or bundles are built, they are placed in /applications and /bundles subdirectories. If one or more application bindings are built, then all associated artifacts are placed in a directory structure that includes the platform name. Any applications or bundles not associated with a binding are placed in subdirectories as normal.

--properties, -p path

Specifies the path of a properties file outside of the built projects' directories.

You can use the --properties option to resolve variables in stand-alone bundles. Bundles within applications or platforms are not supported by this option. A properties file specified through the --properties option takes precedence over properties in the bundle.

For more information about how to define and use variables, see Variables and properties files definition.

--resolve, -r path

Specifies the path of the directory structure that is produced by a previous run of the CICS build toolkit.

This option replaces variables within the CICS bundle parts with corresponding values specified in the variables.properties file in the bundle root folder. For a stand-alone CICS bundle, values can also be specified in a variables.properties file that is specified by the --properties option, and take precedence. For a CICS bundle that is part of an application, values can also be specified in a variables.properties file in the application binding root folder, and take precedence. The variables.properties file must be in ISO-8859-1 (Latin 1) character set encoding.

The --build and --resolve options are mutually exclusive.

--target, -t .target-file-or-target-ID

Specifies which target platform to use.

The target platform defines the Java™ libraries (APIs) that are required to build referenced OSGi Bundle Projects and OSGi Application Projects. The target platform can be predefined, such as a CICS release, or can be an Eclipse .target file that is created by the user.

The following target platforms are available by default:

• com.ibm.cics.explorer.sdk.runtime41.target
• com.ibm.cics.explorer.sdk.runtime42.target
• com.ibm.cics.explorer.sdk.runtime51.target
• com.ibm.cics.explorer.sdk.runtime52.target
• com.ibm.cics.explorer.sdk.runtime53.target
• com.ibm.cics.explorer.sdk.runtime54.target
• com.ibm.cics.explorer.sdk.web.liberty51.target
• com.ibm.cics.explorer.sdk.web.liberty52.target
• com.ibm.cics.explorer.sdk.web.liberty53.target
• com.ibm.cics.explorer.sdk.web.liberty54.target

--verbose, -v

Provides extra details to the console about the progress of the CICS build toolkit.

--workspace, -w path

Specifies the path of the Eclipse workspace that the CICS build toolkit uses.

If this option is omitted, the CICS build toolkit creates a temporary Eclipse workspace that is deleted once processing is complete. If you use this option to specify a workspace, it is not automatically deleted on completion. For more information, see Managing Eclipse workspaces.