Setting the Scalars for a New Package Folder

When your application creates a package (F_PACKAGE folder), some scalars (such as Name) must have valid values so that the package can be used for creating Run Command On Workstation jobs, creating Share Package On Server jobs, and detecting this package for the SMS computer inventory. Other scalars are optional (such as Comment) or are used by the SMS system (such as Key and Workstation transfer file).

This topic lists the scalars that must be set to create a valid package for use with Run Command On Workstation jobs, Share Package On Server jobs, network applications, or inventory.

Note that an inventory rules folder (which can be a subfolder within a package folder) contains only one scalar as well as one or more tokens that represent the set of files used to identify a package. See Setting Tokens for an Inventory Rules Folder.

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 F_PACKAGE folders, the following scalars must be set:

Scalar name Data type Requirement
Name String Required.
Comment String Optional.
Workstation package Integer Required.

If this scalar is set to TRUE, this package will be available for Run Command On Workstation jobs. 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.

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

Workstation root String This scalar is required for the package to be available for Run Command On Workstation jobs.
Workstation permissions Integer This scalar is required for the package to be available for Run Command On Workstation jobs.
Sharing package Integer Required.

If this scalar is set to TRUE, this package will be available for Share Package On Server jobs. The SMS API engine sets this scalar to TRUE if the package has the Server root and Share name scalars set.

If this scalar is set to FALSE, this package will not be available for Share Package On Server jobs.

Server root String This scalar is required for the package to be available for Share Package On Server jobs.
Share name String This scalar is required for the package to be available for Share Package On Server jobs.
Share permissions Integer This scalar is required for the package to be available for Share Package On Server jobs.
Inventory package Integer Required.

If this scalar is set to TRUE, this package will be inventoried on all computers in the current site and all subsites below it in the site hierarchy. The SMS API engine sets this scalar to TRUE if the package has an Inventory rules subfolder and the Inventory this package scalar for the Inventory rules subfolder is set to TRUE.

If this scalar is set to FALSE, this package will not be inventoried.