![]() |
T4S4
19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
|
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... | |