Job type codes
Job type codes indicate what type of job a job is.
Code | Job Type | Description |
---|---|---|
1 | JOB_TYPE_CODE_SYNC_IN | Sync In: Imports all records or a delta set of records. |
2 | JOB_TYPE_CODE_SYNC_OUT | Sync out job. |
3 | JOB_TYPE_CODE_VALIDATION | Validates records. |
4 | JOB_TYPE_CODE_MIGRATION_IN | Migrate in job. |
5 | JOB_TYPE_CODE_UPDATE_ALL | Updates all records in a repository. |
6 | JOB_TYPE_CODE_DELIST_ALL | Unused. |
7 | JOB_TYPE_CODE_DELETE_ALL | Deletes all records from a repository. |
8 | JOB_TYPE_CODE_TRX_MANAGE_ALL | Unused. |
9 | JOB_TYPE_CODE_STATE_MANAGE_ALL | Updates state attribute settings for one or more records. |
10 | JOB_TYPE_CODE_UPDATE_BY_API | Updates one or more records. Initiated by an API call. |
11 | JOB_TYPE_CODE_MIGRATION_OUT | Migrate out job. |
12 | JOB_TYPE_CODE_EXPORT | Performs Current View or Template exports of records. |
13 | JOB_TYPE_CODE_REBUILD_INDEX | Unused. |
14 | JOB_TYPE_CODE_DROP_INDEX | Unused. |
15 | JOB_TYPE_CODE_WITHDRAW | Unused. |
16 | JOB_TYPE_CODE_CLEANUP | Cleanup job. |
17 | JOB_TYPE_CODE_IMPORT_DYNASSOC | Imports dynamic associations for a taxonomy. |
18 | JOB_TYPE_CODE_SNAPSHOT | A snapshot table job. It rebuilds or drops a snapshot table, and repopulates it with missing records. |
19 | JOB_TYPE_CODE_MIGRATION_IN_USERS | Migrates in users. |
20 | JOB_TYPE_CODE_SYNC_IN_SQLSVR | Unused. |
21 | JOB_TYPE_CODE_EXPORT_BUNDLE | Unused. |
22 | JOB_TYPE_CODE_SYNC_IN_BUNDLE | Unused. |
23 | JOB_TYPE_CODE_SNAPSHOT_BATCH | Processes a batch of snapshot table records. This job is started by a snapshot table job. |
24 | JOB_TYPE_CODE_MEDIA_BATCH | Unused. |
25 | JOB_TYPE_CODE_PENDING_REQUEST_EXPORT | Exports records for a named event. Named events used to be called pending requests. |
26 | JOB_TYPE_CODE_PENDING_REQUEST_IMPORT | Imports records for a named event. Named events used to be called pending requests. |
27 | JOB_TYPE_CODE_PENDING_REQUEST_RUN | Executes a named event for all affected repositories. Named events used to be called pending requests. |
28 | JOB_TYPE_CODE_LINK_BATCH | Unused. |
29 | JOB_TYPE_CODE_REPLACE_ALL | When a code set is edited, this job updates code set values in repositories. |
30 | JOB_TYPE_CODE_REPLACE_BY_API | Unused. |
31 | JOB_TYPE_CODE_COPYTOPRODUCTION_ALL | Copy all records from a staging repository to a production repository. |
32 | JOB_TYPE_CODE_REVERTFROMPRODUCTION_ALL | Unused. |
33 | JOB_TYPE_CODE_MOVETOARCHIVE_ALL | Unused. |
34 | JOB_TYPE_CODE_RESTORETOSTAGING_ALL | Unused. |
35 | JOB_TYPE_CODE_COPY_DATA | Copies data from one repository to another. The repositories must have the same profile. All attr_data contents are copied. |
36 | JOB_TYPE_CODE_LINK_IMPORT | Unused. |
37 | JOB_TYPE_CODE_PUBLISH_OUTPUT | Exports data using syndication/export templates |
38 | JOB_TYPE_CODE_REPO_PROMOTE | Promotes records from a staging repository to a production repository. |
39 | JOB_TYPE_CODE_SAVED_SET_IMPORT | Reads primary keys of records from a file, looks them up in the repository, and, if a primary key is found, puts the record into the requested saved set. |
40 | JOB_TYPE_CODE_CREATE_CODE_SET_FROM_REPO | Creates a code set from specified attribute values. |
41 | JOB_TYPE_CODE_CLONE | If a repository is configured with the clone capability, a user can select a list of records from the listing page, and initiate a clone job to clone those selected records. |
42 | JOB_TYPE_CODE_TAXONOMY_NODE_SEQUENCE | A job that sequences taxonomy nodes. |
43 | JOB_TYPE_CODE_GENERATE_VARIANTS | If a repository has parent-child relationship and both repositories have the same set of variant attributes, this job generates variants on the parent repository. This job code is also used in DamMaster to generate variants and start the generation of image reports comparing the DamMaster record to original images. |
44 | JOB_TYPE_CODE_DELETE_IMAGES | Deletes oprhaned images from DamMaster. |
45 | JOB_TYPE_CODE_REPORT_VARIANTS | A job that starts the generation of the image report, comparing DamMaster records to original images. |
46 | JOB_TYPE_CODE_COPY_HIERARCHY | A job that copies a hierarchy. |
47 | JOB_TYPE_MULTI_LANG_IMPORT | A multi-language import job. |
48 | JOB_TYPE_CODE_CODE_SET_IMPORT | Imports code set codes into the specified code set. |
49 | JOB_TYPE_CODE_WEBPROD_SPLITCLONE | Unused. |
50 | JOB_TYPE_CODE_CUSTOM | A custom job. |
51 | JOB_TYPE_CODE_DEDUPLICATION | Unused. |
52 | JOB_TYPE_CODE_DEDUPLICATION_IMPORT | Unused. |
53 | JOB_TYPE_CODE_IMPORT_STREAM | Imports a stream of data into a repository via the REST API. The data must be formatted according to an exchange template. |
54 | JOB_TYPE_CODE_VALIDATE_EXCHANGE_TEMPLATE | Validates records in one or more repositories as defined by an exchange template. |
Job status codes
Job status codes indicate the current state of a job.
When a job is processing a lot of records (such as an import, export, or validation job), the records are split into 200 record batches and run as separate threads. If one of the batches fails, the other batches may still finish successfully. In that case, the job would have completed with errors.
Code | Job Status | Description |
---|---|---|
-2 | JOB_STATUS_ERROR_OUT | The job encountered an error, tried again and still encountered an error, then it stopped processing. |
-1 | JOB_STATUS_ERROR |
The job encountered an error and stopped processing. |
0 | JOB_STATUS_NEW | The job was created. |
1 | JOB_STATUS_DONE | The job completed processing. |
2 | JOB_STATUS_CANCEL | The job was canceled. |
99 | JOB_STATUS_PROCESSING | The job is running. If the job controller is restarted while a job has this status, the job status will be set to -1 (JOB_STATUS_ERROR). |
100 | JOB_STATUS_BATCH_INIT | The batched portion of the job has been started. If the job controller is restarted while a job has this status, the job status will be set to -1 (JOB_STATUS_ERROR). |
101 | JOB_STATUS_BATCH_FINALIZE | The batched portion of the job has finished. If the job controller is restarted while a job has this status, the job status will be set to -1 (JOB_STATUS_ERROR). |
Job abort indicator codes
When a user aborts a job, an abort flag is set to tell the job to abort itself. The job routinely checks the flag to see if it needs to abort itself. If the job is stuck, it may not be able to check the abort flag, therefore it may not abort itself.
Job abort flag codes show whether or not the job's abort flag has been set.
Code | Description |
---|---|
0 | The abort flag has not been set. The job has not been requested to abort itself. |
1 | The abort flag has been set. The job has been requested to abort itself. |
Job history status codes
When a job changes state, it updates the job history status value.
When a user aborts a job, an abort flag is set to tell the job to abort itself. The job routinely checks the flag to see if it needs to abort itself. If the job is stuck, it may not be able to check the abort flag, therefore it may not abort itself.
When a job is processing a lot of records (such as an import, export, or validation job), the records are split into 200 record batches and run as separate threads. If one of the batches fails, the other batches may still finish successfully. In that case, the job would have completed with errors.
Code | History Status | Description |
---|---|---|
0 |
JOB_HISTORY_STATUS_QUEUE |
The job is queued and waiting to process. |
1 |
JOB_HISTORY_STATUS_RUNNING |
The job is running. |
2 |
JOB_HISTORY_STATUS_COMPLETED |
The job completed with no errors. |
3 |
JOB_HISTORY_STATUS_ERROR |
The job could not complete. For example, if an export with template job can't find the template. |
4 |
JOB_HISTORY_STATUS_ABORTED |
The job abort flag was set and the job aborted itself. |
5 |
JOB_HISTORY_STATUS_ABORT_ATTEMPT |
The job abort flag was set, but the job has not yet aborted itself. |
6 |
JOB_HISTORY_STATUS_COMPLETE_ERRORS |
A job batched records and one or more of the batches failed, but other batches completed successfully. |