T4S4  18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
CONFIGURATION::MANAGER::Scheduler Namespace Reference

Commands to receive and edit the scheduler configuration. More...

Functions

 activateScheduledProcess scheduledProcess
 Activates the scheduled process. More...
 
 clearScheduledProcessList
 Remove all scheduled processes. More...
 
 createScheduledProcess ?scheduleTime? ?cmd? ?isActive?
 Creates a new scheduled process. More...
 
 deactivateScheduledProcess scheduledProcess
 Deactivates the scheduled process. More...
 
 getProcessCommand scheduledProcess
 Get process command for process. More...
 
 getProcessScheduleTime scheduledProcess
 Get schedule time for process. More...
 
 getScheduledProcessList
 Returns a list of the currently scheduled processes. More...
 
 isScheduledProcessActive scheduledProcess
 Checks the status of scheduled process. More...
 
 prepareProcessCommand processExe processParameter
 Prepares the command of the scheduled process. More...
 
 prepareScheduleTime type value
 Prepares the schedule time of the scheduled process. More...
 
 setScheduledProcessList processList
 Sets the list of configured scheduled processes. More...
 

Detailed Description

Commands to receive and edit the scheduler configuration.

Function Documentation

◆ activateScheduledProcess()

CONFIGURATION::MANAGER::Scheduler::activateScheduledProcess   scheduledProcess  

Activates the scheduled process.

Parameters
scheduledProcessdict with process information
Returns
nothing
2  ::CONFIGURATION::MANAGER::Scheduler::activateScheduledProcessActive setting
3 }

◆ clearScheduledProcessList()

CONFIGURATION::MANAGER::Scheduler::clearScheduledProcessList

Remove all scheduled processes.

Parameters
none
Returns
nothing
1 set ::errorInfo ""
3  puts $::errorInfo
4  exit 1
5 }

References tpco_shmdelete(), and tpco_shmexists().

Referenced by setScheduledProcessList().

◆ createScheduledProcess()

CONFIGURATION::MANAGER::Scheduler::createScheduledProcess   ?scheduleTime? ?cmd? ?isActive?  

Creates a new scheduled process.

Parameters
scheduleTimeoptional. process schedule time prepared by CONFIGURATION::MANAGER::Scheduler::prepareScheduleTime
cmdoptional. process command prepared by CONFIGURATION::MANAGER::Scheduler::prepareProcessCommand
isActiveoptional. true or false (default)
Returns
dict with process information
1 set processScheduleTime [::CONFIGURATION::MANAGER::Scheduler::prepareScheduleTime "EverySaturday" 11]
2 set processCmd [::CONFIGURATION::MANAGER::Scheduler::prepareProcessCommand "tpapps.exe" "var/init/start.tpscript var/test/create_mm_import_jobs.tcl -Action TEST -Filter {} -PrefixMatNo TP-PERF- -StartMatNo 4500 -Quantity 100"]
3 set scheduledProcessAdvanced [::CONFIGURATION::MANAGER::Scheduler::createScheduledProcess $processScheduleTime $processCmd]

References prepareProcessCommand(), and prepareScheduleTime().

◆ deactivateScheduledProcess()

CONFIGURATION::MANAGER::Scheduler::deactivateScheduledProcess   scheduledProcess  

Deactivates the scheduled process.

Parameters
scheduledProcessdict with process information
Returns
nothing
2  ::CONFIGURATION::MANAGER::Scheduler::activateScheduledProcessActive setting
3 }

◆ getProcessCommand()

CONFIGURATION::MANAGER::Scheduler::getProcessCommand   scheduledProcess  

Get process command for process.

Parameters
scheduledProcessdict with process information
Returns
processCmd

◆ getProcessScheduleTime()

CONFIGURATION::MANAGER::Scheduler::getProcessScheduleTime   scheduledProcess  

Get schedule time for process.

Parameters
scheduledProcessdict with process information
Returns
scheduleTime

◆ getScheduledProcessList()

CONFIGURATION::MANAGER::Scheduler::getScheduledProcessList

Returns a list of the currently scheduled processes.

Parameters
none
Returns
list of scheduled processes (one dict for each process)
2  set id [dict get $setting "id"]
3 }

References tpco_shmexists(), and tpco_shmget().

◆ isScheduledProcessActive()

CONFIGURATION::MANAGER::Scheduler::isScheduledProcessActive   scheduledProcess  

Checks the status of scheduled process.

Parameters
scheduledProcessdict with process information
Returns
true or false

◆ prepareProcessCommand()

CONFIGURATION::MANAGER::Scheduler::prepareProcessCommand   processExe processParameter  

Prepares the command of the scheduled process.

Parameters
processExeexecutable, e.g. tpapps.exe
processParameterparameter for processExe
Returns
prepared command
1 set processCmd [::CONFIGURATION::MANAGER::Scheduler::prepareProcessCommand "tpapps.exe" "var/script/sample.tcl -Count 100"]

References tpco_shmget().

Referenced by createScheduledProcess().

◆ prepareScheduleTime()

CONFIGURATION::MANAGER::Scheduler::prepareScheduleTime   type value  

Prepares the schedule time of the scheduled process.

Parameters
typetype of time
valueinteger value
             The following combinations are valid:
             - type/value
             - EveryMinute/""
             - EveryMinute2/""
             - EveryMinute3/""
             - EveryMinute4/""
             - EveryMinute5/""
             - EveryMinute10/""
             - EveryMinute15/""
             - EveryMinute30/""
             - EveryHour/""
             - EveryHour3/""
             - EveryHour4/""
             - EveryHour6/""
             - EveryHour12/""
             - EveryDay/0 ... 23
             - EveryMonday/0 ... 23
             - EveryTuesday/0 ... 23
             - EveryWednesday/0 ... 23
             - EveryThursday/0 ... 23
             - EveryFriday/0 ... 23
             - EverySaturday/0 ... 23
             - EverySunday/0 ... 23
Returns
scheduled time
1 set scheduleTime [::CONFIGURATION::MANAGER::Scheduler::prepareScheduleTime "EveryHour6" ""]

Referenced by createScheduledProcess().

◆ setScheduledProcessList()

CONFIGURATION::MANAGER::Scheduler::setScheduledProcessList   processList  

Sets the list of configured scheduled processes.

Parameters
processListlist of scheduled processes (one dict for each process)
Returns
nothing
1 set ::errorInfo ""
3  puts $::errorInfo
4  exit 1
5 }

References clearScheduledProcessList(), tpco_shmset(), and SYSBase::unixid().