A system job folder (F_SYSTEMJOB) represents a job created by the SMS system to maintain the configuration at sites below the current site in the site hierarchy.
The SMS system uses system jobs to transfer instructions and data to other sites. For example, if you change a package's properties in the site's database, these package changes trigger a system job that updates the package in the databases of all primary sites beneath the current site.
Unlike other types of jobs, system jobs (except NAD transfer system jobs) are targeted for a single site and do not return job details or status information. However, system jobs created at a site appear in the Jobs window. Internally, SMS has full control over these jobs—it can cancel, activate, or delete system jobs.
Using the SMS API, your application can perform the following actions:
Note that your application can delete a system job from the site database only when it is active or after it has been completed or canceled by SMS.
Different types of system jobs perform different actions. The type of system job is identified by the Comment field in the system job folder.
A system job folder has the following properties:
| Property | Value | Description |
|---|---|---|
| Tag | "System job" | String. A description of the folder type. |
| Folder type | F_SYSTEMJOB | Integer. Folder type. |
| ID | jobID. For example, "RTM00001". | String. An eight-character identifier that the SMS system assigns to the job. Note that the first three characters are the site code for the site where the job was created. |
| Active filters | None | Integer. Filters that are directly activated on the folder. These filter types are used to retrieve the subfolders in the folder. |
| Immediate subfolders | None | Integer. Types of subfolders that the folder type can contain. |
| Number of scalars | 15 | Integer. Number of scalars for the folder type. |