When your application creates a Run Command On Workstation job (F_INSTALLJOB folder), some scalars (such as Activate time and Send phase) must have valid values so that the job activates, sends, distributes, and completes successfully. Other scalars (such as Job comment) are optional or are used by the SMS system to report status (such as Job status) or other system information (such as Job ID and Cancel mode). Still other scalars must be set if another scalar is set to a certain value (for example, the Query ID scalar must be set if Job target is set to WKSTAJOB_TGT_QUERY).
This section lists the scalars that must be set to create a valid Run Command On Workstation job.
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_INSTALLJOB folders, the following scalars must be set:
| Scalar name | Data type | Requirement |
|---|---|---|
| Job comment | String | Optional. |
| Activate time | Time | Required. |
| Priority | Integer | Required. |
| Repeat mode | Integer | Required. |
| Package ID | String | Required. |
| Job target | Integer | Required. |
| Query ID | String | If Job target is set to WKSTAJOB_TGT_QUERY, this scalar is required. Otherwise, it is not used. |
| Machine group name | String | If Job target is set to WKSTAJOB_TGT_MACHGROUP, this scalar is required. If this scalar is set to NULL, the Default Servers machine group will be used. Otherwise, it is not used. |
| Machine path | String | If Job target is set to WKSTAJOB_TGT_MACHPATH, this scalar is required. Otherwise, it is not used. |
| Limit to sites | Integer | Required. |
| Include subsites | Integer | If Limit to sites is set to JOBTGT_SITEGROUP or JOBTGT_SITE, this scalar is required. Otherwise, it is not used. |
| Site limit name | String | If Limit to sites is set to JOBTGT_SITEGROUP or JOBTGT_SITE, this scalar is required. Otherwise, it is not used. |
| Send phase | Integer | Required. |
| Distribute phase | Integer | Required. |
| Distribution servers | String | If Distribute phase is set to WKSTAJOB_DIST_SPECIFIED, this scalar is required. If this scalar is set to NULL, the Default Servers machine group will be used. Otherwise, it is not used. |
| Run workstation command | Integer | Required. If this scalar is set to FALSE, there is no Run phase for the job. |
| WCL name | String | If Run workstation command is set to TRUE, this scalar is required. Otherwise, it is not used. |
| Offer time | Time | If Run workstation command is set to TRUE, this scalar is required. Otherwise, it is not used. |
| Mandatory time | Time | If Use mandatory time is set to TRUE, this scalar is required. If Run workstation command is set to FALSE, this scalar is not used. |
| Use mandatory time | Integer | If Run workstation command is set to TRUE, this scalar is required. Otherwise, it is not used. |
| Force over slow link | Integer | If Use mandatory time is set to TRUE, this scalar is required. If Run workstation command is set to FALSE, this scalar is not used. |
| Use expire time | Integer | If Run workstation command is set to TRUE, this scalar is required. Otherwise, it is not used. |
| Expire time | Time | If Use expire time is set to TRUE, this scalar is required. If Run workstation command is set to FALSE, this scalar is not used. |