Using the single command method for command line building

The single command method is one method you can use for command line building in Designer.

Overview

To use the single command method, you must use the following format:

designer -RPARAMS -vmargs -Dcom.ibm.designer.cmd=<single command>

The single command is made up of a number of comma separated components or values, and is contained within double quotes. The following is an example of the format with components:

"<clean>,<exit>,<file name>,<job name>,<file path>,<file name>"

The supported values for each of the components are:
  • clean - True or False
  • exit - True or False
  • file name - A string value containing the name of the NSF/NTF to be created. If no file extension is included, then a type of NSF will be created.
  • job name - The name of the job to be run
  • file path - the path to the .project file of the repository to be built

The single command method feature also supports a number of jobs including the following:

importandbuild <ondisk project path> <nsf name>
Imports the on-disk, creates the NSF, and begins the association. Processing of the next job does not wait for the sync or build to finish. Note that this command will fail if the on-disk project already exists in the Designer workspace. Using clean will remove these when done processing. Specifying an already existing NSF file will not cause the build to fail.
wait <project name> <# of retries>
Waits for the given project to complete all build or sync operations. Since it is not deterministic when (if) either event will start or finish, this loops a number of times looking before failing.
config <stop on error - true/false> <exit on error - true/false>
Waits for the given project to complete all build or sync operations. Since it is not deterministic when (if) either event will start or finish, this loops a number of times looking before failing.
clean
Deletes all projects create so far in this execution. This job does NOT delete the project contents.
exit [# milli delay] [restart-true/false] [resume - true/false]
Exits Designer. restart will restart the Designer, and resume will tell Designer to continuing processing the command file if there are commands after this exit command.

This code sample illustrates an example command with jobs included:

designer.exe -RPARAMS -vmargs -Dcom.ibm.designer.cmd="true,true,Discussion.nsf,importandbuild,C:\XPageApps\Discussion\.project,Discussion.nsf"

Using the console with the single command method

The output of your build can be viewed in a console by specifying the console as a program argument.

For example:

designer -RPARAMS -console -vmargs -Dcom.ibm.designer.cmd=<single command>

Using logging with the single command method

The command line build method also writes to its own log files:
  • HEADLESS0.log
  • HEADLESSJOB0.log
These files are stored in the Notes Data directory