![]() |
T4S4
19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
|
Functions | |
getDictValue BatchJobDict ParameterName ?Optional? ?DefaultValue? | |
This function gets the input parameters for a batch job from a dict in case the parameter is optional = YES the given default value will be set, otherwise dict needs to contain a value which is not empty string. More... | |
getTimeWindow args | |
This function gets the time window for execution of the batch job. More... | |
logStatusInfo JobId | |
This function writes the StatusInfo into the log file. More... | |
setAttribute4TeamcenterSYSLOG TcSysLogFileName | |
adds the Teamcenter syslog file information as an user attribute to the job More... | |
setBatchjobDefaults Mode FunctionName T4Target args | |
sets the batch job defaults More... | |
setBatchjobStatus RunMode JobStatus ExecuteFunction Mode ?IgnoreRetryCounter? ?UserState? args | |
sets the state of Batch job to APPERR or RETRY depending on the number of retries. More... | |
setJobMessage JobId MsgTxt | |
if code executed in batch job set the message More... | |
translateBatchjobAttr2WorkflowArgs args | |
translates the batch job arguments starting with a "-" sign into workflow arguments More... | |
writeTcUser2LogIndex LogChannel | |
writes the Tc user to our LogfileIndex More... | |
T4X::BATCHJOB::TOOLBOX::getDictValue | BatchJobDict ParameterName ?Optional? ?DefaultValue? | ||
This function gets the input parameters for a batch job from a dict in case the parameter is optional = YES the given default value will be set, otherwise dict needs to contain a value which is not empty string.
BatchJobDict | dict |
ParameterName | JOBID FUNCTION OBJECTTAG OBJECTCLASS OBJECTTYPE OBJECTID OBJECTREV USERSERVICES TRANSFER SESSIONID CLIENT FILTER DEPENDENCIES ADDITIONALINFO |
Optional | YES / NO - default set to NO |
DefaultValue | default set to NONE |
T4X::BATCHJOB::TOOLBOX::getTimeWindow | args | ||
This function gets the time window for execution of the batch job.
T4X::BATCHJOB::TOOLBOX::logStatusInfo | JobId | ||
This function writes the StatusInfo into the log file.
JobId | unique batch job id |
T4X::BATCHJOB::TOOLBOX::setAttribute4TeamcenterSYSLOG | TcSysLogFileName | ||
adds the Teamcenter syslog file information as an user attribute to the job
TcSysLogFileName |
T4X::BATCHJOB::TOOLBOX::setBatchjobDefaults | Mode FunctionName T4Target args | ||
sets the batch job defaults
Mode | - EXPORT/IMPORT which used in the namespace (T4X::BATCHJOB::EXPORT::BatchjobDefaults) |
FunctionName | ex. T4S_IMPORT_MM |
T4Target | licence target T4X/T4S/T4O/T4EA |
T4X::BATCHJOB::TOOLBOX::setBatchjobStatus | RunMode JobStatus ExecuteFunction Mode ?IgnoreRetryCounter? ?UserState? args | ||
sets the state of Batch job to APPERR or RETRY depending on the number of retries.
RunMode | for Batch job mode has to be set to "BatchJob" |
JobStatus | OK / SKIPPED / ERROR / RETRY |
ExecuteFunction | function name for the batch job settings |
Mode | EXPORT / IMPORT |
IgnoreRetryCounter | OFF / ON initialised with "OFF" if not given and the following parameter are not set |
UserState | job state given as a parameter, initialised with "" if not given |
T4X::BATCHJOB::TOOLBOX::setJobMessage | JobId MsgTxt | ||
if code executed in batch job set the message
JobId | in direct mode TEST_BATCHJOB else the BatchJobId |
MsgTxt | message to be set |
T4X::BATCHJOB::TOOLBOX::translateBatchjobAttr2WorkflowArgs | args | ||
translates the batch job arguments starting with a "-" sign into workflow arguments
args | not yet used |
T4X::BATCHJOB::TOOLBOX::writeTcUser2LogIndex | LogChannel | ||
writes the Tc user to our LogfileIndex
LogChannel |