Lotus Expeditor Client for Desktop and Devices, Version 6.1.x
Operating systems: Linux on x86, Symbian, Windows

Required and optional parameters (NativeAppBundle command)

This section describes the required and optional parameters.

NativeAppBundle command parameters are separated into required and optional parameters.
Notes:
  • When specifying path names, use "/" or "\\" to specify directories.
  • The NativeAppBundle command expects valid input. The command performs no input validation and results may be unexpected if invalid input is entered.
  • Start of changeWhen specifying a parameter value, such as yes or no, the value must be in the local language. Use the -Help parameter to view applicable values.End of change

Required parameters (NativeAppBundle command)

Table 1. Required NativeAppBundle parameters
Parameter Description
-BundleName Name of the native software bundle. The bundle name is required.
-InputDirectory Full path name of the directory for the files in the native software bundle. The input directory is required.
-InstallDirectory Full path name of the directory on the device where the files in the native software bundle are installed. The install directory is required.

Optional parameters (NativeAppBundle command)

Table 2. Optional NativeAppBundle parameters
Parameter Description
# Use a # symbol at the first position of the line in the parameter file for writing comments.
-BuildDirectory The name of the directory where the SMF JAR file is located.
-BundleVersion The version number of the native software bundle. The default value is 1.0.0.
-BundleDescription The description of the native software bundle. The default value is BundleName.
-JarName The name of the native software bundle JAR file. The default value is BundleName.
-Prereq Identifies the bundle name of the native software bundle which is a prerequisite to the bundle being installed.
-Install Install program to run on the device after all the files in the native software bundle have been installed. The full path name of the program on the device must be specified.

The -Install option is only invoked if the bundle is distributed with the Auto Start parameter set to True.

Parameters can be passed to the program.

Note: The Lotus® Expeditor Client for Devices does not support the -Install parameter.
-PreInstall and -PostInstall Specify a program to run before, after, or both, the installation program (specified by -Install) runs.
You can use one or more of the following options:
  • -PreInstall=file_name_to_run
  • -PostInstall=file_name_to_run
Optionally, installation verification steps can be included with the -PostInstall parameter.
-WhenToRunPostInstall Determines when the post-install program is run. The allowed values are:
always
Always run the post-install program
afterInstallFailure
Only run the post-install program if the installation fails.
afterInstallSuccess
Only run the post-install program if the installation is successful.
-Uninstall Uninstall program to run on the device prior to the installed files being removed when the native software control bundle is uninstalled. The full path name of the program on the device must be specified.

Parameters can be passed to the program.

Note: The Lotus Expeditor Client for Devices does not support the –Uninstall parameter.
-RemoveOnUninstall Determines whether files are removed when the native software control bundle is uninstalled. The files to be removed are in the directory identified by the -InstallDirectory parameter.

The valid values are yes or no.

The default value is yes.

-CleanupAfterInstall Determines whether files are removed when the standard native software bundle installation program is installed. The files to be removed are in the directory identified by the -InstallDirectory parameter.

The valid values are yes or no.

The default value is no.

-Start Start program to run on the device every time the native software control bundle is started.

When a native software bundle is distributed, the bundle state is at an "installed" state when Auto Start is set to True. Use a bundle control job with a Start action to start the native software control bundle.

The full path name of the program on the device must be specified.

Parameters can be passed to the program.

The -Start option is not invoked during the bundle start of the initial distribution of the package. If the -Start option has been started by using the bundle control job and is not stopped before the OSGi run-time is stopped, every restart of OSGi run-time will restart -Start option.

-Stop Stop program to run on the device every time the native software control bundle is stopped. The full path name of the program on the device must be specified.

Parameters can be passed to the program.

Use a bundle control job with a "stop" action to stop the native application control bundle.

-IgnoreNonZeroInstallRC Use the return code failure parameter (-IgnoreNonZeroInstallRC) to determine whether or not to fail the job if the return code for the install step (INSTALL_EXIT_VALUE) is non-zero. Some commands use non-zero return codes to indicate a successful condition. The allowed values are:
yes
Fail the job (default value)
no
Do not fail the job
If the install step fails because of a non-zero return code (INSTALL_EXIT_VALUE), the device is restarted only if a restart was specified after the corresponding install step.

For pre-install (PRE_INSTALL_EXIT_VALUE) and post-install (POST_INSTALL_EXIT_VALUE) steps, a non-zero return code always indicates a job failure. When a job failure is detected, further steps are not attempted (except if INSTALL_EXIT_VALUE is non-zero and -IgnoreNonZeroInstallRC=no).

-WorkingDirectory The path to the working directory. The default is current directory.

You must have R/W/X access to the working directory. If the specified working directory does not exist, a new directory is created and deleted after use. All files created should be deleted after use.

-PrereqVerison The minimum version number of the prerequisite bundle. The format for the version must be:
n 
n.n 
n.n.n 
If the prerequisite version is not specified, it defaults to the most recent version.

The automatic prerequisite resolution tool chooses at least the specified version number. For example, if the specified version is 1.7.1 and the available versions are 1.7.0, 1.7.1 and 1.7.2, by default, 1.7.2 would be download.

-Help Displays the program syntax. All other parameters are ignored.
Related concepts
Job options and tasks for distributing native software bundles (OSGi bundles)
Native software distribution jobs with OSGi bundles


Library | Support | Terms of use |

Last updated: January 21, 2008
(C) Copyright IBM Corporation 2006, 2008. All Rights Reserved.
This information center is built on Eclipse. (http://www.eclipse.org)