Qorus Integration Engine® Enterprise Edition 6.0.25_prod
|
main job API namespace More...
Classes | |
class | JobApi |
primary job API class More... | |
class | QorusJob |
The abstract class for Qorus jobs. More... | |
Functions | |
deprecated | job_error (string err, softstring desc="", auto info, softstring severity=OMQ::ES_Major, softbool business=False) |
raises an error in a running job; does not affect the flow of execution in the job code More... | |
deprecated | job_warning (string err, softstring desc="", auto info, softbool business=False) |
raises a warning in a running job; does not affect the flow of execution in the job code More... | |
deprecated | job_err (string err, string desc_fmt) |
raises an error in a running job; does not affect the flow of execution in the job code More... | |
deprecated | job_warn (string err, string desc_fmt) |
raises a warning in a running job; does not affect the flow of execution in the job code More... | |
deprecated | job_save_info (auto info) |
saves information against the job instance in the database More... | |
deprecated hash< auto > | job_info () |
returns a hash of job information about the current job More... | |
deprecated | job_save_state_data (hash< auto > data) |
serializes the given hash and stores against the job's state data in JOB_STATE_DATA More... | |
deprecated *hash< auto > | job_get_state_data () |
returns any job state state data stored with job_save_state_data() More... | |
deprecated bool | job_set_trigger (date ts) |
sets a one-time custom trigger time for the job; returns True if set, False if ignored More... | |
main job API namespace
Qorus job API namespace.
deprecated OMQ::UserApi::Job::job_err | ( | string | err, |
string | desc_fmt | ||
) |
raises an error in a running job; does not affect the flow of execution in the job code
the error information is stored in the job_errors
table with a severity of OMQ::ES_Major and the business flag set to True
err | the error code |
desc_fmt | the format specifier for the warning description string; following arguments will be included in the description string as combined with vsprintf() |
deprecated OMQ::UserApi::Job::job_error | ( | string | err, |
softstring | desc = "" , |
||
auto | info, | ||
softstring | severity = OMQ::ES_Major , |
||
softbool | business = False |
||
) |
raises an error in a running job; does not affect the flow of execution in the job code
the error information is stored to the job_errors
table, errors errors with a severity less than or equal to OMQ::ES_Warning are treated as warnings
err | the error code |
desc | a description for the error |
info | additional information to be saved with the error (data structures are serialized in YAML format and saved in the database) |
severity | the severity of the error, errors with a severity less than or equal to OMQ::ES_Warning are treated as warnings; see Error Severity Codes for valid values (default = OMQ::ES_Major) |
business | set to True if the error represents a business error |
deprecated *hash< auto > OMQ::UserApi::Job::job_get_state_data | ( | ) |
returns any job state state data stored with job_save_state_data()
deprecated hash< auto > OMQ::UserApi::Job::job_info | ( | ) |
returns a hash of job information about the current job
jobid:
the metadata jobid of the job typejob_instanceid:
the id of the job instancename:
the job nameversion:
the job versiondescription:
the job descriptiontrigger:
a string describing the timer/trigger for the joblast_executed:
the last executed date/time of the job (NOTHING if never executed before the current iteration)last_executed_job_instanceid:
the last executed instance id of the jobnext:
the next trigger date/timedeprecated OMQ::UserApi::Job::job_save_info | ( | auto | info | ) |
saves information against the job instance in the database
The information is serialized in YAML format and saved in the database in the JOB_INSTANCE
row as a part of the job results.
This information is returned in the API as the info
key in REST Job Result Hash data, for example in the return value to the REST GET /api/latest/jobresults/{id} call.
info | the information to save |
deprecated OMQ::UserApi::Job::job_save_state_data | ( | hash< auto > | data | ) |
serializes the given hash and stores against the job's state data in JOB_STATE_DATA
data | the state data to serialize and store against the job's state data in JOB_STATE_DATA |
deprecated bool OMQ::UserApi::Job::job_set_trigger | ( | date | ts | ) |
sets a one-time custom trigger time for the job; returns True if set, False if ignored
ts | the timestamp to trigger the job; must be in the future and before the next trigger time |
deprecated OMQ::UserApi::Job::job_warn | ( | string | err, |
string | desc_fmt | ||
) |
raises a warning in a running job; does not affect the flow of execution in the job code
the warning information is stored to the job_errors
table with a severity of OMQ::ES_Warning and the business flag set to True
err | the warning or error code |
desc_fmt | the format specifier for the warning description string; following arguments will be included in the description string as combined with vsprintf() |
deprecated OMQ::UserApi::Job::job_warning | ( | string | err, |
softstring | desc = "" , |
||
auto | info, | ||
softbool | business = False |
||
) |
raises a warning in a running job; does not affect the flow of execution in the job code
the warning information is stored to the job_errors
table with a severity of OMQ::ES_Warning
err | the warning or error code |
desc | a description for the warning |
info | additional information to be saved with the warning (data structures are serialized in YAML format and saved in the database) |
business | set to True if the warning represents a business warning |