Creating a Package for Run Command On Workstation Jobs

To create a package (F_PACKAGE) that can be used for Run Command On Workstation jobs (F_INSTALLJOB), some scalars must have valid values (such as the Name scalar). Other scalars are optional (such as Comment) or are set and used only by the SMS system (such as Key and Workstation transfer file).

The Workstation package scalar is used to indicate whether the package is available for Run Command On Workstation jobs. The SMS API engine sets the Workstation package scalar when the package is created. The SMS API engine sets this scalar to TRUE if the package has at least one Workstation Command Line subfolder and has the Workstation root scalar set.

Note that Required means that a valid value must be set. For more information about the range of valid values for a scalar, click on the scalar name in the following table. Your application is responsible for verifying that the value it sets for a scalar is valid.

For a package to be available for Run Command On Workstation jobs, the following scalars must be set (and the package must contain at least one workstation command line folder):

Scalar name Data type Requirement
Name String Required.
Comment String Optional.
Workstation package Integer Required. The SMS API engine sets this scalar to TRUE if the package has at least one Workstation Command Line subfolder and has the Workstation root scalar set.

When this scalar is set to TRUE, this package will be available for Run Command On Workstation jobs.

If this scalar is set to FALSE, this package will not be available for Run Command On Workstation jobs.

Workstation root String Required.
Workstation permissions Integer Required.