T4S4  19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
T4X::BATCHJOB::TOOLBOX Namespace 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...
 

Function Documentation

◆ getDictValue()

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.

Parameters
BatchJobDictdict
ParameterNameJOBID FUNCTION OBJECTTAG OBJECTCLASS OBJECTTYPE OBJECTID OBJECTREV USERSERVICES TRANSFER SESSIONID CLIENT FILTER DEPENDENCIES ADDITIONALINFO
OptionalYES / NO - default set to NO
DefaultValuedefault set to NONE
Returns
found value

◆ getTimeWindow()

T4X::BATCHJOB::TOOLBOX::getTimeWindow   args  

This function gets the time window for execution of the batch job.

Returns
timeWindow

◆ logStatusInfo()

T4X::BATCHJOB::TOOLBOX::logStatusInfo   JobId  

This function writes the StatusInfo into the log file.

Parameters
JobIdunique batch job id
Returns
no return

◆ setAttribute4TeamcenterSYSLOG()

T4X::BATCHJOB::TOOLBOX::setAttribute4TeamcenterSYSLOG   TcSysLogFileName  

adds the Teamcenter syslog file information as an user attribute to the job

Parameters
TcSysLogFileName
Returns
none

◆ setBatchjobDefaults()

T4X::BATCHJOB::TOOLBOX::setBatchjobDefaults   Mode FunctionName T4Target args  

sets the batch job defaults

Parameters
Mode- EXPORT/IMPORT which used in the namespace (T4X::BATCHJOB::EXPORT::BatchjobDefaults)
FunctionNameex. T4S_IMPORT_MM
T4Targetlicence target T4X/T4S/T4O/T4EA
Returns
none

◆ setBatchjobStatus()

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.

Parameters
RunModefor Batch job mode has to be set to "BatchJob"
JobStatusOK / SKIPPED / ERROR / RETRY
ExecuteFunctionfunction name for the batch job settings
ModeEXPORT / IMPORT
IgnoreRetryCounterOFF / ON initialised with "OFF" if not given and the following parameter are not set
UserStatejob state given as a parameter, initialised with "" if not given
Returns
none

◆ setJobMessage()

T4X::BATCHJOB::TOOLBOX::setJobMessage   JobId MsgTxt  

if code executed in batch job set the message

Parameters
JobIdin direct mode TEST_BATCHJOB else the BatchJobId
MsgTxtmessage to be set
Returns
none

◆ translateBatchjobAttr2WorkflowArgs()

T4X::BATCHJOB::TOOLBOX::translateBatchjobAttr2WorkflowArgs   args  

translates the batch job arguments starting with a "-" sign into workflow arguments

Parameters
argsnot yet used
Returns
none

◆ writeTcUser2LogIndex()

T4X::BATCHJOB::TOOLBOX::writeTcUser2LogIndex   LogChannel  

writes the Tc user to our LogfileIndex

Parameters
LogChannel
Returns
none