![]() |
T4S4
18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
|
Namespaces | |
API::Core::Batch | |
Functions | |
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::connect | ip port ?transportType? ?ipProtocol? | ||
Opens a connection with the batch server.
A batch server connection is needed in order to use any of the batch server functions
References API::Core::Batch::connectTo(), and tpwrite().
API::Core::Batch::connectTo | ?connectionID? | ||
Opens a connection to the given server.
A job server connection is needed in order to use any of the job server functions
connectionID | connection id of the job server |
noerr | default "", throws an exception for double connection or connection is not possible |
References API::Core::Batch::disconnect(), and tpwrite().
Referenced by API::Core::Batch::connect(), T4X::BATCHJOB::EXPORT::createBatchjob(), T4X::BATCHJOB::IMPORT::createBatchjob(), T4X::TEST::WORKFLOW::createBatchJob4Workflow(), T4X::BATCHJOB::EXPORT::createJob(), T4X::BATCHJOB::IMPORT::createJob(), T4X::BATCHJOB::EXPORT::handleBatchJob(), and T4X::BATCHJOB::IMPORT::handleBatchJob().
API::Core::Batch::createJob | createJobObjectRef | ||
Creates a batch job.
For infos on objects of type "createJob" see function "createObject" for more details
createJobObjectRef | : a reference to an object (object name) of type "createJob" |
References API::Core::Batch::getObjectAttribute(), and API::Core::Batch::getObjectExtendedAttributeList().
Referenced by T4X::BATCHJOB::EXPORT::createBatchjob(), T4X::BATCHJOB::IMPORT::createBatchjob(), T4X::TEST::WORKFLOW::createBatchJob4Workflow(), T4X::BATCHJOB::EXPORT::createJob(), and T4X::BATCHJOB::IMPORT::createJob().
API::Core::Batch::createObject | type args | ||
Creates an object.
The following object types are supported:
An object of type "createJob"
Attributes for an object of type "createJob":
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.
Attributes for an object of type "jobData":
Attributes for an object of type "clientData":
Attributes for an object of type "serverData":
type | : the object type to create |
args | : (optional) attributes to set or to add |
References API::Core::Batch::isValidAttributeName().
Referenced by T4X::BATCHJOB::EXPORT::createBatchjob(), T4X::BATCHJOB::IMPORT::createBatchjob(), T4X::TEST::WORKFLOW::createBatchJob4Workflow(), T4X::BATCHJOB::EXPORT::createJob(), T4X::BATCHJOB::IMPORT::createJob(), API::Core::Batch::retrieveClientList(), and API::Core::Batch::retrieveServerInfo().
API::Core::Batch::deleteJob | jobId | ||
Deletes a batch job.
jobId | : the job id |
API::Core::Batch::disableJobServerBackend |
disable the job server backend, if already disabled it does nothing
API::Core::Batch::disableJobServerFrontend |
disable the job server frontend, if already disabled it does nothing
API::Core::Batch::disconnect | args | ||
Closes a connection with the batch server.
A batch server connection is needed in order to use any of the batch server functions
args | unused |
Referenced by API::Core::Batch::connectTo(), T4X::BATCHJOB::EXPORT::createBatchjob(), T4X::BATCHJOB::IMPORT::createBatchjob(), T4X::TEST::WORKFLOW::createBatchJob4Workflow(), T4X::BATCHJOB::EXPORT::createJob(), T4X::BATCHJOB::IMPORT::createJob(), T4X::BATCHJOB::EXPORT::handleBatchJob(), and T4X::BATCHJOB::IMPORT::handleBatchJob().
API::Core::Batch::enableJobServerBackend |
enable the job server backend, if already enabled it does nothing
API::Core::Batch::enableJobServerFrontend |
enable the job server frontend, if already enabled it does nothing
API::Core::Batch::getAllDependencies | jobId | ||
Retrieves all dependencies of a job identified by its jobId.
This function retrieves the full dependency structure of the job identified by its jobId. It returns a dict with two elements DEPN and REQY. These elements are dicts too, containing two more dicts soft and hard. Soft and hard each contain a lists of job ids.
job | id |
References API::Core::Batch::getJobAttribute().
API::Core::Batch::getAttributeFromRawAttributeString | rawAttributeStringRef rawAttributeName | ||
Retrieves the value of an attribute of the "raw attribute string" of a batch job.
The "raw attribute string" is a string representation of the attributes of a batch job using the "inner" attribute names
rawAttributeStringRef | : a reference to an attribute string (attribute string name) |
rawAttributeName | : the name of the attribute |
References API::Core::Batch::isValidAttributeName().
Referenced by T4X::BATCHJOB::EXPORT::executeExportJob(), and T4X::BATCHJOB::IMPORT::executeImportJob().
API::Core::Batch::getExtendedAttributeCharacter |
Retrieves the current extended attribute character.
API::Core::Batch::getJobAttachment | jobId fileName | ||
Retrieves an attachment of a batch job.
jobId | : the job id |
fileName | : the name of the attachment |
References tpco_formatHEX16().
API::Core::Batch::getJobAttachment2 | jobId fileName | ||
Retrieves an attachment of a batch job This function is invers to setJobAttachmentByFile2 and setJobAttachmentByStream2.
jobId | : the job id |
fileName | : the name of the attachment |
References tpco_formatHEX16(), and tpco_uncompressB64Str().
API::Core::Batch::getJobAttachmentNameList | jobId | ||
Retrieves a list of attachment names of a batch job.
jobId | : the job id |
Referenced by API::Core::Batch::setJobAttachmentByFile(), API::Core::Batch::setJobAttachmentByStream(), and API::Core::Batch::setJobAttachmentByStream2().
API::Core::Batch::getJobAttribute | jobId attributeName | ||
Retrieves the value of a batch job attribute.
jobId | : the job id |
attributeName | : the name of the attribute |
Job attributes correspond to attributes of objects of type "jobData". See function "createObject" for more details. On the example code you will get a digit from 1 to 6 with following meaning
digit | status | comment |
---|---|---|
1 | READY | job is ready for execution |
2 | RUNNING | job is being processed |
3 | WAITING | job is waiting |
4 | APPLICATION ERROR | job has an application error |
5 | RUNTIME ERROR | job has a runtime error |
6 | FINISHED | job has finished successfully |
References API::Core::Batch::isValidAttributeName().
Referenced by API::Core::Batch::getAllDependencies().
API::Core::Batch::getJobCode | jobId | ||
Retrieves the code of a batch job.
jobId | : the job id |
References tpco_uncompressB64Str().
Referenced by API::Core::Batch::retrieveJobList().
API::Core::Batch::getJobLogChannel | jobId | ||
provide the log channel of job
job_id |
API::Core::Batch::getJobMessage | jobId | ||
Retrieves the message value of a batch job.
jobId | : the job id |
API::Core::Batch::getJobRawAttributeString | jobId | ||
Retrieves the "raw attribute string" of a batch job.
The "raw attribute string" is a string representation of the attributes of a batch job using the "inner" attribute names
jobId | : the job id |
API::Core::Batch::getJobServerBackendStatus |
get the status of job server backend if the job server backend is enabled. ON returned, else OFF
API::Core::Batch::getJobServerFrontendStatus |
get the status of job server frontend if the job server frontend is enabled. ON returned, else OFF
API::Core::Batch::getObjectAttribute | objectRef attributeName | ||
Retrieves the value of an object attribute.
objectRef | : a reference to an object (object name) |
attributeName | : the name of the attribute |
References API::Core::Batch::isValidAttributeName().
Referenced by API::Core::Batch::createJob(), and API::Core::Batch::retrieveJobList().
API::Core::Batch::getObjectAttribute2 | objectRef attributeName | ||
Retrieves the value of an object attribute for retrieveJobList2 objects.
objectRef | : a reference to an object (object name), must be created by retrieveJobList2 with DICT. Please look in the example. |
attributeName | : the name of the attribute |
References API::Core::Batch::isValidAttributeName().
API::Core::Batch::getObjectAttributeNameList | objectRef | ||
Retrieves a list with the attribute names of an object.
objectRef | : a reference to an object (object name) |
API::Core::Batch::getObjectAttributeValueList | objectRef | ||
Retrieves a list with the attribute values of an object.
objectRef | : a reference to an object (object name) |
API::Core::Batch::getObjectBaseAttributeList | objectRef | ||
Retrieves a list with the base attributes of an object.
Each list element is a list having an attribute name as first element and an attribute value as second element
objectRef | : a reference to an object (object name) |
API::Core::Batch::getObjectExtendedAttributeList | objectRef | ||
Retrieves a list with the extended attributes of an object.
Each list element is a list having an attribute name as first element and an attribute value as second element
objectRef | : a reference to an object (object name) |
Referenced by API::Core::Batch::createJob().
API::Core::Batch::getObjectString | objectRef | ||
Retrieves a string representation of an object.
objectRef | : a reference to an object (object name) |
API::Core::Batch::isInBatchContext |
Tells, if the context is a batch context.
API::Core::Batch::isJob | jobId | ||
Tells, if a job id corresponds to a job.
jobId | : the job id to check |
API::Core::Batch::isValidAttributeName | attributeName | ||
Tells, if an item is suitable as attribute name.
attributeName | : the item to check |
Referenced by API::Core::Batch::createObject(), API::Core::Batch::getAttributeFromRawAttributeString(), API::Core::Batch::getJobAttribute(), API::Core::Batch::getObjectAttribute(), API::Core::Batch::getObjectAttribute2(), API::Core::Batch::setAttributeToRawAttributeString(), API::Core::Batch::setJobAttribute(), API::Core::Batch::setObjectAttribute(), and API::Core::Batch::unsetObjectAttribute().
API::Core::Batch::retrieveClientList |
Retrieves the list of batch clients connected to the batch server.
For infos on objects of type "clientData" see function "createObject" for more details
References API::Core::Batch::createObject(), and API::Core::Batch::setObjectAttribute().
API::Core::Batch::retrieveJobList | retrieveJobListObjectRef | ||
Retrieves a list of batch jobs satisfying certain search criteria.
For infos on objects of types "retrieveJobList" or "jobData" see function "createObject" for more details
retrieveJobListObjectRef | : a reference to an object (object name) of type "retrieveJobList" specifying the search criteria |
References API::Core::Batch::getJobCode(), and API::Core::Batch::getObjectAttribute().
API::Core::Batch::retrieveJobList2 | object | ||
Retrieves a list of batch jobs satisfying certain search criteria using the searchJobs2 function, this function have mutch more search possibilities.
For infos on objects of types "retrieveJobList2" or "jobData" see function "createObject" for more details all parameters are lists, please look in the example code sequence. The appoach is following: 1) creating an empty retrieveJobList2 object, 2) setting all the search filters using the setObjectAttribute function, ... n) call the retrieveJobList2 function.
or 1) create a object with the filter criteria 2) call the retrieveJobList2 function for example
object | : a reference to an object (object name) of type "retrieveJobList2" specifying the search criteria |
optional | a list with search patterns (Please look in the description of createObject |
API::Core::Batch::retrieveServerInfo |
Retrieves information about the batch server.
For infos on objects of type "serverData" see function "createObject" for more details
References API::Core::Batch::createObject().
API::Core::Batch::setAttributeToRawAttributeString | rawAttributeStringRef rawAttributeName rawAttributeValue | ||
Changes the value of an attribute of the "raw attribute string" of a batch job.
The "raw attribute string" is a string representation of the attributes of a batch job using the "inner" attribute names
rawAttributeStringRef | : a reference to an attribute string (attribute string name) |
rawAttributeName | : the name of the attribute |
rawAttributeValue | : the value of the attribute |
References API::Core::Batch::isValidAttributeName().
API::Core::Batch::setDependency | headJobId tailJobIdList ?timeout? | ||
Sets a dependency between a "head job" and a list of "tail jobs".
The "head job" is the job that depends on the "tail jobs". A dependency is satisfied if and only if all tail jobs are in finished state. Dependencies have an expiration date depending on their timeout
headJobId | : the id of the head job |
tailJobIdList | : the list of ids of the tail jobs |
timeout | : the timeout in seconds of a dependency (unused) |
References API::Core::Batch::setHardDependency().
Referenced by T4X::BATCHJOB::EXPORT::createJob(), T4X::BATCHJOB::IMPORT::createJob(), and T4X::BATCHJOB::DEPENDENCIES::setBatchJobDependencies().
API::Core::Batch::setHardDependency | headJobId tailJobIdList | ||
Sets a dependency between a "head job" and a list of "tail jobs".
The "head job" is the job that depends on the "tail jobs". A dependency is satisfied if and only if all tail jobs are in finished state.
headJobId | : the id of the head job |
tailJobIdList | : the list of ids of the tail jobs |
Referenced by T4X::BATCHJOB::EXPORT::createJob(), T4X::BATCHJOB::IMPORT::createJob(), and API::Core::Batch::setDependency().
API::Core::Batch::setJobAttachmentByFile | jobId attachmentPath | ||
Adds an attachment to a batch job, where the attachment is given as a file.
jobId | : the job id |
attachmentPath | : the file path of the attachment. The length of one file name is limited to 31 characters. |
References API::Core::Batch::getJobAttachmentNameList(), and tpco_compressFile2B64().
Referenced by API::Core::Batch::setJobAttachmentByFile2().
API::Core::Batch::setJobAttachmentByFile2 | jobId attachmentPath | ||
Adds an attachment to a batch job, where the attachment is given as a file. This function is inverse to getJobAttachment2.
jobId | : the job id |
attachmentPath | : the file path of the attachment. The length of one file name is limited to 31 characters. |
References API::Core::Batch::setJobAttachmentByFile().
API::Core::Batch::setJobAttachmentByStream | jobId attachmentName attachmentStream | ||
Adds an attachment to a batch job, where the attachment is given as a stream (content)
jobId | : the job id |
attachmentName | : the name of the attachment. The length of one attachment name is limited to 31 characters. |
attachmentStream | : the stream (content) of the attachment as base64 string |
References API::Core::Batch::getJobAttachmentNameList().
API::Core::Batch::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.
jobId | : the job id |
attachmentName | : the name of the attachment. The length of one attachment name is limited to 31 characters. |
attachmentStream | : the stream (content) |
References API::Core::Batch::getJobAttachmentNameList(), and tpco_compressString2B64().
Referenced by T4X::BATCHJOB::EXPORT::createJob(), and T4X::BATCHJOB::IMPORT::createJob().
API::Core::Batch::setJobAttribute | jobId attributeName attributeValue | ||
Changes the value of a batch job attribute or adds a new batch job attribute.
If the attribute exists, the attribute value is changed. If the attribute does not exist, a new attribute is added. Job attributes correspond to attributes of objects of type "jobData", except "code". The job code cannot be edited. See function "createObject" for more details.
jobId | : the job id |
attributeName | : the name of the attribute |
attributeValue | : the value of the attribute |
References API::Core::Batch::isValidAttributeName().
Referenced by T4X::BATCHJOB::EXPORT::createJob(), T4X::BATCHJOB::IMPORT::createJob(), and T4X::BATCHJOB::DEPENDENCIES::setBatchJobDependencies().
API::Core::Batch::setJobMessage | jobId messageValue | ||
Changes the message value of a batch job.
jobId | : the job id |
messageValue | : the value of the "message" attribute |
Referenced by T4X::BATCHJOB::TOOLBOX::setJobMessage().
API::Core::Batch::setJobRawAttributeString | jobId rawAttributeStringRef | ||
Changes the "raw attribute string" of a batch job.
The "raw attribute string" is a string representation of the attributes of a batch job using the "inner" attribute names
jobId | : the job id |
rawAttributeStringRef | : a reference to an attribute string (attribute string name) |
API::Core::Batch::setObjectAttribute | objectRef attributeName attributeValue | ||
Changes the value of an object attribute or adds a new object attribute.
If the attribute exists, the attribute value is changed. If the attribute does not exist, a new attribute is added
objectRef | : a reference to an object (object name) |
attributeName | : the name of the attribute |
attributeValue | : the value of the attribute |
References API::Core::Batch::isValidAttributeName().
Referenced by T4X::BATCHJOB::EXPORT::createBatchjob(), T4X::BATCHJOB::IMPORT::createBatchjob(), T4X::TEST::WORKFLOW::createBatchJob4Workflow(), T4X::BATCHJOB::EXPORT::createJob(), T4X::BATCHJOB::IMPORT::createJob(), and API::Core::Batch::retrieveClientList().
API::Core::Batch::setSoftDependency | headJobId tailJobIdList | ||
Sets a dependency between a "head job" and a list of "tail jobs".
The "head job" is the job that depends on the "tail jobs". A dependency is satisfied if and only if all tail jobs are not running any more, i.e. they have finished with an application or runtime error or successfully.
headJobId | : the id of the head job |
tailJobIdList | : the list of ids of the tail jobs |
Referenced by T4X::BATCHJOB::EXPORT::createJob(), and T4X::BATCHJOB::IMPORT::createJob().
API::Core::Batch::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.
The "raw attribute string" is a string representation of the attributes of a batch job using the "inner" attribute names
rawAttributeItem | : an item of the raw attribute string |
API::Core::Batch::unsetDependency | headJobId tailJobIdList | ||
Unsets a dependency between a "head job" and a list of "tail jobs".
The "head job" is the job that depends on the "tail jobs". Removes the dependencies between a "head job" and a list of "tail jobs".
headJobId | : the id of the head job |
tailJobIdList | : the list of ids of the tail jobs |
API::Core::Batch::unsetObjectAttribute | objectRef attributeName | ||
Removes an object attribute.
objectRef | : a reference to an object (object name) |
attributeName | : the name of the attribute |
References API::Core::Batch::isValidAttributeName().