T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
CONFIGURATION::MANAGER::JobAgent Namespace Reference

Commands to edit the job agent configuration of a GS. More...

Functions

 checkJobAgentConfiguration JobAgentConfiguration
 Checks if a job agent configuration defines all required settings. More...
 
 getJobAgentList
 Returns a list of the currently configured job agents of a GS. More...
 
 setJobAgentList ListOfJobAgents
 Sets the list of configured job agents. More...
 

Detailed Description

Commands to edit the job agent configuration of a GS.

Function Documentation

◆ checkJobAgentConfiguration()

CONFIGURATION::MANAGER::JobAgent::checkJobAgentConfiguration   JobAgentConfiguration  

Checks if a job agent configuration defines all required settings.

Parameters
JobAgentConfigurationlist containing all required settings (key value pairs) for the job agent configuration
Returns
nothing
1 set myIncompleteAgent [dict create exeShell tpapps pattern *myPattern*]
3  puts "An error was raised: $::errorInfo"
4 }

Referenced by setJobAgentList().

◆ getJobAgentList()

CONFIGURATION::MANAGER::JobAgent::getJobAgentList

Returns a list of the currently configured job agents of a GS.

Parameters
none
Returns
list of job agents (one dict for each agent)
2  puts "agent for pattern [dict get $agent pattern] is currently turned [dict get $agent enabled]"
3 }

References CONFIGURATION::MANAGER::Util::getConfigKey(), and rcwd().

◆ setJobAgentList()

CONFIGURATION::MANAGER::JobAgent::setJobAgentList   ListOfJobAgents  

Sets the list of configured job agents.

Parameters
ListOfJobAgentslist of agents (one dict for each agent)
Returns
nothing
2 set myAgent [dict create exeShell tpapps \
3  pattern *myPattern2* \
4  idleMemory 128 \
5  enabled on \
6 ]
7 set extendedAgentList [lappend existingAgents $myAgent]

References checkJobAgentConfiguration(), CONFIGURATION::MANAGER::Util::getConfigKey(), rcwd(), and CONFIGURATION::MANAGER::Util::setConfigKey().