T4S4  18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
API::Core::Batch Namespace Reference

Functions

 compressB64String clearString
 Compresses a string from clear string format to base64 string format. More...
 
 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...
 
 createJobByCloning jobDataObjectRef
 Creates a batch job by copying the settings of another 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...
 
 exportXml logicalFilePath ?statusFilter? ?creationDateFilter?
 Exports the information about the batch jobs in the batch server queue to one or more xml files. 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...
 
 getDependencyHeadDictionary tailJobIdList
 Retrieves the "head dictionary" of a list of "tail jobs". More...
 
 getDependencyHeadList tailJobId
 Retrieves a list of pairs of head job ids and tail job ids that the head job depends on the tail job. More...
 
 getDependencyList
 Retrieves the list of dependencies (for all jobs). More...
 
 getDependencyStatus headJobId
 Gets the status of the batch jobs the head id depends on. More...
 
 getDependencyTailDictionary headJobIdList
 Retrieves the "tail dictionary" of a list of "head jobs". More...
 
 getDependencyTailList headJobId
 Retrieves a list of pairs of head job ids and tail jobs that the head job depends on. 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...
 
 getXmlEncoding
 Retrieves the current xml encoding. More...
 
 importXml logicalFilePath ?statusFilter? ?creationDateFilter?
 Imports the information about the batch jobs in the batch server queue from one or more xml files. More...
 
 isDependencySatisfied headJobId
 Tells, if a dependency for a head job is satisfied. 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...
 
 setXmlEncoding externXmlEncoding internXmlEncoding
 Changes the current xml encoding. 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...
 
 uncompressB64String base64String
 Uncompresses a string from base64 string format to clear string format. 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...
 

Variables

 ___clientDataDefaultObject
 
 ___clientDataInternExternTermObject
 
 ___connectionID
 
 ___createJobDefaultObject
 
 ___extendedAttributeCharacter
 
 ___externXmlEncoding
 
 ___internXmlEncoding
 
 ___jobDataDefaultObject
 
 ___jobDataInternExternTermHash
 
 ___jobDataInternExternTermObject
 
 ___jobDefaultCode
 
 ___jobDefaultDescription
 
 ___retrieveJobListDefaultObject
 
 ___retrieveJobListDefaultObject2
 
 ___serverDataDefaultObject
 
 ___xmlBuffer
 
 ___xmlDependency
 
 ___xmlDependencyList
 
 ___xmlJob
 
 ___xmlJobAttachmentName
 
 ___xmlJobList
 
 ___xmlStack
 
 ___xmlTimestamp
 

Function Documentation

◆ getDependencyList()

API::Core::Batch::getDependencyList

Retrieves the list of dependencies (for all jobs).

Deprecated:
It is not useful to get all dependencies and for performance reasons not practicable. For one job id, you can use the function getAllDependencies. If necessary, you can call this function in a loop for all job ids.
Returns
always "" as error

Variable Documentation

◆ ___clientDataDefaultObject

___clientDataDefaultObject
static

◆ ___clientDataInternExternTermObject

___clientDataInternExternTermObject
static

◆ ___connectionID

___connectionID
static

◆ ___createJobDefaultObject

___createJobDefaultObject
static

◆ ___extendedAttributeCharacter

___extendedAttributeCharacter
static

◆ ___externXmlEncoding

___externXmlEncoding
static

◆ ___internXmlEncoding

___internXmlEncoding
static

◆ ___jobDataDefaultObject

___jobDataDefaultObject
static

◆ ___jobDataInternExternTermHash

___jobDataInternExternTermHash
static

◆ ___jobDataInternExternTermObject

___jobDataInternExternTermObject
static

◆ ___jobDefaultCode

___jobDefaultCode
static

◆ ___jobDefaultDescription

___jobDefaultDescription
static

◆ ___retrieveJobListDefaultObject

___retrieveJobListDefaultObject
static

◆ ___retrieveJobListDefaultObject2

___retrieveJobListDefaultObject2
static

◆ ___serverDataDefaultObject

___serverDataDefaultObject
static

◆ ___xmlBuffer

___xmlBuffer
static

◆ ___xmlDependency

___xmlDependency
static

◆ ___xmlDependencyList

___xmlDependencyList
static

◆ ___xmlJob

___xmlJob
static

◆ ___xmlJobAttachmentName

___xmlJobAttachmentName
static

◆ ___xmlJobList

___xmlJobList
static

◆ ___xmlStack

___xmlStack
static

◆ ___xmlTimestamp

___xmlTimestamp
static