|
| connect ip port ?transportType? ?ipProtocol? |
| Opens a connection with the batch server. More...
|
|
| connectTo ?connectionID? |
| Opens a connection to the given server. More...
|
|
| createJob createJobObjectRef |
| Creates a batch job. More...
|
|
| createObject type args |
| Creates an object. More...
|
|
| deleteJob jobId |
| Deletes a batch job. More...
|
|
| disableJobServerBackend |
| disable the job server backend, if already disabled it does nothing More...
|
|
| disableJobServerFrontend |
| disable the job server frontend, if already disabled it does nothing More...
|
|
| disconnect args |
| Closes a connection with the batch server. More...
|
|
| enableJobServerBackend |
| enable the job server backend, if already enabled it does nothing More...
|
|
| enableJobServerFrontend |
| enable the job server frontend, if already enabled it does nothing More...
|
|
| getAllDependencies jobId |
| Retrieves all dependencies of a job identified by its jobId. More...
|
|
| getAttributeFromRawAttributeString rawAttributeStringRef rawAttributeName |
| Retrieves the value of an attribute of the "raw attribute string" of a batch job. More...
|
|
| getExtendedAttributeCharacter |
| Retrieves the current extended attribute character. More...
|
|
| getJobAttachment jobId fileName |
| Retrieves an attachment of a batch job. More...
|
|
| getJobAttachment2 jobId fileName |
| Retrieves an attachment of a batch job This function is invers to setJobAttachmentByFile2 and setJobAttachmentByStream2. More...
|
|
| getJobAttachmentNameList jobId |
| Retrieves a list of attachment names of a batch job. More...
|
|
| getJobAttribute jobId attributeName |
| Retrieves the value of a batch job attribute. More...
|
|
| getJobCode jobId |
| Retrieves the code of a batch job. More...
|
|
| getJobLogChannel jobId |
| provide the log channel of job More...
|
|
| getJobMessage jobId |
| Retrieves the message value of a batch job. More...
|
|
| getJobRawAttributeString jobId |
| Retrieves the "raw attribute string" of a batch job. More...
|
|
| getJobServerBackendStatus |
| get the status of job server backend if the job server backend is enabled. ON returned, else OFF More...
|
|
| getJobServerFrontendStatus |
| get the status of job server frontend if the job server frontend is enabled. ON returned, else OFF More...
|
|
| getObjectAttribute objectRef attributeName |
| Retrieves the value of an object attribute. More...
|
|
| getObjectAttribute2 objectRef attributeName |
| Retrieves the value of an object attribute for retrieveJobList2 objects. More...
|
|
| getObjectAttributeNameList objectRef |
| Retrieves a list with the attribute names of an object. More...
|
|
| getObjectAttributeValueList objectRef |
| Retrieves a list with the attribute values of an object. More...
|
|
| getObjectBaseAttributeList objectRef |
| Retrieves a list with the base attributes of an object. More...
|
|
| getObjectExtendedAttributeList objectRef |
| Retrieves a list with the extended attributes of an object. More...
|
|
| getObjectString objectRef |
| Retrieves a string representation of an object. More...
|
|
| isInBatchContext |
| Tells, if the context is a batch context. More...
|
|
| isJob jobId |
| Tells, if a job id corresponds to a job. More...
|
|
| isValidAttributeName attributeName |
| Tells, if an item is suitable as attribute name. More...
|
|
| retrieveClientList |
| Retrieves the list of batch clients connected to the batch server. More...
|
|
| retrieveJobList retrieveJobListObjectRef |
| Retrieves a list of batch jobs satisfying certain search criteria. More...
|
|
| retrieveJobList2 object |
| Retrieves a list of batch jobs satisfying certain search criteria using the searchJobs2 function, this function have mutch more search possibilities. More...
|
|
| retrieveServerInfo |
| Retrieves information about the batch server. More...
|
|
| setAttributeToRawAttributeString rawAttributeStringRef rawAttributeName rawAttributeValue |
| Changes the value of an attribute of the "raw attribute string" of a batch job. More...
|
|
| setDependency headJobId tailJobIdList ?timeout? |
| Sets a dependency between a "head job" and a list of "tail jobs". More...
|
|
| setHardDependency headJobId tailJobIdList |
| Sets a dependency between a "head job" and a list of "tail jobs". More...
|
|
| setJobAttachmentByFile jobId attachmentPath |
| Adds an attachment to a batch job, where the attachment is given as a file. More...
|
|
| setJobAttachmentByFile2 jobId attachmentPath |
| Adds an attachment to a batch job, where the attachment is given as a file. This function is inverse to getJobAttachment2. More...
|
|
| setJobAttachmentByStream jobId attachmentName attachmentStream |
| Adds an attachment to a batch job, where the attachment is given as a stream (content) More...
|
|
| setJobAttachmentByStream2 jobId attachmentName attachmentStream |
| Adds an attachment to a batch job, where the attachment is given as a stream (content). No compressing is necessary. This function is inverse to getJobAttachment2. More...
|
|
| setJobAttribute jobId attributeName attributeValue |
| Changes the value of a batch job attribute or adds a new batch job attribute. More...
|
|
| setJobMessage jobId messageValue |
| Changes the message value of a batch job. More...
|
|
| setJobRawAttributeString jobId rawAttributeStringRef |
| Changes the "raw attribute string" of a batch job. More...
|
|
| setObjectAttribute objectRef attributeName attributeValue |
| Changes the value of an object attribute or adds a new object attribute. More...
|
|
| setSoftDependency headJobId tailJobIdList |
| Sets a dependency between a "head job" and a list of "tail jobs". More...
|
|
| splitRawAttributeItemToDictionary rawAttributeItem |
| Splits an item of the "raw attribute string" of a batch job to its name and to its value and packs them into a dictionary. More...
|
|
| unsetDependency headJobId tailJobIdList |
| Unsets a dependency between a "head job" and a list of "tail jobs". More...
|
|
| unsetObjectAttribute objectRef attributeName |
| Removes an object attribute. More...
|
|
API::Core::Batch::createObject |
|
|
type args |
|
|
| |
Creates an object.
The following object types are supported:
- "createJob", "retrieveJobList2", "jobData", "clientData", "serverData"
An object of type "createJob"
- describes the properties of a "job object" used as input data when creating a job An object of type "retrieveJobList2"
- describes the properties of a "retrieve job list object" used as input data when retrieving job infos An object of type "jobData"
- describes the properties of a "job data object" used as output data when retrieving job infos An object of type "clientData"
- describes the properties of a "client data object" used as output data when retrieving batch client infos An object of type "serverData"
- describes the properties of a "server data object" used as output data when retrieving batch server infos
Attributes for an object of type "createJob":
- id : job id
- code : job code
- description : job description
- priority : job priority
- timeout : job timeout
- timeWindowStart : job time window start
- timeWindowEnd : job time window end
- attachmentFileList : list of job attachment files Other attributes are possible and are considered as "user defined" job attributes
Attributes for an object of type "retrieveJobList2": All attributes are lists with following structure: [list <key parameter>=""> [list
]] We have cases fore one value in value parameter list like returnType, sortOrder, ... maximal two values for time intervals at example like creationTime, modificationTime, ..., or complete key value lists like searchPattern "[list searchPattern [list DESC OTTO* STATE 45]]" for example search all jobs with description like OTTO* which have runtime or application error.
- state : state of jobs : example [list state [list 4 5]] for application or runtime error
- lock : lock (0 free, 1 locked) : example [list lock [list 0]] for free jobs
- creationTime : job creation time : example [list creationTime [list [expr {[clock seconds]-3600}]]] filters all jobs which are newer than 1 hour
- modificationTime : like creation time but job modification time : example [list modificationTime [list [expr {[clock seconds]-86400}] [expr {[clock seconds]-3600}]]]
- executionTime : the execution time in seconds : example [list executionTime [list 3600]] : all jobs which runs longer than 1 hour
- searchPattern : the searchPattern : see above
- searchPattern2 : search global through all attributes of job with OR : example [list searchPattern2 [list OTTO WILLI]] mean all jobs where the attributes contains WILLI or OTTO
- timeWindow : job time intervall
- priority : one priority : example [list priority [list 10]]
- sortBy : sort by the field : example [list sortBy [list DESC]]
- sortDirection : sort direction can be ASC or DESC : example [list sortDirection [list ASC]]
- caseSensity : 0 for no, 1 for yes : example [list caseSensity [list 1]] for case sensitive search
- returnType : can be LIST or DICT : example [list returnType [list DICT]], default is LIST
- resultRange : the min and max result range : example [list resultRange [list 0 100]], default is [list 0 100000]
Attributes for an object of type "jobData":
- id : job id
- description : job description
- message : job message
- log : content of job log file
- code : job code
- attachmentStreamList : contents of job attachment files
- priority : job priority
- timeout : job timeout
- timeWindowStart : job time window start
- timeWindowEnd : job time window end
- state : job state
- lock : job lock status
- creationTime : job creation time
- modificationTime : job modification time
- clientName : identifier string of batch client (if job execution has started)
- user : user who created the job
- host : host where the job was created
- shell : process that created the job ("tps" or "tpapps")
- ip : ip address of batch client (if job execution has started)
- port : ip address of batch client (if job execution has started)
- retryCounter : job retry counter
- runTime : job run time (if job execution has started) Other attributes are possible and are considered as "user defined" job attributes
Attributes for an object of type "clientData":
- name : batch client name
- type : batch client type ("tps" or "tpapps")
- pattern : batch client pattern
- mode : batch client mode
- user : batch client user
- host : batch client host
- pid : batch client process id
- lastMessageTime : last message time
- jobCounter : number of jobs processed
- jobWorking : job currently processed (if not idle)
Attributes for an object of type "serverData":
- ready : number of jobs in "ready" state
- running : number of jobs in "running" state
- waiting : number of jobs in "waiting" state
- applicationError : number of jobs in "applicationError" state
- runtimeError : number of jobs in "runtimeError" state
- finished : number of jobs in "finished" state
- poolSize : number of jobs in the batch pool
- Parameters
-
type | the object type to create |
args | (optional) attributes to set or to add |
- Returns
- created object=ok an empty list ([list]) =error